mirror of https://github.com/helm/helm
Remove deprecated `internal/chart/v3/` code (#32365)
Signed-off-by: George Jenkins <gvjenkins@gmail.com>pull/32596/head
parent
9a3c040369
commit
4dfbaa40c6
@ -1,110 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The Helm Authors.
|
|
||||||
|
|
||||||
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 util
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"regexp"
|
|
||||||
)
|
|
||||||
|
|
||||||
// validName is a regular expression for resource names.
|
|
||||||
//
|
|
||||||
// According to the Kubernetes help text, the regular expression it uses is:
|
|
||||||
//
|
|
||||||
// [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
|
||||||
//
|
|
||||||
// This follows the above regular expression (but requires a full string match, not partial).
|
|
||||||
//
|
|
||||||
// The Kubernetes documentation is here, though it is not entirely correct:
|
|
||||||
// https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
|
||||||
var validName = regexp.MustCompile(`^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$`)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// errMissingName indicates that a release (name) was not provided.
|
|
||||||
errMissingName = errors.New("no name provided")
|
|
||||||
|
|
||||||
// errInvalidName indicates that an invalid release name was provided
|
|
||||||
errInvalidName = fmt.Errorf(
|
|
||||||
"invalid release name, must match regex %s and the length must not be longer than 53",
|
|
||||||
validName.String())
|
|
||||||
|
|
||||||
// errInvalidKubernetesName indicates that the name does not meet the Kubernetes
|
|
||||||
// restrictions on metadata names.
|
|
||||||
errInvalidKubernetesName = fmt.Errorf(
|
|
||||||
"invalid metadata name, must match regex %s and the length must not be longer than 253",
|
|
||||||
validName.String())
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// According to the Kubernetes docs (https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names)
|
|
||||||
// some resource names have a max length of 63 characters while others have a max
|
|
||||||
// length of 253 characters. As we cannot be sure the resources used in a chart, we
|
|
||||||
// therefore need to limit it to 63 chars and reserve 10 chars for additional part to name
|
|
||||||
// of the resource. The reason is that chart maintainers can use release name as part of
|
|
||||||
// the resource name (and some additional chars).
|
|
||||||
maxReleaseNameLen = 53
|
|
||||||
// maxMetadataNameLen is the maximum length Kubernetes allows for any name.
|
|
||||||
maxMetadataNameLen = 253
|
|
||||||
)
|
|
||||||
|
|
||||||
// ValidateReleaseName performs checks for an entry for a Helm release name
|
|
||||||
//
|
|
||||||
// For Helm to allow a name, it must be below a certain character count (53) and also match
|
|
||||||
// a regular expression.
|
|
||||||
//
|
|
||||||
// According to the Kubernetes help text, the regular expression it uses is:
|
|
||||||
//
|
|
||||||
// [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
|
||||||
//
|
|
||||||
// This follows the above regular expression (but requires a full string match, not partial).
|
|
||||||
//
|
|
||||||
// The Kubernetes documentation is here, though it is not entirely correct:
|
|
||||||
// https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
|
||||||
func ValidateReleaseName(name string) error {
|
|
||||||
// This case is preserved for backwards compatibility
|
|
||||||
if name == "" {
|
|
||||||
return errMissingName
|
|
||||||
}
|
|
||||||
if len(name) > maxReleaseNameLen || !validName.MatchString(name) {
|
|
||||||
return errInvalidName
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ValidateMetadataName validates the name field of a Kubernetes metadata object.
|
|
||||||
//
|
|
||||||
// Empty strings, strings longer than 253 chars, or strings that don't match the regexp
|
|
||||||
// will fail.
|
|
||||||
//
|
|
||||||
// According to the Kubernetes help text, the regular expression it uses is:
|
|
||||||
//
|
|
||||||
// [a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*
|
|
||||||
//
|
|
||||||
// This follows the above regular expression (but requires a full string match, not partial).
|
|
||||||
//
|
|
||||||
// The Kubernetes documentation is here, though it is not entirely correct:
|
|
||||||
// https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
|
||||||
//
|
|
||||||
// Deprecated: remove in Helm 4. Name validation now uses rules defined in
|
|
||||||
// pkg/lint/rules.validateMetadataNameFunc()
|
|
||||||
func ValidateMetadataName(name string) error {
|
|
||||||
if name == "" || len(name) > maxMetadataNameLen || !validName.MatchString(name) {
|
|
||||||
return errInvalidKubernetesName
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@ -1,93 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The Helm Authors.
|
|
||||||
|
|
||||||
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 util
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestValidateReleaseName is a regression test for ValidateName
|
|
||||||
//
|
|
||||||
// Kubernetes has strict naming conventions for resource names. This test represents
|
|
||||||
// those conventions.
|
|
||||||
//
|
|
||||||
// See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
|
||||||
//
|
|
||||||
// NOTE: At the time of this writing, the docs above say that names cannot begin with
|
|
||||||
// digits. However, `kubectl`'s regular expression explicit allows this, and
|
|
||||||
// Kubernetes (at least as of 1.18) also accepts resources whose names begin with digits.
|
|
||||||
func TestValidateReleaseName(t *testing.T) {
|
|
||||||
names := map[string]bool{
|
|
||||||
"": false,
|
|
||||||
"foo": true,
|
|
||||||
"foo.bar1234baz.seventyone": true,
|
|
||||||
"FOO": false,
|
|
||||||
"123baz": true,
|
|
||||||
"foo.BAR.baz": false,
|
|
||||||
"one-two": true,
|
|
||||||
"-two": false,
|
|
||||||
"one_two": false,
|
|
||||||
"a..b": false,
|
|
||||||
"%^&#$%*@^*@&#^": false,
|
|
||||||
"example:com": false,
|
|
||||||
"example%%com": false,
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z": false,
|
|
||||||
}
|
|
||||||
for input, expectPass := range names {
|
|
||||||
err := ValidateReleaseName(input)
|
|
||||||
if expectPass {
|
|
||||||
assert.NoErrorf(t, err, "Expected release name %q to pass validation", input)
|
|
||||||
} else {
|
|
||||||
assert.Errorf(t, err, "Expected release name %q to fail validation, but it passed", input)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestValidateMetadataName(t *testing.T) {
|
|
||||||
names := map[string]bool{
|
|
||||||
"": false,
|
|
||||||
"foo": true,
|
|
||||||
"foo.bar1234baz.seventyone": true,
|
|
||||||
"FOO": false,
|
|
||||||
"123baz": true,
|
|
||||||
"foo.BAR.baz": false,
|
|
||||||
"one-two": true,
|
|
||||||
"-two": false,
|
|
||||||
"one_two": false,
|
|
||||||
"a..b": false,
|
|
||||||
"%^&#$%*@^*@&#^": false,
|
|
||||||
"example:com": false,
|
|
||||||
"example%%com": false,
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z": true,
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z" +
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z" +
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z" +
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z" +
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z" +
|
|
||||||
"a1111111111111111111111111111111111111111111111111111111111z": false,
|
|
||||||
}
|
|
||||||
for input, expectPass := range names {
|
|
||||||
err := ValidateMetadataName(input)
|
|
||||||
if expectPass {
|
|
||||||
assert.NoError(t, err, "Expected %q to succeed", input)
|
|
||||||
} else {
|
|
||||||
assert.Error(t, err, "Expected %q to fail", input)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Loading…
Reference in new issue