Includes sensitive flag in yaml/json output of porter explain.

[MadhuMPandurangi]

What does this change

Includes sensitive flag in yaml/json output of porter explain for outputs and parameters.

What issue does it fix

Closes # 2228

Notes for the reviewer

Please verify the pull request.

Checklist

• Did you write tests?
• Did you write documentation?
• Did you change porter.yaml or a storage document record? Update the corresponding schema file.
• If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

Reviewer Checklist

• Comment with /azp run test-porter-release if a magefile or build script was modified
• Comment with /azp run porter-integration if it's a non-trivial PR

[carolynvs]

Let's change one of the parameters in the test bundle so that it's sensitive. Right now they are all false, so it's hard to tell that the change is working.

The test bundle is here:

porter/pkg/porter/testdata/explain/params-bundle.json

Line 25 in 3a56d91

"seed": {

In order to make a parameter in a CNAB bundle sensitive (this is a cnab bundle here, you can tell because it's a json file, not porter.yaml), is to set "writeOnly": true in the parameter's definition.

    "seed": {
      "type": "boolean"
      "writeOnly": true
    },

Hopefully we can just edit the existing parameter instead of adding another, but if it doesn't work well (maybe impacts other tests) then let's just add a new parameter that is sensitive.

[carolynvs]

🎉

[MadhuMPandurangi]

Thanks for adding. I'll look into the edits that need to be done in this.

[MadhuMPandurangi]

I'm getting errors after editing

"seed": {
"type": "boolean"
"writeOnly": true
},

and running go run mage.go TestUnit TestSmoke

[carolynvs]

In the future, if you can provide a copy/paste of the text, instead of an image, and include the full output, that would be helpful. It looks like you did not update the expected output files for the test that failed. The tests are still asserting that none of the parameters are sensitive.

You can either update the expected output files by hand, or run mage UpdateTestFiles and have it updated to automatically match whatever the current output is from that test.

[MadhuMPandurangi]

hi @carolynvs, I added "writeonly": true in the parameter definition, and after updating the test cases, all the test cases are successfully passed.

[carolynvs]

Looks great! Again apologies for the delay with the review, I appreciate your time getting this implemented. 💖

[MadhuMPandurangi]

Thank you @carolynvs . This is my first contribution to the opensource and happy to see merged 😊.

[carolynvs]

I'm looking forward to collaborating with you in the future!