refactor: move CLI commands to match Ory CLI structure

BREAKING CHANGE: This patch moves several CLI command to comply with the Ory CLI command structure: ```patch - ory identities get ... + ory get identity ... - ory identities delete ... + ory delete identity ... - ory identities import ... + ory import identity ... - ory identities list ... + ory list identities ... - ory identities validate ... + ory validate identity ... - ory jsonnet format ... + ory format jsonnet ... - ory jsonnet lint ... + ory lint jsonnet ... ```
ory · Apr 5, 2022 · 73910a3 · 73910a3
1 parent aee2b1e
commit 73910a3
Show file tree

Hide file tree

Showing 15 changed files with 137 additions and 124 deletions.
diff --git a/cmd/identities/delete.go b/cmd/identities/delete.go
@@ -10,17 +10,27 @@ import (
 	"github.com/ory/x/cmdx"
 )
 
-func NewDeleteCmd() *cobra.Command {
+func NewDeleteCmd(root *cobra.Command) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "delete",
+		Short: "Delete resources",
+	}
+	cmd.AddCommand(NewDeleteIdentityCmd(root))
+	cliclient.RegisterClientFlags(cmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(cmd.PersistentFlags())
+	return cmd
+}
+
+func NewDeleteIdentityCmd(root *cobra.Command) *cobra.Command {
 	return &cobra.Command{
-		Use:   "delete <id-0 [id-1 ...]>",
-		Short: "Delete identities by ID",
+		Use:   "identity id-0 [id-1] [id-2] [id-n]",
+		Short: "Delete one or more identities by their ID(s)",
 		Long: fmt.Sprintf(`This command deletes one or more identities by ID. To delete an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.
 
-%s
-`, clihelpers.WarningJQIsComplicated),
-		Example: `To delete the identity with the recovery email address "foo@bar.com", run:
+%s`, clihelpers.WarningJQIsComplicated),
+		Example: fmt.Sprintf(`To delete the identity with the recovery email address "foo@bar.com", run:
 
-	$ kratos identities delete $(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value == "foo@bar.com")) | .[].id')`,
+	%[1]s delete identity $(%[1]s list identities --format json | jq -r 'map(select(.recovery_addresses[].value == "foo@bar.com")) | .[].id')`, root.Use),
 		Args: cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			c := cliclient.NewClient(cmd)

diff --git a/cmd/identities/delete_test.go b/cmd/identities/delete_test.go
@@ -6,6 +6,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/spf13/cobra"
+
 	"github.com/ory/kratos/cmd/identities"
 
 	"github.com/stretchr/testify/assert"
@@ -18,7 +20,7 @@ import (
 )
 
 func TestDeleteCmd(t *testing.T) {
-	c := identities.NewDeleteCmd()
+	c := identities.NewDeleteIdentityCmd(new(cobra.Command))
 	reg := setup(t, c)
 
 	t.Run("case=deletes successfully", func(t *testing.T) {

diff --git a/cmd/identities/get.go b/cmd/identities/get.go
@@ -19,21 +19,31 @@ const (
 	FlagIncludeCreds = "include-credentials"
 )
 
-func NewGetCmd() *cobra.Command {
+func NewGetCmd(root *cobra.Command) *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:   "get",
+		Short: "Get resources",
+	}
+	cmd.AddCommand(NewGetIdentityCmd(root))
+	cliclient.RegisterClientFlags(cmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(cmd.PersistentFlags())
+	return cmd
+}
+
+func NewGetIdentityCmd(root *cobra.Command) *cobra.Command {
 	var (
 		includeCreds []string
 	)
 
 	cmd := &cobra.Command{
-		Use:   "get <id-0 [id-1 ...]>",
-		Short: "Get one or more identities by ID",
+		Use:   "identity [id-1] [id-2] [id-n]",
+		Short: "Get one or more identities by their ID(s)",
 		Long: fmt.Sprintf(`This command gets all the details about an identity. To get an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.
 
-%s
-`, clihelpers.WarningJQIsComplicated),
-		Example: `To get the identities with the recovery email address at the domain "ory.sh", run:
+%s`, clihelpers.WarningJQIsComplicated),
+		Example: fmt.Sprintf(`To get the identities with the recovery email address at the domain "ory.sh", run:
 
-	$ kratos identities get $(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')`,
+	%s get identity $(%[1]s ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')`, root.Use),
 		Args: cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			c := cliclient.NewClient(cmd)

diff --git a/cmd/identities/get_test.go b/cmd/identities/get_test.go
@@ -6,6 +6,8 @@ import (
 	"encoding/json"
 	"testing"
 
+	"github.com/spf13/cobra"
+
 	"github.com/ory/kratos/cmd/identities"
 	"github.com/ory/x/assertx"
 
@@ -19,7 +21,7 @@ import (
 )
 
 func TestGetCmd(t *testing.T) {
-	c := identities.NewGetCmd()
+	c := identities.NewGetIdentityCmd(new(cobra.Command))
 	reg := setup(t, c)
 
 	t.Run("case=gets a single identity", func(t *testing.T) {

diff --git a/cmd/identities/import.go b/cmd/identities/import.go
@@ -15,23 +15,38 @@ import (
 	"github.com/ory/kratos/cmd/cliclient"
 )
 
-// NewImportCmd represents the import command
-func NewImportCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:   "import <file.json [file-2.json [file-3.json] ...]>",
-		Short: "Import identities from files or STD_IN",
-		Example: `$ cat > ./file.json <<EOF
-{
-    "schema_id": "default",
-    "traits": {
-        "email": "foo@example.com"
-    }
+func NewImportCmd(root *cobra.Command) *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:   "import",
+		Short: "Import resources",
+	}
+	cmd.AddCommand(NewImportIdentitiesCmd(root))
+	cliclient.RegisterClientFlags(cmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(cmd.PersistentFlags())
+	return cmd
 }
-EOF
 
-$ kratos identities import file.json
-# Alternatively:
-$ cat file.json | kratos identities import`,
+// NewImportIdentitiesCmd represents the import command
+func NewImportIdentitiesCmd(root *cobra.Command) *cobra.Command {
+	return &cobra.Command{
+		Use:   "identities file-1.json [file-2.json] [file-3.json] [file-n.json]",
+		Short: "Import one or more identities from files or STD_IN",
+		Example: fmt.Sprintf(`Create an example identity:
+
+	cat > ./file.json <<EOF
+	{
+	    "schema_id": "default",
+	    "traits": {
+	        "email": "foo@example.com"
+	    }
+	}
+	EOF
+
+	%[1]s import identities file.json
+
+Alternatively:
+
+	cat file.json | %[1]s import identities`, root.Use),
 		Long: `Import identities from files or STD_IN.
 
 Files can contain only a single or an array of identities. The validity of files can be tested beforehand using "... identities validate".

diff --git a/cmd/identities/import_test.go b/cmd/identities/import_test.go
@@ -8,6 +8,8 @@ import (
 	"io/ioutil"
 	"testing"
 
+	"github.com/spf13/cobra"
+
 	"github.com/ory/kratos/cmd/identities"
 
 	"github.com/gofrs/uuid"
@@ -21,7 +23,7 @@ import (
 )
 
 func TestImportCmd(t *testing.T) {
-	c := identities.NewImportCmd()
+	c := identities.NewImportIdentitiesCmd(new(cobra.Command))
 	reg := setup(t, c)
 
 	t.Run("case=imports a new identity from file", func(t *testing.T) {

diff --git a/cmd/identities/list.go b/cmd/identities/list.go
@@ -11,11 +11,24 @@ import (
 	"github.com/ory/kratos/cmd/cliclient"
 )
 
-func NewListCmd() *cobra.Command {
+func NewListCmd(root *cobra.Command) *cobra.Command {
+	c := &cobra.Command{
+		Use:     "list",
+		Aliases: []string{"ls"},
+		Short:   "List resources",
+	}
+	c.AddCommand(NewListIdentitiesCmd(root))
+	cliclient.RegisterClientFlags(c.PersistentFlags())
+	cmdx.RegisterFormatFlags(c.PersistentFlags())
+	return c
+}
+
+func NewListIdentitiesCmd(root *cobra.Command) *cobra.Command {
 	return &cobra.Command{
-		Use:   "list [<page> <per-page>]",
-		Short: "List identities",
-		Long:  "List identities (paginated)",
+		Use:     "identities [<page> <per-page>]",
+		Short:   "List identities",
+		Long:    "List identities (paginated)",
+		Example: fmt.Sprintf("%[1]s ls identities 100 1", root.Use),
 		Args: func(cmd *cobra.Command, args []string) error {
 			// zero or exactly two args
 			if len(args) != 0 && len(args) != 2 {

diff --git a/cmd/identities/list_test.go b/cmd/identities/list_test.go
@@ -5,6 +5,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/spf13/cobra"
+
 	"github.com/ory/kratos/cmd/identities"
 
 	"github.com/ory/x/cmdx"
@@ -16,7 +18,7 @@ import (
 )
 
 func TestListCmd(t *testing.T) {
-	c := identities.NewListCmd()
+	c := identities.NewListIdentitiesCmd(new(cobra.Command))
 	reg := setup(t, c)
 	require.NoError(t, c.Flags().Set(cmdx.FlagQuiet, "true"))
 

diff --git a/cmd/identities/patch.go b/cmd/identities/patch.go
diff --git a/cmd/identities/root.go b/cmd/identities/root.go
diff --git a/cmd/identities/validate.go b/cmd/identities/validate.go
@@ -22,13 +22,24 @@ import (
 )
 
 func NewValidateCmd() *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:   "validate",
+		Short: "Validate resources",
+	}
+	cmd.AddCommand(NewValidateIdentityCmd())
+	cliclient.RegisterClientFlags(cmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(cmd.PersistentFlags())
+	return cmd
+
+}
+
+func NewValidateIdentityCmd() *cobra.Command {
 	var c = &cobra.Command{
-		Use:   "validate <file.json [file-2.json [file-3.json] ...]>",
+		Use:   "identity file.json [file-2.json] [file-3.json] [file-n.json]",
 		Short: "Validate local identity files",
 		Long: `This command allows validation of identity files.
 It validates against the payload of the API and the identity schema as configured in Ory Kratos.
-Identities can be supplied via STD_IN or JSON files containing a single or an array of identities.
-`,
+Identities can be supplied via STD_IN or JSON files containing a single or an array of identities.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			c := cliclient.NewClient(cmd)
 

diff --git a/cmd/jsonnet/format.go b/cmd/jsonnet/format.go
@@ -12,9 +12,18 @@ import (
 	"github.com/ory/x/flagx"
 )
 
+func NewFormatCmd() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "format",
+		Short: "Helpers for formatting code",
+	}
+	c.AddCommand(NewJsonnetFormatCmd())
+	return c
+}
+
 func NewJsonnetFormatCmd() *cobra.Command {
 	c := &cobra.Command{
-		Use: "format path/to/files/*.jsonnet [more/files.jsonnet, [supports/**/{foo,bar}.jsonnet]]",
+		Use: "jsonnet path/to/files/*.jsonnet [more/files.jsonnet] [supports/**/{foo,bar}.jsonnet]",
 		Long: `Formats JSONNet files using the official JSONNet formatter.
 
 Use -w or --write to write output back to files instead of stdout.

diff --git a/cmd/jsonnet/lint.go b/cmd/jsonnet/lint.go
@@ -14,9 +14,18 @@ import (
 	"github.com/ory/x/cmdx"
 )
 
+func NewLintCmd() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "lint",
+		Short: "Helpers for linting code",
+	}
+	c.AddCommand(NewJsonnetLintCmd())
+	return c
+}
+
 func NewJsonnetLintCmd() *cobra.Command {
 	return &cobra.Command{
-		Use: "lint path/to/files/*.jsonnet [more/files.jsonnet, [supports/**/{foo,bar}.jsonnet]]",
+		Use: "lint path/to/files/*.jsonnet [more/files.jsonnet] [supports/**/{foo,bar}.jsonnet]",
 		Long: `Lints JSONNet files using the official JSONNet linter and exits with a status code of 1 when issues are detected.
 
 ` + GlobHelp,

diff --git a/cmd/jsonnet/root.go b/cmd/jsonnet/root.go
@@ -1,9 +1,5 @@
 package jsonnet
 
-import (
-	"github.com/spf13/cobra"
-)
-
 const GlobHelp = `Glob Syntax:
 
     pattern:
@@ -28,20 +24,3 @@ const GlobHelp = `Glob Syntax:
     pattern-list:
         pattern { ',' pattern }
                     comma-separated (without spaces) patterns`
-
-func NewJsonnetCmd() *cobra.Command {
-	c := &cobra.Command{
-		Use:   "jsonnet",
-		Short: "Helpers for linting and formatting JSONNet code",
-	}
-
-	return c
-}
-
-func RegisterCommandRecursive(parent *cobra.Command) {
-	c := NewJsonnetCmd()
-	parent.AddCommand(c)
-
-	c.AddCommand(NewJsonnetFormatCmd())
-	c.AddCommand(NewJsonnetLintCmd())
-}