pulumi/pkg/util/validation/stack.go

103 lines
3.2 KiB
Go
Raw Normal View History

// Copyright 2016-2019, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package validation
import (
"errors"
"fmt"
"regexp"
"github.com/pulumi/pulumi/sdk/v3/go/common/apitype"
"github.com/pulumi/pulumi/sdk/v3/go/common/tokens"
)
var stackNameRE = regexp.MustCompile("^" + tokens.NameRegexpPattern)
// ValidateStackName checks if s is a valid stack name, otherwise returns a descriptive error.
// This should match the stack naming rules enforced by the Pulumi Service.
func ValidateStackName(s string) error {
if s == "" {
return errors.New("a stack name may not be empty")
}
if len(s) > 100 {
return errors.New("a stack name cannot exceed 100 characters")
}
failure := -1
if match := stackNameRE.FindStringIndex(s); match == nil {
// We have failed to find any match, so the first token must be invalid.
failure = 0
} else if match[1] != len(s) {
// Our match did not extend to the end, so the invalid token must be the
// first token not matched.
failure = match[1]
}
if failure == -1 {
return nil
}
return fmt.Errorf(
"a stack name may only contain alphanumeric, hyphens, underscores, or periods: "+
"invalid character %q at position %d", s[failure], failure)
}
// validateStackTagName checks if s is a valid stack tag name, otherwise returns a descriptive error.
// This should match the stack naming rules enforced by the Pulumi Service.
func validateStackTagName(s string) error {
const maxTagName = 40
if len(s) == 0 {
return fmt.Errorf("invalid stack tag %q", s)
}
if len(s) > maxTagName {
return fmt.Errorf("stack tag %q is too long (max length %d characters)", s, maxTagName)
}
all: Reformat with gofumpt Per team discussion, switching to gofumpt. [gofumpt][1] is an alternative, stricter alternative to gofmt. It addresses other stylistic concerns that gofmt doesn't yet cover. [1]: https://github.com/mvdan/gofumpt See the full list of [Added rules][2], but it includes: - Dropping empty lines around function bodies - Dropping unnecessary variable grouping when there's only one variable - Ensuring an empty line between multi-line functions - simplification (`-s` in gofmt) is always enabled - Ensuring multi-line function signatures end with `) {` on a separate line. [2]: https://github.com/mvdan/gofumpt#Added-rules gofumpt is stricter, but there's no lock-in. All gofumpt output is valid gofmt output, so if we decide we don't like it, it's easy to switch back without any code changes. gofumpt support is built into the tooling we use for development so this won't change development workflows. - golangci-lint includes a gofumpt check (enabled in this PR) - gopls, the LSP for Go, includes a gofumpt option (see [installation instrutions][3]) [3]: https://github.com/mvdan/gofumpt#installation This change was generated by running: ```bash gofumpt -w $(rg --files -g '*.go' | rg -v testdata | rg -v compilation_error) ``` The following files were manually tweaked afterwards: - pkg/cmd/pulumi/stack_change_secrets_provider.go: one of the lines overflowed and had comments in an inconvenient place - pkg/cmd/pulumi/destroy.go: `var x T = y` where `T` wasn't necessary - pkg/cmd/pulumi/policy_new.go: long line because of error message - pkg/backend/snapshot_test.go: long line trying to assign three variables in the same assignment I have included mention of gofumpt in the CONTRIBUTING.md.
2023-03-03 16:36:39 +00:00
tagNameRE := regexp.MustCompile("^[a-zA-Z0-9-_.:]{1,40}$")
if tagNameRE.MatchString(s) {
return nil
}
return errors.New("stack tag names may only contain alphanumerics, hyphens, underscores, periods, or colons")
}
// ValidateStackTags validates the tag names and values.
func ValidateStackTags(tags map[apitype.StackTagName]string) error {
const maxTagValue = 256
for t, v := range tags {
if err := validateStackTagName(t); err != nil {
return err
}
if len(v) > maxTagValue {
return fmt.Errorf("stack tag %q value is too long (max length %d characters)", t, maxTagValue)
}
}
return nil
}
// ValidateStackProperties validates the stack name and its tags to confirm they adhear to various
// naming and length restrictions.
func ValidateStackProperties(stack string, tags map[apitype.StackTagName]string) error {
if err := ValidateStackName(stack); err != nil {
return err
}
// Ensure tag values won't be rejected by the Pulumi Service. We do not validate that their
// values make sense, e.g. ProjectRuntimeTag is a supported runtime.
return ValidateStackTags(tags)
}