Update to termtest v2

.github/workflows/build.yml

@@ -55,6 +55,11 @@ jobs:
 
     # === OS Specific Steps ===
     steps:
+      - # === Disable Windows Defender as it slows things down significantly ===
+        name: Disabling Windows Defender
+        if: runner.os == 'Windows'
+        shell: powershell
+        run: Set-MpPreference -DisableRealtimeMonitoring $true
 
       - # === Checkout Code ===
         name: Checkout code
@@ -313,14 +318,13 @@ jobs:
           echo "Running integration tests with tags: $TEST_SUITE_TAGS (empty means every test not specifically tagged)"
 
           export TEST_SUITE_TAGS="$TEST_SUITE_TAGS"
-          TIMEOUT=15m
+          TIMEOUT=30m
           if [[ "$TEST_SUITE_TAGS" == "all" ]]; then
             TIMEOUT=60m
           fi
           SHELL='' go test -timeout $TIMEOUT -v `go list ./... | grep "integration"` -json 2>&1 | gotestfmt -hide empty-packages
         continue-on-error: ${{ github.event_name == 'schedule' }}
         env:
-          ACTIVESTATE_VERBOSE: true
           INTEGRATION_TEST_USERNAME: ${{ secrets.INTEGRATION_TEST_USERNAME }}
           INTEGRATION_TEST_PASSWORD: ${{ secrets.INTEGRATION_TEST_PASSWORD }}
           INTEGRATION_TEST_TOKEN: ${{ secrets.INTEGRATION_TEST_TOKEN }}

.golangci.yaml

@@ -9,7 +9,7 @@ linters-settings:
       - (*github.com/ActiveState/termtest.ConsoleProcess).ExpectExitCode
       - (*github.com/ActiveState/termtest.ConsoleProcess).ExpectNotExitCode
       - (*github.com/ActiveState/termtest.ConsoleProcess).ExpectRe
-      - (*github.com/ActiveState/termtest.ConsoleProcess).ExpectLongString
+      - (*github.com/ActiveState/termtest.ConsoleProcess).Expect
       - (*github.com/ActiveState/termtest.ConsoleProcess).WaitForInput
 
 # When issues occur with linting us the snippet below to help with debugging
@@ -23,4 +23,4 @@ linters-settings:
 #     - ineffassign
 #     - staticcheck
 #     - typecheck
-#     - unused
+#     - unused

cmd/state-installer/test/integration/installer_int_test.go

@@ -46,9 +46,9 @@ func (suite *InstallerIntegrationTestSuite) TestInstallFromLocalSource() {
 	// Run installer with source-path flag (ie. install from this local path)
 	cp := ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)),
-		e2e.AppendEnv(constants.DisableUpdates+"=false"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs(installationDir(ts)),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=false"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
 
 	// Assert output
@@ -58,20 +58,20 @@ func (suite *InstallerIntegrationTestSuite) TestInstallFromLocalSource() {
 	if runtime.GOOS == "darwin" && condition.OnCI() {
 		cp.Expect("You are running bash on macOS")
 	}
-	suite.NotContains(cp.TrimmedSnapshot(), "Downloading State Tool")
-	cp.WaitForInput()
+	suite.NotContains(cp.Output(), "Downloading State Tool")
+	cp.ExpectInput()
 	cp.SendLine("exit")
 	cp.ExpectExitCode(0)
 
 	// Ensure installing overtop doesn't result in errors
 	cp = ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)),
-		e2e.AppendEnv(constants.DisableUpdates+"=false"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs(installationDir(ts)),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=false"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
 	cp.Expect("successfully installed")
-	cp.WaitForInput()
+	cp.ExpectInput()
 	cp.SendLine("exit")
 	cp.ExpectExitCode(0)
 
@@ -80,9 +80,9 @@ func (suite *InstallerIntegrationTestSuite) TestInstallFromLocalSource() {
 	suite.Require().NoError(fileutils.WriteFile(filepath.Join(installationDir(ts), installation.InstallDirMarker), []byte{}))
 	cp = ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)),
-		e2e.AppendEnv(constants.DisableUpdates+"=false"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs(installationDir(ts)),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=false"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
 	cp.Expect("successfully installed")
 
@@ -99,21 +99,21 @@ func (suite *InstallerIntegrationTestSuite) TestInstallFromLocalSource() {
 	suite.NoError(err)
 
 	// Verify that launched subshell has State tool on PATH
-	cp.WaitForInput()
+	cp.ExpectInput()
 	cp.SendLine("state --version")
 	cp.Expect("Version")
-	cp.WaitForInput()
+	cp.ExpectInput()
 
 	if runtime.GOOS == "windows" {
 		cp.SendLine("where state")
 	} else {
 		cp.SendLine("which state")
 	}
-	cp.WaitForInput()
+	cp.ExpectInput()
 	cp.SendLine("exit")
 	cp.ExpectExitCode(0)
 
-	snapshot := strings.Replace(cp.TrimmedSnapshot(), "\n", "", -1)
+	snapshot := strings.Replace(cp.Output(), "\n", "", -1)
 	if !strings.Contains(snapshot, stateExec) && !strings.Contains(snapshot, stateExecResolved) {
 		suite.Fail(fmt.Sprintf("Snapshot does not include '%s' or '%s', snapshot:\n %s", stateExec, stateExecResolved, snapshot))
 	}
@@ -141,8 +141,8 @@ func (suite *InstallerIntegrationTestSuite) TestInstallIncompatible() {
 	// Run installer with source-path flag (ie. install from this local path)
 	cp := ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)),
-		e2e.AppendEnv(constants.DisableUpdates+"=false", sysinfo.VersionOverrideEnvVar+"=10.0.0"),
+		e2e.OptArgs(installationDir(ts)),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=false", sysinfo.VersionOverrideEnvVar+"=10.0.0"),
 	)
 
 	// Assert output
@@ -160,13 +160,13 @@ func (suite *InstallerIntegrationTestSuite) TestInstallNoErrorTips() {
 
 	cp := ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts), "--activate", "ActiveState/DoesNotExist"),
-		e2e.AppendEnv(constants.DisableUpdates+"=true"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs(installationDir(ts), "--activate", "ActiveState/DoesNotExist"),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=true"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
 
 	cp.ExpectExitCode(1)
-	suite.Assert().NotContains(cp.TrimmedSnapshot(), "Need More Help?", "error tips should not be displayed when invoking installer")
+	suite.Assert().NotContains(cp.Output(), "Need More Help?", "error tips should not be displayed when invoking installer")
 }
 
 func (suite *InstallerIntegrationTestSuite) TestInstallErrorTips() {
@@ -179,17 +179,18 @@ func (suite *InstallerIntegrationTestSuite) TestInstallErrorTips() {
 
 	cp := ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts), "--activate", "ActiveState-CLI/Python3"),
-		e2e.AppendEnv(constants.DisableUpdates+"=true"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs(installationDir(ts), "--activate", "ActiveState-CLI/Python3"),
+		e2e.OptAppendEnv(constants.DisableUpdates+"=true"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
 
-	cp.WaitForInput()
+	cp.ExpectInput()
 	cp.SendLine("state command-does-not-exist")
-	cp.WaitForInput()
+	cp.ExpectInput()
 	cp.SendLine("exit")
-	cp.Wait()
-	suite.Assert().Contains(cp.TrimmedSnapshot(), "Need More Help?", "error tips should be displayed in shell created by installer")
+	cp.ExpectExit()
+	suite.Assert().Contains(cp.Output(), "Need More Help?",
+		"error tips should be displayed in shell created by installer")
 }
 
 func (suite *InstallerIntegrationTestSuite) TestStateTrayRemoval() {
@@ -201,12 +202,12 @@ func (suite *InstallerIntegrationTestSuite) TestStateTrayRemoval() {
 
 	// Install a release version that still has state-tray.
 	version := "0.35.0-SHAb78e2a4"
-	var cp *termtest.ConsoleProcess
+	var cp *e2e.SpawnedCmd
 	if runtime.GOOS != "windows" {
 		oneLiner := fmt.Sprintf("sh <(curl -q https://platform.activestate.com/dl/cli/pdli01/install.sh) -f -n -t %s -v %s", dir, version)
 		cp = ts.SpawnCmdWithOpts(
-			"bash", e2e.WithArgs("-c", oneLiner),
-			e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+			"bash", e2e.OptArgs("-c", oneLiner),
+			e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 		)
 	} else {
 		b, err := httputil.GetDirect("https://platform.activestate.com/dl/cli/pdli01/install.ps1")
@@ -215,12 +216,12 @@ func (suite *InstallerIntegrationTestSuite) TestStateTrayRemoval() {
 		ps1File := filepath.Join(ts.Dirs.Work, "install.ps1")
 		suite.Require().NoError(fileutils.WriteFile(ps1File, b))
 
-		cp = ts.SpawnCmdWithOpts("powershell.exe", e2e.WithArgs(ps1File, "-f", "-n", "-t", dir, "-v", version),
-			e2e.AppendEnv("SHELL="),
-			e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		cp = ts.SpawnCmdWithOpts("powershell.exe", e2e.OptArgs(ps1File, "-f", "-n", "-t", dir, "-v", version),
+			e2e.OptAppendEnv("SHELL="),
+			e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 		)
 	}
-	cp.Expect("Installation Complete", 5*time.Minute)
+	cp.Expect("Installation Complete", termtest.OptExpectTimeout(5*time.Minute))
 
 	// Verify state-tray is there.
 	svcExec, err := installation.ServiceExecFromDir(dir)
@@ -233,12 +234,12 @@ func (suite *InstallerIntegrationTestSuite) TestStateTrayRemoval() {
 	// Run the installer, which should remove state-tray and clean up after it.
 	cp = ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs("-f", "-n", "-t", dir),
-		e2e.AppendEnv(constants.UpdateBranchEnvVarName+"=release"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
+		e2e.OptArgs("-f", "-n", "-t", dir),
+		e2e.OptAppendEnv(constants.UpdateBranchEnvVarName+"=release"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.OverwriteDefaultSystemPathEnvVarName, dir)),
 	)
-	cp.Expect("Installing", 10*time.Second)
-	cp.Expect("Done", 30*time.Second)
+	cp.Expect("Installing", termtest.OptExpectTimeout(10*time.Second))
+	cp.Expect("Done", termtest.OptExpectTimeout(30*time.Second))
 
 	// Verify state-tray is no longer there.
 	suite.NoFileExists(trayExec)
@@ -247,8 +248,8 @@ func (suite *InstallerIntegrationTestSuite) TestStateTrayRemoval() {
 	// Verify state can still be run and has a newly updated version.
 	stateExec, err := installation.StateExecFromDir(dir)
 	suite.Require().NoError(err)
-	cp = ts.SpawnCmdWithOpts(stateExec, e2e.WithArgs("--version"))
-	suite.Assert().NotContains(cp.TrimmedSnapshot(), version)
+	cp = ts.SpawnCmdWithOpts(stateExec, e2e.OptArgs("--version"))
+	suite.Assert().NotContains(cp.Output(), version)
 	cp.ExpectExitCode(0)
 }
 
@@ -267,8 +268,8 @@ func (suite *InstallerIntegrationTestSuite) TestInstallerOverwriteServiceApp() {
 
 	cp := ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.AppInstallDirOverrideEnvVarName, appInstallDir)),
+		e2e.OptArgs(installationDir(ts)),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.AppInstallDirOverrideEnvVarName, appInstallDir)),
 	)
 	cp.Expect("Done")
 	cp.SendLine("exit")
@@ -277,8 +278,8 @@ func (suite *InstallerIntegrationTestSuite) TestInstallerOverwriteServiceApp() {
 	// State Service.app should be overwritten cleanly without error.
 	cp = ts.SpawnCmdWithOpts(
 		suite.installerExe,
-		e2e.WithArgs(installationDir(ts)+"2"),
-		e2e.AppendEnv(fmt.Sprintf("%s=%s", constants.AppInstallDirOverrideEnvVarName, appInstallDir)),
+		e2e.OptArgs(installationDir(ts)+"2"),
+		e2e.OptAppendEnv(fmt.Sprintf("%s=%s", constants.AppInstallDirOverrideEnvVarName, appInstallDir)),
 	)
 	cp.Expect("Done")
 	cp.SendLine("exit")
@@ -338,10 +339,10 @@ func installationDir(ts *e2e.Session) string {
 func (suite *InstallerIntegrationTestSuite) SetupSuite() {
 	rootPath := environment.GetRootPathUnsafe()
 	localPayload := filepath.Join(rootPath, "build", "payload", constants.ToplevelInstallArchiveDir)
-	suite.Assert().DirExists(localPayload, "locally generated payload exists")
+	suite.Require().DirExists(localPayload, "locally generated payload exists")
 
 	installerExe := filepath.Join(localPayload, constants.StateInstallerCmd+osutils.ExeExt)
-	suite.Assert().FileExists(installerExe, "locally generated installer exists")
+	suite.Require().FileExists(installerExe, "locally generated installer exists")
 
 	suite.installerExe = installerExe
 }