feat: ability to set value of API_DATA_IS_SENSITIVE to false

[Vipin654]

Description

Ability to set API_DATA_IS_SENSITIVE to false so that if terraform detects some output value to be sensitive we can avoid the test failure.

Release required?

• No release
• Patch release (x.x.X)
• Minor release (x.X.x)
• Major release (X.x.x)

Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

• If relevant, a test for the change is included or updated with this PR.
• If relevant, documentation for the change is included or updated with this PR.

For mergers

• Use a conventional commit message to set the release level. Follow the guidelines.
• Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
• Use the Squash and merge option.

[Vipin654]

/run pipeline

[Vipin654]

/run pipeline

[Vipin654]

/run pipeline

[daniel-butler-irl]

@toddgiguere, what do you think? I am not a big fan of the double negative, so I would switch to a pointer-based approach. For example:

type TestOptions struct {
    ApiDataIsSensitive *bool
    // ...
}

if options.ApiDataIsSensitive == nil {
    // Preserve old behavior
    os.Setenv("API_DATA_IS_SENSITIVE", "true")
} else {
    os.Setenv("API_DATA_IS_SENSITIVE", strconv.FormatBool(*options.ApiDataIsSensitive))
}

That way, leaving ApiDataIsSensitive as nil defaults to sensitive (old behavior), and setting it explicitly to true or false is straightforward.

[toddgiguere]

I agree, a pointer is probably the only way to go here, if it is not a pointer we have no way of determining if the caller didn't set it at all (took the default) or if they really did want it set to false. So I agree with the pointer idea.

Let me ask another question though, @ocofaigh I don't know the context of the original ask, but here is my question:
"Is there a legitimate reason why a unit test should EVER want this set to false"?

If the answer to the above is "maybe not" then another approach would be to check for the presense of this ENV and if it is not present then just set it to true. Don't even have the option to turn off.

[daniel-butler-irl]

@Vipin654 please go ahead with the suggested pointer-based implementation thanks

[Vipin654]

/run pipeline

[terraform-ibm-modules-ops]

🎉 This PR is included in version 1.44.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀