snapshot of https://github.com/ory/keto.git (master, 2026-09-16; blobs > 131072B omitted)

cmd/migrate/migrate_test.go

@@ -0,0 +1,181 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package migrate
+
+import (
+	"bytes"
+	"context"
+	"strings"
+	"testing"
+	"time"
+
+	"github.com/spf13/cobra"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/ory/x/cmdx"
+	"github.com/ory/x/configx"
+	"github.com/ory/x/dbal"
+
+	"github.com/ory/keto/internal/driver/config"
+	"github.com/ory/keto/internal/namespace"
+	"github.com/ory/keto/internal/x/dbx"
+)
+
+func assertAllApplied(t *testing.T, status string) {
+	assert.NotContains(t, status, "Pending")
+	assert.Contains(t, status, "Applied")
+}
+
+func assertNoneApplied(t *testing.T, status string) {
+	assert.Contains(t, status, "Pending")
+	assert.NotContains(t, status, "Applied")
+}
+
+func TestMigrate(t *testing.T) {
+	t.Parallel()
+
+	nspaces := []*namespace.Namespace{
+		{
+			Name: "default",
+		},
+		{
+			Name: "other",
+		},
+	}
+
+	newCmd := func(ctx context.Context, persistentArgs ...string) *cmdx.CommandExecuter {
+		return &cmdx.CommandExecuter{
+			New: func() *cobra.Command {
+				cmd := NewMigrateCmd(nil)
+				configx.RegisterFlags(cmd.PersistentFlags())
+				return cmd
+			},
+			Ctx:            ctx,
+			PersistentArgs: persistentArgs,
+		}
+	}
+
+	for _, dsn := range dbx.GetDSNs(t) {
+		if dbal.IsMemorySQLite(dsn.Conn) {
+			t.Run("dsn=memory", func(t *testing.T) {
+				t.Parallel()
+
+				t.Run("case=auto migrates", func(t *testing.T) {
+					cf := dbx.ConfigFile(t, map[string]interface{}{
+						config.KeyDSN:        dsn.Conn,
+						config.KeyNamespaces: nspaces,
+						"log.level":          "debug",
+					})
+
+					cmd := newCmd(t.Context(), "-c", cf)
+
+					out := cmd.ExecNoErr(t, "up", "--"+FlagYes)
+					assert.Contains(t, out, "All migrations are already applied, there is nothing to do.")
+				})
+			})
+		} else {
+			t.Run("dsn="+dsn.Name, func(t *testing.T) {
+				t.Parallel()
+
+				cf := dbx.ConfigFile(t, map[string]interface{}{
+					config.KeyDSN:        dsn.Conn,
+					config.KeyNamespaces: nspaces,
+					"log.level":          "debug",
+				})
+
+				cmd := newCmd(t.Context(), "-c", cf)
+
+				t.Run("case=shows status", func(t *testing.T) {
+					stdOut := cmd.ExecNoErr(t, "status")
+					assert.Contains(t, stdOut, "Pending")
+					assert.NotContains(t, stdOut, "Applied")
+				})
+
+				t.Run("case=status blocks until all are applied", func(t *testing.T) {
+					cmd := *cmd
+					ctx, cancel := context.WithTimeout(t.Context(), 5*time.Second)
+					defer cancel()
+					cmd.Ctx = ctx
+
+					stdErr := &bytes.Buffer{}
+					stdOut := &cmdx.CallbackWriter{
+						Callbacks: map[string]func([]byte) error{
+							"Waiting for migrations to finish...": func([]byte) error {
+								cancel()
+								return nil
+							},
+						},
+					}
+
+					err := cmd.ExecBackground(nil, stdOut, stdErr, "status", "--block").Wait()
+					require.ErrorIs(t, err, cmdx.ErrNoPrintButFail)
+					assert.Contains(t, stdOut.String(), "Waiting for migrations to finish...")
+					assert.Contains(t, stdErr.String(), "Context was canceled, exiting...", stdOut.String())
+				})
+
+				t.Run("case=aborts on no", func(t *testing.T) {
+					stdOut, stdErr, err := cmd.Exec(strings.NewReader("n\n"), "up")
+					require.NoError(t, err, "%s %s", stdOut, stdErr)
+
+					assert.Containsf(t, stdOut, "Pending", "%s %s", stdOut, stdErr)
+					assert.NotContainsf(t, stdOut, "Applied", "%s %s", stdOut, stdErr)
+					assert.Containsf(t, stdOut, "Aborting", "%s %s", stdOut, stdErr)
+				})
+
+				t.Run("case=applies on yes input", func(t *testing.T) {
+					stdOut, stdErr, err := cmd.Exec(bytes.NewBufferString("y\n"), "up")
+					require.NoErrorf(t, err, "%s %s", stdOut, stdErr)
+
+					t.Cleanup(func() {
+						// migrate all down
+						t.Logf("cleanup:\n%s\n", cmd.ExecNoErr(t, "down", "0", "--"+FlagYes))
+					})
+
+					parts := strings.Split(stdOut, "Are you sure that you want to apply this migration?")
+					require.Len(t, parts, 2)
+
+					assertNoneApplied(t, parts[0])
+					assertAllApplied(t, parts[1])
+				})
+
+				t.Run("case=applies on yes flag", func(t *testing.T) {
+					out := cmd.ExecNoErr(t, "up", "--"+FlagYes)
+
+					t.Cleanup(func() {
+						// migrate all down
+						t.Logf("cleanup:\n%s\n", cmd.ExecNoErr(t, "down", "0", "--"+FlagYes))
+					})
+
+					parts := strings.Split(out, "Applying migrations...")
+					require.Len(t, parts, 2)
+
+					assertNoneApplied(t, parts[0])
+					assertAllApplied(t, parts[1])
+				})
+			})
+		}
+	}
+}
+
+func TestUpAndDown(t *testing.T) {
+	t.Parallel()
+
+	newCmd := func() *cobra.Command {
+		cmd := NewMigrateCmd(nil)
+		configx.RegisterFlags(cmd.PersistentFlags())
+		return cmd
+	}
+	for _, dsn := range dbx.GetDSNs(t) {
+		t.Run("dsn="+dsn.Name, func(t *testing.T) {
+			cf := dbx.ConfigFile(t, map[string]interface{}{
+				config.KeyDSN:        dsn.Conn,
+				config.KeyNamespaces: []*namespace.Namespace{},
+			})
+
+			t.Log(cmdx.ExecNoErr(t, newCmd(), "up", "-c", cf, "--"+FlagYes))
+			t.Log(cmdx.ExecNoErr(t, newCmd(), "down", "0", "-c", cf, "--"+FlagYes))
+		})
+	}
+}