mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-30 09:51:23 +00:00
Improve command package isolation.
This commit is contained in:
114
pkg/commands/misc/config.go
Normal file
114
pkg/commands/misc/config.go
Normal file
@@ -0,0 +1,114 @@
|
||||
/*
|
||||
Copyright 2018 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 misc
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"sigs.k8s.io/kustomize/pkg/fs"
|
||||
"sigs.k8s.io/kustomize/pkg/transformerconfig/defaultconfig"
|
||||
)
|
||||
|
||||
// NewCmdConfig returns an instance of 'config' subcommand.
|
||||
func NewCmdConfig(fsys fs.FileSystem) *cobra.Command {
|
||||
c := &cobra.Command{
|
||||
Use: "config",
|
||||
Short: "Config Kustomize transformers",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Save the default transformer configrations to a local directory
|
||||
kustomize config save -d ~/.kustomize/config
|
||||
`,
|
||||
Args: cobra.MinimumNArgs(1),
|
||||
}
|
||||
c.AddCommand(
|
||||
newCmdSave(fsys),
|
||||
)
|
||||
return c
|
||||
}
|
||||
|
||||
type saveOptions struct {
|
||||
saveDirectory string
|
||||
}
|
||||
|
||||
func newCmdSave(fsys fs.FileSystem) *cobra.Command {
|
||||
var o saveOptions
|
||||
|
||||
c := &cobra.Command{
|
||||
Use: "save",
|
||||
Short: "Save default kustomize transformer configurations to a local directory",
|
||||
Long: "",
|
||||
Example: `
|
||||
# Save the default transformer configrations to a local directory
|
||||
save -d ~/.kustomize/config
|
||||
|
||||
`,
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
err := o.Validate()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = o.Complete(fsys)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return o.RunSave(fsys)
|
||||
},
|
||||
}
|
||||
c.Flags().StringVarP(
|
||||
&o.saveDirectory,
|
||||
"directory", "d", "",
|
||||
"Directory to save the default transformer configurations")
|
||||
|
||||
return c
|
||||
|
||||
}
|
||||
|
||||
// Validate validates the saveOptions is not empty
|
||||
func (o *saveOptions) Validate() error {
|
||||
if o.saveDirectory == "" {
|
||||
return fmt.Errorf("must specify one local directory to save the default transformer configurations")
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// Complete creates the save directory when the directory doesn't exist
|
||||
func (o *saveOptions) Complete(fsys fs.FileSystem) error {
|
||||
if !fsys.Exists(o.saveDirectory) {
|
||||
return fsys.MkdirAll(o.saveDirectory)
|
||||
}
|
||||
if fsys.IsDir(o.saveDirectory) {
|
||||
return nil
|
||||
}
|
||||
return fmt.Errorf("%s is not a directory. Please use a different directory name.", o.saveDirectory)
|
||||
}
|
||||
|
||||
// RunSave saves the default transformer configurations local directory
|
||||
func (o *saveOptions) RunSave(fsys fs.FileSystem) error {
|
||||
m := defaultconfig.GetDefaultPathConfigStrings()
|
||||
for tname, tcfg := range m {
|
||||
filename := filepath.Join(o.saveDirectory, tname+".yaml")
|
||||
err := fsys.WriteFile(filename, []byte(tcfg))
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
87
pkg/commands/misc/config_test.go
Normal file
87
pkg/commands/misc/config_test.go
Normal file
@@ -0,0 +1,87 @@
|
||||
/*
|
||||
Copyright 2018 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 misc
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"reflect"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"sigs.k8s.io/kustomize/pkg/fs"
|
||||
)
|
||||
|
||||
func TestValidate(t *testing.T) {
|
||||
o := saveOptions{
|
||||
saveDirectory: "",
|
||||
}
|
||||
err := o.Validate()
|
||||
if !strings.Contains(err.Error(), "must specify one local directory") {
|
||||
t.Fatalf("Incorrect error %v", err)
|
||||
}
|
||||
|
||||
o.saveDirectory = "/some/dir"
|
||||
err = o.Validate()
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
func TestComplete(t *testing.T) {
|
||||
fsys := fs.MakeFakeFS()
|
||||
fsys.Mkdir("/some/dir")
|
||||
fsys.WriteFile("/some/file", []byte(`some file`))
|
||||
|
||||
type testcase struct {
|
||||
dir string
|
||||
expect error
|
||||
}
|
||||
testcases := []testcase{
|
||||
{
|
||||
dir: "/some/dir",
|
||||
expect: nil,
|
||||
},
|
||||
{
|
||||
dir: "/some/dir/not/existing",
|
||||
expect: nil,
|
||||
},
|
||||
{
|
||||
dir: "/some/file",
|
||||
expect: fmt.Errorf("%s is not a directory. Please use a different directory name.", "/some/file"),
|
||||
},
|
||||
}
|
||||
|
||||
for _, tcase := range testcases {
|
||||
o := saveOptions{saveDirectory: tcase.dir}
|
||||
actual := o.Complete(fsys)
|
||||
if !reflect.DeepEqual(actual, tcase.expect) {
|
||||
t.Fatalf("Expected %v\n but bot %v\n", tcase.expect, actual)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestRunSave(t *testing.T) {
|
||||
fsys := fs.MakeFakeFS()
|
||||
o := saveOptions{saveDirectory: "/some/dir"}
|
||||
err := o.RunSave(fsys)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error %v", err)
|
||||
}
|
||||
if !fsys.Exists("/some/dir/nameprefix.yaml") {
|
||||
t.Fatal("default configurations are not successfully save.")
|
||||
}
|
||||
}
|
||||
75
pkg/commands/misc/version.go
Normal file
75
pkg/commands/misc/version.go
Normal file
@@ -0,0 +1,75 @@
|
||||
/*
|
||||
Copyright 2018 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 misc
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
var (
|
||||
kustomizeVersion = "unknown"
|
||||
goos = "unknown"
|
||||
goarch = "unknown"
|
||||
gitCommit = "$Format:%H$" // sha1 from git, output of $(git rev-parse HEAD)
|
||||
|
||||
buildDate = "1970-01-01T00:00:00Z" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
|
||||
)
|
||||
|
||||
// version returns the version of kustomize.
|
||||
type version struct {
|
||||
// KustomizeVersion is a kustomize binary version.
|
||||
KustomizeVersion string `json:"kustomizeVersion"`
|
||||
// GitCommit is a git commit
|
||||
GitCommit string `json:"gitCommit"`
|
||||
// BuildDate is a build date of the binary.
|
||||
BuildDate string `json:"buildDate"`
|
||||
// GoOs holds OS name.
|
||||
GoOs string `json:"goOs"`
|
||||
// GoArch holds architecture name.
|
||||
GoArch string `json:"goArch"`
|
||||
}
|
||||
|
||||
// getVersion returns version.
|
||||
func getVersion() version {
|
||||
return version{
|
||||
kustomizeVersion,
|
||||
gitCommit,
|
||||
buildDate,
|
||||
goos,
|
||||
goarch,
|
||||
}
|
||||
}
|
||||
|
||||
// Print prints version.
|
||||
func (v version) Print(w io.Writer) {
|
||||
fmt.Fprintf(w, "Version: %+v\n", v)
|
||||
}
|
||||
|
||||
// NewCmdVersion makes version command.
|
||||
func NewCmdVersion(w io.Writer) *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "Prints the kustomize version",
|
||||
Example: `kustomize version`,
|
||||
Run: func(cmd *cobra.Command, args []string) {
|
||||
getVersion().Print(w)
|
||||
},
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user