feat: make cli commands consumable in Ory Cloud

cmd/cliclient/client.go

@@ -9,7 +9,7 @@ import (
 
  "github.com/spf13/pflag"
 
- "github.com/ory/kratos/internal/httpclient/client"
+ "github.com/ory/kratos-client-go/client"
  "github.com/ory/x/cmdx"
 )
 
@@ -18,7 +18,17 @@ const (
  FlagEndpoint = "endpoint"
 )
 
+type ContextKey int
+
+const (
+ ClientContextKey ContextKey = iota + 1
+)
+
 func NewClient(cmd *cobra.Command) *client.OryKratos {
+ if f, ok := cmd.Context().Value(ClientContextKey).(func(cmd *cobra.Command) *client.OryKratos); ok {
+ return f(cmd)
+ }
+
  endpoint, err := cmd.Flags().GetString(FlagEndpoint)
  cmdx.Must(err, "flag access error: %s", err)
 

cmd/identities/definitions.go

@@ -5,7 +5,7 @@ import (
 
  "github.com/ory/x/cmdx"
 
- "github.com/ory/kratos/internal/httpclient/models"
+ "github.com/ory/kratos-client-go/models"
 )
 
 type (

cmd/identities/delete.go

@@ -2,19 +2,15 @@ package identities
 
 import (
  "fmt"
+ "github.com/ory/kratos-client-go/client/admin"
  "time"
-
  "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"
 )
 
-var deleteCmd = &cobra.Command{
+var DeleteCmd = &cobra.Command{
  Use: "delete <id-0 [id-1 ...]>",
  Short: "Delete identities by ID",
  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.

cmd/identities/delete_test.go

@@ -16,14 +16,14 @@ import (
 )
 
 func TestDeleteCmd(t *testing.T) {
- reg := setup(t, deleteCmd)
+ reg := setup(t, DeleteCmd)
 
  t.Run("case=deletes successfully", func(t *testing.T) {
  // create identity to delete
  i := identity.NewIdentity(config.DefaultIdentityTraitsSchemaID)
  require.NoError(t, reg.Persister().CreateIdentity(context.Background(), i))
 
- stdOut := execNoErr(t, deleteCmd, i.ID.String())
+ stdOut := execNoErr(t, DeleteCmd, i.ID.String())
 
  // expect ID and no error
  assert.Equal(t, i.ID.String()+"\n", stdOut)
@@ -36,7 +36,7 @@ func TestDeleteCmd(t *testing.T) {
  t.Run("case=deletes three identities", func(t *testing.T) {
  is, ids := makeIdentities(t, reg, 3)
 
- stdOut := execNoErr(t, deleteCmd, ids...)
+ stdOut := execNoErr(t, DeleteCmd, ids...)
 
  assert.Equal(t, strings.Join(ids, "\n")+"\n", stdOut)
 
@@ -47,7 +47,7 @@ func TestDeleteCmd(t *testing.T) {
  })
 
  t.Run("case=fails with unknown ID", func(t *testing.T) {
- stdErr := execErr(t, deleteCmd, x.NewUUID().String())
+ stdErr := execErr(t, DeleteCmd, x.NewUUID().String())
 
  assert.Contains(t, stdErr, "[DELETE /identities/{id}][404] deleteIdentityNotFound", stdErr)
  })

cmd/identities/get.go

@@ -2,20 +2,20 @@ package identities
 
 import (
  "fmt"
+ "github.com/ory/kratos-client-go/client/admin"
  "time"
 
  "github.com/ory/x/cmdx"
 
  "github.com/ory/kratos/internal/clihelpers"
- "github.com/ory/kratos/internal/httpclient/models"
+ "github.com/ory/kratos-client-go/models"
 
  "github.com/spf13/cobra"
 
  "github.com/ory/kratos/cmd/cliclient"
- "github.com/ory/kratos/internal/httpclient/client/admin"
 )
 
-var getCmd = &cobra.Command{
+var GetCmd = &cobra.Command{
  Use: "get <id-0 [id-1 ...]>",
  Short: "Get one or more identities by ID",
  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.

cmd/identities/get_test.go

@@ -15,13 +15,13 @@ import (
 )
 
 func TestGetCmd(t *testing.T) {
- reg := setup(t, getCmd)
+ reg := setup(t, GetCmd)
 
  t.Run("case=gets a single identity", func(t *testing.T) {
  i := identity.NewIdentity(config.DefaultIdentityTraitsSchemaID)
  require.NoError(t, reg.Persister().CreateIdentity(context.Background(), i))
 
- stdOut := execNoErr(t, getCmd, i.ID.String())
+ stdOut := execNoErr(t, GetCmd, i.ID.String())
 
  ij, err := json.Marshal(i)
  require.NoError(t, err)
@@ -32,7 +32,7 @@ func TestGetCmd(t *testing.T) {
  t.Run("case=gets three identities", func(t *testing.T) {
  is, ids := makeIdentities(t, reg, 3)
 
- stdOut := execNoErr(t, getCmd, ids...)
+ stdOut := execNoErr(t, GetCmd, ids...)
 
  isj, err := json.Marshal(is)
  require.NoError(t, err)
@@ -41,7 +41,7 @@ func TestGetCmd(t *testing.T) {
  })
 
  t.Run("case=fails with unknown ID", func(t *testing.T) {
- stdErr := execErr(t, getCmd, x.NewUUID().String())
+ stdErr := execErr(t, GetCmd, x.NewUUID().String())
 
  assert.Contains(t, stdErr, "status 404", stdErr)
  })

cmd/identities/import.go

@@ -10,12 +10,12 @@ import (
  "github.com/spf13/cobra"
 
  "github.com/ory/kratos/cmd/cliclient"
- "github.com/ory/kratos/internal/httpclient/client/admin"
- "github.com/ory/kratos/internal/httpclient/models"
+ "github.com/ory/kratos-client-go/client/admin"
+ "github.com/ory/kratos-client-go/models"
 )
 
-// importCmd represents the import command
-var importCmd = &cobra.Command{
+// ImportCmd represents the import command
+var ImportCmd = &cobra.Command{
  Use: "import <file.json [file-2.json [file-3.json] ...]>",
  Short: "Import identities from files or STD_IN",
  Example: `$ kratos identities import file.json

cmd/identities/import_test.go

@@ -16,12 +16,12 @@ import (
  "github.com/tidwall/gjson"
 
  "github.com/ory/kratos/driver/config"
- "github.com/ory/kratos/internal/httpclient/models"
+ "github.com/ory/kratos-client-go/models"
  "github.com/ory/x/pointerx"
 )
 
 func TestImportCmd(t *testing.T) {
- reg := setup(t, importCmd)
+ reg := setup(t, ImportCmd)
 
  t.Run("case=imports a new identity from file", func(t *testing.T) {
  i := models.CreateIdentity{
@@ -36,7 +36,7 @@ func TestImportCmd(t *testing.T) {
  require.NoError(t, err)
  require.NoError(t, f.Close())
 
- stdOut := execNoErr(t, importCmd, f.Name())
+ stdOut := execNoErr(t, ImportCmd, f.Name())
 
  id, err := uuid.FromString(gjson.Get(stdOut, "id").String())
  require.NoError(t, err)
@@ -63,7 +63,7 @@ func TestImportCmd(t *testing.T) {
  require.NoError(t, err)
  require.NoError(t, f.Close())
 
- stdOut := execNoErr(t, importCmd, f.Name())
+ stdOut := execNoErr(t, ImportCmd, f.Name())
 
  id, err := uuid.FromString(gjson.Get(stdOut, "0.id").String())
  require.NoError(t, err)
@@ -90,7 +90,7 @@ func TestImportCmd(t *testing.T) {
  ij, err := json.Marshal(i)
  require.NoError(t, err)
 
- stdOut, stdErr, err := exec(importCmd, bytes.NewBuffer(ij))
+ stdOut, stdErr, err := exec(ImportCmd, bytes.NewBuffer(ij))
  require.NoError(t, err, "%s %s", stdOut, stdErr)
 
  id, err := uuid.FromString(gjson.Get(stdOut, "0.id").String())
@@ -112,7 +112,7 @@ func TestImportCmd(t *testing.T) {
  ij, err := json.Marshal(i)
  require.NoError(t, err)
 
- stdOut, stdErr, err := exec(importCmd, bytes.NewBuffer(ij))
+ stdOut, stdErr, err := exec(ImportCmd, bytes.NewBuffer(ij))
  require.NoError(t, err, "%s %s", stdOut, stdErr)
 
  id, err := uuid.FromString(gjson.Get(stdOut, "id").String())
@@ -123,7 +123,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("{}"))
+ stdOut, stdErr, err := exec(ImportCmd, bytes.NewBufferString("{}"))
  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

@@ -1,7 +1,6 @@
 package identities
 
 import (
- "context"
  "fmt"
  "strconv"
 
@@ -10,10 +9,10 @@ import (
  "github.com/spf13/cobra"
 
  "github.com/ory/kratos/cmd/cliclient"
- "github.com/ory/kratos/internal/httpclient/client/admin"
+ "github.com/ory/kratos-client-go/client/admin"
 )
 
-var listCmd = &cobra.Command{
+var ListCmd = &cobra.Command{
  Use: "list [<page> <per-page>]",
  Short: "List identities",
  Long: "List identities (paginated)",
@@ -29,7 +28,7 @@ var listCmd = &cobra.Command{
  c := cliclient.NewClient(cmd)
 
  params := &admin.ListIdentitiesParams{
- Context: context.Background(),
+ Context: cmd.Context(),
  }
 
  if len(args) == 2 {

cmd/identities/list_test.go

@@ -14,8 +14,8 @@ import (
 )
 
 func TestListCmd(t *testing.T) {
- reg := setup(t, listCmd)
- require.NoError(t, listCmd.Flags().Set(cmdx.FlagQuiet, "true"))
+ reg := setup(t, ListCmd)
+ require.NoError(t, ListCmd.Flags().Set(cmdx.FlagQuiet, "true"))
 
  var deleteIdentities = func(t *testing.T, is []*identity.Identity) {
  for _, i := range is {
@@ -27,7 +27,7 @@ func TestListCmd(t *testing.T) {
  is, ids := makeIdentities(t, reg, 5)
  defer deleteIdentities(t, is)
 
- stdOut := execNoErr(t, listCmd)
+ stdOut := execNoErr(t, ListCmd)
 
  for _, i := range ids {
  assert.Contains(t, stdOut, i)
@@ -38,8 +38,8 @@ func TestListCmd(t *testing.T) {
  is, ids := makeIdentities(t, reg, 6)
  defer deleteIdentities(t, is)
 
- stdoutP1 := execNoErr(t, listCmd, "1", "3")
- stdoutP2 := execNoErr(t, listCmd, "2", "3")
+ stdoutP1 := execNoErr(t, ListCmd, "1", "3")
+ stdoutP2 := execNoErr(t, ListCmd, "2", "3")
 
  for _, id := range ids {
  // exactly one of page 1 and 2 should contain the id

cmd/identities/patch.go

@@ -7,7 +7,7 @@ import (
  "github.com/spf13/cobra"
 )
 
-var patchCmd = &cobra.Command{
+var PatchCmd = &cobra.Command{
  Use: "patch <file.json [file-2.json [file-3.json] ...]>",
  Short: "Patch identities by ID (not yet implemented)",
  Args: cobra.MinimumNArgs(1),

cmd/identities/root.go

@@ -17,15 +17,15 @@ var identitiesCmd = &cobra.Command{
 func RegisterCommandRecursive(parent *cobra.Command) {
  parent.AddCommand(identitiesCmd)
 
- identitiesCmd.AddCommand(importCmd)
- identitiesCmd.AddCommand(validateCmd)
- identitiesCmd.AddCommand(listCmd)
- identitiesCmd.AddCommand(getCmd)
- identitiesCmd.AddCommand(deleteCmd)
- identitiesCmd.AddCommand(patchCmd)
+ identitiesCmd.AddCommand(ImportCmd)
+ identitiesCmd.AddCommand(ValidateCmd)
+ identitiesCmd.AddCommand(ListCmd)
+ identitiesCmd.AddCommand(GetCmd)
+ identitiesCmd.AddCommand(DeleteCmd)
+ identitiesCmd.AddCommand(PatchCmd)
 }
 
-func init() {
+func RegisterFlags() {
  cliclient.RegisterClientFlags(identitiesCmd.PersistentFlags())
  cmdx.RegisterFormatFlags(identitiesCmd.PersistentFlags())
 }

cmd/identities/validate.go

@@ -15,13 +15,13 @@ import (
  "github.com/spf13/cobra"
  "github.com/tidwall/gjson"
 
- "github.com/ory/kratos/internal/httpclient/client/public"
+ "github.com/ory/kratos-client-go/client/public"
 
  "github.com/ory/jsonschema/v3"
  "github.com/ory/kratos/cmd/cliclient"
 )
 
-var validateCmd = &cobra.Command{
+var ValidateCmd = &cobra.Command{
  Use: "validate <file.json [file-2.json [file-3.json] ...]>",
  Short: "Validate local identity files",
  Long: `This command allows validation of identity files.

cmd/identities/validate_test.go

@@ -5,7 +5,7 @@ import (
  "fmt"
  "testing"
 
- "github.com/ory/kratos/internal/httpclient/client/public"
+ "github.com/ory/kratos-client-go/client/public"
 
  "github.com/spf13/cobra"
  "github.com/stretchr/testify/assert"

cmd/remote/status.go

@@ -8,7 +8,7 @@ import (
  "github.com/spf13/cobra"
 
  "github.com/ory/kratos/cmd/cliclient"
- "github.com/ory/kratos/internal/httpclient/client/health"
+ "github.com/ory/kratos-client-go/client/health"
 )
 
 type statusState struct {

cmd/remote/version.go

@@ -6,7 +6,7 @@ import (
  "github.com/spf13/cobra"
 
  "github.com/ory/kratos/cmd/cliclient"
- "github.com/ory/kratos/internal/httpclient/client/version"
+ "github.com/ory/kratos-client-go/client/version"
  "github.com/ory/x/cmdx"
 )
 

cmd/root.go

@@ -37,6 +37,8 @@ func Execute() {
 
 func init() {
  identities.RegisterCommandRecursive(RootCmd)
+ identities.RegisterFlags()
+
  jsonnet.RegisterCommandRecursive(RootCmd)
  serve.RegisterCommandRecursive(RootCmd)
  migrate.RegisterCommandRecursive(RootCmd)

courier/courier_test.go

@@ -16,7 +16,7 @@ import (
  "github.com/stretchr/testify/require"
  "github.com/tidwall/gjson"
 
- "github.com/ory/dockertest"
+ "github.com/ory/dockertest/v3"
 
  dhelper "github.com/ory/x/sqlcon/dockertest"
 

docs/docs/self-service/flows/code/registration/samples/get.go.txt

@@ -6,7 +6,7 @@ import (
  "github.com/ory/kratos-client-go/client/public"
  "github.com/ory/kratos-client-go/client"
 
- "github.com/ory/kratos/internal/httpclient/client/common"
+ "github.com/ory/kratos-client-go/client/common"
 )
 
 func main() {

docs/docs/self-service/flows/code/settings/samples/get.go.txt

@@ -6,7 +6,7 @@ import (
  "github.com/ory/kratos-client-go/client/public"
  "github.com/ory/kratos-client-go/client"
 
- "github.com/ory/kratos/internal/httpclient/client/common"
+ "github.com/ory/kratos-client-go/client/common"
 )
 
 func main() {