mirror of https://github.com/pulumi/pulumi.git
d771acf707
<!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> This adds a new type `tokens.StackName` which is a relatively strongly typed container for a stack name. The only weakly typed aspect of it is Go will always allow the "zero" value to be created for a struct, which for a stack name is the empty string which is invalid. To prevent introducing unexpected empty strings when working with stack names the `String()` method will panic for zero initialized stack names. Apart from the zero value, all other instances of `StackName` are via `ParseStackName` which returns a descriptive error if the string is not valid. This PR only updates "pkg/" to use this type. There are a number of places in "sdk/" which could do with this type as well, but there's no harm in doing a staggered roll out, and some parts of "sdk/" are user facing and will probably have to stay on the current `tokens.Name` and `tokens.QName` types. There are two places in the system where we panic on invalid stack names, both in the http backend. This _should_ be fine as we've had long standing validation that stacks created in the service are valid stack names. Just in case people have managed to introduce invalid stack names, there is the `PULUMI_DISABLE_VALIDATION` environment variable which will turn off the validation _and_ panicing for stack names. Users can use that to temporarily disable the validation and continue working, but it should only be seen as a temporary measure. If they have invalid names they should rename them, or if they think they should be valid raise an issue with us to change the validation code. ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [ ] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [ ] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> |
||
|---|---|---|
| .. | ||
| about | ||
| aliases | ||
| cloud_secrets_provider | ||
| component_provider_schema | ||
| config_basic | ||
| config_capture_e2e/nodejs | ||
| config_missing | ||
| config_secrets_warn | ||
| construct_component | ||
| construct_component_error_apply | ||
| construct_component_methods | ||
| construct_component_methods_errors | ||
| construct_component_methods_provider | ||
| construct_component_methods_resources | ||
| construct_component_methods_unknown | ||
| construct_component_output_values | ||
| construct_component_plain | ||
| construct_component_provider | ||
| construct_component_provider_explicit | ||
| construct_component_provider_propagation | ||
| construct_component_resource_options | ||
| construct_component_slow | ||
| construct_component_unknown | ||
| construct_nested_component/go | ||
| custom_timeouts | ||
| delete_before_create | ||
| deleted_with | ||
| dependency_steps | ||
| double_pending_delete | ||
| duplicate_urns | ||
| dynamic | ||
| ee_perf | ||
| empty | ||
| enums | ||
| environments_basic | ||
| environments_merge | ||
| exclude_protected | ||
| explicit_provider | ||
| gather_plugin | ||
| get_created | ||
| get_resource | ||
| go | ||
| invalid_package_json | ||
| large_resource | ||
| nodejs | ||
| partial_state | ||
| partial_values | ||
| policy | ||
| printf | ||
| project_main | ||
| project_main_abs | ||
| project_main_parent/foo | ||
| protect_resources | ||
| provider_secret_config | ||
| python | ||
| python_await | ||
| query | ||
| read | ||
| recreate_resource_check | ||
| refresh/go | ||
| resource_refs_get_resource | ||
| rotate_passphrase | ||
| secret_outputs | ||
| single_resource | ||
| stack_bad_parenting | ||
| stack_dependencies | ||
| stack_outputs | ||
| stack_parenting | ||
| stack_project_name | ||
| stack_reference | ||
| stack_reference_multi/python | ||
| stack_reference_secrets/nodejs | ||
| state_rename_parent | ||
| steps | ||
| targets | ||
| transformations | ||
| tsconfig | ||
| types | ||
| unsafe_snapshot_tests/bad_resource | ||
| .gitignore | ||
| appdash_test.go | ||
| component_setup.sh | ||
| integration_acceptance_test.go | ||
| integration_go_acceptance_test.go | ||
| integration_go_test.go | ||
| integration_nodejs_acceptance_test.go | ||
| integration_nodejs_test.go | ||
| integration_python_acceptance_test.go | ||
| integration_python_test.go | ||
| integration_test.go | ||
| integration_util_test.go | ||