Skip to content

Commit

Permalink
add alias to commands
Browse files Browse the repository at this point in the history
  • Loading branch information
arghya88 committed Oct 6, 2020
1 parent adb3793 commit ee2a66e
Show file tree
Hide file tree
Showing 40 changed files with 113 additions and 62 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
| Add "--annotation-service" and "--annotation-revision" to kn service create/update
| https://github.com/knative/client/pull/1029[#1029]

| 🎁
| Add alias to commands
| https://github.com/knative/client/pull/1041[#1041]

|===

## v0.17.0 (2020-08-26)
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ kn broker
* [kn broker create](kn_broker_create.md) - Create a broker
* [kn broker delete](kn_broker_delete.md) - Delete a broker
* [kn broker describe](kn_broker_describe.md) - Describe broker
* [kn broker list](kn_broker_list.md) - List brokers
* [kn broker list](kn_broker_list.md) - List brokers (alias: 'ls')

4 changes: 2 additions & 2 deletions docs/cmd/kn_broker_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn broker list

List brokers
List brokers (alias: 'ls')

### Synopsis

List brokers
List brokers (alias: 'ls')

```
kn broker list
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ kn channel COMMAND
* [kn channel create](kn_channel_create.md) - Create an event channel
* [kn channel delete](kn_channel_delete.md) - Delete a channel
* [kn channel describe](kn_channel_describe.md) - Show details of a channel
* [kn channel list](kn_channel_list.md) - List channels
* [kn channel list](kn_channel_list.md) - List channels (alias: 'ls')

4 changes: 2 additions & 2 deletions docs/cmd/kn_channel_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn channel list

List channels
List channels (alias: 'ls')

### Synopsis

List channels
List channels (alias: 'ls')

```
kn channel list
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ kn plugin
### SEE ALSO

* [kn](kn.md) - kn manages Knative Serving and Eventing resources
* [kn plugin list](kn_plugin_list.md) - List plugins
* [kn plugin list](kn_plugin_list.md) - List plugins (alias: 'ls')

2 changes: 1 addition & 1 deletion docs/cmd/kn_plugin_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kn plugin list

List plugins
List plugins (alias: 'ls')

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_revision.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ kn revision
* [kn](kn.md) - kn manages Knative Serving and Eventing resources
* [kn revision delete](kn_revision_delete.md) - Delete revisions
* [kn revision describe](kn_revision_describe.md) - Show details of a revision
* [kn revision list](kn_revision_list.md) - List revisions
* [kn revision list](kn_revision_list.md) - List revisions (alias: 'ls')

2 changes: 1 addition & 1 deletion docs/cmd/kn_revision_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## kn revision list

List revisions
List revisions (alias: 'ls')

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,5 @@ kn route

* [kn](kn.md) - kn manages Knative Serving and Eventing resources
* [kn route describe](kn_route_describe.md) - Show details of a route
* [kn route list](kn_route_list.md) - List routes
* [kn route list](kn_route_list.md) - List routes (alias: 'ls')

4 changes: 2 additions & 2 deletions docs/cmd/kn_route_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn route list

List routes
List routes (alias: 'ls')

### Synopsis

List routes
List routes (alias: 'ls')

```
kn route list NAME
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ kn service
* [kn service delete](kn_service_delete.md) - Delete services
* [kn service describe](kn_service_describe.md) - Show details of a service
* [kn service export](kn_service_export.md) - Export a service and its revisions
* [kn service list](kn_service_list.md) - List services
* [kn service list](kn_service_list.md) - List services (alias: 'ls')
* [kn service update](kn_service_update.md) - Update a service

4 changes: 2 additions & 2 deletions docs/cmd/kn_service_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn service list

List services
List services (alias: 'ls')

### Synopsis

List services
List services (alias: 'ls')

```
kn service list
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_source.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ kn source SOURCE|COMMAND
* [kn](kn.md) - kn manages Knative Serving and Eventing resources
* [kn source apiserver](kn_source_apiserver.md) - Manage Kubernetes api-server sources
* [kn source binding](kn_source_binding.md) - Manage sink bindings
* [kn source list](kn_source_list.md) - List event sources
* [kn source list](kn_source_list.md) - List event sources (alias: 'ls')
* [kn source list-types](kn_source_list-types.md) - List event source types
* [kn source ping](kn_source_ping.md) - Manage ping sources

4 changes: 2 additions & 2 deletions docs/cmd/kn_source_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn source list

List event sources
List event sources (alias: 'ls')

### Synopsis

List event sources
List event sources (alias: 'ls')

```
kn source list
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ kn subscription COMMAND
* [kn subscription create](kn_subscription_create.md) - Create a subscription
* [kn subscription delete](kn_subscription_delete.md) - Delete a subscription
* [kn subscription describe](kn_subscription_describe.md) - Show details of a subscription
* [kn subscription list](kn_subscription_list.md) - List subscriptions
* [kn subscription list](kn_subscription_list.md) - List subscriptions (alias: 'ls')
* [kn subscription update](kn_subscription_update.md) - Update an event subscription

4 changes: 2 additions & 2 deletions docs/cmd/kn_subscription_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn subscription list

List subscriptions
List subscriptions (alias: 'ls')

### Synopsis

List subscriptions
List subscriptions (alias: 'ls')

```
kn subscription list
Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/kn_trigger.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ kn trigger
* [kn trigger create](kn_trigger_create.md) - Create a trigger
* [kn trigger delete](kn_trigger_delete.md) - Delete a trigger
* [kn trigger describe](kn_trigger_describe.md) - Show details of a trigger
* [kn trigger list](kn_trigger_list.md) - List triggers
* [kn trigger list](kn_trigger_list.md) - List triggers (alias: 'ls')
* [kn trigger update](kn_trigger_update.md) - Update a trigger

4 changes: 2 additions & 2 deletions docs/cmd/kn_trigger_list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## kn trigger list

List triggers
List triggers (alias: 'ls')

### Synopsis

List triggers
List triggers (alias: 'ls')

```
kn trigger list
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/broker/broker.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ import (
// NewBrokerCommand represents broker management commands
func NewBrokerCommand(p *commands.KnParams) *cobra.Command {
brokerCmd := &cobra.Command{
Use: "broker",
Short: "Manage message broker",
Use: "broker",
Short: "Manage message broker",
Aliases: []string{"brokers"},
}
brokerCmd.AddCommand(NewBrokerCreateCommand(p))
brokerCmd.AddCommand(NewBrokerDescribeCommand(p))
Expand Down
3 changes: 2 additions & 1 deletion pkg/kn/commands/broker/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ func NewBrokerListCommand(p *commands.KnParams) *cobra.Command {

cmd := &cobra.Command{
Use: "list",
Short: "List brokers",
Short: "List brokers (alias: 'ls')",
Aliases: []string{"ls"},
Example: listExample,
RunE: func(cmd *cobra.Command, args []string) (err error) {
namespace, err := p.GetNamespace(cmd)
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/channel/channel.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ import (
// NewChannelCommand to manage event channels
func NewChannelCommand(p *commands.KnParams) *cobra.Command {
channelCmd := &cobra.Command{
Use: "channel COMMAND",
Short: "Manage event channels",
Use: "channel COMMAND",
Short: "Manage event channels",
Aliases: []string{"channels"},
}
channelCmd.AddCommand(NewChannelCreateCommand(p))
channelCmd.AddCommand(NewChannelListCommand(p))
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/channel/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,9 @@ func NewChannelListCommand(p *commands.KnParams) *cobra.Command {
listFlags := flags.NewListPrintFlags(ListHandlers)

listCommand := &cobra.Command{
Use: "list",
Short: "List channels",
Use: "list",
Short: "List channels (alias: 'ls')",
Aliases: []string{"ls"},
Example: `
# List all channels
kn channel list
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/plugin/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ func NewPluginListCommand(p *commands.KnParams) *cobra.Command {

plFlags := pluginListFlags{}
pluginListCommand := &cobra.Command{
Use: "list",
Short: "List plugins",
Use: "list",
Short: "List plugins (alias: 'ls')",
Aliases: []string{"ls"},
Long: `List all installed plugins.
Available plugins are those that are:
Expand Down
2 changes: 1 addition & 1 deletion pkg/kn/commands/plugin/list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestPluginListBasic(t *testing.T) {
}

assert.Assert(t, pluginListCmd.Use == "list")
assert.Assert(t, pluginListCmd.Short == "List plugins")
assert.Assert(t, pluginListCmd.Short == "List plugins(alias: 'ls')")
assert.Assert(t, strings.Contains(pluginListCmd.Long, "List all installed plugins"))
assert.Assert(t, pluginListCmd.RunE != nil)
}
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/plugin/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import (

func NewPluginCommand(p *commands.KnParams) *cobra.Command {
pluginCmd := &cobra.Command{
Use: "plugin",
Short: "Manage kn plugins",
Use: "plugin",
Short: "Manage kn plugins",
Aliases: []string{"plugins"},
Long: `Manage kn plugins
Plugins provide extended functionality that is not part of the core kn command-line distribution.
Expand Down
7 changes: 4 additions & 3 deletions pkg/kn/commands/revision/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ func NewRevisionListCommand(p *commands.KnParams) *cobra.Command {
revisionListFlags := flags.NewListPrintFlags(RevisionListHandlers)

revisionListCommand := &cobra.Command{
Use: "list",
Short: "List revisions",
Long: "List revisions for a given service.",
Use: "list",
Short: "List revisions (alias: 'ls')",
Aliases: []string{"ls"},
Long: "List revisions for a given service.",
Example: `
# List all revisions
kn revision list
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/revision/revision.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ import (

func NewRevisionCommand(p *commands.KnParams) *cobra.Command {
revisionCmd := &cobra.Command{
Use: "revision",
Short: "Manage service revisions",
Use: "revision",
Short: "Manage service revisions",
Aliases: []string{"revisions"},
}
revisionCmd.AddCommand(NewRevisionListCommand(p))
revisionCmd.AddCommand(NewRevisionDescribeCommand(p))
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/route/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ import (
func NewRouteListCommand(p *commands.KnParams) *cobra.Command {
routeListFlags := flags.NewListPrintFlags(RouteListHandlers)
routeListCommand := &cobra.Command{
Use: "list NAME",
Short: "List routes",
Use: "list NAME",
Short: "List routes (alias: 'ls')",
Aliases: []string{"ls"},
Example: `
# List all routes
kn route list
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/route/route.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@ import (

func NewRouteCommand(p *commands.KnParams) *cobra.Command {
routeCmd := &cobra.Command{
Use: "route",
Short: "List and describe service routes",
Use: "route",
Short: "List and describe service routes",
Aliases: []string{"routes"},
}
routeCmd.AddCommand(NewRouteListCommand(p))
routeCmd.AddCommand(NewRouteDescribeCommand(p))
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/service/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ func NewServiceListCommand(p *commands.KnParams) *cobra.Command {
serviceListFlags := flags.NewListPrintFlags(ServiceListHandlers)

serviceListCommand := &cobra.Command{
Use: "list",
Short: "List services",
Use: "list",
Short: "List services (alias: 'ls')",
Aliases: []string{"ls"},
Example: `
# List all services
kn service list
Expand Down
13 changes: 13 additions & 0 deletions pkg/kn/commands/service/list_mock_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,19 @@ func TestServiceListWithTwoSrvNameMock(t *testing.T) {
r.Validate()
}

func TestServiceListWithTwoSrvNameAliasMock(t *testing.T) {
// New mock client
client := clientservingv1.NewMockKnServiceClient(t)

// Recording:
r := client.Recorder()

_, err := executeServiceCommand(client, "ls", "foo", "bar")
assert.ErrorContains(t, err, "'kn service list' accepts maximum 1 argument")

r.Validate()
}

func getServiceWithNamespace(name, namespace string) *servingv1.Service {
service := servingv1.Service{}
service.Name = name
Expand Down
18 changes: 18 additions & 0 deletions pkg/kn/commands/service/list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,24 @@ func TestServiceGetWithTwoSrvName(t *testing.T) {
_, _, err := fakeServiceList([]string{"service", "list", "foo", "bar"}, serviceList)
assert.ErrorContains(t, err, "'kn service list' accepts maximum 1 argument")
}
func TestServiceListWithAlias(t *testing.T) {
service1 := createMockServiceWithParams("foo", "default", "http://foo.default.example.com", "foo-xyz")
service3 := createMockServiceWithParams("sss", "default", "http://sss.default.example.com", "sss-xyz")
service2 := createMockServiceWithParams("bar", "default", "http://bar.default.example.com", "bar-xyz")
serviceList := &servingv1.ServiceList{Items: []servingv1.Service{*service1, *service2, *service3}}
action, output, err := fakeServiceList([]string{"service", "ls"}, serviceList)
assert.NilError(t, err)
if action == nil {
t.Errorf("No action")
} else if !action.Matches("list", "services") {
t.Errorf("Bad action %v", action)
}
// Outputs in alphabetical order
assert.Check(t, util.ContainsAll(output[0], "NAME", "URL", "LATEST", "AGE", "CONDITIONS", "READY", "REASON"))
assert.Check(t, util.ContainsAll(output[1], "bar", "bar.default.example.com", "bar-xyz"))
assert.Check(t, util.ContainsAll(output[2], "foo", "foo.default.example.com", "foo-xyz"))
assert.Check(t, util.ContainsAll(output[3], "sss", "sss.default.example.com", "sss-xyz"))
}

func createMockServiceWithParams(name, namespace, urlS string, revision string) *servingv1.Service {
url, _ := apis.ParseURL(urlS)
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/service/service.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ const (

func NewServiceCommand(p *commands.KnParams) *cobra.Command {
serviceCmd := &cobra.Command{
Use: "service",
Short: "Manage Knative services",
Use: "service",
Short: "Manage Knative services",
Aliases: []string{"ksvc", "services"},
}
serviceCmd.AddCommand(NewServiceListCommand(p))
serviceCmd.AddCommand(NewServiceDescribeCommand(p))
Expand Down
3 changes: 2 additions & 1 deletion pkg/kn/commands/source/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ func NewListCommand(p *commands.KnParams) *cobra.Command {
listFlags := flags.NewListPrintFlags(ListHandlers)
listCommand := &cobra.Command{
Use: "list",
Short: "List event sources",
Short: "List event sources (alias: 'ls')",
Aliases: []string{"ls"},
Example: listExample,
RunE: func(cmd *cobra.Command, args []string) error {
namespace, err := p.GetNamespace(cmd)
Expand Down
Loading

0 comments on commit ee2a66e

Please sign in to comment.