fix(pam/integration-tests): Fix potential failures depending on pam arguments

.github/workflows/qa.yaml

@@ -9,6 +9,7 @@ on:
 
 env:
   DEBIAN_FRONTEND: noninteractive
+  GO_TESTS_TIMEOUT: 20m
   apt_deps: >-
     libpam-dev
     libglib2.0-dev
@@ -192,7 +193,7 @@ jobs:
           # Overriding the default coverage directory is not an exported flag of go test (yet), so
           # we need to override it using the test.gocoverdir flag instead.
           #TODO: Update when https://go-review.googlesource.com/c/go/+/456595 is merged.
-          go test -cover -covermode=set ./... -coverpkg=./... -shuffle=on -args -test.gocoverdir="${raw_cov_dir}"
+          go test -timeout ${GO_TESTS_TIMEOUT} -cover -covermode=set ./... -coverpkg=./... -shuffle=on -args -test.gocoverdir="${raw_cov_dir}"
 
           # Convert the raw coverage data into textfmt so we can merge the Rust one into it
           go tool covdata textfmt -i="${raw_cov_dir}" -o="${cov_dir}/coverage.out"
@@ -208,7 +209,7 @@ jobs:
 
       - name: Run tests (with race detector)
         run: |
-          go test -race ./...
+          go test -timeout ${GO_TESTS_TIMEOUT} -race ./...
 
       - name: Run PAM tests (with Address Sanitizer)
         env:
@@ -218,10 +219,10 @@ jobs:
           G_DEBUG: "fatal-criticals"
         run: |
           # Use `-dwarflocationlists` to give ASAN a better time to unwind the stack trace
-          go test -C ./pam/internal -asan -gcflags="-dwarflocationlists=true" ./...
+          go test -C ./pam/internal -asan -gcflags="-dwarflocationlists=true" -timeout ${GO_TESTS_TIMEOUT} ./...
 
           pushd ./pam/integration-tests
-          go test -asan -gcflags="-dwarflocationlists=true" -c
+          go test -asan -gcflags="-dwarflocationlists=true" -timeout ${GO_TESTS_TIMEOUT} -c
           # FIXME: Suppression may be removed with newer libpam, as the one we ship in ubuntu as some leaks
           env LSAN_OPTIONS=suppressions=$(pwd)/lsan.supp \
             ./integration-tests.test \

pam/integration-tests/cmd/exec-client/client.go

@@ -11,6 +11,7 @@ import (
 	"os"
 	"reflect"
 	"regexp"
+	"strings"
 
 	"github.com/godbus/dbus/v5"
 	"github.com/msteinert/pam/v2"
@@ -23,6 +24,7 @@ var (
 	pamFlags      = flag.Int64("flags", 0, "pam flags")
 	serverAddress = flag.String("server-address", "", "the dbus connection address to use to communicate with module")
 	logFile       = flag.String("client-log", "", "the file where to save logs")
+	argsFile      = flag.String("client-args-file", "", "the file where arguments are saved")
 )
 
 func main() {
@@ -78,6 +80,15 @@ func mainFunc() error {
 		log.SetOutput(f)
 	}
 
+	if argsFile != nil && *argsFile != "" {
+		log.Debug(context.TODO(), "Reading arguments from %s", *argsFile)
+		ca, err := os.ReadFile(*argsFile)
+		if err != nil {
+			return err
+		}
+		args = append(args, strings.Split(string(ca), "\t")...)
+	}
+
 	actionFlags := pam.Flags(0)
 	if pamFlags != nil {
 		actionFlags = pam.Flags(*pamFlags)

pam/integration-tests/exec_test.go

@@ -843,13 +843,24 @@ func getModuleArgs(t *testing.T, clientPath string, args []string) []string {
 	logFile := os.Stderr.Name()
 	if !testutils.IsVerbose() {
 		logFile = prepareFileLogging(t, "exec-module.log")
-		saveArtifactsForDebug(t, []string{logFile})
+		saveArtifactsForDebugOnCleanup(t, []string{logFile})
 	}
 	moduleArgs = append(moduleArgs, "--exec-log", logFile)
 
 	if clientPath != "" {
 		moduleArgs = append(moduleArgs, "--", clientPath)
 		moduleArgs = append(moduleArgs, "-client-log", logFile)
+
+		if len(strings.Join(append(moduleArgs, args...), " ")) > 768 {
+			// FIXME: If the number of arguments is too big, we may break old PAM.
+			// This is not required anymore when we can use libpam 1.6.0 in CI:
+			// https://github.com/linux-pam/linux-pam/pull/658
+			clientArgsPath := filepath.Join(t.TempDir(), "client-args-file")
+			require.NoError(t, os.WriteFile(clientArgsPath, []byte(strings.Join(args, "\t")), 0600),
+				"Setup: Creation of client args file failed")
+			saveArtifactsForDebugOnCleanup(t, []string{clientArgsPath})
+			return append(moduleArgs, "-client-args-file", clientArgsPath)
+		}
 	}
 	return append(moduleArgs, args...)
 }
@@ -891,6 +902,7 @@ func preparePamTransactionForServiceFile(t *testing.T, serviceFile string, user
 	} else {
 		tx, err = pam.StartConfDir(filepath.Base(serviceFile), user, nil, filepath.Dir(serviceFile))
 	}
+	saveArtifactsForDebugOnCleanup(t, []string{serviceFile})
 	require.NoError(t, err, "PAM: Error to initialize module")
 	require.NotNil(t, tx, "PAM: Transaction is not set")
 	t.Cleanup(func() { require.NoError(t, tx.End(), "PAM: can't end transaction") })

pam/integration-tests/gdm_test.go

@@ -673,11 +673,11 @@ func TestGdmModule(t *testing.T) {
 			moduleArgs := []string{"socket=" + socketPath}
 
 			gdmLog := prepareFileLogging(t, "authd-pam-gdm.log")
-			t.Cleanup(func() { saveArtifactsForDebug(t, []string{gdmLog}) })
+			saveArtifactsForDebugOnCleanup(t, []string{gdmLog})
 			moduleArgs = append(moduleArgs, "debug=true", "logfile="+gdmLog)
 
-			serviceFile := createServiceFile(t, "gdm-authd", libPath,
-				moduleArgs)
+			serviceFile := createServiceFile(t, "gdm-authd", libPath, moduleArgs)
+			saveArtifactsForDebugOnCleanup(t, []string{serviceFile})
 
 			pamUser := "user-integration-" + strings.ReplaceAll(filepath.Base(t.Name()), "_", "-")
 			if tc.pamUser != nil {
@@ -788,10 +788,11 @@ func TestGdmModuleAuthenticateWithoutGdmExtension(t *testing.T) {
 	moduleArgs = append(moduleArgs, "socket="+socketPath)
 
 	gdmLog := prepareFileLogging(t, "authd-pam-gdm.log")
-	t.Cleanup(func() { saveArtifactsForDebug(t, []string{gdmLog}) })
+	saveArtifactsForDebugOnCleanup(t, []string{gdmLog})
 	moduleArgs = append(moduleArgs, "debug=true", "logfile="+gdmLog)
 
 	serviceFile := createServiceFile(t, "gdm-authd", libPath, moduleArgs)
+	saveArtifactsForDebugOnCleanup(t, []string{serviceFile})
 	pamUser := "user-integration-auth-no-gdm-extension"
 	gh := newGdmTestModuleHandler(t, serviceFile, pamUser)
 	t.Cleanup(func() { require.NoError(t, gh.tx.End(), "PAM: can't end transaction") })
@@ -830,10 +831,11 @@ func TestGdmModuleAcctMgmtWithoutGdmExtension(t *testing.T) {
 	moduleArgs = append(moduleArgs, "socket="+socketPath)
 
 	gdmLog := prepareFileLogging(t, "authd-pam-gdm.log")
-	t.Cleanup(func() { saveArtifactsForDebug(t, []string{gdmLog}) })
+	saveArtifactsForDebugOnCleanup(t, []string{gdmLog})
 	moduleArgs = append(moduleArgs, "debug=true", "logfile="+gdmLog)
 
 	serviceFile := createServiceFile(t, "gdm-authd", libPath, moduleArgs)
+	saveArtifactsForDebugOnCleanup(t, []string{serviceFile})
 	pamUser := "user-integration-acctmgmt-no-gdm-extension"
 	gh := newGdmTestModuleHandler(t, serviceFile, pamUser)
 	t.Cleanup(func() { require.NoError(t, gh.tx.End(), "PAM: can't end transaction") })

pam/integration-tests/helpers_test.go

@@ -51,3 +51,8 @@ func requirePreviousBrokerForUser(t *testing.T, socketPath string, brokerName st
 	}
 	require.Equal(t, prevBroker.PreviousBroker, prevBrokerID)
 }
+
+func saveArtifactsForDebugOnCleanup(t *testing.T, artifacts []string) {
+	t.Helper()
+	t.Cleanup(func() { saveArtifactsForDebug(t, artifacts) })
+}