-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8143 from priyawadhwa/list
Add defaults subcommand to `minikube config`
- Loading branch information
Showing
5 changed files
with
232 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| Copyright 2016 The Kubernetes Authors All rights reserved. | ||
| 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 config | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "github.com/spf13/cobra" | ||
| "k8s.io/minikube/pkg/minikube/out" | ||
| ) | ||
|
|
||
| var configDefaultsCommand = &cobra.Command{ | ||
| Use: "defaults PROPERTY_NAME", | ||
| Short: "Lists all valid default values for PROPERTY_NAME", | ||
| Long: `list displays all valid default settings for PROPERTY_NAME | ||
| Acceptable fields: ` + "\n\n" + fieldsWithDefaults(), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if len(args) == 0 { | ||
| cmd.SilenceErrors = true | ||
| return errors.New("not enough arguments.\nusage: minikube config list PROPERTY_NAME") | ||
| } | ||
| if len(args) > 1 { | ||
| cmd.SilenceErrors = true | ||
| return fmt.Errorf("too many arguments (%d)\nusage: minikube config list PROPERTY_NAME", len(args)) | ||
| } | ||
|
|
||
| property := args[0] | ||
| defaults, err := getDefaults(property) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| return printDefaults(defaults) | ||
| }, | ||
| } | ||
|
|
||
| func getDefaults(property string) ([]string, error) { | ||
| setting, err := findSetting(property) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if setting.validDefaults == nil { | ||
| return nil, fmt.Errorf("%s is not a valid option for the `defaults` command; to see valid options run `minikube config defaults -h`", property) | ||
| } | ||
| return setting.validDefaults(), nil | ||
| } | ||
|
|
||
| func printDefaults(defaults []string) error { | ||
| if output == "json" { | ||
| encoding, err := json.Marshal(defaults) | ||
| if err != nil { | ||
| return errors.Wrap(err, "encoding json") | ||
| } | ||
| out.Ln(string(encoding)) | ||
| return nil | ||
| } | ||
| for _, d := range defaults { | ||
| out.Ln("* %s", d) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func fieldsWithDefaults() string { | ||
| fields := []string{} | ||
| for _, s := range settings { | ||
| if s.validDefaults != nil { | ||
| fields = append(fields, " * "+s.name) | ||
| } | ||
| } | ||
| return strings.Join(fields, "\n") | ||
| } | ||
|
|
||
| func init() { | ||
| configDefaultsCommand.Flags().StringVar(&output, "output", "", "Output format. Accepted values: [json]") | ||
| ConfigCmd.AddCommand(configDefaultsCommand) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /* | ||
| Copyright 2016 The Kubernetes Authors All rights reserved. | ||
| 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 config | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "k8s.io/minikube/pkg/minikube/out" | ||
| "k8s.io/minikube/pkg/minikube/tests" | ||
| ) | ||
|
|
||
| func TestGetDefaults(t *testing.T) { | ||
| tcs := []struct { | ||
| property string | ||
| expectedContents string | ||
| shouldErr bool | ||
| }{ | ||
| { | ||
| property: "driver", | ||
| expectedContents: "docker", | ||
| }, { | ||
| property: "invalid", | ||
| shouldErr: true, | ||
| }, | ||
| } | ||
| for _, tc := range tcs { | ||
| t.Run(tc.property, func(t *testing.T) { | ||
| defaults, err := getDefaults(tc.property) | ||
| if err != nil && !tc.shouldErr { | ||
| t.Fatalf("test shouldn't have failed, error listing defaults: %v", err) | ||
| } | ||
| if err == nil && tc.shouldErr { | ||
| t.Fatal("test should have failed but did not") | ||
| } | ||
| if tc.shouldErr { | ||
| return | ||
| } | ||
| for _, d := range defaults { | ||
| if d == tc.expectedContents { | ||
| return | ||
| } | ||
| } | ||
| t.Fatalf("defaults didn't contain expected default. Actual: %v\nExpected: %v\n", defaults, tc.expectedContents) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestPrintDefaults(t *testing.T) { | ||
| defaults := []string{"a", "b", "c"} | ||
| tcs := []struct { | ||
| description string | ||
| format string | ||
| expected string | ||
| }{ | ||
| { | ||
| description: "print to stdout", | ||
| expected: "* a\n* b\n* c\n", | ||
| }, { | ||
| description: "print in json", | ||
| format: "json", | ||
| expected: "[\"a\",\"b\",\"c\"]\n", | ||
| }, | ||
| } | ||
| for _, tc := range tcs { | ||
| t.Run(tc.description, func(t *testing.T) { | ||
| output = tc.format | ||
| f := tests.NewFakeFile() | ||
| out.SetOutFile(f) | ||
| if err := printDefaults(defaults); err != nil { | ||
| t.Fatalf("error printing defaults: %v", err) | ||
| } | ||
| if f.String() != tc.expected { | ||
| t.Fatalf("Expected: %v\n Actual: %v\n", tc.expected, f.String()) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters