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

…rter#2440) * Included sensitive flag in yaml/json output Signed-off-by: MadhuMPandurangi <[email protected]> * Set "writeonly ":true in the parameters definition Signed-off-by: MadhuMPandurangi <[email protected]> Signed-off-by: MadhuMPandurangi <[email protected]> Co-authored-by: Carolyn Van Slyck <[email protected]>
reveurguy · Nov 16, 2022 · 620f014 · 620f014
1 parent c9cfdf5
commit 620f014
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 4 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -74,3 +74,4 @@ and we will add you. **All** contributors belong here. 💯
 * [Kevin Barbour](https://github.com/kevinbarbour)
 * [Epsxy](https://github.com/epsxy)
 * [Jens Arnfast](https://github.com/jarnfast)
+* [Madhu M Pandurangi](https://github.com/MadhuMPandurangi)
diff --git a/pkg/porter/explain.go b/pkg/porter/explain.go
@@ -90,6 +90,7 @@ type PrintableParameter struct {
 	ApplyTo     string      `json:"applyTo" yaml:"applyTo"`
 	Description string      `json:"description" yaml:"description"`
 	Required    bool        `json:"required" yaml:"required"`
+	Sensitive   bool        `json:"sensitive" yaml:"sensitive"`
 }
 
 type SortPrintableParameter []PrintableParameter
@@ -251,6 +252,7 @@ func generatePrintable(bun cnab.ExtendedBundle, action string) (*PrintableBundle
 		pp.ApplyTo = generateApplyToString(v.ApplyTo)
 		pp.Required = v.Required
 		pp.Description = v.Description
+		pp.Sensitive = bun.IsSensitiveParameter((p))
 
 		if shouldIncludeInExplainOutput(&v, action) {
 			pb.Parameters = append(pb.Parameters, pp)

diff --git a/pkg/porter/testdata/explain/expected-json-output.json b/pkg/porter/testdata/explain/expected-json-output.json
@@ -10,23 +10,26 @@
       "default": null,
       "applyTo": "upgrade",
       "description": "",
-      "required": false
+      "required": false,
+      "sensitive": false
     },
     {
       "name": "region",
       "type": "string",
       "default": "mars",
       "applyTo": "All Actions",
       "description": "",
-      "required": false
+      "required": false,
+      "sensitive": false
     },
     {
       "name": "seed",
       "type": "boolean",
       "default": null,
       "applyTo": "All Actions",
       "description": "",
-      "required": true
+      "required": true,
+      "sensitive": true
     }
   ],
   "mixins": [

diff --git a/pkg/porter/testdata/explain/expected-yaml-output.yaml b/pkg/porter/testdata/explain/expected-yaml-output.yaml
@@ -9,18 +9,21 @@ parameters:
     applyTo: upgrade
     description: ""
     required: false
+    sensitive: false
   - name: region
     type: string
     default: mars
     applyTo: All Actions
     description: ""
     required: false
+    sensitive: false
   - name: seed
     type: boolean
     default: null
     applyTo: All Actions
     description: ""
     required: true
+    sensitive: true
 mixins:
   - helm
   - terraform
diff --git a/pkg/porter/testdata/explain/params-bundle.json b/pkg/porter/testdata/explain/params-bundle.json
@@ -23,7 +23,8 @@
       "type": "string"
     },
     "seed": {
-      "type": "boolean"
+      "type": "boolean",
+      "writeOnly": true
     },
     "namespace": {
       "type": "string"