test for parameters with space (#1931)

* test for parameters with space Signed-off-by: Simpcyclassy <[email protected]> * add contributor Signed-off-by: Simpcyclassy <[email protected]> * handle bundle parameter escape Signed-off-by: Simpcyclassy <[email protected]> * update parameters documentation Signed-off-by: Simpcyclassy <[email protected]> * Merge branch 'release/v1' into parameter-space-error Signed-off-by: Simpcyclassy <[email protected]> * array to slice paramenter Signed-off-by: Simpcyclassy <[email protected]> * define params as array var Signed-off-by: Simpcyclassy <[email protected]> * add schema version to yaml file Signed-off-by: Simpcyclassy <[email protected]> * Help get PR merged * Run mage build to generate the cli command documentation to include the recent changes * Skip the failing test that was added. This PR has enough to fix the comma parsing, and a follow-up will fix this failing test for when a parameter has a space in it. Signed-off-by: Carolyn Van Slyck <[email protected]> * Fix merge conflicts with release/v1 Signed-off-by: Carolyn Van Slyck <[email protected]> Co-authored-by: Carolyn Van Slyck <[email protected]>
getporter · Apr 29, 2022 · cba074a · cba074a
1 parent 8ba9ade
commit cba074a
Show file tree

Hide file tree

Showing 13 changed files with 202 additions and 123 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -62,4 +62,5 @@ and we will add you. **All** contributors belong here. 💯
 * [Mahendra Bishnoi](https://github.com/mahendrabishnoi2)
 * [Yingrong Zhao](https://github.com/VinozzZ)
 * [Saksham Sharma](https://github.com/sakkshm26)
-* [Jeremy Goss](https://github.com/Jemgoss)
+* [Jeremy Goss](https://github.com/Jemgoss)
+* [Chioma Onyekpere](https://github.com/Simpcyclassy)
diff --git a/cmd/porter/bundle.go b/cmd/porter/bundle.go
@@ -166,9 +166,9 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set for the bundle. It should be a named set of parameters and may be specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
 	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.")
@@ -223,9 +223,9 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
 	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.")
@@ -282,9 +282,9 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
 	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
@@ -339,9 +339,9 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
 		"Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.")
 	f.StringVar(&opts.CNABFile, "cnab-file", "",
 		"Path to the CNAB bundle.json file.")
-	f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
+	f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
 		"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
-	f.StringSliceVar(&opts.Params, "param", nil,
+	f.StringArrayVar(&opts.Params, "param", nil,
 		"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
 	f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
 		"Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")

diff --git a/docs/content/cli/bundles_install.md b/docs/content/cli/bundles_install.md
@@ -39,20 +39,20 @@ porter bundles install [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for install
-      --insecure-registry          Don't require TLS for the registry
-  -l, --label strings              Associate the specified labels with the installation. May be specified multiple times.
-  -n, --namespace string           Create the installation in the specified namespace. Defaults to the global namespace.
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set for the bundle. It should be a named set of parameters and may be specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred strings                Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for install
+      --insecure-registry           Don't require TLS for the registry
+  -l, --label strings               Associate the specified labels with the installation. May be specified multiple times.
+  -n, --namespace string            Create the installation in the specified namespace. Defaults to the global namespace.
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set for the bundle. It should be a named set of parameters and may be specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_invoke.md b/docs/content/cli/bundles_invoke.md
@@ -36,20 +36,20 @@ porter bundles invoke [INSTALLATION] --action ACTION [flags]
 ### Options
 
 ```
-      --action string              Custom action name to invoke.
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for invoke
-      --insecure-registry          Don't require TLS for the registry
-  -n, --namespace string           Namespace of the specified installation. Defaults to the global namespace.
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --action string               Custom action name to invoke.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred strings                Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for invoke
+      --insecure-registry           Don't require TLS for the registry
+  -n, --namespace string            Namespace of the specified installation. Defaults to the global namespace.
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_uninstall.md b/docs/content/cli/bundles_uninstall.md
@@ -38,21 +38,21 @@ porter bundles uninstall [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-      --delete                     Delete all records associated with the installation, assuming the uninstall action succeeds
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
-      --force                      Force a fresh pull of the bundle
-      --force-delete               UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
-  -h, --help                       help for uninstall
-      --insecure-registry          Don't require TLS for the registry
-  -n, --namespace string           Namespace of the specified installation. Defaults to the global namespace.
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred strings                Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
+      --delete                      Delete all records associated with the installation, assuming the uninstall action succeeds
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
+      --force                       Force a fresh pull of the bundle
+      --force-delete                UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
+  -h, --help                        help for uninstall
+      --insecure-registry           Don't require TLS for the registry
+  -n, --namespace string            Namespace of the specified installation. Defaults to the global namespace.
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/content/cli/bundles_upgrade.md b/docs/content/cli/bundles_upgrade.md
@@ -36,20 +36,20 @@ porter bundles upgrade [INSTALLATION] [flags]
 ### Options
 
 ```
-      --allow-docker-host-access   Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
-      --cnab-file string           Path to the CNAB bundle.json file.
-  -c, --cred strings               Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
-  -d, --driver string              Specify a driver to use. Allowed values: docker, debug (default "docker")
-  -f, --file string                Path to the porter manifest file. Defaults to the bundle in the current directory.
-      --force                      Force a fresh pull of the bundle
-  -h, --help                       help for upgrade
-      --insecure-registry          Don't require TLS for the registry
-  -n, --namespace string           Namespace of the specified installation. Defaults to the global namespace.
-      --no-logs                    Do not persist the bundle execution logs
-      --param strings              Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-  -p, --parameter-set strings      Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-  -r, --reference string           Use a bundle in an OCI registry specified by the given reference.
-      --version string             Version to which the installation should be upgraded. This represents the version of the bundle, which assumes the convention of setting the bundle tag to its version.
+      --allow-docker-host-access    Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
+      --cnab-file string            Path to the CNAB bundle.json file.
+  -c, --cred strings                Credential to use when installing the bundle. It should be a named set of credentials and may be specified multiple times.
+  -d, --driver string               Specify a driver to use. Allowed values: docker, debug (default "docker")
+  -f, --file string                 Path to the porter manifest file. Defaults to the bundle in the current directory.
+      --force                       Force a fresh pull of the bundle
+  -h, --help                        help for upgrade
+      --insecure-registry           Don't require TLS for the registry
+  -n, --namespace string            Namespace of the specified installation. Defaults to the global namespace.
+      --no-logs                     Do not persist the bundle execution logs
+      --param stringArray           Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
+  -p, --parameter-set stringArray   Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
+  -r, --reference string            Use a bundle in an OCI registry specified by the given reference.
+      --version string              Version to which the installation should be upgraded. This represents the version of the bundle, which assumes the convention of setting the bundle tag to its version.
 ```
 
 ### Options inherited from parent commands