mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-29 17:41:13 +00:00
The PR exposes some of the top level kustomize commands (especially `build`) for reuse in other command line tools (expecially `kubectl`, see #1500). This PR represents option 3 from the following list of ways this exposure could be arranged. 1. Expose the commands in the `api` module. ``` REPO/api/go.mod REPO/api/builtins REPO/api/commands <- new REPO/api/... ``` Disadvantage: This would make `api` module depend on cobra. That's bad for clients that want to depend on the api, but want to write their own commands at their own version of cobra. The `api` module shouldn't depend on UX libraries like cobra. 2. Expose the commands in their own `commands` module. They'd appear alongside `api`, e.g. ` ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/commands/go.mod REPO/commands/build REPO/commands/edit REPO/commands/... ``` Advantage: The commands would be consumed by the kustomize binary and the kubectl binary in the same way. Disadvantage: The kustomize binary module and the commands module could evolve separately with their own version numbers, creating confusion. 3. Expose the commands in the existing `kustomize` module ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/kustomize/go.mod REPO/kustomize/main.go REPO/kustomize/commands/build REPO/kustomize/commands/edit REPO/kustomize/commands/... ``` Outside users, e.g. kubectl, could then ``` import sigs.k8s.io/kustomize/kustomize/v3/commands/build ``` and hopefully still get the `main` package as they do now via: ``` go get sigs.k8s.io/kustomize/kustomize/v3 ``` Advantage: 1) The kustomize binary ships at the same version as the commands - which makes sense as the binary's _version_ refers to how the CLI operates (command names, flags, etc.). This makes it easy to related the version of a kustomize binary with the version of commands running in some other CLI binary. 2) The path to the kustomize binary doesn't change. Disadvantage: It's an atypical Go module arrangement. Usually `main` packages live as leaves under a directory called `cmd` inside a module, rather than at the _top_ of the module. This might cause some problems. If so, we can go with option 4. 4. Same as 3, but move `main.go` (the `main` package) down one step. ``` REPO/api/go.mod REPO/api/builtins REPO/api/... REPO/kustomize/go.mod REPO/kustomize/cmd/main.go REPO/kustomize/commands/build REPO/kustomize/commands/edit REPO/kustomize/commands/... ```
196 lines
5.1 KiB
Go
196 lines
5.1 KiB
Go
// Copyright 2019 The Kubernetes Authors.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package create
|
|
|
|
import (
|
|
"reflect"
|
|
"testing"
|
|
|
|
"sigs.k8s.io/kustomize/api/filesys"
|
|
"sigs.k8s.io/kustomize/api/provider"
|
|
"sigs.k8s.io/kustomize/api/types"
|
|
"sigs.k8s.io/kustomize/kustomize/v3/commands/internal/kustfile"
|
|
)
|
|
|
|
var factory = provider.NewDefaultDepProvider().GetKunstructuredFactory()
|
|
|
|
func readKustomizationFS(t *testing.T, fSys filesys.FileSystem) *types.Kustomization {
|
|
kf, err := kustfile.NewKustomizationFile(fSys)
|
|
if err != nil {
|
|
t.Errorf("unexpected new error %v", err)
|
|
}
|
|
m, err := kf.Read()
|
|
if err != nil {
|
|
t.Errorf("unexpected read error %v", err)
|
|
}
|
|
return m
|
|
}
|
|
func TestCreateNoArgs(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
cmd := NewCmdCreate(fSys, factory)
|
|
err := cmd.RunE(cmd, []string{})
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
readKustomizationFS(t, fSys)
|
|
}
|
|
|
|
func TestCreateWithResources(t *testing.T) {
|
|
fSys := filesys.MakeEmptyDirInMemory()
|
|
fSys.WriteFile("foo.yaml", []byte(""))
|
|
fSys.WriteFile("bar.yaml", []byte(""))
|
|
opts := createFlags{resources: "foo.yaml,bar.yaml"}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
expected := []string{"foo.yaml", "bar.yaml"}
|
|
if !reflect.DeepEqual(m.Resources, expected) {
|
|
t.Fatalf("expected %+v but got %+v", expected, m.Resources)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithNamespace(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
want := "foo"
|
|
opts := createFlags{namespace: want}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
got := m.Namespace
|
|
if got != want {
|
|
t.Errorf("want: %s, got: %s", want, got)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithLabels(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
opts := createFlags{labels: "foo:bar"}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
expected := map[string]string{"foo": "bar"}
|
|
if !reflect.DeepEqual(m.CommonLabels, expected) {
|
|
t.Fatalf("expected %+v but got %+v", expected, m.CommonLabels)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithAnnotations(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
opts := createFlags{annotations: "foo:bar"}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
expected := map[string]string{"foo": "bar"}
|
|
if !reflect.DeepEqual(m.CommonAnnotations, expected) {
|
|
t.Fatalf("expected %+v but got %+v", expected, m.CommonAnnotations)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithNamePrefix(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
want := "foo-"
|
|
opts := createFlags{prefix: want}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
got := m.NamePrefix
|
|
if got != want {
|
|
t.Errorf("want: %s, got: %s", want, got)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithNameSuffix(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
opts := createFlags{suffix: "-foo"}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Errorf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
if m.NameSuffix != "-foo" {
|
|
t.Errorf("want: -foo, got: %s", m.NameSuffix)
|
|
}
|
|
}
|
|
|
|
func writeDetectContent(fSys filesys.FileSystem) {
|
|
fSys.WriteFile("/test.yaml", []byte(`
|
|
apiVersion: v1
|
|
kind: Service
|
|
metadata:
|
|
name: test`))
|
|
fSys.WriteFile("/README.md", []byte(`
|
|
# Not a k8s resource
|
|
This file is not a valid kubernetes object.`))
|
|
fSys.WriteFile("/non-k8s.yaml", []byte(`
|
|
# Not a k8s resource
|
|
other: yaml
|
|
foo:
|
|
- bar
|
|
- baz`))
|
|
fSys.Mkdir("/sub")
|
|
fSys.WriteFile("/sub/test.yaml", []byte(`
|
|
apiVersion: v1
|
|
kind: Service
|
|
metadata:
|
|
name: test2`))
|
|
fSys.WriteFile("/sub/README.md", []byte(`
|
|
# Not a k8s resource
|
|
This file in a subdirectory is not a valid kubernetes object.`))
|
|
fSys.WriteFile("/sub/non-k8s.yaml", []byte(`
|
|
# Not a k8s resource
|
|
other: yaml
|
|
foo:
|
|
- bar
|
|
- baz`))
|
|
fSys.Mkdir("/overlay")
|
|
fSys.WriteFile("/overlay/test.yaml", []byte(`
|
|
apiVersion: v1
|
|
kind: Service
|
|
metadata:
|
|
name: test3`))
|
|
fSys.WriteFile("/overlay/kustomization.yaml", []byte(`
|
|
resources:
|
|
- test.yaml`))
|
|
}
|
|
|
|
func TestCreateWithDetect(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
writeDetectContent(fSys)
|
|
opts := createFlags{path: "/", detectResources: true}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Fatalf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
expected := []string{"/test.yaml"}
|
|
if !reflect.DeepEqual(m.Resources, expected) {
|
|
t.Fatalf("expected %+v but got %+v", expected, m.Resources)
|
|
}
|
|
}
|
|
|
|
func TestCreateWithDetectRecursive(t *testing.T) {
|
|
fSys := filesys.MakeFsInMemory()
|
|
writeDetectContent(fSys)
|
|
opts := createFlags{path: "/", detectResources: true, detectRecursive: true}
|
|
err := runCreate(opts, fSys, factory)
|
|
if err != nil {
|
|
t.Fatalf("unexpected cmd error: %v", err)
|
|
}
|
|
m := readKustomizationFS(t, fSys)
|
|
expected := []string{"/overlay", "/sub/test.yaml", "/test.yaml"}
|
|
if !reflect.DeepEqual(m.Resources, expected) {
|
|
t.Fatalf("expected %+v but got %+v", expected, m.Resources)
|
|
}
|
|
}
|