refactor: moved clihelpers to ory/x (#756)

Contributes to ory/hydra#2124.

Co-authored-by: aeneasr <3372410+aeneasr@users.noreply.github.com>

cmd/identities/definitions.go

@@ -3,7 +3,8 @@ package identities
 import (
 	"strings"
 
-	"github.com/ory/kratos/internal/clihelpers"
+	"github.com/ory/x/cmdx"
+
 	"github.com/ory/kratos/internal/httpclient/models"
 )
 
@@ -21,10 +22,10 @@ func (_ *outputIdentity) Header() []string {
 func (i *outputIdentity) Fields() []string {
 	data := [5]string{
 		string(i.ID),
-		clihelpers.None,
-		clihelpers.None,
-		clihelpers.None,
-		clihelpers.None,
+		cmdx.None,
+		cmdx.None,
+		cmdx.None,
+		cmdx.None,
 	}
 
 	addresses := make([]string, 0, len(i.VerifiableAddresses))
@@ -67,10 +68,10 @@ func (c *outputIdentityCollection) Table() [][]string {
 	for i, ident := range c.identities {
 		data := [5]string{
 			string(ident.ID),
-			clihelpers.None,
-			clihelpers.None,
-			clihelpers.None,
-			clihelpers.None,
+			cmdx.None,
+			cmdx.None,
+			cmdx.None,
+			cmdx.None,
 		}
 
 		if len(ident.VerifiableAddresses) != 0 && ident.VerifiableAddresses[0].Value != nil {

cmd/identities/delete.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/ory/kratos/internal/clihelpers"
 
 	"github.com/spf13/cobra"
@@ -49,7 +51,7 @@ var deleteCmd = &cobra.Command{
 		}
 
 		if len(errs) != 0 {
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 		return nil
 	},

cmd/identities/get.go

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/ory/kratos/internal/clihelpers"
 	"github.com/ory/kratos/internal/httpclient/models"
 
@@ -40,14 +42,14 @@ var getCmd = &cobra.Command{
 		}
 
 		if len(identities) == 1 {
-			clihelpers.PrintRow(cmd, (*outputIdentity)(identities[0]))
+			cmdx.PrintRow(cmd, (*outputIdentity)(identities[0]))
 		} else {
-			clihelpers.PrintCollection(cmd, &outputIdentityCollection{identities})
+			cmdx.PrintCollection(cmd, &outputIdentityCollection{identities})
 		}
-		clihelpers.PrintErrors(cmd, failed)
+		cmdx.PrintErrors(cmd, failed)
 
 		if len(failed) != 0 {
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 		return nil
 	},

cmd/identities/helpers.go

@@ -8,6 +8,8 @@ import (
 	"io/ioutil"
 	"testing"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/pkg/errors"
 	"github.com/tidwall/gjson"
 
@@ -20,7 +22,6 @@ import (
 	"github.com/ory/kratos/driver"
 	"github.com/ory/kratos/driver/configuration"
 	"github.com/ory/kratos/internal"
-	"github.com/ory/kratos/internal/clihelpers"
 	"github.com/ory/kratos/internal/testhelpers"
 	"github.com/ory/viper"
 )
@@ -43,7 +44,7 @@ func readIdentities(cmd *cobra.Command, args []string) (map[string]string, error
 		fc, err := ioutil.ReadAll(cmd.InOrStdin())
 		if err != nil {
 			_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "STD_IN: Could not read: %s\n", err)
-			return nil, clihelpers.FailSilently(cmd)
+			return nil, cmdx.FailSilently(cmd)
 		}
 		for i, id := range parseIdentities(fc) {
 			rawIdentities[fmt.Sprintf("STD_IN[%d]", i)] = id
@@ -54,7 +55,7 @@ func readIdentities(cmd *cobra.Command, args []string) (map[string]string, error
 		fc, err := ioutil.ReadFile(fn)
 		if err != nil {
 			_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s: Could not open identity file: %s\n", fn, err)
-			return nil, clihelpers.FailSilently(cmd)
+			return nil, cmdx.FailSilently(cmd)
 		}
 		for i, id := range parseIdentities(fc) {
 			rawIdentities[fmt.Sprintf("%s[%d]", fn, i)] = id
@@ -69,9 +70,9 @@ func setup(t *testing.T, cmd *cobra.Command) driver.Registry {
 	viper.Set(configuration.ViperKeyDefaultIdentitySchemaURL, "file://./stubs/identity.schema.json")
 	// setup command
 	cliclient.RegisterClientFlags(cmd.Flags())
-	clihelpers.RegisterFormatFlags(cmd.Flags())
+	cmdx.RegisterFormatFlags(cmd.Flags())
 	require.NoError(t, cmd.Flags().Set(cliclient.FlagEndpoint, admin.URL))
-	require.NoError(t, cmd.Flags().Set(clihelpers.FlagFormat, string(clihelpers.FormatJSON)))
+	require.NoError(t, cmd.Flags().Set(cmdx.FlagFormat, string(cmdx.FormatJSON)))
 	return reg
 }
 
@@ -98,7 +99,7 @@ func execNoErr(t *testing.T, cmd *cobra.Command, args ...string) string {
 
 func execErr(t *testing.T, cmd *cobra.Command, args ...string) string {
 	stdOut, stdErr, err := exec(cmd, nil, args...)
-	require.True(t, errors.Is(err, clihelpers.NoPrintButFailError))
+	require.True(t, errors.Is(err, cmdx.ErrNoPrintButFail))
 	require.Len(t, stdOut, 0, stdErr)
 	return stdErr
 }

cmd/identities/import.go

@@ -5,9 +5,9 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/spf13/cobra"
+	"github.com/ory/x/cmdx"
 
-	"github.com/ory/kratos/internal/clihelpers"
+	"github.com/spf13/cobra"
 
 	"github.com/ory/kratos/cmd/cliclient"
 	"github.com/ory/kratos/internal/httpclient/client/admin"
@@ -46,7 +46,7 @@ WARNING: Importing credentials is not yet supported.`,
 			err = json.Unmarshal([]byte(i), &params)
 			if err != nil {
 				_, _ = fmt.Fprintln(cmd.ErrOrStderr(), "STD_IN: Could not parse identity")
-				return clihelpers.FailSilently(cmd)
+				return cmdx.FailSilently(cmd)
 			}
 
 			resp, err := c.Admin.CreateIdentity(&admin.CreateIdentityParams{
@@ -60,14 +60,14 @@ WARNING: Importing credentials is not yet supported.`,
 			}
 		}
 		if len(imported) == 1 {
-			clihelpers.PrintRow(cmd, (*outputIdentity)(imported[0]))
+			cmdx.PrintRow(cmd, (*outputIdentity)(imported[0]))
 		} else {
-			clihelpers.PrintCollection(cmd, &outputIdentityCollection{identities: imported})
+			cmdx.PrintCollection(cmd, &outputIdentityCollection{identities: imported})
 		}
-		clihelpers.PrintErrors(cmd, failed)
+		cmdx.PrintErrors(cmd, failed)
 
 		if len(failed) != 0 {
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 
 		return nil

cmd/identities/import_test.go

@@ -8,13 +8,14 @@ import (
 	"io/ioutil"
 	"testing"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/gofrs/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/tidwall/gjson"
 
 	"github.com/ory/kratos/driver/configuration"
-	"github.com/ory/kratos/internal/clihelpers"
 	"github.com/ory/kratos/internal/httpclient/models"
 	"github.com/ory/x/pointerx"
 )
@@ -123,7 +124,7 @@ func TestImportCmd(t *testing.T) {
 	t.Run("case=fails to import invalid identity", func(t *testing.T) {
 		// validation is further tested with the validate command
 		stdOut, stdErr, err := exec(importCmd, bytes.NewBufferString("{}"))
-		assert.True(t, errors.Is(err, clihelpers.NoPrintButFailError))
+		assert.True(t, errors.Is(err, cmdx.ErrNoPrintButFail))
 		assert.Contains(t, stdErr, "STD_IN[0]: not valid")
 		assert.Len(t, stdOut, 0)
 	})

cmd/identities/list.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"strconv"
 
-	"github.com/ory/kratos/internal/clihelpers"
+	"github.com/ory/x/cmdx"
 
 	"github.com/spf13/cobra"
 
@@ -36,25 +36,25 @@ var listCmd = &cobra.Command{
 			page, err := strconv.ParseInt(args[0], 0, 64)
 			if err != nil {
 				_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "Could not parse page argument\"%s\": %s", args[0], err)
-				return clihelpers.FailSilently(cmd)
+				return cmdx.FailSilently(cmd)
 			}
 			params.Page = &page
 
 			perPage, err := strconv.ParseInt(args[1], 0, 64)
 			if err != nil {
 				_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "Could not parse per-page argument\"%s\": %s", args[1], err)
-				return clihelpers.FailSilently(cmd)
+				return cmdx.FailSilently(cmd)
 			}
 			params.PerPage = &perPage
 		}
 
 		resp, err := c.Admin.ListIdentities(params)
 		if err != nil {
 			_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "Could not get the identities: %+v\n", err)
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 
-		clihelpers.PrintCollection(cmd, &outputIdentityCollection{
+		cmdx.PrintCollection(cmd, &outputIdentityCollection{
 			identities: resp.Payload,
 		})
 

cmd/identities/list_test.go

@@ -5,16 +5,17 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
 	"github.com/ory/kratos/identity"
-	"github.com/ory/kratos/internal/clihelpers"
 )
 
 func TestListCmd(t *testing.T) {
 	reg := setup(t, listCmd)
-	require.NoError(t, listCmd.Flags().Set(clihelpers.FlagQuiet, "true"))
+	require.NoError(t, listCmd.Flags().Set(cmdx.FlagQuiet, "true"))
 
 	var deleteIdentities = func(t *testing.T, is []*identity.Identity) {
 		for _, i := range is {

cmd/identities/root.go

@@ -3,7 +3,7 @@ package identities
 import (
 	"github.com/spf13/cobra"
 
-	"github.com/ory/kratos/internal/clihelpers"
+	"github.com/ory/x/cmdx"
 
 	"github.com/ory/kratos/cmd/cliclient"
 )
@@ -27,5 +27,5 @@ func RegisterCommandRecursive(parent *cobra.Command) {
 
 func init() {
 	cliclient.RegisterClientFlags(identitiesCmd.PersistentFlags())
-	clihelpers.RegisterFormatFlags(identitiesCmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(identitiesCmd.PersistentFlags())
 }

cmd/identities/validate.go

@@ -6,15 +6,15 @@ import (
 	"encoding/json"
 	"fmt"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/markbates/pkger"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	"github.com/tidwall/gjson"
 
 	"github.com/ory/kratos/internal/httpclient/client/public"
 
-	"github.com/ory/kratos/internal/clihelpers"
-
 	"github.com/ory/jsonschema/v3"
 	"github.com/ory/kratos/cmd/cliclient"
 	"github.com/ory/x/viperx"
@@ -95,7 +95,7 @@ func validateIdentity(cmd *cobra.Command, src, i string, getRemoteSchema schemaG
 	sid := gjson.Get(i, "schema_id")
 	if !sid.Exists() {
 		_, _ = fmt.Fprintf(cmd.ErrOrStderr(), `%s: Expected key "schema_id" to be defined in identity file`, src)
-		return clihelpers.FailSilently(cmd)
+		return cmdx.FailSilently(cmd)
 	}
 
 	customSchema, ok := schemas[sid.String()]
@@ -104,7 +104,7 @@ func validateIdentity(cmd *cobra.Command, src, i string, getRemoteSchema schemaG
 		ts, err := getRemoteSchema(&public.GetSchemaParams{ID: sid.String(), Context: context.Background()})
 		if err != nil {
 			_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s: Could not fetch schema with ID \"%s\": %s\n", src, sid.String(), err)
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 		sf, err := json.Marshal(ts.Payload)
 		if err != nil {
@@ -115,7 +115,7 @@ func validateIdentity(cmd *cobra.Command, src, i string, getRemoteSchema schemaG
 		customSchema, err = jsonschema.CompileString("identity_traits.schema.json", string(sf))
 		if err != nil {
 			_, _ = fmt.Fprintf(cmd.ErrOrStderr(), "%s: Could not compile the traits schema: %s\n", src, err)
-			return clihelpers.FailSilently(cmd)
+			return cmdx.FailSilently(cmd)
 		}
 		schemas[sid.String()] = customSchema
 	}
@@ -129,7 +129,7 @@ func validateIdentity(cmd *cobra.Command, src, i string, getRemoteSchema schemaG
 	}
 
 	if foundValidationErrors {
-		return clihelpers.FailSilently(cmd)
+		return cmdx.FailSilently(cmd)
 	}
 	return nil
 }

cmd/remote/root.go

@@ -3,8 +3,9 @@ package remote
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/ory/kratos/cmd/cliclient"
-	"github.com/ory/kratos/internal/clihelpers"
 )
 
 var remoteCmd = &cobra.Command{
@@ -21,5 +22,5 @@ func RegisterCommandRecursive(parent *cobra.Command) {
 
 func init() {
 	cliclient.RegisterClientFlags(remoteCmd.PersistentFlags())
-	clihelpers.RegisterFormatFlags(remoteCmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(remoteCmd.PersistentFlags())
 }

cmd/remote/status.go

@@ -3,10 +3,11 @@ package remote
 import (
 	"context"
 
+	"github.com/ory/x/cmdx"
+
 	"github.com/spf13/cobra"
 
 	"github.com/ory/kratos/cmd/cliclient"
-	"github.com/ory/kratos/internal/clihelpers"
 	"github.com/ory/kratos/internal/httpclient/client/health"
 )
 
@@ -44,7 +45,7 @@ var statusCmd = &cobra.Command{
 	Run: func(cmd *cobra.Command, args []string) {
 		c := cliclient.NewClient(cmd)
 		state := &statusState{}
-		defer clihelpers.PrintRow(cmd, state)
+		defer cmdx.PrintRow(cmd, state)
 
 		_, err := c.Health.IsInstanceAlive(&health.IsInstanceAliveParams{
 			Context: context.Background(),

cmd/remote/version.go

@@ -6,7 +6,6 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/ory/kratos/cmd/cliclient"
-	"github.com/ory/kratos/internal/clihelpers"
 	"github.com/ory/kratos/internal/httpclient/client/version"
 	"github.com/ory/x/cmdx"
 )
@@ -37,6 +36,6 @@ var versionCmd = &cobra.Command{
 		resp, err := c.Version.GetVersion(&version.GetVersionParams{Context: context.Background()})
 		cmdx.Must(err, "Could not get version: %s", err)
 
-		clihelpers.PrintRow(cmd, (*versionValue)(resp.Payload))
+		cmdx.PrintRow(cmd, (*versionValue)(resp.Payload))
 	},
 }