mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-07-17 01:39:06 +00:00
Add RNode implementation of label and annotation selectors.
This commit is contained in:
@@ -4,7 +4,7 @@
|
|||||||
MYGOBIN := $(shell go env GOPATH)/bin
|
MYGOBIN := $(shell go env GOPATH)/bin
|
||||||
export PATH := $(MYGOBIN):$(PATH)
|
export PATH := $(MYGOBIN):$(PATH)
|
||||||
|
|
||||||
.PHONY: generate license fix vet fmt test lint tidy
|
.PHONY: generate license fix vet fmt test lint tidy clean
|
||||||
all: generate license fix vet fmt test lint tidy
|
all: generate license fix vet fmt test lint tidy
|
||||||
|
|
||||||
fix:
|
fix:
|
||||||
@@ -19,17 +19,23 @@ generate:
|
|||||||
|
|
||||||
license:
|
license:
|
||||||
(which $(MYGOBIN)/addlicense || go get github.com/google/addlicense)
|
(which $(MYGOBIN)/addlicense || go get github.com/google/addlicense)
|
||||||
$(MYGOBIN)/addlicense -y 2019 -c "The Kubernetes Authors." -f LICENSE_TEMPLATE .
|
$(MYGOBIN)/addlicense -c "The Kubernetes Authors." -f LICENSE_TEMPLATE .
|
||||||
|
|
||||||
tidy:
|
tidy:
|
||||||
go mod tidy
|
go mod tidy
|
||||||
|
|
||||||
lint:
|
lint:
|
||||||
(which $(MYGOBIN)/golangci-lint || go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.19.1)
|
(which $(MYGOBIN)/golangci-lint || \
|
||||||
$(MYGOBIN)/golangci-lint run ./...
|
go get github.com/golangci/golangci-lint/cmd/golangci-lint@v1.19.1)
|
||||||
|
$(MYGOBIN)/golangci-lint \
|
||||||
|
--skip-dirs yaml/internal/k8sgen/pkg \
|
||||||
|
run ./...
|
||||||
|
|
||||||
test:
|
test:
|
||||||
go test -cover ./...
|
go test -cover ./...
|
||||||
|
|
||||||
vet:
|
vet:
|
||||||
go vet ./...
|
go vet ./...
|
||||||
|
|
||||||
|
clean:
|
||||||
|
rm -rf yaml/internal/k8sgen/pkg
|
||||||
|
|||||||
27
kyaml/yaml/internal/k8sgen/doc.go
Normal file
27
kyaml/yaml/internal/k8sgen/doc.go
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
// Copyright 2020 The Kubernetes Authors.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
// Package k8sgen contains code generated by copying bits of k8s.io code.
|
||||||
|
// The copier is in generator/main.go.
|
||||||
|
//
|
||||||
|
// kyaml (and indirectly kustomize) wants to reuse the k/k label selection code.
|
||||||
|
// Labels and annotations are a key part of k8s metadata.
|
||||||
|
//
|
||||||
|
// kyaml cannot depend on it via a normal Go import because kubectl will
|
||||||
|
// depend on kyaml eventually (see kubernetes-sigs/kustomize/issues/1500).
|
||||||
|
// While kubectl remains in the k/k repo, it depends on local relative symlinked
|
||||||
|
// path to a 'staging' version of k8s.io code. No code imported by kubectl can
|
||||||
|
// refer to any other version of k8s.io code.
|
||||||
|
//
|
||||||
|
// So to do what that code does, kyaml must either reimplement it or copy it.
|
||||||
|
// When/if kubectl is finally extracted from k/k to its own repo, it can
|
||||||
|
// depend on apimachinery code via normal imports, and so can kyaml.
|
||||||
|
// At that point, this copy (and copying mechanism) can be dropped.
|
||||||
|
//
|
||||||
|
// Until then, if a bug is found in a particular instance of copied k8s.io
|
||||||
|
// (unlikely, since this code is old and stable), just increment
|
||||||
|
// apiMachineryVersion below to match the fixed version, possibly change
|
||||||
|
// the files copied, re-generate, and if need be adjust call points.
|
||||||
|
//
|
||||||
|
//go:generate go run generator/main.go
|
||||||
|
package k8sgen
|
||||||
3
kyaml/yaml/internal/k8sgen/generator/go.mod
Normal file
3
kyaml/yaml/internal/k8sgen/generator/go.mod
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
module sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/generator
|
||||||
|
|
||||||
|
go 1.15
|
||||||
213
kyaml/yaml/internal/k8sgen/generator/main.go
Normal file
213
kyaml/yaml/internal/k8sgen/generator/main.go
Normal file
@@ -0,0 +1,213 @@
|
|||||||
|
// Copyright 2020 The Kubernetes Authors.
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
// A code copier launched via `go generate`.
|
||||||
|
// See k8segen/doc.go for further discussion.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// Splitting this so it doesn't show up in grep.
|
||||||
|
apiMachineryModule = "k8s.io" + "/" + "apimachinery"
|
||||||
|
apiMachineryVersion = "v0.17.0"
|
||||||
|
sigsK8sIo = "sigs.k8s.io"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
filesToCopy = map[string][]string{
|
||||||
|
filepath.Join("pkg", "labels"): {
|
||||||
|
"labels.go",
|
||||||
|
"selector.go",
|
||||||
|
"zz_generated.deepcopy.go",
|
||||||
|
},
|
||||||
|
filepath.Join("pkg", "selection"): {
|
||||||
|
"operator.go",
|
||||||
|
},
|
||||||
|
filepath.Join("pkg", "util", "sets"): {
|
||||||
|
"empty.go",
|
||||||
|
"string.go",
|
||||||
|
},
|
||||||
|
filepath.Join("pkg", "util", "errors"): {
|
||||||
|
"errors.go",
|
||||||
|
},
|
||||||
|
filepath.Join("pkg", "util", "validation"): {
|
||||||
|
"validation.go",
|
||||||
|
},
|
||||||
|
filepath.Join("pkg", "util", "validation", "field"): {
|
||||||
|
"errors.go",
|
||||||
|
"path.go",
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
c := newCopier()
|
||||||
|
// c.print()
|
||||||
|
runNoOutputCommand("go", "get", c.apiMachineryModSpec())
|
||||||
|
for dir, files := range filesToCopy {
|
||||||
|
for _, n := range files {
|
||||||
|
if err := c.copyFile(dir, n); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
runNoOutputCommand(
|
||||||
|
"go", "mod", "edit", "-droprequire="+apiMachineryModule)
|
||||||
|
runNoOutputCommand("go", "mod", "tidy")
|
||||||
|
runGetOutputCommand("go", "fmt", "./...")
|
||||||
|
}
|
||||||
|
|
||||||
|
type copier struct {
|
||||||
|
goModCache string
|
||||||
|
topPackage string
|
||||||
|
srcDir string
|
||||||
|
pgmName string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c copier) apiMachineryModSpec() string {
|
||||||
|
return apiMachineryModule + "@" + apiMachineryVersion
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c copier) replacementPath() string {
|
||||||
|
return filepath.Join(c.topPackage, c.subPath())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c copier) subPath() string {
|
||||||
|
return filepath.Join("internal", c.pgmName)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c copier) print() {
|
||||||
|
fmt.Printf(" apiMachineryModule: %s\n", apiMachineryModule)
|
||||||
|
fmt.Printf(" replacementPath: %s\n", c.replacementPath())
|
||||||
|
fmt.Printf(" goModCache: %s\n", c.goModCache)
|
||||||
|
fmt.Printf(" topPackage: %s\n", c.topPackage)
|
||||||
|
fmt.Printf(" subPath: %s\n", c.subPath())
|
||||||
|
fmt.Printf(" srcDir: %s\n", c.srcDir)
|
||||||
|
fmt.Printf(" apiMachineryModSpec: %s\n", c.apiMachineryModSpec())
|
||||||
|
fmt.Printf(" pgmName: %s\n", c.pgmName)
|
||||||
|
fmt.Printf(" pwd: %s\n", os.Getenv("PWD"))
|
||||||
|
}
|
||||||
|
|
||||||
|
func newCopier() copier {
|
||||||
|
tmp := copier{
|
||||||
|
pgmName: os.Getenv("GOPACKAGE"),
|
||||||
|
goModCache: runGetOutputCommand("go", "env", "GOMODCACHE"),
|
||||||
|
}
|
||||||
|
goMod := runGetOutputCommand("go", "env", "GOMOD")
|
||||||
|
topPackage := filepath.Join(goMod[:len(goMod)-len("go.mod")-1], "yaml")
|
||||||
|
k := strings.Index(topPackage, sigsK8sIo)
|
||||||
|
if k < 1 {
|
||||||
|
log.Fatalf("cannot find %s in %s", sigsK8sIo, topPackage)
|
||||||
|
}
|
||||||
|
tmp.srcDir = topPackage[:k-1]
|
||||||
|
tmp.topPackage = topPackage[k:]
|
||||||
|
return tmp
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c copier) copyFile(dir, name string) error {
|
||||||
|
inFile, err := os.Open(
|
||||||
|
filepath.Join(c.goModCache, c.apiMachineryModSpec(), dir, name))
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer inFile.Close()
|
||||||
|
scanner := bufio.NewScanner(inFile)
|
||||||
|
|
||||||
|
w, err := newWriter(dir, name)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer w.close()
|
||||||
|
|
||||||
|
w.write(
|
||||||
|
fmt.Sprintf(
|
||||||
|
// This particular phrasing is required.
|
||||||
|
"// Code generated by %s/generator from %s; DO NOT EDIT.",
|
||||||
|
c.pgmName, c.apiMachineryModSpec()))
|
||||||
|
w.write(
|
||||||
|
fmt.Sprintf(
|
||||||
|
"// Copied from %s\n",
|
||||||
|
filepath.Join(c.apiMachineryModSpec(), dir, name)))
|
||||||
|
|
||||||
|
for scanner.Scan() {
|
||||||
|
l := scanner.Text()
|
||||||
|
// Disallow recursive generation.
|
||||||
|
if strings.HasPrefix(l, "//go:generate") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Don't want it to appear double generated.
|
||||||
|
if strings.HasPrefix(l, "// Code generated") {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
// Fix self-imports.
|
||||||
|
l = strings.Replace(l, apiMachineryModule, c.replacementPath(), 1)
|
||||||
|
// Replace klog with generic log (eschewing k8s.io entirely).
|
||||||
|
l = strings.Replace(l, "\"k8s.io/klog\"", "\"log\"", 1)
|
||||||
|
l = strings.Replace(l, "klog.V(10).Infof(", "log.Printf(", 1)
|
||||||
|
w.write(l)
|
||||||
|
}
|
||||||
|
if err := scanner.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
w.write("")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type writer struct {
|
||||||
|
root string
|
||||||
|
f *os.File
|
||||||
|
}
|
||||||
|
|
||||||
|
func newWriter(toDir, name string) (*writer, error) {
|
||||||
|
if err := os.MkdirAll(toDir, 0755); err != nil {
|
||||||
|
log.Printf("unable to create directory: %s", toDir)
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
n := filepath.Join(toDir, name)
|
||||||
|
f, err := os.Create(n)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("unable to create `%s`; %v", n, err)
|
||||||
|
}
|
||||||
|
return &writer{root: toDir, f: f}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *writer) close() {
|
||||||
|
w.f.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *writer) write(line string) {
|
||||||
|
if _, err := w.f.WriteString(line + "\n"); err != nil {
|
||||||
|
log.Printf("Trouble writing: %s", line)
|
||||||
|
log.Fatalf("Error: %s", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runNoOutputCommand(n string, args ...string) {
|
||||||
|
o := runGetOutputCommand(n, args...)
|
||||||
|
if len(o) > 0 {
|
||||||
|
log.Fatalf("unexpected output: %q", o)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func runGetOutputCommand(n string, args ...string) string {
|
||||||
|
cmd := exec.Command(n, args...)
|
||||||
|
var outBuf bytes.Buffer
|
||||||
|
cmd.Stdout = &outBuf
|
||||||
|
var errBuf bytes.Buffer
|
||||||
|
cmd.Stderr = &errBuf
|
||||||
|
if err := cmd.Run(); err != nil {
|
||||||
|
fmt.Printf("err: %q\n", errBuf.String())
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
return strings.TrimSpace(outBuf.String())
|
||||||
|
}
|
||||||
184
kyaml/yaml/internal/k8sgen/pkg/labels/labels.go
Normal file
184
kyaml/yaml/internal/k8sgen/pkg/labels/labels.go
Normal file
@@ -0,0 +1,184 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/labels/labels.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2014 The Kubernetes 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 labels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Labels allows you to present labels independently from their storage.
|
||||||
|
type Labels interface {
|
||||||
|
// Has returns whether the provided label exists.
|
||||||
|
Has(label string) (exists bool)
|
||||||
|
|
||||||
|
// Get returns the value for the provided label.
|
||||||
|
Get(label string) (value string)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set is a map of label:value. It implements Labels.
|
||||||
|
type Set map[string]string
|
||||||
|
|
||||||
|
// String returns all labels listed as a human readable string.
|
||||||
|
// Conveniently, exactly the format that ParseSelector takes.
|
||||||
|
func (ls Set) String() string {
|
||||||
|
selector := make([]string, 0, len(ls))
|
||||||
|
for key, value := range ls {
|
||||||
|
selector = append(selector, key+"="+value)
|
||||||
|
}
|
||||||
|
// Sort for determinism.
|
||||||
|
sort.StringSlice(selector).Sort()
|
||||||
|
return strings.Join(selector, ",")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Has returns whether the provided label exists in the map.
|
||||||
|
func (ls Set) Has(label string) bool {
|
||||||
|
_, exists := ls[label]
|
||||||
|
return exists
|
||||||
|
}
|
||||||
|
|
||||||
|
// Get returns the value in the map for the provided label.
|
||||||
|
func (ls Set) Get(label string) string {
|
||||||
|
return ls[label]
|
||||||
|
}
|
||||||
|
|
||||||
|
// AsSelector converts labels into a selectors.
|
||||||
|
func (ls Set) AsSelector() Selector {
|
||||||
|
return SelectorFromSet(ls)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AsSelectorPreValidated converts labels into a selector, but
|
||||||
|
// assumes that labels are already validated and thus don't
|
||||||
|
// preform any validation.
|
||||||
|
// According to our measurements this is significantly faster
|
||||||
|
// in codepaths that matter at high scale.
|
||||||
|
func (ls Set) AsSelectorPreValidated() Selector {
|
||||||
|
return SelectorFromValidatedSet(ls)
|
||||||
|
}
|
||||||
|
|
||||||
|
// FormatLabels convert label map into plain string
|
||||||
|
func FormatLabels(labelMap map[string]string) string {
|
||||||
|
l := Set(labelMap).String()
|
||||||
|
if l == "" {
|
||||||
|
l = "<none>"
|
||||||
|
}
|
||||||
|
return l
|
||||||
|
}
|
||||||
|
|
||||||
|
// Conflicts takes 2 maps and returns true if there a key match between
|
||||||
|
// the maps but the value doesn't match, and returns false in other cases
|
||||||
|
func Conflicts(labels1, labels2 Set) bool {
|
||||||
|
small := labels1
|
||||||
|
big := labels2
|
||||||
|
if len(labels2) < len(labels1) {
|
||||||
|
small = labels2
|
||||||
|
big = labels1
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range small {
|
||||||
|
if val, match := big[k]; match {
|
||||||
|
if val != v {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Merge combines given maps, and does not check for any conflicts
|
||||||
|
// between the maps. In case of conflicts, second map (labels2) wins
|
||||||
|
func Merge(labels1, labels2 Set) Set {
|
||||||
|
mergedMap := Set{}
|
||||||
|
|
||||||
|
for k, v := range labels1 {
|
||||||
|
mergedMap[k] = v
|
||||||
|
}
|
||||||
|
for k, v := range labels2 {
|
||||||
|
mergedMap[k] = v
|
||||||
|
}
|
||||||
|
return mergedMap
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equals returns true if the given maps are equal
|
||||||
|
func Equals(labels1, labels2 Set) bool {
|
||||||
|
if len(labels1) != len(labels2) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range labels1 {
|
||||||
|
value, ok := labels2[k]
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if value != v {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// AreLabelsInWhiteList verifies if the provided label list
|
||||||
|
// is in the provided whitelist and returns true, otherwise false.
|
||||||
|
func AreLabelsInWhiteList(labels, whitelist Set) bool {
|
||||||
|
if len(whitelist) == 0 {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
for k, v := range labels {
|
||||||
|
value, ok := whitelist[k]
|
||||||
|
if !ok {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if value != v {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConvertSelectorToLabelsMap converts selector string to labels map
|
||||||
|
// and validates keys and values
|
||||||
|
func ConvertSelectorToLabelsMap(selector string) (Set, error) {
|
||||||
|
labelsMap := Set{}
|
||||||
|
|
||||||
|
if len(selector) == 0 {
|
||||||
|
return labelsMap, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
labels := strings.Split(selector, ",")
|
||||||
|
for _, label := range labels {
|
||||||
|
l := strings.Split(label, "=")
|
||||||
|
if len(l) != 2 {
|
||||||
|
return labelsMap, fmt.Errorf("invalid selector: %s", l)
|
||||||
|
}
|
||||||
|
key := strings.TrimSpace(l[0])
|
||||||
|
if err := validateLabelKey(key); err != nil {
|
||||||
|
return labelsMap, err
|
||||||
|
}
|
||||||
|
value := strings.TrimSpace(l[1])
|
||||||
|
if err := validateLabelValue(key, value); err != nil {
|
||||||
|
return labelsMap, err
|
||||||
|
}
|
||||||
|
labelsMap[key] = value
|
||||||
|
}
|
||||||
|
return labelsMap, nil
|
||||||
|
}
|
||||||
919
kyaml/yaml/internal/k8sgen/pkg/labels/selector.go
Normal file
919
kyaml/yaml/internal/k8sgen/pkg/labels/selector.go
Normal file
@@ -0,0 +1,919 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/labels/selector.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2014 The Kubernetes 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 labels
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"sort"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"log"
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/selection"
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/sets"
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/validation"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Requirements is AND of all requirements.
|
||||||
|
type Requirements []Requirement
|
||||||
|
|
||||||
|
// Selector represents a label selector.
|
||||||
|
type Selector interface {
|
||||||
|
// Matches returns true if this selector matches the given set of labels.
|
||||||
|
Matches(Labels) bool
|
||||||
|
|
||||||
|
// Empty returns true if this selector does not restrict the selection space.
|
||||||
|
Empty() bool
|
||||||
|
|
||||||
|
// String returns a human readable string that represents this selector.
|
||||||
|
String() string
|
||||||
|
|
||||||
|
// Add adds requirements to the Selector
|
||||||
|
Add(r ...Requirement) Selector
|
||||||
|
|
||||||
|
// Requirements converts this interface into Requirements to expose
|
||||||
|
// more detailed selection information.
|
||||||
|
// If there are querying parameters, it will return converted requirements and selectable=true.
|
||||||
|
// If this selector doesn't want to select anything, it will return selectable=false.
|
||||||
|
Requirements() (requirements Requirements, selectable bool)
|
||||||
|
|
||||||
|
// Make a deep copy of the selector.
|
||||||
|
DeepCopySelector() Selector
|
||||||
|
|
||||||
|
// RequiresExactMatch allows a caller to introspect whether a given selector
|
||||||
|
// requires a single specific label to be set, and if so returns the value it
|
||||||
|
// requires.
|
||||||
|
RequiresExactMatch(label string) (value string, found bool)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Everything returns a selector that matches all labels.
|
||||||
|
func Everything() Selector {
|
||||||
|
return internalSelector{}
|
||||||
|
}
|
||||||
|
|
||||||
|
type nothingSelector struct{}
|
||||||
|
|
||||||
|
func (n nothingSelector) Matches(_ Labels) bool { return false }
|
||||||
|
func (n nothingSelector) Empty() bool { return false }
|
||||||
|
func (n nothingSelector) String() string { return "" }
|
||||||
|
func (n nothingSelector) Add(_ ...Requirement) Selector { return n }
|
||||||
|
func (n nothingSelector) Requirements() (Requirements, bool) { return nil, false }
|
||||||
|
func (n nothingSelector) DeepCopySelector() Selector { return n }
|
||||||
|
func (n nothingSelector) RequiresExactMatch(label string) (value string, found bool) {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Nothing returns a selector that matches no labels
|
||||||
|
func Nothing() Selector {
|
||||||
|
return nothingSelector{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewSelector returns a nil selector
|
||||||
|
func NewSelector() Selector {
|
||||||
|
return internalSelector(nil)
|
||||||
|
}
|
||||||
|
|
||||||
|
type internalSelector []Requirement
|
||||||
|
|
||||||
|
func (s internalSelector) DeepCopy() internalSelector {
|
||||||
|
if s == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
result := make([]Requirement, len(s))
|
||||||
|
for i := range s {
|
||||||
|
s[i].DeepCopyInto(&result[i])
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s internalSelector) DeepCopySelector() Selector {
|
||||||
|
return s.DeepCopy()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ByKey sorts requirements by key to obtain deterministic parser
|
||||||
|
type ByKey []Requirement
|
||||||
|
|
||||||
|
func (a ByKey) Len() int { return len(a) }
|
||||||
|
|
||||||
|
func (a ByKey) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
|
||||||
|
|
||||||
|
func (a ByKey) Less(i, j int) bool { return a[i].key < a[j].key }
|
||||||
|
|
||||||
|
// Requirement contains values, a key, and an operator that relates the key and values.
|
||||||
|
// The zero value of Requirement is invalid.
|
||||||
|
// Requirement implements both set based match and exact match
|
||||||
|
// Requirement should be initialized via NewRequirement constructor for creating a valid Requirement.
|
||||||
|
// +k8s:deepcopy-gen=true
|
||||||
|
type Requirement struct {
|
||||||
|
key string
|
||||||
|
operator selection.Operator
|
||||||
|
// In huge majority of cases we have at most one value here.
|
||||||
|
// It is generally faster to operate on a single-element slice
|
||||||
|
// than on a single-element map, so we have a slice here.
|
||||||
|
strValues []string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewRequirement is the constructor for a Requirement.
|
||||||
|
// If any of these rules is violated, an error is returned:
|
||||||
|
// (1) The operator can only be In, NotIn, Equals, DoubleEquals, NotEquals, Exists, or DoesNotExist.
|
||||||
|
// (2) If the operator is In or NotIn, the values set must be non-empty.
|
||||||
|
// (3) If the operator is Equals, DoubleEquals, or NotEquals, the values set must contain one value.
|
||||||
|
// (4) If the operator is Exists or DoesNotExist, the value set must be empty.
|
||||||
|
// (5) If the operator is Gt or Lt, the values set must contain only one value, which will be interpreted as an integer.
|
||||||
|
// (6) The key is invalid due to its length, or sequence
|
||||||
|
// of characters. See validateLabelKey for more details.
|
||||||
|
//
|
||||||
|
// The empty string is a valid value in the input values set.
|
||||||
|
func NewRequirement(key string, op selection.Operator, vals []string) (*Requirement, error) {
|
||||||
|
if err := validateLabelKey(key); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
switch op {
|
||||||
|
case selection.In, selection.NotIn:
|
||||||
|
if len(vals) == 0 {
|
||||||
|
return nil, fmt.Errorf("for 'in', 'notin' operators, values set can't be empty")
|
||||||
|
}
|
||||||
|
case selection.Equals, selection.DoubleEquals, selection.NotEquals:
|
||||||
|
if len(vals) != 1 {
|
||||||
|
return nil, fmt.Errorf("exact-match compatibility requires one single value")
|
||||||
|
}
|
||||||
|
case selection.Exists, selection.DoesNotExist:
|
||||||
|
if len(vals) != 0 {
|
||||||
|
return nil, fmt.Errorf("values set must be empty for exists and does not exist")
|
||||||
|
}
|
||||||
|
case selection.GreaterThan, selection.LessThan:
|
||||||
|
if len(vals) != 1 {
|
||||||
|
return nil, fmt.Errorf("for 'Gt', 'Lt' operators, exactly one value is required")
|
||||||
|
}
|
||||||
|
for i := range vals {
|
||||||
|
if _, err := strconv.ParseInt(vals[i], 10, 64); err != nil {
|
||||||
|
return nil, fmt.Errorf("for 'Gt', 'Lt' operators, the value must be an integer")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("operator '%v' is not recognized", op)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := range vals {
|
||||||
|
if err := validateLabelValue(key, vals[i]); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return &Requirement{key: key, operator: op, strValues: vals}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Requirement) hasValue(value string) bool {
|
||||||
|
for i := range r.strValues {
|
||||||
|
if r.strValues[i] == value {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Matches returns true if the Requirement matches the input Labels.
|
||||||
|
// There is a match in the following cases:
|
||||||
|
// (1) The operator is Exists and Labels has the Requirement's key.
|
||||||
|
// (2) The operator is In, Labels has the Requirement's key and Labels'
|
||||||
|
// value for that key is in Requirement's value set.
|
||||||
|
// (3) The operator is NotIn, Labels has the Requirement's key and
|
||||||
|
// Labels' value for that key is not in Requirement's value set.
|
||||||
|
// (4) The operator is DoesNotExist or NotIn and Labels does not have the
|
||||||
|
// Requirement's key.
|
||||||
|
// (5) The operator is GreaterThanOperator or LessThanOperator, and Labels has
|
||||||
|
// the Requirement's key and the corresponding value satisfies mathematical inequality.
|
||||||
|
func (r *Requirement) Matches(ls Labels) bool {
|
||||||
|
switch r.operator {
|
||||||
|
case selection.In, selection.Equals, selection.DoubleEquals:
|
||||||
|
if !ls.Has(r.key) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return r.hasValue(ls.Get(r.key))
|
||||||
|
case selection.NotIn, selection.NotEquals:
|
||||||
|
if !ls.Has(r.key) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return !r.hasValue(ls.Get(r.key))
|
||||||
|
case selection.Exists:
|
||||||
|
return ls.Has(r.key)
|
||||||
|
case selection.DoesNotExist:
|
||||||
|
return !ls.Has(r.key)
|
||||||
|
case selection.GreaterThan, selection.LessThan:
|
||||||
|
if !ls.Has(r.key) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
lsValue, err := strconv.ParseInt(ls.Get(r.key), 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("ParseInt failed for value %+v in label %+v, %+v", ls.Get(r.key), ls, err)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// There should be only one strValue in r.strValues, and can be converted to a integer.
|
||||||
|
if len(r.strValues) != 1 {
|
||||||
|
log.Printf("Invalid values count %+v of requirement %#v, for 'Gt', 'Lt' operators, exactly one value is required", len(r.strValues), r)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
var rValue int64
|
||||||
|
for i := range r.strValues {
|
||||||
|
rValue, err = strconv.ParseInt(r.strValues[i], 10, 64)
|
||||||
|
if err != nil {
|
||||||
|
log.Printf("ParseInt failed for value %+v in requirement %#v, for 'Gt', 'Lt' operators, the value must be an integer", r.strValues[i], r)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return (r.operator == selection.GreaterThan && lsValue > rValue) || (r.operator == selection.LessThan && lsValue < rValue)
|
||||||
|
default:
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key returns requirement key
|
||||||
|
func (r *Requirement) Key() string {
|
||||||
|
return r.key
|
||||||
|
}
|
||||||
|
|
||||||
|
// Operator returns requirement operator
|
||||||
|
func (r *Requirement) Operator() selection.Operator {
|
||||||
|
return r.operator
|
||||||
|
}
|
||||||
|
|
||||||
|
// Values returns requirement values
|
||||||
|
func (r *Requirement) Values() sets.String {
|
||||||
|
ret := sets.String{}
|
||||||
|
for i := range r.strValues {
|
||||||
|
ret.Insert(r.strValues[i])
|
||||||
|
}
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
// Empty returns true if the internalSelector doesn't restrict selection space
|
||||||
|
func (lsel internalSelector) Empty() bool {
|
||||||
|
if lsel == nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return len(lsel) == 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// String returns a human-readable string that represents this
|
||||||
|
// Requirement. If called on an invalid Requirement, an error is
|
||||||
|
// returned. See NewRequirement for creating a valid Requirement.
|
||||||
|
func (r *Requirement) String() string {
|
||||||
|
var buffer bytes.Buffer
|
||||||
|
if r.operator == selection.DoesNotExist {
|
||||||
|
buffer.WriteString("!")
|
||||||
|
}
|
||||||
|
buffer.WriteString(r.key)
|
||||||
|
|
||||||
|
switch r.operator {
|
||||||
|
case selection.Equals:
|
||||||
|
buffer.WriteString("=")
|
||||||
|
case selection.DoubleEquals:
|
||||||
|
buffer.WriteString("==")
|
||||||
|
case selection.NotEquals:
|
||||||
|
buffer.WriteString("!=")
|
||||||
|
case selection.In:
|
||||||
|
buffer.WriteString(" in ")
|
||||||
|
case selection.NotIn:
|
||||||
|
buffer.WriteString(" notin ")
|
||||||
|
case selection.GreaterThan:
|
||||||
|
buffer.WriteString(">")
|
||||||
|
case selection.LessThan:
|
||||||
|
buffer.WriteString("<")
|
||||||
|
case selection.Exists, selection.DoesNotExist:
|
||||||
|
return buffer.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
switch r.operator {
|
||||||
|
case selection.In, selection.NotIn:
|
||||||
|
buffer.WriteString("(")
|
||||||
|
}
|
||||||
|
if len(r.strValues) == 1 {
|
||||||
|
buffer.WriteString(r.strValues[0])
|
||||||
|
} else { // only > 1 since == 0 prohibited by NewRequirement
|
||||||
|
// normalizes value order on output, without mutating the in-memory selector representation
|
||||||
|
// also avoids normalization when it is not required, and ensures we do not mutate shared data
|
||||||
|
buffer.WriteString(strings.Join(safeSort(r.strValues), ","))
|
||||||
|
}
|
||||||
|
|
||||||
|
switch r.operator {
|
||||||
|
case selection.In, selection.NotIn:
|
||||||
|
buffer.WriteString(")")
|
||||||
|
}
|
||||||
|
return buffer.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// safeSort sort input strings without modification
|
||||||
|
func safeSort(in []string) []string {
|
||||||
|
if sort.StringsAreSorted(in) {
|
||||||
|
return in
|
||||||
|
}
|
||||||
|
out := make([]string, len(in))
|
||||||
|
copy(out, in)
|
||||||
|
sort.Strings(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add adds requirements to the selector. It copies the current selector returning a new one
|
||||||
|
func (lsel internalSelector) Add(reqs ...Requirement) Selector {
|
||||||
|
var sel internalSelector
|
||||||
|
for ix := range lsel {
|
||||||
|
sel = append(sel, lsel[ix])
|
||||||
|
}
|
||||||
|
for _, r := range reqs {
|
||||||
|
sel = append(sel, r)
|
||||||
|
}
|
||||||
|
sort.Sort(ByKey(sel))
|
||||||
|
return sel
|
||||||
|
}
|
||||||
|
|
||||||
|
// Matches for a internalSelector returns true if all
|
||||||
|
// its Requirements match the input Labels. If any
|
||||||
|
// Requirement does not match, false is returned.
|
||||||
|
func (lsel internalSelector) Matches(l Labels) bool {
|
||||||
|
for ix := range lsel {
|
||||||
|
if matches := lsel[ix].Matches(l); !matches {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (lsel internalSelector) Requirements() (Requirements, bool) { return Requirements(lsel), true }
|
||||||
|
|
||||||
|
// String returns a comma-separated string of all
|
||||||
|
// the internalSelector Requirements' human-readable strings.
|
||||||
|
func (lsel internalSelector) String() string {
|
||||||
|
var reqs []string
|
||||||
|
for ix := range lsel {
|
||||||
|
reqs = append(reqs, lsel[ix].String())
|
||||||
|
}
|
||||||
|
return strings.Join(reqs, ",")
|
||||||
|
}
|
||||||
|
|
||||||
|
// RequiresExactMatch introspect whether a given selector requires a single specific field
|
||||||
|
// to be set, and if so returns the value it requires.
|
||||||
|
func (lsel internalSelector) RequiresExactMatch(label string) (value string, found bool) {
|
||||||
|
for ix := range lsel {
|
||||||
|
if lsel[ix].key == label {
|
||||||
|
switch lsel[ix].operator {
|
||||||
|
case selection.Equals, selection.DoubleEquals, selection.In:
|
||||||
|
if len(lsel[ix].strValues) == 1 {
|
||||||
|
return lsel[ix].strValues[0], true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Token represents constant definition for lexer token
|
||||||
|
type Token int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// ErrorToken represents scan error
|
||||||
|
ErrorToken Token = iota
|
||||||
|
// EndOfStringToken represents end of string
|
||||||
|
EndOfStringToken
|
||||||
|
// ClosedParToken represents close parenthesis
|
||||||
|
ClosedParToken
|
||||||
|
// CommaToken represents the comma
|
||||||
|
CommaToken
|
||||||
|
// DoesNotExistToken represents logic not
|
||||||
|
DoesNotExistToken
|
||||||
|
// DoubleEqualsToken represents double equals
|
||||||
|
DoubleEqualsToken
|
||||||
|
// EqualsToken represents equal
|
||||||
|
EqualsToken
|
||||||
|
// GreaterThanToken represents greater than
|
||||||
|
GreaterThanToken
|
||||||
|
// IdentifierToken represents identifier, e.g. keys and values
|
||||||
|
IdentifierToken
|
||||||
|
// InToken represents in
|
||||||
|
InToken
|
||||||
|
// LessThanToken represents less than
|
||||||
|
LessThanToken
|
||||||
|
// NotEqualsToken represents not equal
|
||||||
|
NotEqualsToken
|
||||||
|
// NotInToken represents not in
|
||||||
|
NotInToken
|
||||||
|
// OpenParToken represents open parenthesis
|
||||||
|
OpenParToken
|
||||||
|
)
|
||||||
|
|
||||||
|
// string2token contains the mapping between lexer Token and token literal
|
||||||
|
// (except IdentifierToken, EndOfStringToken and ErrorToken since it makes no sense)
|
||||||
|
var string2token = map[string]Token{
|
||||||
|
")": ClosedParToken,
|
||||||
|
",": CommaToken,
|
||||||
|
"!": DoesNotExistToken,
|
||||||
|
"==": DoubleEqualsToken,
|
||||||
|
"=": EqualsToken,
|
||||||
|
">": GreaterThanToken,
|
||||||
|
"in": InToken,
|
||||||
|
"<": LessThanToken,
|
||||||
|
"!=": NotEqualsToken,
|
||||||
|
"notin": NotInToken,
|
||||||
|
"(": OpenParToken,
|
||||||
|
}
|
||||||
|
|
||||||
|
// ScannedItem contains the Token and the literal produced by the lexer.
|
||||||
|
type ScannedItem struct {
|
||||||
|
tok Token
|
||||||
|
literal string
|
||||||
|
}
|
||||||
|
|
||||||
|
// isWhitespace returns true if the rune is a space, tab, or newline.
|
||||||
|
func isWhitespace(ch byte) bool {
|
||||||
|
return ch == ' ' || ch == '\t' || ch == '\r' || ch == '\n'
|
||||||
|
}
|
||||||
|
|
||||||
|
// isSpecialSymbol detect if the character ch can be an operator
|
||||||
|
func isSpecialSymbol(ch byte) bool {
|
||||||
|
switch ch {
|
||||||
|
case '=', '!', '(', ')', ',', '>', '<':
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lexer represents the Lexer struct for label selector.
|
||||||
|
// It contains necessary informationt to tokenize the input string
|
||||||
|
type Lexer struct {
|
||||||
|
// s stores the string to be tokenized
|
||||||
|
s string
|
||||||
|
// pos is the position currently tokenized
|
||||||
|
pos int
|
||||||
|
}
|
||||||
|
|
||||||
|
// read return the character currently lexed
|
||||||
|
// increment the position and check the buffer overflow
|
||||||
|
func (l *Lexer) read() (b byte) {
|
||||||
|
b = 0
|
||||||
|
if l.pos < len(l.s) {
|
||||||
|
b = l.s[l.pos]
|
||||||
|
l.pos++
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
// unread 'undoes' the last read character
|
||||||
|
func (l *Lexer) unread() {
|
||||||
|
l.pos--
|
||||||
|
}
|
||||||
|
|
||||||
|
// scanIDOrKeyword scans string to recognize literal token (for example 'in') or an identifier.
|
||||||
|
func (l *Lexer) scanIDOrKeyword() (tok Token, lit string) {
|
||||||
|
var buffer []byte
|
||||||
|
IdentifierLoop:
|
||||||
|
for {
|
||||||
|
switch ch := l.read(); {
|
||||||
|
case ch == 0:
|
||||||
|
break IdentifierLoop
|
||||||
|
case isSpecialSymbol(ch) || isWhitespace(ch):
|
||||||
|
l.unread()
|
||||||
|
break IdentifierLoop
|
||||||
|
default:
|
||||||
|
buffer = append(buffer, ch)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s := string(buffer)
|
||||||
|
if val, ok := string2token[s]; ok { // is a literal token?
|
||||||
|
return val, s
|
||||||
|
}
|
||||||
|
return IdentifierToken, s // otherwise is an identifier
|
||||||
|
}
|
||||||
|
|
||||||
|
// scanSpecialSymbol scans string starting with special symbol.
|
||||||
|
// special symbol identify non literal operators. "!=", "==", "="
|
||||||
|
func (l *Lexer) scanSpecialSymbol() (Token, string) {
|
||||||
|
lastScannedItem := ScannedItem{}
|
||||||
|
var buffer []byte
|
||||||
|
SpecialSymbolLoop:
|
||||||
|
for {
|
||||||
|
switch ch := l.read(); {
|
||||||
|
case ch == 0:
|
||||||
|
break SpecialSymbolLoop
|
||||||
|
case isSpecialSymbol(ch):
|
||||||
|
buffer = append(buffer, ch)
|
||||||
|
if token, ok := string2token[string(buffer)]; ok {
|
||||||
|
lastScannedItem = ScannedItem{tok: token, literal: string(buffer)}
|
||||||
|
} else if lastScannedItem.tok != 0 {
|
||||||
|
l.unread()
|
||||||
|
break SpecialSymbolLoop
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
l.unread()
|
||||||
|
break SpecialSymbolLoop
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if lastScannedItem.tok == 0 {
|
||||||
|
return ErrorToken, fmt.Sprintf("error expected: keyword found '%s'", buffer)
|
||||||
|
}
|
||||||
|
return lastScannedItem.tok, lastScannedItem.literal
|
||||||
|
}
|
||||||
|
|
||||||
|
// skipWhiteSpaces consumes all blank characters
|
||||||
|
// returning the first non blank character
|
||||||
|
func (l *Lexer) skipWhiteSpaces(ch byte) byte {
|
||||||
|
for {
|
||||||
|
if !isWhitespace(ch) {
|
||||||
|
return ch
|
||||||
|
}
|
||||||
|
ch = l.read()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lex returns a pair of Token and the literal
|
||||||
|
// literal is meaningfull only for IdentifierToken token
|
||||||
|
func (l *Lexer) Lex() (tok Token, lit string) {
|
||||||
|
switch ch := l.skipWhiteSpaces(l.read()); {
|
||||||
|
case ch == 0:
|
||||||
|
return EndOfStringToken, ""
|
||||||
|
case isSpecialSymbol(ch):
|
||||||
|
l.unread()
|
||||||
|
return l.scanSpecialSymbol()
|
||||||
|
default:
|
||||||
|
l.unread()
|
||||||
|
return l.scanIDOrKeyword()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parser data structure contains the label selector parser data structure
|
||||||
|
type Parser struct {
|
||||||
|
l *Lexer
|
||||||
|
scannedItems []ScannedItem
|
||||||
|
position int
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParserContext represents context during parsing:
|
||||||
|
// some literal for example 'in' and 'notin' can be
|
||||||
|
// recognized as operator for example 'x in (a)' but
|
||||||
|
// it can be recognized as value for example 'value in (in)'
|
||||||
|
type ParserContext int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// KeyAndOperator represents key and operator
|
||||||
|
KeyAndOperator ParserContext = iota
|
||||||
|
// Values represents values
|
||||||
|
Values
|
||||||
|
)
|
||||||
|
|
||||||
|
// lookahead func returns the current token and string. No increment of current position
|
||||||
|
func (p *Parser) lookahead(context ParserContext) (Token, string) {
|
||||||
|
tok, lit := p.scannedItems[p.position].tok, p.scannedItems[p.position].literal
|
||||||
|
if context == Values {
|
||||||
|
switch tok {
|
||||||
|
case InToken, NotInToken:
|
||||||
|
tok = IdentifierToken
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return tok, lit
|
||||||
|
}
|
||||||
|
|
||||||
|
// consume returns current token and string. Increments the position
|
||||||
|
func (p *Parser) consume(context ParserContext) (Token, string) {
|
||||||
|
p.position++
|
||||||
|
tok, lit := p.scannedItems[p.position-1].tok, p.scannedItems[p.position-1].literal
|
||||||
|
if context == Values {
|
||||||
|
switch tok {
|
||||||
|
case InToken, NotInToken:
|
||||||
|
tok = IdentifierToken
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return tok, lit
|
||||||
|
}
|
||||||
|
|
||||||
|
// scan runs through the input string and stores the ScannedItem in an array
|
||||||
|
// Parser can now lookahead and consume the tokens
|
||||||
|
func (p *Parser) scan() {
|
||||||
|
for {
|
||||||
|
token, literal := p.l.Lex()
|
||||||
|
p.scannedItems = append(p.scannedItems, ScannedItem{token, literal})
|
||||||
|
if token == EndOfStringToken {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parse runs the left recursive descending algorithm
|
||||||
|
// on input string. It returns a list of Requirement objects.
|
||||||
|
func (p *Parser) parse() (internalSelector, error) {
|
||||||
|
p.scan() // init scannedItems
|
||||||
|
|
||||||
|
var requirements internalSelector
|
||||||
|
for {
|
||||||
|
tok, lit := p.lookahead(Values)
|
||||||
|
switch tok {
|
||||||
|
case IdentifierToken, DoesNotExistToken:
|
||||||
|
r, err := p.parseRequirement()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("unable to parse requirement: %v", err)
|
||||||
|
}
|
||||||
|
requirements = append(requirements, *r)
|
||||||
|
t, l := p.consume(Values)
|
||||||
|
switch t {
|
||||||
|
case EndOfStringToken:
|
||||||
|
return requirements, nil
|
||||||
|
case CommaToken:
|
||||||
|
t2, l2 := p.lookahead(Values)
|
||||||
|
if t2 != IdentifierToken && t2 != DoesNotExistToken {
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: identifier after ','", l2)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: ',' or 'end of string'", l)
|
||||||
|
}
|
||||||
|
case EndOfStringToken:
|
||||||
|
return requirements, nil
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: !, identifier, or 'end of string'", lit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Parser) parseRequirement() (*Requirement, error) {
|
||||||
|
key, operator, err := p.parseKeyAndInferOperator()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if operator == selection.Exists || operator == selection.DoesNotExist { // operator found lookahead set checked
|
||||||
|
return NewRequirement(key, operator, []string{})
|
||||||
|
}
|
||||||
|
operator, err = p.parseOperator()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
var values sets.String
|
||||||
|
switch operator {
|
||||||
|
case selection.In, selection.NotIn:
|
||||||
|
values, err = p.parseValues()
|
||||||
|
case selection.Equals, selection.DoubleEquals, selection.NotEquals, selection.GreaterThan, selection.LessThan:
|
||||||
|
values, err = p.parseExactValue()
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return NewRequirement(key, operator, values.List())
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseKeyAndInferOperator parse literals.
|
||||||
|
// in case of no operator '!, in, notin, ==, =, !=' are found
|
||||||
|
// the 'exists' operator is inferred
|
||||||
|
func (p *Parser) parseKeyAndInferOperator() (string, selection.Operator, error) {
|
||||||
|
var operator selection.Operator
|
||||||
|
tok, literal := p.consume(Values)
|
||||||
|
if tok == DoesNotExistToken {
|
||||||
|
operator = selection.DoesNotExist
|
||||||
|
tok, literal = p.consume(Values)
|
||||||
|
}
|
||||||
|
if tok != IdentifierToken {
|
||||||
|
err := fmt.Errorf("found '%s', expected: identifier", literal)
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
if err := validateLabelKey(literal); err != nil {
|
||||||
|
return "", "", err
|
||||||
|
}
|
||||||
|
if t, _ := p.lookahead(Values); t == EndOfStringToken || t == CommaToken {
|
||||||
|
if operator != selection.DoesNotExist {
|
||||||
|
operator = selection.Exists
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return literal, operator, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseOperator return operator and eventually matchType
|
||||||
|
// matchType can be exact
|
||||||
|
func (p *Parser) parseOperator() (op selection.Operator, err error) {
|
||||||
|
tok, lit := p.consume(KeyAndOperator)
|
||||||
|
switch tok {
|
||||||
|
// DoesNotExistToken shouldn't be here because it's a unary operator, not a binary operator
|
||||||
|
case InToken:
|
||||||
|
op = selection.In
|
||||||
|
case EqualsToken:
|
||||||
|
op = selection.Equals
|
||||||
|
case DoubleEqualsToken:
|
||||||
|
op = selection.DoubleEquals
|
||||||
|
case GreaterThanToken:
|
||||||
|
op = selection.GreaterThan
|
||||||
|
case LessThanToken:
|
||||||
|
op = selection.LessThan
|
||||||
|
case NotInToken:
|
||||||
|
op = selection.NotIn
|
||||||
|
case NotEqualsToken:
|
||||||
|
op = selection.NotEquals
|
||||||
|
default:
|
||||||
|
return "", fmt.Errorf("found '%s', expected: '=', '!=', '==', 'in', notin'", lit)
|
||||||
|
}
|
||||||
|
return op, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseValues parses the values for set based matching (x,y,z)
|
||||||
|
func (p *Parser) parseValues() (sets.String, error) {
|
||||||
|
tok, lit := p.consume(Values)
|
||||||
|
if tok != OpenParToken {
|
||||||
|
return nil, fmt.Errorf("found '%s' expected: '('", lit)
|
||||||
|
}
|
||||||
|
tok, lit = p.lookahead(Values)
|
||||||
|
switch tok {
|
||||||
|
case IdentifierToken, CommaToken:
|
||||||
|
s, err := p.parseIdentifiersList() // handles general cases
|
||||||
|
if err != nil {
|
||||||
|
return s, err
|
||||||
|
}
|
||||||
|
if tok, _ = p.consume(Values); tok != ClosedParToken {
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: ')'", lit)
|
||||||
|
}
|
||||||
|
return s, nil
|
||||||
|
case ClosedParToken: // handles "()"
|
||||||
|
p.consume(Values)
|
||||||
|
return sets.NewString(""), nil
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: ',', ')' or identifier", lit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseIdentifiersList parses a (possibly empty) list of
|
||||||
|
// of comma separated (possibly empty) identifiers
|
||||||
|
func (p *Parser) parseIdentifiersList() (sets.String, error) {
|
||||||
|
s := sets.NewString()
|
||||||
|
for {
|
||||||
|
tok, lit := p.consume(Values)
|
||||||
|
switch tok {
|
||||||
|
case IdentifierToken:
|
||||||
|
s.Insert(lit)
|
||||||
|
tok2, lit2 := p.lookahead(Values)
|
||||||
|
switch tok2 {
|
||||||
|
case CommaToken:
|
||||||
|
continue
|
||||||
|
case ClosedParToken:
|
||||||
|
return s, nil
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: ',' or ')'", lit2)
|
||||||
|
}
|
||||||
|
case CommaToken: // handled here since we can have "(,"
|
||||||
|
if s.Len() == 0 {
|
||||||
|
s.Insert("") // to handle (,
|
||||||
|
}
|
||||||
|
tok2, _ := p.lookahead(Values)
|
||||||
|
if tok2 == ClosedParToken {
|
||||||
|
s.Insert("") // to handle ,) Double "" removed by StringSet
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
if tok2 == CommaToken {
|
||||||
|
p.consume(Values)
|
||||||
|
s.Insert("") // to handle ,, Double "" removed by StringSet
|
||||||
|
}
|
||||||
|
default: // it can be operator
|
||||||
|
return s, fmt.Errorf("found '%s', expected: ',', or identifier", lit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseExactValue parses the only value for exact match style
|
||||||
|
func (p *Parser) parseExactValue() (sets.String, error) {
|
||||||
|
s := sets.NewString()
|
||||||
|
tok, lit := p.lookahead(Values)
|
||||||
|
if tok == EndOfStringToken || tok == CommaToken {
|
||||||
|
s.Insert("")
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
tok, lit = p.consume(Values)
|
||||||
|
if tok == IdentifierToken {
|
||||||
|
s.Insert(lit)
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("found '%s', expected: identifier", lit)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Parse takes a string representing a selector and returns a selector
|
||||||
|
// object, or an error. This parsing function differs from ParseSelector
|
||||||
|
// as they parse different selectors with different syntaxes.
|
||||||
|
// The input will cause an error if it does not follow this form:
|
||||||
|
//
|
||||||
|
// <selector-syntax> ::= <requirement> | <requirement> "," <selector-syntax>
|
||||||
|
// <requirement> ::= [!] KEY [ <set-based-restriction> | <exact-match-restriction> ]
|
||||||
|
// <set-based-restriction> ::= "" | <inclusion-exclusion> <value-set>
|
||||||
|
// <inclusion-exclusion> ::= <inclusion> | <exclusion>
|
||||||
|
// <exclusion> ::= "notin"
|
||||||
|
// <inclusion> ::= "in"
|
||||||
|
// <value-set> ::= "(" <values> ")"
|
||||||
|
// <values> ::= VALUE | VALUE "," <values>
|
||||||
|
// <exact-match-restriction> ::= ["="|"=="|"!="] VALUE
|
||||||
|
//
|
||||||
|
// KEY is a sequence of one or more characters following [ DNS_SUBDOMAIN "/" ] DNS_LABEL. Max length is 63 characters.
|
||||||
|
// VALUE is a sequence of zero or more characters "([A-Za-z0-9_-\.])". Max length is 63 characters.
|
||||||
|
// Delimiter is white space: (' ', '\t')
|
||||||
|
// Example of valid syntax:
|
||||||
|
// "x in (foo,,baz),y,z notin ()"
|
||||||
|
//
|
||||||
|
// Note:
|
||||||
|
// (1) Inclusion - " in " - denotes that the KEY exists and is equal to any of the
|
||||||
|
// VALUEs in its requirement
|
||||||
|
// (2) Exclusion - " notin " - denotes that the KEY is not equal to any
|
||||||
|
// of the VALUEs in its requirement or does not exist
|
||||||
|
// (3) The empty string is a valid VALUE
|
||||||
|
// (4) A requirement with just a KEY - as in "y" above - denotes that
|
||||||
|
// the KEY exists and can be any VALUE.
|
||||||
|
// (5) A requirement with just !KEY requires that the KEY not exist.
|
||||||
|
//
|
||||||
|
func Parse(selector string) (Selector, error) {
|
||||||
|
parsedSelector, err := parse(selector)
|
||||||
|
if err == nil {
|
||||||
|
return parsedSelector, nil
|
||||||
|
}
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
// parse parses the string representation of the selector and returns the internalSelector struct.
|
||||||
|
// The callers of this method can then decide how to return the internalSelector struct to their
|
||||||
|
// callers. This function has two callers now, one returns a Selector interface and the other
|
||||||
|
// returns a list of requirements.
|
||||||
|
func parse(selector string) (internalSelector, error) {
|
||||||
|
p := &Parser{l: &Lexer{s: selector, pos: 0}}
|
||||||
|
items, err := p.parse()
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
sort.Sort(ByKey(items)) // sort to grant determistic parsing
|
||||||
|
return internalSelector(items), err
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateLabelKey(k string) error {
|
||||||
|
if errs := validation.IsQualifiedName(k); len(errs) != 0 {
|
||||||
|
return fmt.Errorf("invalid label key %q: %s", k, strings.Join(errs, "; "))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateLabelValue(k, v string) error {
|
||||||
|
if errs := validation.IsValidLabelValue(v); len(errs) != 0 {
|
||||||
|
return fmt.Errorf("invalid label value: %q: at key: %q: %s", v, k, strings.Join(errs, "; "))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SelectorFromSet returns a Selector which will match exactly the given Set. A
|
||||||
|
// nil and empty Sets are considered equivalent to Everything().
|
||||||
|
func SelectorFromSet(ls Set) Selector {
|
||||||
|
if ls == nil || len(ls) == 0 {
|
||||||
|
return internalSelector{}
|
||||||
|
}
|
||||||
|
requirements := make([]Requirement, 0, len(ls))
|
||||||
|
for label, value := range ls {
|
||||||
|
r, err := NewRequirement(label, selection.Equals, []string{value})
|
||||||
|
if err == nil {
|
||||||
|
requirements = append(requirements, *r)
|
||||||
|
} else {
|
||||||
|
//TODO: double check errors when input comes from serialization?
|
||||||
|
return internalSelector{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// sort to have deterministic string representation
|
||||||
|
sort.Sort(ByKey(requirements))
|
||||||
|
return internalSelector(requirements)
|
||||||
|
}
|
||||||
|
|
||||||
|
// SelectorFromValidatedSet returns a Selector which will match exactly the given Set.
|
||||||
|
// A nil and empty Sets are considered equivalent to Everything().
|
||||||
|
// It assumes that Set is already validated and doesn't do any validation.
|
||||||
|
func SelectorFromValidatedSet(ls Set) Selector {
|
||||||
|
if ls == nil || len(ls) == 0 {
|
||||||
|
return internalSelector{}
|
||||||
|
}
|
||||||
|
requirements := make([]Requirement, 0, len(ls))
|
||||||
|
for label, value := range ls {
|
||||||
|
requirements = append(requirements, Requirement{key: label, operator: selection.Equals, strValues: []string{value}})
|
||||||
|
}
|
||||||
|
// sort to have deterministic string representation
|
||||||
|
sort.Sort(ByKey(requirements))
|
||||||
|
return internalSelector(requirements)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseToRequirements takes a string representing a selector and returns a list of
|
||||||
|
// requirements. This function is suitable for those callers that perform additional
|
||||||
|
// processing on selector requirements.
|
||||||
|
// See the documentation for Parse() function for more details.
|
||||||
|
// TODO: Consider exporting the internalSelector type instead.
|
||||||
|
func ParseToRequirements(selector string) ([]Requirement, error) {
|
||||||
|
return parse(selector)
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/labels/zz_generated.deepcopy.go
|
||||||
|
|
||||||
|
// +build !ignore_autogenerated
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright The Kubernetes 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 labels
|
||||||
|
|
||||||
|
// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
|
||||||
|
func (in *Requirement) DeepCopyInto(out *Requirement) {
|
||||||
|
*out = *in
|
||||||
|
if in.strValues != nil {
|
||||||
|
in, out := &in.strValues, &out.strValues
|
||||||
|
*out = make([]string, len(*in))
|
||||||
|
copy(*out, *in)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Requirement.
|
||||||
|
func (in *Requirement) DeepCopy() *Requirement {
|
||||||
|
if in == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
out := new(Requirement)
|
||||||
|
in.DeepCopyInto(out)
|
||||||
|
return out
|
||||||
|
}
|
||||||
36
kyaml/yaml/internal/k8sgen/pkg/selection/operator.go
Normal file
36
kyaml/yaml/internal/k8sgen/pkg/selection/operator.go
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/selection/operator.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2016 The Kubernetes 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 selection
|
||||||
|
|
||||||
|
// Operator represents a key/field's relationship to value(s).
|
||||||
|
// See labels.Requirement and fields.Requirement for more details.
|
||||||
|
type Operator string
|
||||||
|
|
||||||
|
const (
|
||||||
|
DoesNotExist Operator = "!"
|
||||||
|
Equals Operator = "="
|
||||||
|
DoubleEquals Operator = "=="
|
||||||
|
In Operator = "in"
|
||||||
|
NotEquals Operator = "!="
|
||||||
|
NotIn Operator = "notin"
|
||||||
|
Exists Operator = "exists"
|
||||||
|
GreaterThan Operator = "gt"
|
||||||
|
LessThan Operator = "lt"
|
||||||
|
)
|
||||||
232
kyaml/yaml/internal/k8sgen/pkg/util/errors/errors.go
Normal file
232
kyaml/yaml/internal/k8sgen/pkg/util/errors/errors.go
Normal file
@@ -0,0 +1,232 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/errors/errors.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2015 The Kubernetes 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 errors
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/sets"
|
||||||
|
)
|
||||||
|
|
||||||
|
// MessageCountMap contains occurrence for each error message.
|
||||||
|
type MessageCountMap map[string]int
|
||||||
|
|
||||||
|
// Aggregate represents an object that contains multiple errors, but does not
|
||||||
|
// necessarily have singular semantic meaning.
|
||||||
|
type Aggregate interface {
|
||||||
|
error
|
||||||
|
Errors() []error
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewAggregate converts a slice of errors into an Aggregate interface, which
|
||||||
|
// is itself an implementation of the error interface. If the slice is empty,
|
||||||
|
// this returns nil.
|
||||||
|
// It will check if any of the element of input error list is nil, to avoid
|
||||||
|
// nil pointer panic when call Error().
|
||||||
|
func NewAggregate(errlist []error) Aggregate {
|
||||||
|
if len(errlist) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// In case of input error list contains nil
|
||||||
|
var errs []error
|
||||||
|
for _, e := range errlist {
|
||||||
|
if e != nil {
|
||||||
|
errs = append(errs, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(errs) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return aggregate(errs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// This helper implements the error and Errors interfaces. Keeping it private
|
||||||
|
// prevents people from making an aggregate of 0 errors, which is not
|
||||||
|
// an error, but does satisfy the error interface.
|
||||||
|
type aggregate []error
|
||||||
|
|
||||||
|
// Error is part of the error interface.
|
||||||
|
func (agg aggregate) Error() string {
|
||||||
|
if len(agg) == 0 {
|
||||||
|
// This should never happen, really.
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
if len(agg) == 1 {
|
||||||
|
return agg[0].Error()
|
||||||
|
}
|
||||||
|
seenerrs := sets.NewString()
|
||||||
|
result := ""
|
||||||
|
agg.visit(func(err error) {
|
||||||
|
msg := err.Error()
|
||||||
|
if seenerrs.Has(msg) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
seenerrs.Insert(msg)
|
||||||
|
if len(seenerrs) > 1 {
|
||||||
|
result += ", "
|
||||||
|
}
|
||||||
|
result += msg
|
||||||
|
})
|
||||||
|
if len(seenerrs) == 1 {
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
return "[" + result + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (agg aggregate) visit(f func(err error)) {
|
||||||
|
for _, err := range agg {
|
||||||
|
switch err := err.(type) {
|
||||||
|
case aggregate:
|
||||||
|
err.visit(f)
|
||||||
|
case Aggregate:
|
||||||
|
for _, nestedErr := range err.Errors() {
|
||||||
|
f(nestedErr)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
f(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Errors is part of the Aggregate interface.
|
||||||
|
func (agg aggregate) Errors() []error {
|
||||||
|
return []error(agg)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Matcher is used to match errors. Returns true if the error matches.
|
||||||
|
type Matcher func(error) bool
|
||||||
|
|
||||||
|
// FilterOut removes all errors that match any of the matchers from the input
|
||||||
|
// error. If the input is a singular error, only that error is tested. If the
|
||||||
|
// input implements the Aggregate interface, the list of errors will be
|
||||||
|
// processed recursively.
|
||||||
|
//
|
||||||
|
// This can be used, for example, to remove known-OK errors (such as io.EOF or
|
||||||
|
// os.PathNotFound) from a list of errors.
|
||||||
|
func FilterOut(err error, fns ...Matcher) error {
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if agg, ok := err.(Aggregate); ok {
|
||||||
|
return NewAggregate(filterErrors(agg.Errors(), fns...))
|
||||||
|
}
|
||||||
|
if !matchesError(err, fns...) {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// matchesError returns true if any Matcher returns true
|
||||||
|
func matchesError(err error, fns ...Matcher) bool {
|
||||||
|
for _, fn := range fns {
|
||||||
|
if fn(err) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// filterErrors returns any errors (or nested errors, if the list contains
|
||||||
|
// nested Errors) for which all fns return false. If no errors
|
||||||
|
// remain a nil list is returned. The resulting silec will have all
|
||||||
|
// nested slices flattened as a side effect.
|
||||||
|
func filterErrors(list []error, fns ...Matcher) []error {
|
||||||
|
result := []error{}
|
||||||
|
for _, err := range list {
|
||||||
|
r := FilterOut(err, fns...)
|
||||||
|
if r != nil {
|
||||||
|
result = append(result, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// Flatten takes an Aggregate, which may hold other Aggregates in arbitrary
|
||||||
|
// nesting, and flattens them all into a single Aggregate, recursively.
|
||||||
|
func Flatten(agg Aggregate) Aggregate {
|
||||||
|
result := []error{}
|
||||||
|
if agg == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for _, err := range agg.Errors() {
|
||||||
|
if a, ok := err.(Aggregate); ok {
|
||||||
|
r := Flatten(a)
|
||||||
|
if r != nil {
|
||||||
|
result = append(result, r.Errors()...)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if err != nil {
|
||||||
|
result = append(result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return NewAggregate(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// CreateAggregateFromMessageCountMap converts MessageCountMap Aggregate
|
||||||
|
func CreateAggregateFromMessageCountMap(m MessageCountMap) Aggregate {
|
||||||
|
if m == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
result := make([]error, 0, len(m))
|
||||||
|
for errStr, count := range m {
|
||||||
|
var countStr string
|
||||||
|
if count > 1 {
|
||||||
|
countStr = fmt.Sprintf(" (repeated %v times)", count)
|
||||||
|
}
|
||||||
|
result = append(result, fmt.Errorf("%v%v", errStr, countStr))
|
||||||
|
}
|
||||||
|
return NewAggregate(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Reduce will return err or, if err is an Aggregate and only has one item,
|
||||||
|
// the first item in the aggregate.
|
||||||
|
func Reduce(err error) error {
|
||||||
|
if agg, ok := err.(Aggregate); ok && err != nil {
|
||||||
|
switch len(agg.Errors()) {
|
||||||
|
case 1:
|
||||||
|
return agg.Errors()[0]
|
||||||
|
case 0:
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// AggregateGoroutines runs the provided functions in parallel, stuffing all
|
||||||
|
// non-nil errors into the returned Aggregate.
|
||||||
|
// Returns nil if all the functions complete successfully.
|
||||||
|
func AggregateGoroutines(funcs ...func() error) Aggregate {
|
||||||
|
errChan := make(chan error, len(funcs))
|
||||||
|
for _, f := range funcs {
|
||||||
|
go func(f func() error) { errChan <- f() }(f)
|
||||||
|
}
|
||||||
|
errs := make([]error, 0)
|
||||||
|
for i := 0; i < cap(errChan); i++ {
|
||||||
|
if err := <-errChan; err != nil {
|
||||||
|
errs = append(errs, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return NewAggregate(errs)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrPreconditionViolated is returned when the precondition is violated
|
||||||
|
var ErrPreconditionViolated = errors.New("precondition is violated")
|
||||||
24
kyaml/yaml/internal/k8sgen/pkg/util/sets/empty.go
Normal file
24
kyaml/yaml/internal/k8sgen/pkg/util/sets/empty.go
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/sets/empty.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright The Kubernetes 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 sets
|
||||||
|
|
||||||
|
// Empty is public since it is used by some internal API objects for conversions between external
|
||||||
|
// string arrays and internal sets, and conversion logic requires public types today.
|
||||||
|
type Empty struct{}
|
||||||
206
kyaml/yaml/internal/k8sgen/pkg/util/sets/string.go
Normal file
206
kyaml/yaml/internal/k8sgen/pkg/util/sets/string.go
Normal file
@@ -0,0 +1,206 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/sets/string.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright The Kubernetes 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 sets
|
||||||
|
|
||||||
|
import (
|
||||||
|
"reflect"
|
||||||
|
"sort"
|
||||||
|
)
|
||||||
|
|
||||||
|
// sets.String is a set of strings, implemented via map[string]struct{} for minimal memory consumption.
|
||||||
|
type String map[string]Empty
|
||||||
|
|
||||||
|
// NewString creates a String from a list of values.
|
||||||
|
func NewString(items ...string) String {
|
||||||
|
ss := String{}
|
||||||
|
ss.Insert(items...)
|
||||||
|
return ss
|
||||||
|
}
|
||||||
|
|
||||||
|
// StringKeySet creates a String from a keys of a map[string](? extends interface{}).
|
||||||
|
// If the value passed in is not actually a map, this will panic.
|
||||||
|
func StringKeySet(theMap interface{}) String {
|
||||||
|
v := reflect.ValueOf(theMap)
|
||||||
|
ret := String{}
|
||||||
|
|
||||||
|
for _, keyValue := range v.MapKeys() {
|
||||||
|
ret.Insert(keyValue.Interface().(string))
|
||||||
|
}
|
||||||
|
return ret
|
||||||
|
}
|
||||||
|
|
||||||
|
// Insert adds items to the set.
|
||||||
|
func (s String) Insert(items ...string) String {
|
||||||
|
for _, item := range items {
|
||||||
|
s[item] = Empty{}
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Delete removes all items from the set.
|
||||||
|
func (s String) Delete(items ...string) String {
|
||||||
|
for _, item := range items {
|
||||||
|
delete(s, item)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// Has returns true if and only if item is contained in the set.
|
||||||
|
func (s String) Has(item string) bool {
|
||||||
|
_, contained := s[item]
|
||||||
|
return contained
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasAll returns true if and only if all items are contained in the set.
|
||||||
|
func (s String) HasAll(items ...string) bool {
|
||||||
|
for _, item := range items {
|
||||||
|
if !s.Has(item) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// HasAny returns true if any items are contained in the set.
|
||||||
|
func (s String) HasAny(items ...string) bool {
|
||||||
|
for _, item := range items {
|
||||||
|
if s.Has(item) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Difference returns a set of objects that are not in s2
|
||||||
|
// For example:
|
||||||
|
// s1 = {a1, a2, a3}
|
||||||
|
// s2 = {a1, a2, a4, a5}
|
||||||
|
// s1.Difference(s2) = {a3}
|
||||||
|
// s2.Difference(s1) = {a4, a5}
|
||||||
|
func (s String) Difference(s2 String) String {
|
||||||
|
result := NewString()
|
||||||
|
for key := range s {
|
||||||
|
if !s2.Has(key) {
|
||||||
|
result.Insert(key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// Union returns a new set which includes items in either s1 or s2.
|
||||||
|
// For example:
|
||||||
|
// s1 = {a1, a2}
|
||||||
|
// s2 = {a3, a4}
|
||||||
|
// s1.Union(s2) = {a1, a2, a3, a4}
|
||||||
|
// s2.Union(s1) = {a1, a2, a3, a4}
|
||||||
|
func (s1 String) Union(s2 String) String {
|
||||||
|
result := NewString()
|
||||||
|
for key := range s1 {
|
||||||
|
result.Insert(key)
|
||||||
|
}
|
||||||
|
for key := range s2 {
|
||||||
|
result.Insert(key)
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// Intersection returns a new set which includes the item in BOTH s1 and s2
|
||||||
|
// For example:
|
||||||
|
// s1 = {a1, a2}
|
||||||
|
// s2 = {a2, a3}
|
||||||
|
// s1.Intersection(s2) = {a2}
|
||||||
|
func (s1 String) Intersection(s2 String) String {
|
||||||
|
var walk, other String
|
||||||
|
result := NewString()
|
||||||
|
if s1.Len() < s2.Len() {
|
||||||
|
walk = s1
|
||||||
|
other = s2
|
||||||
|
} else {
|
||||||
|
walk = s2
|
||||||
|
other = s1
|
||||||
|
}
|
||||||
|
for key := range walk {
|
||||||
|
if other.Has(key) {
|
||||||
|
result.Insert(key)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsSuperset returns true if and only if s1 is a superset of s2.
|
||||||
|
func (s1 String) IsSuperset(s2 String) bool {
|
||||||
|
for item := range s2 {
|
||||||
|
if !s1.Has(item) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Equal returns true if and only if s1 is equal (as a set) to s2.
|
||||||
|
// Two sets are equal if their membership is identical.
|
||||||
|
// (In practice, this means same elements, order doesn't matter)
|
||||||
|
func (s1 String) Equal(s2 String) bool {
|
||||||
|
return len(s1) == len(s2) && s1.IsSuperset(s2)
|
||||||
|
}
|
||||||
|
|
||||||
|
type sortableSliceOfString []string
|
||||||
|
|
||||||
|
func (s sortableSliceOfString) Len() int { return len(s) }
|
||||||
|
func (s sortableSliceOfString) Less(i, j int) bool { return lessString(s[i], s[j]) }
|
||||||
|
func (s sortableSliceOfString) Swap(i, j int) { s[i], s[j] = s[j], s[i] }
|
||||||
|
|
||||||
|
// List returns the contents as a sorted string slice.
|
||||||
|
func (s String) List() []string {
|
||||||
|
res := make(sortableSliceOfString, 0, len(s))
|
||||||
|
for key := range s {
|
||||||
|
res = append(res, key)
|
||||||
|
}
|
||||||
|
sort.Sort(res)
|
||||||
|
return []string(res)
|
||||||
|
}
|
||||||
|
|
||||||
|
// UnsortedList returns the slice with contents in random order.
|
||||||
|
func (s String) UnsortedList() []string {
|
||||||
|
res := make([]string, 0, len(s))
|
||||||
|
for key := range s {
|
||||||
|
res = append(res, key)
|
||||||
|
}
|
||||||
|
return res
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns a single element from the set.
|
||||||
|
func (s String) PopAny() (string, bool) {
|
||||||
|
for key := range s {
|
||||||
|
s.Delete(key)
|
||||||
|
return key, true
|
||||||
|
}
|
||||||
|
var zeroValue string
|
||||||
|
return zeroValue, false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Len returns the size of the set.
|
||||||
|
func (s String) Len() int {
|
||||||
|
return len(s)
|
||||||
|
}
|
||||||
|
|
||||||
|
func lessString(lhs, rhs string) bool {
|
||||||
|
return lhs < rhs
|
||||||
|
}
|
||||||
275
kyaml/yaml/internal/k8sgen/pkg/util/validation/field/errors.go
Normal file
275
kyaml/yaml/internal/k8sgen/pkg/util/validation/field/errors.go
Normal file
@@ -0,0 +1,275 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/validation/field/errors.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2014 The Kubernetes 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 field
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
utilerrors "sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/errors"
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/sets"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Error is an implementation of the 'error' interface, which represents a
|
||||||
|
// field-level validation error.
|
||||||
|
type Error struct {
|
||||||
|
Type ErrorType
|
||||||
|
Field string
|
||||||
|
BadValue interface{}
|
||||||
|
Detail string
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ error = &Error{}
|
||||||
|
|
||||||
|
// Error implements the error interface.
|
||||||
|
func (v *Error) Error() string {
|
||||||
|
return fmt.Sprintf("%s: %s", v.Field, v.ErrorBody())
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrorBody returns the error message without the field name. This is useful
|
||||||
|
// for building nice-looking higher-level error reporting.
|
||||||
|
func (v *Error) ErrorBody() string {
|
||||||
|
var s string
|
||||||
|
switch v.Type {
|
||||||
|
case ErrorTypeRequired, ErrorTypeForbidden, ErrorTypeTooLong, ErrorTypeInternal:
|
||||||
|
s = v.Type.String()
|
||||||
|
default:
|
||||||
|
value := v.BadValue
|
||||||
|
valueType := reflect.TypeOf(value)
|
||||||
|
if value == nil || valueType == nil {
|
||||||
|
value = "null"
|
||||||
|
} else if valueType.Kind() == reflect.Ptr {
|
||||||
|
if reflectValue := reflect.ValueOf(value); reflectValue.IsNil() {
|
||||||
|
value = "null"
|
||||||
|
} else {
|
||||||
|
value = reflectValue.Elem().Interface()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch t := value.(type) {
|
||||||
|
case int64, int32, float64, float32, bool:
|
||||||
|
// use simple printer for simple types
|
||||||
|
s = fmt.Sprintf("%s: %v", v.Type, value)
|
||||||
|
case string:
|
||||||
|
s = fmt.Sprintf("%s: %q", v.Type, t)
|
||||||
|
case fmt.Stringer:
|
||||||
|
// anything that defines String() is better than raw struct
|
||||||
|
s = fmt.Sprintf("%s: %s", v.Type, t.String())
|
||||||
|
default:
|
||||||
|
// fallback to raw struct
|
||||||
|
// TODO: internal types have panic guards against json.Marshalling to prevent
|
||||||
|
// accidental use of internal types in external serialized form. For now, use
|
||||||
|
// %#v, although it would be better to show a more expressive output in the future
|
||||||
|
s = fmt.Sprintf("%s: %#v", v.Type, value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(v.Detail) != 0 {
|
||||||
|
s += fmt.Sprintf(": %s", v.Detail)
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrorType is a machine readable value providing more detail about why
|
||||||
|
// a field is invalid. These values are expected to match 1-1 with
|
||||||
|
// CauseType in api/types.go.
|
||||||
|
type ErrorType string
|
||||||
|
|
||||||
|
// TODO: These values are duplicated in api/types.go, but there's a circular dep. Fix it.
|
||||||
|
const (
|
||||||
|
// ErrorTypeNotFound is used to report failure to find a requested value
|
||||||
|
// (e.g. looking up an ID). See NotFound().
|
||||||
|
ErrorTypeNotFound ErrorType = "FieldValueNotFound"
|
||||||
|
// ErrorTypeRequired is used to report required values that are not
|
||||||
|
// provided (e.g. empty strings, null values, or empty arrays). See
|
||||||
|
// Required().
|
||||||
|
ErrorTypeRequired ErrorType = "FieldValueRequired"
|
||||||
|
// ErrorTypeDuplicate is used to report collisions of values that must be
|
||||||
|
// unique (e.g. unique IDs). See Duplicate().
|
||||||
|
ErrorTypeDuplicate ErrorType = "FieldValueDuplicate"
|
||||||
|
// ErrorTypeInvalid is used to report malformed values (e.g. failed regex
|
||||||
|
// match, too long, out of bounds). See Invalid().
|
||||||
|
ErrorTypeInvalid ErrorType = "FieldValueInvalid"
|
||||||
|
// ErrorTypeNotSupported is used to report unknown values for enumerated
|
||||||
|
// fields (e.g. a list of valid values). See NotSupported().
|
||||||
|
ErrorTypeNotSupported ErrorType = "FieldValueNotSupported"
|
||||||
|
// ErrorTypeForbidden is used to report valid (as per formatting rules)
|
||||||
|
// values which would be accepted under some conditions, but which are not
|
||||||
|
// permitted by the current conditions (such as security policy). See
|
||||||
|
// Forbidden().
|
||||||
|
ErrorTypeForbidden ErrorType = "FieldValueForbidden"
|
||||||
|
// ErrorTypeTooLong is used to report that the given value is too long.
|
||||||
|
// This is similar to ErrorTypeInvalid, but the error will not include the
|
||||||
|
// too-long value. See TooLong().
|
||||||
|
ErrorTypeTooLong ErrorType = "FieldValueTooLong"
|
||||||
|
// ErrorTypeTooMany is used to report "too many". This is used to
|
||||||
|
// report that a given list has too many items. This is similar to FieldValueTooLong,
|
||||||
|
// but the error indicates quantity instead of length.
|
||||||
|
ErrorTypeTooMany ErrorType = "FieldValueTooMany"
|
||||||
|
// ErrorTypeInternal is used to report other errors that are not related
|
||||||
|
// to user input. See InternalError().
|
||||||
|
ErrorTypeInternal ErrorType = "InternalError"
|
||||||
|
)
|
||||||
|
|
||||||
|
// String converts a ErrorType into its corresponding canonical error message.
|
||||||
|
func (t ErrorType) String() string {
|
||||||
|
switch t {
|
||||||
|
case ErrorTypeNotFound:
|
||||||
|
return "Not found"
|
||||||
|
case ErrorTypeRequired:
|
||||||
|
return "Required value"
|
||||||
|
case ErrorTypeDuplicate:
|
||||||
|
return "Duplicate value"
|
||||||
|
case ErrorTypeInvalid:
|
||||||
|
return "Invalid value"
|
||||||
|
case ErrorTypeNotSupported:
|
||||||
|
return "Unsupported value"
|
||||||
|
case ErrorTypeForbidden:
|
||||||
|
return "Forbidden"
|
||||||
|
case ErrorTypeTooLong:
|
||||||
|
return "Too long"
|
||||||
|
case ErrorTypeTooMany:
|
||||||
|
return "Too many"
|
||||||
|
case ErrorTypeInternal:
|
||||||
|
return "Internal error"
|
||||||
|
default:
|
||||||
|
panic(fmt.Sprintf("unrecognized validation error: %q", string(t)))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotFound returns a *Error indicating "value not found". This is
|
||||||
|
// used to report failure to find a requested value (e.g. looking up an ID).
|
||||||
|
func NotFound(field *Path, value interface{}) *Error {
|
||||||
|
return &Error{ErrorTypeNotFound, field.String(), value, ""}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Required returns a *Error indicating "value required". This is used
|
||||||
|
// to report required values that are not provided (e.g. empty strings, null
|
||||||
|
// values, or empty arrays).
|
||||||
|
func Required(field *Path, detail string) *Error {
|
||||||
|
return &Error{ErrorTypeRequired, field.String(), "", detail}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Duplicate returns a *Error indicating "duplicate value". This is
|
||||||
|
// used to report collisions of values that must be unique (e.g. names or IDs).
|
||||||
|
func Duplicate(field *Path, value interface{}) *Error {
|
||||||
|
return &Error{ErrorTypeDuplicate, field.String(), value, ""}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Invalid returns a *Error indicating "invalid value". This is used
|
||||||
|
// to report malformed values (e.g. failed regex match, too long, out of bounds).
|
||||||
|
func Invalid(field *Path, value interface{}, detail string) *Error {
|
||||||
|
return &Error{ErrorTypeInvalid, field.String(), value, detail}
|
||||||
|
}
|
||||||
|
|
||||||
|
// NotSupported returns a *Error indicating "unsupported value".
|
||||||
|
// This is used to report unknown values for enumerated fields (e.g. a list of
|
||||||
|
// valid values).
|
||||||
|
func NotSupported(field *Path, value interface{}, validValues []string) *Error {
|
||||||
|
detail := ""
|
||||||
|
if validValues != nil && len(validValues) > 0 {
|
||||||
|
quotedValues := make([]string, len(validValues))
|
||||||
|
for i, v := range validValues {
|
||||||
|
quotedValues[i] = strconv.Quote(v)
|
||||||
|
}
|
||||||
|
detail = "supported values: " + strings.Join(quotedValues, ", ")
|
||||||
|
}
|
||||||
|
return &Error{ErrorTypeNotSupported, field.String(), value, detail}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forbidden returns a *Error indicating "forbidden". This is used to
|
||||||
|
// report valid (as per formatting rules) values which would be accepted under
|
||||||
|
// some conditions, but which are not permitted by current conditions (e.g.
|
||||||
|
// security policy).
|
||||||
|
func Forbidden(field *Path, detail string) *Error {
|
||||||
|
return &Error{ErrorTypeForbidden, field.String(), "", detail}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TooLong returns a *Error indicating "too long". This is used to
|
||||||
|
// report that the given value is too long. This is similar to
|
||||||
|
// Invalid, but the returned error will not include the too-long
|
||||||
|
// value.
|
||||||
|
func TooLong(field *Path, value interface{}, maxLength int) *Error {
|
||||||
|
return &Error{ErrorTypeTooLong, field.String(), value, fmt.Sprintf("must have at most %d bytes", maxLength)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TooMany returns a *Error indicating "too many". This is used to
|
||||||
|
// report that a given list has too many items. This is similar to TooLong,
|
||||||
|
// but the returned error indicates quantity instead of length.
|
||||||
|
func TooMany(field *Path, actualQuantity, maxQuantity int) *Error {
|
||||||
|
return &Error{ErrorTypeTooMany, field.String(), actualQuantity, fmt.Sprintf("must have at most %d items", maxQuantity)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// InternalError returns a *Error indicating "internal error". This is used
|
||||||
|
// to signal that an error was found that was not directly related to user
|
||||||
|
// input. The err argument must be non-nil.
|
||||||
|
func InternalError(field *Path, err error) *Error {
|
||||||
|
return &Error{ErrorTypeInternal, field.String(), nil, err.Error()}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ErrorList holds a set of Errors. It is plausible that we might one day have
|
||||||
|
// non-field errors in this same umbrella package, but for now we don't, so
|
||||||
|
// we can keep it simple and leave ErrorList here.
|
||||||
|
type ErrorList []*Error
|
||||||
|
|
||||||
|
// NewErrorTypeMatcher returns an errors.Matcher that returns true
|
||||||
|
// if the provided error is a Error and has the provided ErrorType.
|
||||||
|
func NewErrorTypeMatcher(t ErrorType) utilerrors.Matcher {
|
||||||
|
return func(err error) bool {
|
||||||
|
if e, ok := err.(*Error); ok {
|
||||||
|
return e.Type == t
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ToAggregate converts the ErrorList into an errors.Aggregate.
|
||||||
|
func (list ErrorList) ToAggregate() utilerrors.Aggregate {
|
||||||
|
errs := make([]error, 0, len(list))
|
||||||
|
errorMsgs := sets.NewString()
|
||||||
|
for _, err := range list {
|
||||||
|
msg := fmt.Sprintf("%v", err)
|
||||||
|
if errorMsgs.Has(msg) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
errorMsgs.Insert(msg)
|
||||||
|
errs = append(errs, err)
|
||||||
|
}
|
||||||
|
return utilerrors.NewAggregate(errs)
|
||||||
|
}
|
||||||
|
|
||||||
|
func fromAggregate(agg utilerrors.Aggregate) ErrorList {
|
||||||
|
errs := agg.Errors()
|
||||||
|
list := make(ErrorList, len(errs))
|
||||||
|
for i := range errs {
|
||||||
|
list[i] = errs[i].(*Error)
|
||||||
|
}
|
||||||
|
return list
|
||||||
|
}
|
||||||
|
|
||||||
|
// Filter removes items from the ErrorList that match the provided fns.
|
||||||
|
func (list ErrorList) Filter(fns ...utilerrors.Matcher) ErrorList {
|
||||||
|
err := utilerrors.FilterOut(list.ToAggregate(), fns...)
|
||||||
|
if err == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
// FilterOut takes an Aggregate and returns an Aggregate
|
||||||
|
return fromAggregate(err.(utilerrors.Aggregate))
|
||||||
|
}
|
||||||
94
kyaml/yaml/internal/k8sgen/pkg/util/validation/field/path.go
Normal file
94
kyaml/yaml/internal/k8sgen/pkg/util/validation/field/path.go
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/validation/field/path.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2015 The Kubernetes 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 field
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Path represents the path from some root to a particular field.
|
||||||
|
type Path struct {
|
||||||
|
name string // the name of this field or "" if this is an index
|
||||||
|
index string // if name == "", this is a subscript (index or map key) of the previous element
|
||||||
|
parent *Path // nil if this is the root element
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewPath creates a root Path object.
|
||||||
|
func NewPath(name string, moreNames ...string) *Path {
|
||||||
|
r := &Path{name: name, parent: nil}
|
||||||
|
for _, anotherName := range moreNames {
|
||||||
|
r = &Path{name: anotherName, parent: r}
|
||||||
|
}
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Root returns the root element of this Path.
|
||||||
|
func (p *Path) Root() *Path {
|
||||||
|
for ; p.parent != nil; p = p.parent {
|
||||||
|
// Do nothing.
|
||||||
|
}
|
||||||
|
return p
|
||||||
|
}
|
||||||
|
|
||||||
|
// Child creates a new Path that is a child of the method receiver.
|
||||||
|
func (p *Path) Child(name string, moreNames ...string) *Path {
|
||||||
|
r := NewPath(name, moreNames...)
|
||||||
|
r.Root().parent = p
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Index indicates that the previous Path is to be subscripted by an int.
|
||||||
|
// This sets the same underlying value as Key.
|
||||||
|
func (p *Path) Index(index int) *Path {
|
||||||
|
return &Path{index: strconv.Itoa(index), parent: p}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Key indicates that the previous Path is to be subscripted by a string.
|
||||||
|
// This sets the same underlying value as Index.
|
||||||
|
func (p *Path) Key(key string) *Path {
|
||||||
|
return &Path{index: key, parent: p}
|
||||||
|
}
|
||||||
|
|
||||||
|
// String produces a string representation of the Path.
|
||||||
|
func (p *Path) String() string {
|
||||||
|
// make a slice to iterate
|
||||||
|
elems := []*Path{}
|
||||||
|
for ; p != nil; p = p.parent {
|
||||||
|
elems = append(elems, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
// iterate, but it has to be backwards
|
||||||
|
buf := bytes.NewBuffer(nil)
|
||||||
|
for i := range elems {
|
||||||
|
p := elems[len(elems)-1-i]
|
||||||
|
if p.parent != nil && len(p.name) > 0 {
|
||||||
|
// This is either the root or it is a subscript.
|
||||||
|
buf.WriteString(".")
|
||||||
|
}
|
||||||
|
if len(p.name) > 0 {
|
||||||
|
buf.WriteString(p.name)
|
||||||
|
} else {
|
||||||
|
fmt.Fprintf(buf, "[%s]", p.index)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return buf.String()
|
||||||
|
}
|
||||||
463
kyaml/yaml/internal/k8sgen/pkg/util/validation/validation.go
Normal file
463
kyaml/yaml/internal/k8sgen/pkg/util/validation/validation.go
Normal file
@@ -0,0 +1,463 @@
|
|||||||
|
// Code generated by k8sgen/generator from k8s.io/apimachinery@v0.17.0; DO NOT EDIT.
|
||||||
|
// Copied from k8s.io/apimachinery@v0.17.0/pkg/util/validation/validation.go
|
||||||
|
|
||||||
|
/*
|
||||||
|
Copyright 2014 The Kubernetes 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 validation
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"math"
|
||||||
|
"net"
|
||||||
|
"regexp"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/util/validation/field"
|
||||||
|
)
|
||||||
|
|
||||||
|
const qnameCharFmt string = "[A-Za-z0-9]"
|
||||||
|
const qnameExtCharFmt string = "[-A-Za-z0-9_.]"
|
||||||
|
const qualifiedNameFmt string = "(" + qnameCharFmt + qnameExtCharFmt + "*)?" + qnameCharFmt
|
||||||
|
const qualifiedNameErrMsg string = "must consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character"
|
||||||
|
const qualifiedNameMaxLength int = 63
|
||||||
|
|
||||||
|
var qualifiedNameRegexp = regexp.MustCompile("^" + qualifiedNameFmt + "$")
|
||||||
|
|
||||||
|
// IsQualifiedName tests whether the value passed is what Kubernetes calls a
|
||||||
|
// "qualified name". This is a format used in various places throughout the
|
||||||
|
// system. If the value is not valid, a list of error strings is returned.
|
||||||
|
// Otherwise an empty list (or nil) is returned.
|
||||||
|
func IsQualifiedName(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
parts := strings.Split(value, "/")
|
||||||
|
var name string
|
||||||
|
switch len(parts) {
|
||||||
|
case 1:
|
||||||
|
name = parts[0]
|
||||||
|
case 2:
|
||||||
|
var prefix string
|
||||||
|
prefix, name = parts[0], parts[1]
|
||||||
|
if len(prefix) == 0 {
|
||||||
|
errs = append(errs, "prefix part "+EmptyError())
|
||||||
|
} else if msgs := IsDNS1123Subdomain(prefix); len(msgs) != 0 {
|
||||||
|
errs = append(errs, prefixEach(msgs, "prefix part ")...)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return append(errs, "a qualified name "+RegexError(qualifiedNameErrMsg, qualifiedNameFmt, "MyName", "my.name", "123-abc")+
|
||||||
|
" with an optional DNS subdomain prefix and '/' (e.g. 'example.com/MyName')")
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(name) == 0 {
|
||||||
|
errs = append(errs, "name part "+EmptyError())
|
||||||
|
} else if len(name) > qualifiedNameMaxLength {
|
||||||
|
errs = append(errs, "name part "+MaxLenError(qualifiedNameMaxLength))
|
||||||
|
}
|
||||||
|
if !qualifiedNameRegexp.MatchString(name) {
|
||||||
|
errs = append(errs, "name part "+RegexError(qualifiedNameErrMsg, qualifiedNameFmt, "MyName", "my.name", "123-abc"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsFullyQualifiedName checks if the name is fully qualified. This is similar
|
||||||
|
// to IsFullyQualifiedDomainName but requires a minimum of 3 segments instead of
|
||||||
|
// 2 and does not accept a trailing . as valid.
|
||||||
|
// TODO: This function is deprecated and preserved until all callers migrate to
|
||||||
|
// IsFullyQualifiedDomainName; please don't add new callers.
|
||||||
|
func IsFullyQualifiedName(fldPath *field.Path, name string) field.ErrorList {
|
||||||
|
var allErrors field.ErrorList
|
||||||
|
if len(name) == 0 {
|
||||||
|
return append(allErrors, field.Required(fldPath, ""))
|
||||||
|
}
|
||||||
|
if errs := IsDNS1123Subdomain(name); len(errs) > 0 {
|
||||||
|
return append(allErrors, field.Invalid(fldPath, name, strings.Join(errs, ",")))
|
||||||
|
}
|
||||||
|
if len(strings.Split(name, ".")) < 3 {
|
||||||
|
return append(allErrors, field.Invalid(fldPath, name, "should be a domain with at least three segments separated by dots"))
|
||||||
|
}
|
||||||
|
return allErrors
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsFullyQualifiedDomainName checks if the domain name is fully qualified. This
|
||||||
|
// is similar to IsFullyQualifiedName but only requires a minimum of 2 segments
|
||||||
|
// instead of 3 and accepts a trailing . as valid.
|
||||||
|
func IsFullyQualifiedDomainName(fldPath *field.Path, name string) field.ErrorList {
|
||||||
|
var allErrors field.ErrorList
|
||||||
|
if len(name) == 0 {
|
||||||
|
return append(allErrors, field.Required(fldPath, ""))
|
||||||
|
}
|
||||||
|
if strings.HasSuffix(name, ".") {
|
||||||
|
name = name[:len(name)-1]
|
||||||
|
}
|
||||||
|
if errs := IsDNS1123Subdomain(name); len(errs) > 0 {
|
||||||
|
return append(allErrors, field.Invalid(fldPath, name, strings.Join(errs, ",")))
|
||||||
|
}
|
||||||
|
if len(strings.Split(name, ".")) < 2 {
|
||||||
|
return append(allErrors, field.Invalid(fldPath, name, "should be a domain with at least two segments separated by dots"))
|
||||||
|
}
|
||||||
|
return allErrors
|
||||||
|
}
|
||||||
|
|
||||||
|
const labelValueFmt string = "(" + qualifiedNameFmt + ")?"
|
||||||
|
const labelValueErrMsg string = "a valid label must be an empty string or consist of alphanumeric characters, '-', '_' or '.', and must start and end with an alphanumeric character"
|
||||||
|
|
||||||
|
// LabelValueMaxLength is a label's max length
|
||||||
|
const LabelValueMaxLength int = 63
|
||||||
|
|
||||||
|
var labelValueRegexp = regexp.MustCompile("^" + labelValueFmt + "$")
|
||||||
|
|
||||||
|
// IsValidLabelValue tests whether the value passed is a valid label value. If
|
||||||
|
// the value is not valid, a list of error strings is returned. Otherwise an
|
||||||
|
// empty list (or nil) is returned.
|
||||||
|
func IsValidLabelValue(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(value) > LabelValueMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(LabelValueMaxLength))
|
||||||
|
}
|
||||||
|
if !labelValueRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(labelValueErrMsg, labelValueFmt, "MyValue", "my_value", "12345"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
const dns1123LabelFmt string = "[a-z0-9]([-a-z0-9]*[a-z0-9])?"
|
||||||
|
const dns1123LabelErrMsg string = "a DNS-1123 label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character"
|
||||||
|
|
||||||
|
// DNS1123LabelMaxLength is a label's max length in DNS (RFC 1123)
|
||||||
|
const DNS1123LabelMaxLength int = 63
|
||||||
|
|
||||||
|
var dns1123LabelRegexp = regexp.MustCompile("^" + dns1123LabelFmt + "$")
|
||||||
|
|
||||||
|
// IsDNS1123Label tests for a string that conforms to the definition of a label in
|
||||||
|
// DNS (RFC 1123).
|
||||||
|
func IsDNS1123Label(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(value) > DNS1123LabelMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(DNS1123LabelMaxLength))
|
||||||
|
}
|
||||||
|
if !dns1123LabelRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(dns1123LabelErrMsg, dns1123LabelFmt, "my-name", "123-abc"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
const dns1123SubdomainFmt string = dns1123LabelFmt + "(\\." + dns1123LabelFmt + ")*"
|
||||||
|
const dns1123SubdomainErrorMsg string = "a DNS-1123 subdomain must consist of lower case alphanumeric characters, '-' or '.', and must start and end with an alphanumeric character"
|
||||||
|
|
||||||
|
// DNS1123SubdomainMaxLength is a subdomain's max length in DNS (RFC 1123)
|
||||||
|
const DNS1123SubdomainMaxLength int = 253
|
||||||
|
|
||||||
|
var dns1123SubdomainRegexp = regexp.MustCompile("^" + dns1123SubdomainFmt + "$")
|
||||||
|
|
||||||
|
// IsDNS1123Subdomain tests for a string that conforms to the definition of a
|
||||||
|
// subdomain in DNS (RFC 1123).
|
||||||
|
func IsDNS1123Subdomain(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(value) > DNS1123SubdomainMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(DNS1123SubdomainMaxLength))
|
||||||
|
}
|
||||||
|
if !dns1123SubdomainRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(dns1123SubdomainErrorMsg, dns1123SubdomainFmt, "example.com"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
const dns1035LabelFmt string = "[a-z]([-a-z0-9]*[a-z0-9])?"
|
||||||
|
const dns1035LabelErrMsg string = "a DNS-1035 label must consist of lower case alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character"
|
||||||
|
|
||||||
|
// DNS1035LabelMaxLength is a label's max length in DNS (RFC 1035)
|
||||||
|
const DNS1035LabelMaxLength int = 63
|
||||||
|
|
||||||
|
var dns1035LabelRegexp = regexp.MustCompile("^" + dns1035LabelFmt + "$")
|
||||||
|
|
||||||
|
// IsDNS1035Label tests for a string that conforms to the definition of a label in
|
||||||
|
// DNS (RFC 1035).
|
||||||
|
func IsDNS1035Label(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(value) > DNS1035LabelMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(DNS1035LabelMaxLength))
|
||||||
|
}
|
||||||
|
if !dns1035LabelRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(dns1035LabelErrMsg, dns1035LabelFmt, "my-name", "abc-123"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// wildcard definition - RFC 1034 section 4.3.3.
|
||||||
|
// examples:
|
||||||
|
// - valid: *.bar.com, *.foo.bar.com
|
||||||
|
// - invalid: *.*.bar.com, *.foo.*.com, *bar.com, f*.bar.com, *
|
||||||
|
const wildcardDNS1123SubdomainFmt = "\\*\\." + dns1123SubdomainFmt
|
||||||
|
const wildcardDNS1123SubdomainErrMsg = "a wildcard DNS-1123 subdomain must start with '*.', followed by a valid DNS subdomain, which must consist of lower case alphanumeric characters, '-' or '.' and end with an alphanumeric character"
|
||||||
|
|
||||||
|
// IsWildcardDNS1123Subdomain tests for a string that conforms to the definition of a
|
||||||
|
// wildcard subdomain in DNS (RFC 1034 section 4.3.3).
|
||||||
|
func IsWildcardDNS1123Subdomain(value string) []string {
|
||||||
|
wildcardDNS1123SubdomainRegexp := regexp.MustCompile("^" + wildcardDNS1123SubdomainFmt + "$")
|
||||||
|
|
||||||
|
var errs []string
|
||||||
|
if len(value) > DNS1123SubdomainMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(DNS1123SubdomainMaxLength))
|
||||||
|
}
|
||||||
|
if !wildcardDNS1123SubdomainRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(wildcardDNS1123SubdomainErrMsg, wildcardDNS1123SubdomainFmt, "*.example.com"))
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
const cIdentifierFmt string = "[A-Za-z_][A-Za-z0-9_]*"
|
||||||
|
const identifierErrMsg string = "a valid C identifier must start with alphabetic character or '_', followed by a string of alphanumeric characters or '_'"
|
||||||
|
|
||||||
|
var cIdentifierRegexp = regexp.MustCompile("^" + cIdentifierFmt + "$")
|
||||||
|
|
||||||
|
// IsCIdentifier tests for a string that conforms the definition of an identifier
|
||||||
|
// in C. This checks the format, but not the length.
|
||||||
|
func IsCIdentifier(value string) []string {
|
||||||
|
if !cIdentifierRegexp.MatchString(value) {
|
||||||
|
return []string{RegexError(identifierErrMsg, cIdentifierFmt, "my_name", "MY_NAME", "MyName")}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidPortNum tests that the argument is a valid, non-zero port number.
|
||||||
|
func IsValidPortNum(port int) []string {
|
||||||
|
if 1 <= port && port <= 65535 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return []string{InclusiveRangeError(1, 65535)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsInRange tests that the argument is in an inclusive range.
|
||||||
|
func IsInRange(value int, min int, max int) []string {
|
||||||
|
if value >= min && value <= max {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return []string{InclusiveRangeError(min, max)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Now in libcontainer UID/GID limits is 0 ~ 1<<31 - 1
|
||||||
|
// TODO: once we have a type for UID/GID we should make these that type.
|
||||||
|
const (
|
||||||
|
minUserID = 0
|
||||||
|
maxUserID = math.MaxInt32
|
||||||
|
minGroupID = 0
|
||||||
|
maxGroupID = math.MaxInt32
|
||||||
|
)
|
||||||
|
|
||||||
|
// IsValidGroupID tests that the argument is a valid Unix GID.
|
||||||
|
func IsValidGroupID(gid int64) []string {
|
||||||
|
if minGroupID <= gid && gid <= maxGroupID {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return []string{InclusiveRangeError(minGroupID, maxGroupID)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidUserID tests that the argument is a valid Unix UID.
|
||||||
|
func IsValidUserID(uid int64) []string {
|
||||||
|
if minUserID <= uid && uid <= maxUserID {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return []string{InclusiveRangeError(minUserID, maxUserID)}
|
||||||
|
}
|
||||||
|
|
||||||
|
var portNameCharsetRegex = regexp.MustCompile("^[-a-z0-9]+$")
|
||||||
|
var portNameOneLetterRegexp = regexp.MustCompile("[a-z]")
|
||||||
|
|
||||||
|
// IsValidPortName check that the argument is valid syntax. It must be
|
||||||
|
// non-empty and no more than 15 characters long. It may contain only [-a-z0-9]
|
||||||
|
// and must contain at least one letter [a-z]. It must not start or end with a
|
||||||
|
// hyphen, nor contain adjacent hyphens.
|
||||||
|
//
|
||||||
|
// Note: We only allow lower-case characters, even though RFC 6335 is case
|
||||||
|
// insensitive.
|
||||||
|
func IsValidPortName(port string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(port) > 15 {
|
||||||
|
errs = append(errs, MaxLenError(15))
|
||||||
|
}
|
||||||
|
if !portNameCharsetRegex.MatchString(port) {
|
||||||
|
errs = append(errs, "must contain only alpha-numeric characters (a-z, 0-9), and hyphens (-)")
|
||||||
|
}
|
||||||
|
if !portNameOneLetterRegexp.MatchString(port) {
|
||||||
|
errs = append(errs, "must contain at least one letter or number (a-z, 0-9)")
|
||||||
|
}
|
||||||
|
if strings.Contains(port, "--") {
|
||||||
|
errs = append(errs, "must not contain consecutive hyphens")
|
||||||
|
}
|
||||||
|
if len(port) > 0 && (port[0] == '-' || port[len(port)-1] == '-') {
|
||||||
|
errs = append(errs, "must not begin or end with a hyphen")
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidIP tests that the argument is a valid IP address.
|
||||||
|
func IsValidIP(value string) []string {
|
||||||
|
if net.ParseIP(value) == nil {
|
||||||
|
return []string{"must be a valid IP address, (e.g. 10.9.8.7)"}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidIPv4Address tests that the argument is a valid IPv4 address.
|
||||||
|
func IsValidIPv4Address(fldPath *field.Path, value string) field.ErrorList {
|
||||||
|
var allErrors field.ErrorList
|
||||||
|
ip := net.ParseIP(value)
|
||||||
|
if ip == nil || ip.To4() == nil {
|
||||||
|
allErrors = append(allErrors, field.Invalid(fldPath, value, "must be a valid IPv4 address"))
|
||||||
|
}
|
||||||
|
return allErrors
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidIPv6Address tests that the argument is a valid IPv6 address.
|
||||||
|
func IsValidIPv6Address(fldPath *field.Path, value string) field.ErrorList {
|
||||||
|
var allErrors field.ErrorList
|
||||||
|
ip := net.ParseIP(value)
|
||||||
|
if ip == nil || ip.To4() != nil {
|
||||||
|
allErrors = append(allErrors, field.Invalid(fldPath, value, "must be a valid IPv6 address"))
|
||||||
|
}
|
||||||
|
return allErrors
|
||||||
|
}
|
||||||
|
|
||||||
|
const percentFmt string = "[0-9]+%"
|
||||||
|
const percentErrMsg string = "a valid percent string must be a numeric string followed by an ending '%'"
|
||||||
|
|
||||||
|
var percentRegexp = regexp.MustCompile("^" + percentFmt + "$")
|
||||||
|
|
||||||
|
// IsValidPercent checks that string is in the form of a percentage
|
||||||
|
func IsValidPercent(percent string) []string {
|
||||||
|
if !percentRegexp.MatchString(percent) {
|
||||||
|
return []string{RegexError(percentErrMsg, percentFmt, "1%", "93%")}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
const httpHeaderNameFmt string = "[-A-Za-z0-9]+"
|
||||||
|
const httpHeaderNameErrMsg string = "a valid HTTP header must consist of alphanumeric characters or '-'"
|
||||||
|
|
||||||
|
var httpHeaderNameRegexp = regexp.MustCompile("^" + httpHeaderNameFmt + "$")
|
||||||
|
|
||||||
|
// IsHTTPHeaderName checks that a string conforms to the Go HTTP library's
|
||||||
|
// definition of a valid header field name (a stricter subset than RFC7230).
|
||||||
|
func IsHTTPHeaderName(value string) []string {
|
||||||
|
if !httpHeaderNameRegexp.MatchString(value) {
|
||||||
|
return []string{RegexError(httpHeaderNameErrMsg, httpHeaderNameFmt, "X-Header-Name")}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
const envVarNameFmt = "[-._a-zA-Z][-._a-zA-Z0-9]*"
|
||||||
|
const envVarNameFmtErrMsg string = "a valid environment variable name must consist of alphabetic characters, digits, '_', '-', or '.', and must not start with a digit"
|
||||||
|
|
||||||
|
var envVarNameRegexp = regexp.MustCompile("^" + envVarNameFmt + "$")
|
||||||
|
|
||||||
|
// IsEnvVarName tests if a string is a valid environment variable name.
|
||||||
|
func IsEnvVarName(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if !envVarNameRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(envVarNameFmtErrMsg, envVarNameFmt, "my.env-name", "MY_ENV.NAME", "MyEnvName1"))
|
||||||
|
}
|
||||||
|
|
||||||
|
errs = append(errs, hasChDirPrefix(value)...)
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
const configMapKeyFmt = `[-._a-zA-Z0-9]+`
|
||||||
|
const configMapKeyErrMsg string = "a valid config key must consist of alphanumeric characters, '-', '_' or '.'"
|
||||||
|
|
||||||
|
var configMapKeyRegexp = regexp.MustCompile("^" + configMapKeyFmt + "$")
|
||||||
|
|
||||||
|
// IsConfigMapKey tests for a string that is a valid key for a ConfigMap or Secret
|
||||||
|
func IsConfigMapKey(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
if len(value) > DNS1123SubdomainMaxLength {
|
||||||
|
errs = append(errs, MaxLenError(DNS1123SubdomainMaxLength))
|
||||||
|
}
|
||||||
|
if !configMapKeyRegexp.MatchString(value) {
|
||||||
|
errs = append(errs, RegexError(configMapKeyErrMsg, configMapKeyFmt, "key.name", "KEY_NAME", "key-name"))
|
||||||
|
}
|
||||||
|
errs = append(errs, hasChDirPrefix(value)...)
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaxLenError returns a string explanation of a "string too long" validation
|
||||||
|
// failure.
|
||||||
|
func MaxLenError(length int) string {
|
||||||
|
return fmt.Sprintf("must be no more than %d characters", length)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RegexError returns a string explanation of a regex validation failure.
|
||||||
|
func RegexError(msg string, fmt string, examples ...string) string {
|
||||||
|
if len(examples) == 0 {
|
||||||
|
return msg + " (regex used for validation is '" + fmt + "')"
|
||||||
|
}
|
||||||
|
msg += " (e.g. "
|
||||||
|
for i := range examples {
|
||||||
|
if i > 0 {
|
||||||
|
msg += " or "
|
||||||
|
}
|
||||||
|
msg += "'" + examples[i] + "', "
|
||||||
|
}
|
||||||
|
msg += "regex used for validation is '" + fmt + "')"
|
||||||
|
return msg
|
||||||
|
}
|
||||||
|
|
||||||
|
// EmptyError returns a string explanation of a "must not be empty" validation
|
||||||
|
// failure.
|
||||||
|
func EmptyError() string {
|
||||||
|
return "must be non-empty"
|
||||||
|
}
|
||||||
|
|
||||||
|
func prefixEach(msgs []string, prefix string) []string {
|
||||||
|
for i := range msgs {
|
||||||
|
msgs[i] = prefix + msgs[i]
|
||||||
|
}
|
||||||
|
return msgs
|
||||||
|
}
|
||||||
|
|
||||||
|
// InclusiveRangeError returns a string explanation of a numeric "must be
|
||||||
|
// between" validation failure.
|
||||||
|
func InclusiveRangeError(lo, hi int) string {
|
||||||
|
return fmt.Sprintf(`must be between %d and %d, inclusive`, lo, hi)
|
||||||
|
}
|
||||||
|
|
||||||
|
func hasChDirPrefix(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
switch {
|
||||||
|
case value == ".":
|
||||||
|
errs = append(errs, `must not be '.'`)
|
||||||
|
case value == "..":
|
||||||
|
errs = append(errs, `must not be '..'`)
|
||||||
|
case strings.HasPrefix(value, ".."):
|
||||||
|
errs = append(errs, `must not start with '..'`)
|
||||||
|
}
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsValidSocketAddr checks that string represents a valid socket address
|
||||||
|
// as defined in RFC 789. (e.g 0.0.0.0:10254 or [::]:10254))
|
||||||
|
func IsValidSocketAddr(value string) []string {
|
||||||
|
var errs []string
|
||||||
|
ip, port, err := net.SplitHostPort(value)
|
||||||
|
if err != nil {
|
||||||
|
errs = append(errs, "must be a valid socket address format, (e.g. 0.0.0.0:10254 or [::]:10254)")
|
||||||
|
return errs
|
||||||
|
}
|
||||||
|
portInt, _ := strconv.Atoi(port)
|
||||||
|
errs = append(errs, IsValidPortNum(portInt)...)
|
||||||
|
errs = append(errs, IsValidIP(ip)...)
|
||||||
|
return errs
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
// Copyright 2019 The Kubernetes Authors.
|
// Copyright 2020 The Kubernetes Authors.
|
||||||
// SPDX-License-Identifier: Apache-2.0
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
// Code generated by "stringer -type=smpDirective -linecomment"; DO NOT EDIT.
|
// Code generated by "stringer -type=smpDirective -linecomment"; DO NOT EDIT.
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ import (
|
|||||||
|
|
||||||
"gopkg.in/yaml.v3"
|
"gopkg.in/yaml.v3"
|
||||||
"sigs.k8s.io/kustomize/kyaml/errors"
|
"sigs.k8s.io/kustomize/kyaml/errors"
|
||||||
|
"sigs.k8s.io/kustomize/kyaml/yaml/internal/k8sgen/pkg/labels"
|
||||||
)
|
)
|
||||||
|
|
||||||
// MakeNullNode returns an RNode that represents an empty document.
|
// MakeNullNode returns an RNode that represents an empty document.
|
||||||
@@ -690,6 +691,32 @@ func (rn *RNode) GetValidatedMetadata() (ResourceMeta, error) {
|
|||||||
return m, nil
|
return m, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// MatchesAnnotationSelector implements ifc.Kunstructured.
|
||||||
|
func (rn *RNode) MatchesAnnotationSelector(selector string) (bool, error) {
|
||||||
|
s, err := labels.Parse(selector)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
slice, err := rn.GetAnnotations()
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return s.Matches(labels.Set(slice)), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// MatchesLabelSelector implements ifc.Kunstructured.
|
||||||
|
func (rn *RNode) MatchesLabelSelector(selector string) (bool, error) {
|
||||||
|
s, err := labels.Parse(selector)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
slice, err := rn.GetLabels()
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return s.Matches(labels.Set(slice)), nil
|
||||||
|
}
|
||||||
|
|
||||||
// HasNilEntryInList returns true if the RNode contains a list which has
|
// HasNilEntryInList returns true if the RNode contains a list which has
|
||||||
// a nil item, along with the path to the missing item.
|
// a nil item, along with the path to the missing item.
|
||||||
// TODO(broken): This was copied from
|
// TODO(broken): This was copied from
|
||||||
|
|||||||
@@ -852,3 +852,99 @@ func TestRNodeGetAnnotations(t *testing.T) {
|
|||||||
assert.NoError(t, n.SetAnnotations(map[string]string{}))
|
assert.NoError(t, n.SetAnnotations(map[string]string{}))
|
||||||
assert.Equal(t, 0, len(getAnnotationsOrDie(t, n)))
|
assert.Equal(t, 0, len(getAnnotationsOrDie(t, n)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestRNodeMatchesAnnotationSelector(t *testing.T) {
|
||||||
|
rn := NewRNode(nil)
|
||||||
|
assert.NoError(t, rn.UnmarshalJSON([]byte(deploymentJSON)))
|
||||||
|
testcases := map[string]struct {
|
||||||
|
selector string
|
||||||
|
matches bool
|
||||||
|
errMsg string
|
||||||
|
}{
|
||||||
|
"select_01": {
|
||||||
|
selector: ".*",
|
||||||
|
matches: false,
|
||||||
|
errMsg: "name part must consist of alphanumeric character",
|
||||||
|
},
|
||||||
|
"select_02": {
|
||||||
|
selector: "area=51",
|
||||||
|
matches: true,
|
||||||
|
},
|
||||||
|
"select_03": {
|
||||||
|
selector: "area=florida",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
"select_04": {
|
||||||
|
selector: "area in (disneyland, 51, iowa)",
|
||||||
|
matches: true,
|
||||||
|
},
|
||||||
|
"select_05": {
|
||||||
|
selector: "area in (disneyland, iowa)",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
"select_06": {
|
||||||
|
selector: "area notin (disneyland, 51, iowa)",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for n, tc := range testcases {
|
||||||
|
gotMatch, err := rn.MatchesAnnotationSelector(tc.selector)
|
||||||
|
if tc.errMsg == "" {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equalf(
|
||||||
|
t, tc.matches, gotMatch, "test=%s selector=%v", n, tc.selector)
|
||||||
|
} else {
|
||||||
|
assert.Truef(
|
||||||
|
t, strings.Contains(err.Error(), tc.errMsg),
|
||||||
|
"test=%s selector=%v", n, tc.selector)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRNodeMatchesLabelSelector(t *testing.T) {
|
||||||
|
rn := NewRNode(nil)
|
||||||
|
assert.NoError(t, rn.UnmarshalJSON([]byte(deploymentJSON)))
|
||||||
|
testcases := map[string]struct {
|
||||||
|
selector string
|
||||||
|
matches bool
|
||||||
|
errMsg string
|
||||||
|
}{
|
||||||
|
"select_01": {
|
||||||
|
selector: ".*",
|
||||||
|
matches: false,
|
||||||
|
errMsg: "name part must consist of alphanumeric character",
|
||||||
|
},
|
||||||
|
"select_02": {
|
||||||
|
selector: "fruit=apple",
|
||||||
|
matches: true,
|
||||||
|
},
|
||||||
|
"select_03": {
|
||||||
|
selector: "fruit=banana",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
"select_04": {
|
||||||
|
selector: "fruit in (orange, banana, apple)",
|
||||||
|
matches: true,
|
||||||
|
},
|
||||||
|
"select_05": {
|
||||||
|
selector: "fruit in (orange, banana)",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
"select_06": {
|
||||||
|
selector: "fruit notin (orange, banana, apple)",
|
||||||
|
matches: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for n, tc := range testcases {
|
||||||
|
gotMatch, err := rn.MatchesLabelSelector(tc.selector)
|
||||||
|
if tc.errMsg == "" {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equalf(
|
||||||
|
t, tc.matches, gotMatch, "test=%s selector=%v", n, tc.selector)
|
||||||
|
} else {
|
||||||
|
assert.Truef(
|
||||||
|
t, strings.Contains(err.Error(), tc.errMsg),
|
||||||
|
"test=%s selector=%v", n, tc.selector)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user