Files
kustomize/kyaml/kio/pkgio_reader_test.go
Phillip Wittrock e473433cba Remove config.kubernetes.io/package annotation
It doesn't do anything useful
2020-01-07 16:24:52 -08:00

482 lines
11 KiB
Go

// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0
package kio_test
import (
"io/ioutil"
"os"
"path/filepath"
"strings"
"testing"
"github.com/stretchr/testify/assert"
. "sigs.k8s.io/kustomize/kyaml/kio"
// "sigs.k8s.io/kustomize/kyaml/testutil"
)
// setup creates directories and files for testing
type setup struct {
// root is the tmp directory
root string
}
// setupDirectories creates directories for reading test configuration from
func setupDirectories(t *testing.T, dirs ...string) setup {
d, err := ioutil.TempDir("", "kyaml-test")
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
err = os.Chdir(d)
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
for _, s := range dirs {
err = os.MkdirAll(s, 0700)
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
}
return setup{root: d}
}
// writeFile writes a file under the test directory
func (s setup) writeFile(t *testing.T, path string, value []byte) {
err := os.MkdirAll(filepath.Dir(filepath.Join(s.root, path)), 0700)
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
err = ioutil.WriteFile(filepath.Join(s.root, path), value, 0600)
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
}
// clean deletes the test config
func (s setup) clean() {
os.RemoveAll(s.root)
}
var readFileA = []byte(`---
a: b #first
---
c: d # second
`)
var readFileB = []byte(`# second thing
e: f
g:
h:
- i # has a list
- j
`)
var pkgFile = []byte(``)
func TestLocalPackageReader_Read_empty(t *testing.T) {
var r LocalPackageReader
nodes, err := r.Read()
if assert.Error(t, err) {
assert.Contains(t, err.Error(), "must specify package path")
}
assert.Nil(t, nodes)
}
func TestLocalPackageReader_Read_pkg(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("b_test.yaml"), readFileB)
paths := []struct {
path string
}{
{path: "./"},
{path: s.root},
}
for _, p := range paths {
rfr := LocalPackageReader{PackagePath: p.path}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
return
}
if !assert.Len(t, nodes, 3) {
return
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a_test.yaml'
`,
`# second thing
e: f
g:
h:
- i # has a list
- j
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'b_test.yaml'
`,
}
for i := range nodes {
val, err := nodes[i].String()
if !assert.NoError(t, err) {
return
}
if !assert.Equal(t, expected[i], val) {
return
}
}
}
}
func TestLocalPackageReader_Read_file(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("b_test.yaml"), readFileB)
paths := []struct {
path string
}{
{path: "./"},
{path: s.root},
}
for _, p := range paths {
rfr := LocalPackageReader{PackagePath: filepath.Join(p.path, "a_test.yaml")}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
return
}
if !assert.Len(t, nodes, 2) {
return
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a_test.yaml'
`,
}
for i := range nodes {
val, err := nodes[i].String()
if !assert.NoError(t, err) {
return
}
if !assert.Equal(t, expected[i], val) {
return
}
}
}
}
func TestLocalPackageReader_Read_pkgOmitAnnotations(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("b_test.yaml"), readFileB)
paths := []struct {
path string
}{
{path: "./"},
{path: s.root},
}
for _, p := range paths {
// empty path
rfr := LocalPackageReader{PackagePath: p.path, OmitReaderAnnotations: true}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
return
}
if !assert.Len(t, nodes, 3) {
return
}
expected := []string{
`a: b #first
`,
`c: d # second
`,
`# second thing
e: f
g:
h:
- i # has a list
- j
`,
}
for i := range nodes {
val, err := nodes[i].String()
if !assert.NoError(t, err) {
return
}
if !assert.Equal(t, expected[i], val) {
return
}
}
}
}
func TestLocalPackageReader_Read_nestedDirs(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a", "b", "a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("a", "b", "b_test.yaml"), readFileB)
paths := []struct {
path string
}{
{path: "./"},
{path: s.root},
}
for _, p := range paths {
// empty path
rfr := LocalPackageReader{PackagePath: p.path}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
if !assert.Len(t, nodes, 3) {
return
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`# second thing
e: f
g:
h:
- i # has a list
- j
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}b${SEP}b_test.yaml'
`,
}
for i := range nodes {
val, err := nodes[i].String()
if !assert.NoError(t, err) {
return
}
want := strings.ReplaceAll(expected[i], "${SEP}", string(filepath.Separator))
if !assert.Equal(t, want, val) {
return
}
}
}
}
func TestLocalPackageReader_Read_matchRegex(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a", "b", "a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("a", "b", "b_test.yaml"), readFileB)
// empty path
rfr := LocalPackageReader{PackagePath: s.root, MatchFilesGlob: []string{`a*.yaml`}}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
if !assert.Len(t, nodes, 2) {
assert.FailNow(t, "wrong number items")
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
}
for i, node := range nodes {
val, err := node.String()
assert.NoError(t, err)
want := strings.ReplaceAll(expected[i], "${SEP}", string(filepath.Separator))
assert.Equal(t, want, val)
}
}
func TestLocalPackageReader_Read_skipSubpackage(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a", "b", "a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("a", "c", "c_test.yaml"), readFileB)
s.writeFile(t, filepath.Join("a", "c", "pkgFile"), pkgFile)
// empty path
rfr := LocalPackageReader{PackagePath: s.root, PackageFileName: "pkgFile"}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
if !assert.Len(t, nodes, 2) {
assert.FailNow(t, "wrong number items")
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
}
for i, node := range nodes {
val, err := node.String()
assert.NoError(t, err)
want := strings.ReplaceAll(expected[i], "${SEP}", string(filepath.Separator))
assert.Equal(t, want, val)
}
}
func TestLocalPackageReader_Read_includeSubpackage(t *testing.T) {
s := setupDirectories(t, filepath.Join("a", "b"), filepath.Join("a", "c"))
defer s.clean()
s.writeFile(t, filepath.Join("a", "b", "a_test.yaml"), readFileA)
s.writeFile(t, filepath.Join("a", "c", "c_test.yaml"), readFileB)
s.writeFile(t, filepath.Join("a", "c", "pkgFile"), pkgFile)
// empty path
rfr := LocalPackageReader{PackagePath: s.root, IncludeSubpackages: true, PackageFileName: "pkgFile"}
nodes, err := rfr.Read()
if !assert.NoError(t, err) {
assert.FailNow(t, err.Error())
}
if !assert.Len(t, nodes, 3) {
assert.FailNow(t, "wrong number items")
}
expected := []string{
`a: b #first
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`c: d # second
metadata:
annotations:
config.kubernetes.io/index: '1'
config.kubernetes.io/path: 'a${SEP}b${SEP}a_test.yaml'
`,
`# second thing
e: f
g:
h:
- i # has a list
- j
metadata:
annotations:
config.kubernetes.io/index: '0'
config.kubernetes.io/path: 'a${SEP}c${SEP}c_test.yaml'
`,
}
for i, node := range nodes {
val, err := node.String()
assert.NoError(t, err)
want := strings.ReplaceAll(expected[i], "${SEP}", string(filepath.Separator))
assert.Equal(t, want, val)
}
}
// func TestLocalPackageReaderWriter_DeleteFiles(t *testing.T) {
// g, _, clean := testutil.SetupDefaultRepoAndWorkspace(t)
// defer clean()
// if !assert.NoError(t, os.Chdir(g.RepoDirectory)) {
// return
// }
//
// rw := LocalPackageReadWriter{PackagePath: "."}
// nodes, err := rw.Read()
// if !assert.NoError(t, err) {
// t.FailNow()
// }
// _, err = os.Stat(filepath.Join("java", "java-deployment.resource.yaml"))
// if !assert.NoError(t, err) {
// t.FailNow()
// }
//
// // delete one of the nodes
// var newNodes []*yaml.RNode
// for i := range nodes {
// meta, err := nodes[i].GetMeta()
// if !assert.NoError(t, err) {
// t.FailNow()
// }
// if meta.Name == "app" && meta.Kind == "Deployment" {
// continue
// }
// newNodes = append(newNodes, nodes[i])
// }
//
// if !assert.NoError(t, rw.Write(newNodes)) {
// t.FailNow()
// }
//
// _, err = os.Stat(filepath.Join("java", "java-deployment.resource.yaml"))
// if !assert.Error(t, err) {
// t.FailNow()
// }
//
// diff, err := copyutil.Diff(filepath.Join(g.DatasetDirectory, testutil.Dataset1), ".")
// if !assert.NoError(t, err) {
// t.FailNow()
// }
//
// assert.ElementsMatch(t,
// diff.List(),
// []string{filepath.Join("java", "java-deployment.resource.yaml")})
// }