feat: add hook support (#817)

- added support to add anonyms functions to hook into various parts of the test
  - `PreApplyHook` In upgrade tests, this hook will be called before the base apply
  - `PostApplyHook` In upgrade tests, this hook will be called after the base apply
  - `PreDestroyHook` If this fails, the destroy will continue
  - `PostDestroyHook`

Author: daniel-butler-irl

.secrets.baseline

@@ -198,15 +198,15 @@
         "hashed_secret": "b4e929aa58c928e3e44d12e6f873f39cd8207a25",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 643,
+        "line_number": 664,
         "type": "Secret Keyword",
         "verified_result": null
       },
       {
         "hashed_secret": "16282376ddaaaf2bf60be9041a7504280f3f338b",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 656,
+        "line_number": 677,
         "type": "Secret Keyword",
         "verified_result": null
       }

testhelper/test_options.go

@@ -160,6 +160,16 @@ type TestOptions struct {
 	IsUpgradeTest      bool // Identifies if current test is an UPGRADE test, used for special processing
 	UpgradeTestSkipped bool // Informs the calling test that conditions were met to skip the upgrade test
 
+	// Hooks These allow us to inject custom code into the test process
+	// example to set a hook:
+	// options.PreApplyHook = func(options *TestOptions) error {
+	//     // do something
+	//     return nil
+	// }
+	PreApplyHook    func(options *TestOptions) error // In upgrade tests, this hook will be called before the base apply
+	PostApplyHook   func(options *TestOptions) error // In upgrade tests, this hook will be called after the base apply
+	PreDestroyHook  func(options *TestOptions) error // If this fails, the destroy will continue
+	PostDestroyHook func(options *TestOptions) error
 }
 
 // Default constructor for TestOptions struct. This constructor takes in an existing TestOptions object with minimal values set, and returns

testhelper/tests.go

@@ -361,6 +361,17 @@ func (options *TestOptions) testTearDown() {
 					logger.Log(options.Testing, fmt.Sprintf("Error output containg CBRRuleList %s not found in Statefile, skipping CBR Rule disable", options.CBRRuleListOutputVariable))
 				}
 			}
+			if options.PreDestroyHook != nil {
+				logger.Log(options.Testing, "START: PreDestroyHook")
+				hookErr := options.PreDestroyHook(options)
+				if hookErr != nil {
+					logger.Log(options.Testing, "Error running PreDestroyHook")
+					logger.Log(options.Testing, hookErr)
+					logger.Log(options.Testing, "END: PreDestroyHook, continuing with destroy")
+				} else {
+					logger.Log(options.Testing, "END: PreDestroyHook")
+				}
+			}
 			logger.Log(options.Testing, "START: Destroy")
 			destroyOutput, destroyError := terraform.DestroyE(options.Testing, options.TerraformOptions)
 			if assert.NoError(options.Testing, destroyError) == false {
@@ -432,7 +443,17 @@ func (options *TestOptions) testTearDown() {
 				terraform.WorkspaceDelete(options.Testing, options.TerraformOptions, options.Prefix)
 			}
 			logger.Log(options.Testing, "END: Destroy")
-
+			if options.PostDestroyHook != nil {
+				logger.Log(options.Testing, "START: PostDestroyHook")
+				hookErr := options.PostDestroyHook(options)
+				if hookErr != nil {
+					logger.Log(options.Testing, "Error running PostDestroyHook")
+					logger.Log(options.Testing, hookErr)
+					logger.Log(options.Testing, "END: PostDestroyHook")
+				} else {
+					logger.Log(options.Testing, "END: PostDestroyHook")
+				}
+			}
 			//Clean up terraform files
 			CleanTerraformDir(options.TerraformDir)
 		}
@@ -673,6 +694,16 @@ func (options *TestOptions) RunTestUpgrade() (*terraform.PlanStruct, error) {
 		// Set TerraformDir to the appropriate directory within baseTempDir
 		options.setTerraformDir(path.Join(baseTempDir, relativeTestSampleDir))
 
+		if options.PreApplyHook != nil {
+			logger.Log(options.Testing, "Running PreApplyHook")
+			hookErr := options.PreApplyHook(options)
+			if hookErr != nil {
+				assert.Nilf(options.Testing, hookErr, "PreApplyHook failed")
+				options.testTearDown()
+				return nil, hookErr
+			}
+			logger.Log(options.Testing, "PreApplyHook completed successfully")
+		}
 		logger.Log(options.Testing, "Init / Apply on Base repo:", baseRepo)
 		logger.Log(options.Testing, "Init / Apply on Base branch:", baseBranch)
 		logger.Log(options.Testing, "Init / Apply on Base branch dir:", options.TerraformOptions.TerraformDir)
@@ -683,6 +714,17 @@ func (options *TestOptions) RunTestUpgrade() (*terraform.PlanStruct, error) {
 			options.testTearDown()
 			return nil, resultErr
 		}
+
+		if options.PostApplyHook != nil {
+			logger.Log(options.Testing, "Running PostApplyHook")
+			hookErr := options.PostApplyHook(options)
+			if hookErr != nil {
+				assert.Nilf(options.Testing, hookErr, "PostApplyHook failed")
+				options.testTearDown()
+				return nil, hookErr
+			}
+			logger.Log(options.Testing, "PostApplyHook completed successfully")
+		}
 		// Get the path to the state file in baseTempDir
 		baseStatePath := path.Join(options.TerraformOptions.TerraformDir, "terraform.tfstate")
 
@@ -822,11 +864,27 @@ func (options *TestOptions) RunTest() (string, error) {
 // runTest Runs Test and returns the output as a string for assertions for internal use no setup or teardown
 func (options *TestOptions) runTest() (string, error) {
 
+	if options.PreApplyHook != nil {
+		logger.Log(options.Testing, "Running PreApplyHook")
+		hook_err := options.PreApplyHook(options)
+		if hook_err != nil {
+			return "", hook_err
+		}
+		logger.Log(options.Testing, "Finished PreApplyHook")
+	}
 	logger.Log(options.Testing, "START: Init / Apply")
 	output, err := terraform.InitAndApplyE(options.Testing, options.TerraformOptions)
 	assert.Nil(options.Testing, err, "Failed", err)
 	logger.Log(options.Testing, "FINISHED: Init / Apply")
 
+	if err == nil && options.PostApplyHook != nil {
+		logger.Log(options.Testing, "Running PostApplyHook")
+		hook_err := options.PostApplyHook(options)
+		if hook_err != nil {
+			return "", hook_err
+		}
+		logger.Log(options.Testing, "Finished PostApplyHook")
+	}
 	return output, err
 }