diff --git a/docs/cmd/kn_revision_list.md b/docs/cmd/kn_revision_list.md index 903931dfda..a03e6ab1a9 100644 --- a/docs/cmd/kn_revision_list.md +++ b/docs/cmd/kn_revision_list.md @@ -34,6 +34,7 @@ kn revision list [name] [flags] --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) -h, --help help for list -n, --namespace string List the requested object(s) in given namespace. + --no-headers When using the default output format, don't print headers (default: print headers). -o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file. -s, --service string Service name --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. diff --git a/docs/cmd/kn_route_list.md b/docs/cmd/kn_route_list.md index 07babbbfb1..4b358ab8ae 100644 --- a/docs/cmd/kn_route_list.md +++ b/docs/cmd/kn_route_list.md @@ -31,6 +31,7 @@ kn route list NAME [flags] --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) -h, --help help for list -n, --namespace string List the requested object(s) in given namespace. + --no-headers When using the default output format, don't print headers (default: print headers). -o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. ``` diff --git a/docs/cmd/kn_service_list.md b/docs/cmd/kn_service_list.md index 3bbc2ffd9c..62b53f9f88 100644 --- a/docs/cmd/kn_service_list.md +++ b/docs/cmd/kn_service_list.md @@ -31,6 +31,7 @@ kn service list [name] [flags] --allow-missing-template-keys If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats. (default true) -h, --help help for list -n, --namespace string List the requested object(s) in given namespace. + --no-headers When using the default output format, don't print headers (default: print headers). -o, --output string Output format. One of: json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-file. --template string Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview]. ``` diff --git a/pkg/kn/commands/human_readable_flags.go b/pkg/kn/commands/human_readable_flags.go index 516bc202d0..eb009ca1e2 100644 --- a/pkg/kn/commands/human_readable_flags.go +++ b/pkg/kn/commands/human_readable_flags.go @@ -30,19 +30,20 @@ import ( // Given the following flag values, a printer can be requested that knows // how to handle printing based on these values. type HumanPrintFlags struct { + NoHeaders bool //TODO: Add more flags as required } // AllowedFormats returns more customized formating options func (f *HumanPrintFlags) AllowedFormats() []string { // TODO: Add more formats eg: wide - return []string{""} + return []string{"no-headers"} } // ToPrinter receives returns a printer capable of // handling human-readable output. func (f *HumanPrintFlags) ToPrinter(getHandlerFunc func(h hprinters.PrintHandler)) (hprinters.ResourcePrinter, error) { - p := hprinters.NewTablePrinter(hprinters.PrintOptions{}) + p := hprinters.NewTablePrinter(hprinters.PrintOptions{NoHeaders: f.NoHeaders}) getHandlerFunc(p) return p, nil } @@ -50,6 +51,7 @@ func (f *HumanPrintFlags) ToPrinter(getHandlerFunc func(h hprinters.PrintHandler // AddFlags receives a *cobra.Command reference and binds // flags related to human-readable printing to it func (f *HumanPrintFlags) AddFlags(c *cobra.Command) { + c.Flags().BoolVar(&f.NoHeaders, "no-headers", false, "When using the default output format, don't print headers (default: print headers).") //TODO: Add more flags as required } diff --git a/pkg/kn/commands/revision/revision_list_test.go b/pkg/kn/commands/revision/revision_list_test.go index 5425dfbfd1..9522555327 100644 --- a/pkg/kn/commands/revision/revision_list_test.go +++ b/pkg/kn/commands/revision/revision_list_test.go @@ -48,10 +48,7 @@ func fakeRevisionList(args []string, response *v1alpha1.RevisionList) (action cl func TestRevisionListEmpty(t *testing.T) { action, output, err := fakeRevisionList([]string{"revision", "list"}, &v1alpha1.RevisionList{}) - if err != nil { - t.Error(err) - return - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "revisions") { @@ -63,10 +60,7 @@ func TestRevisionListEmpty(t *testing.T) { func TestRevisionListEmptyByName(t *testing.T) { action, _, err := fakeRevisionList([]string{"revision", "list", "name"}, &v1alpha1.RevisionList{}) - if err != nil { - t.Error(err) - return - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "revisions") { @@ -79,9 +73,7 @@ func TestRevisionListDefaultOutput(t *testing.T) { revision2 := createMockRevisionWithParams("bar-wxyz", "bar") RevisionList := &v1alpha1.RevisionList{Items: []v1alpha1.Revision{*revision1, *revision2}} action, output, err := fakeRevisionList([]string{"revision", "list"}, RevisionList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "revisions") { @@ -92,6 +84,23 @@ func TestRevisionListDefaultOutput(t *testing.T) { assert.Check(t, util.ContainsAll(output[2], "bar-wxyz", "bar")) } +func TestRevisionListDefaultOutputNoHeaders(t *testing.T) { + revision1 := createMockRevisionWithParams("foo-abcd", "foo") + revision2 := createMockRevisionWithParams("bar-wxyz", "bar") + RevisionList := &v1alpha1.RevisionList{Items: []v1alpha1.Revision{*revision1, *revision2}} + action, output, err := fakeRevisionList([]string{"revision", "list", "--no-headers"}, RevisionList) + assert.NilError(t, err) + if action == nil { + t.Errorf("No action") + } else if !action.Matches("list", "revisions") { + t.Errorf("Bad action %v", action) + } + + assert.Check(t, util.ContainsNone(output[0], "NAME", "URL", "GENERATION", "AGE", "CONDITIONS", "READY", "REASON")) + assert.Check(t, util.ContainsAll(output[0], "foo-abcd", "foo")) + assert.Check(t, util.ContainsAll(output[1], "bar-wxyz", "bar")) +} + func TestRevisionListForService(t *testing.T) { revision1 := createMockRevisionWithParams("foo-abcd", "svc1") revision2 := createMockRevisionWithParams("bar-wxyz", "svc1") @@ -99,9 +108,7 @@ func TestRevisionListForService(t *testing.T) { revision4 := createMockRevisionWithParams("bar-wxyz", "svc2") RevisionList := &v1alpha1.RevisionList{Items: []v1alpha1.Revision{*revision1, *revision2, *revision3, *revision4}} action, output, err := fakeRevisionList([]string{"revision", "list", "-s", "svc1"}, RevisionList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "revisions") { @@ -124,9 +131,7 @@ func TestRevisionListForService(t *testing.T) { assert.Check(t, util.ContainsAll(output[2], "bar-wxyz", "svc")) //test for non existent service action, output, err = fakeRevisionList([]string{"revision", "list", "-s", "svc3"}, RevisionList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } @@ -140,9 +145,7 @@ func TestRevisionListOneOutput(t *testing.T) { revision := createMockRevisionWithParams("foo-abcd", "foo") RevisionList := &v1alpha1.RevisionList{Items: []v1alpha1.Revision{*revision}} action, output, err := fakeRevisionList([]string{"revision", "list", "foo-abcd"}, RevisionList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "revisions") { diff --git a/pkg/kn/commands/route/list_test.go b/pkg/kn/commands/route/list_test.go index 1a30aa8095..30e342c3c2 100644 --- a/pkg/kn/commands/route/list_test.go +++ b/pkg/kn/commands/route/list_test.go @@ -46,10 +46,7 @@ func fakeRouteList(args []string, response *v1alpha1.RouteList) (action client_t func TestListEmpty(t *testing.T) { action, output, err := fakeRouteList([]string{"route", "list"}, &v1alpha1.RouteList{}) - if err != nil { - t.Error(err) - return - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "routes") { @@ -64,9 +61,7 @@ func TestRouteListDefaultOutput(t *testing.T) { route2 := createMockRouteSingleTarget("bar", "bar-98765", 100) routeList := &v1alpha1.RouteList{Items: []v1alpha1.Route{*route1, *route2}} action, output, err := fakeRouteList([]string{"route", "list"}, routeList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "routes") { @@ -77,13 +72,28 @@ func TestRouteListDefaultOutput(t *testing.T) { assert.Check(t, util.ContainsAll(output[2], "bar", "100% -> bar-98765")) } +func TestRouteListDefaultOutputNoHeaders(t *testing.T) { + route1 := createMockRouteSingleTarget("foo", "foo-01234", 100) + route2 := createMockRouteSingleTarget("bar", "bar-98765", 100) + routeList := &v1alpha1.RouteList{Items: []v1alpha1.Route{*route1, *route2}} + action, output, err := fakeRouteList([]string{"route", "list", "--no-headers"}, routeList) + assert.NilError(t, err) + if action == nil { + t.Errorf("No action") + } else if !action.Matches("list", "routes") { + t.Errorf("Bad action %v", action) + } + + assert.Check(t, util.ContainsNone(output[0], "NAME", "URL", "GENERATION", "AGE", "CONDITIONS", "READY", "REASON")) + assert.Check(t, util.ContainsAll(output[0], "foo", "100% -> foo-01234")) + assert.Check(t, util.ContainsAll(output[1], "bar", "100% -> bar-98765")) +} + func TestRouteListWithTwoTargetsOutput(t *testing.T) { route := createMockRouteTwoTarget("foo", "foo-01234", "foo-98765", 20, 80) routeList := &v1alpha1.RouteList{Items: []v1alpha1.Route{*route}} action, output, err := fakeRouteList([]string{"route", "list"}, routeList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "routes") { diff --git a/pkg/kn/commands/service/service_list_test.go b/pkg/kn/commands/service/service_list_test.go index 990bddd8fe..b41f3a344f 100644 --- a/pkg/kn/commands/service/service_list_test.go +++ b/pkg/kn/commands/service/service_list_test.go @@ -49,10 +49,7 @@ func fakeServiceList(args []string, response *v1alpha1.ServiceList) (action clie func TestListEmpty(t *testing.T) { action, output, err := fakeServiceList([]string{"service", "list"}, &v1alpha1.ServiceList{}) - if err != nil { - t.Error(err) - return - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "services") { @@ -64,10 +61,7 @@ func TestListEmpty(t *testing.T) { func TestGetEmpty(t *testing.T) { action, _, err := fakeServiceList([]string{"service", "list", "name"}, &v1alpha1.ServiceList{}) - if err != nil { - t.Error(err) - return - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "services") { @@ -80,9 +74,7 @@ func TestServiceListDefaultOutput(t *testing.T) { service2 := createMockServiceWithParams("bar", "http://bar.default.example.com", 2) serviceList := &v1alpha1.ServiceList{Items: []v1alpha1.Service{*service1, *service2}} action, output, err := fakeServiceList([]string{"service", "list"}, serviceList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "services") { @@ -93,13 +85,28 @@ func TestServiceListDefaultOutput(t *testing.T) { assert.Check(t, util.ContainsAll(output[2], "bar", "bar.default.example.com", "2")) } +func TestServiceListDefaultOutputNoHeaders(t *testing.T) { + service1 := createMockServiceWithParams("foo", "http://foo.default.example.com", 1) + service2 := createMockServiceWithParams("bar", "http://bar.default.example.com", 2) + serviceList := &v1alpha1.ServiceList{Items: []v1alpha1.Service{*service1, *service2}} + action, output, err := fakeServiceList([]string{"service", "list", "--no-headers"}, serviceList) + assert.NilError(t, err) + if action == nil { + t.Errorf("No action") + } else if !action.Matches("list", "services") { + t.Errorf("Bad action %v", action) + } + + assert.Check(t, util.ContainsNone(output[0], "NAME", "URL", "GENERATION", "AGE", "CONDITIONS", "READY", "REASON")) + assert.Check(t, util.ContainsAll(output[0], "foo", "foo.default.example.com", "1")) + assert.Check(t, util.ContainsAll(output[1], "bar", "bar.default.example.com", "2")) +} + func TestServiceGetOneOutput(t *testing.T) { service := createMockServiceWithParams("foo", "foo.default.example.com", 1) serviceList := &v1alpha1.ServiceList{Items: []v1alpha1.Service{*service}} action, output, err := fakeServiceList([]string{"service", "list", "foo"}, serviceList) - if err != nil { - t.Fatal(err) - } + assert.NilError(t, err) if action == nil { t.Errorf("No action") } else if !action.Matches("list", "services") { diff --git a/pkg/printers/interface.go b/pkg/printers/interface.go index 70aa97b4dd..91dad164a8 100644 --- a/pkg/printers/interface.go +++ b/pkg/printers/interface.go @@ -38,5 +38,6 @@ func (fn ResourcePrinterFunc) PrintObj(obj runtime.Object, w io.Writer) error { // PrintOptions for different table printing options type PrintOptions struct { + NoHeaders bool //TODO: Add options for eg: with-kind, server-printing, wide etc } diff --git a/pkg/printers/tableprinter.go b/pkg/printers/tableprinter.go index ff49ed52b7..0f3f347c68 100644 --- a/pkg/printers/tableprinter.go +++ b/pkg/printers/tableprinter.go @@ -73,12 +73,13 @@ func printRowsForHandlerEntry(output io.Writer, handler *handlerEntry, obj runti if !results[1].IsNil() { return results[1].Interface().(error) } - - var headers []string - for _, column := range handler.columnDefinitions { - headers = append(headers, strings.ToUpper(column.Name)) + if !options.NoHeaders { + var headers []string + for _, column := range handler.columnDefinitions { + headers = append(headers, strings.ToUpper(column.Name)) + } + printHeader(headers, output) } - printHeader(headers, output) if results[1].IsNil() { rows := results[0].Interface().([]metav1beta1.TableRow) diff --git a/pkg/util/compare.go b/pkg/util/compare.go index de0064cc15..2c90b4a109 100644 --- a/pkg/util/compare.go +++ b/pkg/util/compare.go @@ -38,3 +38,21 @@ func ContainsAll(target string, substrings ...string) cmp.Comparison { return cmp.ResultSuccess } } + +// ContainsNone is a comparison utility, compares given substrings against +// target string and returns the gotest.tools/assert/cmp.Comaprison function. +// Provide target string as first arg, followed by any number of substring as args +func ContainsNone(target string, substrings ...string) cmp.Comparison { + return func() cmp.Result { + var contains []string + for _, sub := range substrings { + if strings.Contains(target, sub) { + contains = append(contains, sub) + } + } + if len(contains) > 0 { + return cmp.ResultFailure(fmt.Sprintf("\nActual output: %s\nContains strings: %s", target, strings.Join(contains[:], ", "))) + } + return cmp.ResultSuccess + } +} diff --git a/pkg/util/compare_test.go b/pkg/util/compare_test.go index 670f2b669b..9cb9f7341d 100644 --- a/pkg/util/compare_test.go +++ b/pkg/util/compare_test.go @@ -30,6 +30,13 @@ type containsAllTestCase struct { missing []string } +type containsNoneTestCase struct { + target string + substrings []string + success bool + contains []string +} + func TestContainsAll(t *testing.T) { for i, tc := range []containsAllTestCase{ { @@ -68,3 +75,42 @@ func TestContainsAll(t *testing.T) { } } } + +func TestContainsNone(t *testing.T) { + for i, tc := range []containsNoneTestCase{ + { + target: "NAME SERVICE AGE CONDITIONS", + substrings: []string{"REASON", "READY", "foo", "bar"}, + success: true, + }, + { + "NAME SERVICE AGE CONDITIONS READY REASON", + []string{"foo", "bar", "NAME", "AGE"}, + false, + []string{"NAME", "AGE"}, + }, + { + "No resources found", + []string{"NAME", "URL", "DOMAIN", "READY", "resources"}, + false, + []string{"resources"}, + }, + { + target: "Sword!", + substrings: []string{}, + success: true, + }, + } { + comparison := ContainsNone(tc.target, tc.substrings...) + result := comparison() + if result.Success() != tc.success { + t.Errorf("%d: Expecting %s to contain %s", i, tc.target, tc.substrings) + } + if !tc.success { + message := fmt.Sprintf("\nActual output: %s\nContains strings: %s", tc.target, strings.Join(tc.contains[:], ", ")) + if !reflect.DeepEqual(result, cmp.ResultFailure(message)) { + t.Errorf("%d: Incorrect error message returned\nExpecting: %s", i, message) + } + } + } +}