migrate command

Author: cabaucom376

.goreleaser.yaml

@@ -79,36 +79,6 @@ builds:
       - -trimpath
     mod_timestamp: "{{ .CommitTimestamp }}"
 
-  - id: arcane-migrator
-    main: ./cmd/migrator/main.go
-    dir: backend
-    binary: arcane-migrator
-    env:
-      - CGO_ENABLED=0
-    goos:
-      - linux
-      - darwin
-    goarch:
-      - amd64
-      - arm64
-      - "386"
-      - arm
-    goarm:
-      - "7"
-    goamd64:
-      - v1
-    go386:
-      - sse2
-    ldflags:
-      - -w -s
-      - -buildid={{ .Version }}
-      - -X github.com/getarcaneapp/arcane/backend/internal/config.Version={{ .Version }}
-      - -X github.com/getarcaneapp/arcane/backend/internal/config.Revision={{ .ShortCommit }}
-      - -X github.com/getarcaneapp/arcane/backend/internal/config.BuildTime={{ .Date }}
-    flags:
-      - -trimpath
-    mod_timestamp: "{{ .CommitTimestamp }}"
-
   - id: arcane-cli
     main: .
     dir: cli
@@ -149,7 +119,6 @@ archives:
     ids:
       - arcane
       - arcane-agent
-      - arcane-migrator
     formats:
       - binary
     name_template: "{{ .Binary }}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}"
@@ -159,7 +128,6 @@ upx:
     ids:
       - arcane
       - arcane-agent
-      - arcane-migrator
       - arcane-cli
     goos:
       - linux
@@ -198,7 +166,6 @@ binary_signs:
     ids:
       - arcane
       - arcane-agent
-      - arcane-migrator
       - arcane-cli
     signature: '${artifact}_{{ .Os }}_{{ .Arch }}{{ with .Arm }}v{{ . }}{{ end }}{{ with .Mips }}_{{ . }}{{ end }}{{ if not (eq .Amd64 "v1") }}{{ .Amd64 }}{{ end }}.sigstore.json'
     stdin: "{{ .Env.COSIGN_PASSWORD }}"
@@ -318,7 +285,6 @@ dockers_v2:
   - id: arcane-next
     ids:
       - arcane
-      - arcane-migrator
     dockerfile: docker/next-builds/Dockerfile-static
     images:
       - "ghcr.io/getarcaneapp/arcane"
@@ -346,7 +312,6 @@ dockers_v2:
   - id: arcane-agent-next
     ids:
       - arcane-agent
-      - arcane-migrator
     dockerfile: docker/next-builds/Dockerfile-agent-static
     images:
       - "ghcr.io/getarcaneapp/arcane-headless"
@@ -374,7 +339,6 @@ dockers_v2:
   - id: arcane-next-distroless
     ids:
       - arcane
-      - arcane-migrator
     dockerfile: docker/next-builds/Dockerfile-next-distroless
     images:
       - "ghcr.io/getarcaneapp/arcane"
@@ -402,7 +366,6 @@ dockers_v2:
   - id: arcane-agent-next-distroless
     ids:
       - arcane-agent
-      - arcane-migrator
     dockerfile: docker/next-builds/Dockerfile-agent-distroless
     images:
       - "ghcr.io/getarcaneapp/arcane-headless"

Justfile

@@ -447,7 +447,7 @@ migration-manifest version="" output="backend/resources/migration_versions.json"
         args+=(--include-version "{{ version }}")
     fi
 
-    go run ./backend/cmd/migrator/main.go generate-manifest "${args[@]}"
+    go run -tags exclude_frontend ./backend/cmd migrate generate-manifest "${args[@]}"
 
 # Generate the docs config schema JSON.
 [group('docs')]

backend/internal/migrator/command.go backend/cli/migrate/command.gobackend/internal/migrator/command.go renamed to backend/cli/migrate/command.go

@@ -1,4 +1,4 @@
-package migrator
+package migrate
 
 import (
 	"context"
@@ -17,25 +17,40 @@ import (
 	"github.com/getarcaneapp/arcane/backend/pkg/libarcane/startup"
 )
 
-func NewCommand(out io.Writer) *cobra.Command {
-	if out == nil {
-		out = io.Discard
-	}
+var MigrateCmd = &cobra.Command{
+	Use:           "migrate",
+	Short:         "Manage Arcane database schema migrations",
+	Version:       config.Version,
+	SilenceUsage:  true,
+	SilenceErrors: true,
+}
 
-	rootCmd := &cobra.Command{
-		Use:           "arcane-migrator",
+func init() {
+	configureCommand(MigrateCmd, os.Stdout)
+}
+
+func newCommand(out io.Writer) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:           "migrate",
 		Short:         "Manage Arcane database schema migrations",
 		Version:       config.Version,
 		SilenceUsage:  true,
 		SilenceErrors: true,
 	}
-	rootCmd.SetOut(out)
+	configureCommand(cmd, out)
+	return cmd
+}
+
+func configureCommand(cmd *cobra.Command, out io.Writer) {
+	if out == nil {
+		out = io.Discard
+	}
 
-	rootCmd.AddCommand(newStatusCommand(out))
-	rootCmd.AddCommand(newUpCommand(out))
-	rootCmd.AddCommand(newDownCommand(out))
-	rootCmd.AddCommand(newGenerateManifestCommand(out))
-	return rootCmd
+	cmd.SetOut(out)
+	cmd.AddCommand(newStatusCommand(out))
+	cmd.AddCommand(newUpCommand(out))
+	cmd.AddCommand(newDownCommand(out))
+	cmd.AddCommand(newGenerateManifestCommand(out))
 }
 
 func newStatusCommand(out io.Writer) *cobra.Command {
@@ -105,7 +120,7 @@ func newDownCommand(out io.Writer) *cobra.Command {
 				return fmt.Errorf("database schema version %d is dirty; resolve the dirty migration state before downgrading", status.CurrentVersion)
 			}
 			if targetMigrationVersion > status.LatestVersion {
-				return fmt.Errorf("target Arcane version %s requires schema version %d, but this migrator only includes migrations through %d", targetAppVersion, targetMigrationVersion, status.LatestVersion)
+				return fmt.Errorf("target Arcane version %s requires schema version %d, but this Arcane binary only includes migrations through %d", targetAppVersion, targetMigrationVersion, status.LatestVersion)
 			}
 			if !status.HasVersion {
 				return fmt.Errorf("database has no migration version; start Arcane once to initialize the schema before downgrading")

backend/internal/migrator/command_test.go backend/cli/migrate/command_test.gobackend/internal/migrator/command_test.go renamed to backend/cli/migrate/command_test.go

@@ -1,4 +1,4 @@
-package migrator
+package migrate
 
 import (
 	"bytes"
@@ -10,7 +10,7 @@ import (
 
 func TestDownRequiresTarget(t *testing.T) {
 	var out bytes.Buffer
-	cmd := NewCommand(&out)
+	cmd := newCommand(&out)
 	cmd.SetArgs([]string{"down"})
 
 	err := cmd.Execute()
@@ -19,7 +19,8 @@ func TestDownRequiresTarget(t *testing.T) {
 }
 
 func TestCommandIncludesMigrationCommands(t *testing.T) {
-	cmd := NewCommand(nil)
+	cmd := newCommand(nil)
+	assert.Equal(t, "migrate", cmd.Name())
 
 	commandNames := make(map[string]struct{})
 	for _, child := range cmd.Commands() {

backend/cli/root.go

@@ -8,6 +8,7 @@ import (
 	"github.com/spf13/cobra"
 
 	"github.com/getarcaneapp/arcane/backend/cli/generate"
+	"github.com/getarcaneapp/arcane/backend/cli/migrate"
 	"github.com/getarcaneapp/arcane/backend/cli/upgrade"
 	"github.com/getarcaneapp/arcane/backend/internal/bootstrap"
 	"github.com/getarcaneapp/arcane/backend/internal/config"
@@ -39,6 +40,7 @@ func Execute() {
 
 func init() {
 	rootCmd.AddCommand(upgrade.UpgradeCmd)
+	rootCmd.AddCommand(migrate.MigrateCmd)
 	rootCmd.AddCommand(generate.GenerateCmd)
 }
 

backend/cli/upgrade/upgrade.go

@@ -157,7 +157,7 @@ func findArcaneContainer(ctx context.Context, dockerClient *client.Client) (cont
 		}
 
 		// Legacy label (pre-migration): com.getarcaneapp.arcane.server=true
-		// NOTE: older agent images also used this label, so we must additionally exclude AGENT_MODE=true.
+		// NOTE: older agent images also used this label, so we must additionally exclude agent modes.
 		if isLegacyServerLabel(labels) {
 			slog.Info("Found Arcane container by legacy label", "id", c.ID[:12], "image", c.Image, "names", c.Names)
 			return inspect, nil
@@ -197,9 +197,9 @@ func isAgentContainer(inspect container.InspectResponse) bool {
 			}
 		}
 	}
-	// Legacy agent detection: AGENT_MODE=true in env
+	// Legacy agent detection: AGENT_MODE=true or EDGE_AGENT=true in env
 	for _, env := range inspect.Config.Env {
-		if strings.EqualFold(env, "AGENT_MODE=true") {
+		if strings.EqualFold(env, "AGENT_MODE=true") || strings.EqualFold(env, "EDGE_AGENT=true") {
 			return true
 		}
 	}
@@ -419,16 +419,12 @@ func upgradeContainer(ctx context.Context, dockerClient *client.Client, oldConta
 		return fmt.Errorf("stop old container: %w", err)
 	}
 
-	if shouldRunMigratorForContainerInternal(oldContainer) {
-		fmt.Println("PROGRESS:73:Running database migrator")
-		slog.Info("Running database migrator before starting new container", "image", newImage)
-		if err := runMigratorContainerInternal(ctx, dockerClient, oldContainer, newImage, hostConfig, networkConfig, apiVersion); err != nil {
-			_, _ = dockerClient.ContainerStart(ctx, oldContainer.ID, client.ContainerStartOptions{})
-			_, _ = dockerClient.ContainerRename(ctx, oldContainer.ID, client.ContainerRenameOptions{NewName: originalName})
-			return fmt.Errorf("run database migrator: %w", err)
-		}
-	} else {
-		slog.Info("Skipping database migrator for non-server Arcane target", "container", originalName)
+	fmt.Println("PROGRESS:73:Running database migrator")
+	slog.Info("Running database migrator before starting new container", "image", newImage)
+	if err := runMigratorContainerInternal(ctx, dockerClient, oldContainer, newImage, hostConfig, networkConfig, apiVersion); err != nil {
+		_, _ = dockerClient.ContainerStart(ctx, oldContainer.ID, client.ContainerStartOptions{})
+		_, _ = dockerClient.ContainerRename(ctx, oldContainer.ID, client.ContainerRenameOptions{NewName: originalName})
+		return fmt.Errorf("run database migrator: %w", err)
 	}
 
 	fmt.Println("PROGRESS:75:Creating new container")
@@ -472,14 +468,6 @@ func upgradeContainer(ctx context.Context, dockerClient *client.Client, oldConta
 	return nil
 }
 
-func shouldRunMigratorForContainerInternal(cont container.InspectResponse) bool {
-	if cont.Config == nil {
-		return false
-	}
-
-	return !isAgentContainer(cont)
-}
-
 func runMigratorContainerInternal(
 	ctx context.Context,
 	dockerClient *client.Client,
@@ -495,8 +483,8 @@ func runMigratorContainerInternal(
 
 	migratorConfig := *oldContainer.Config
 	migratorConfig.Image = image
-	migratorConfig.Entrypoint = []string{"/app/arcane-migrator"}
-	migratorConfig.Cmd = []string{"up"}
+	migratorConfig.Entrypoint = []string{migrationBinaryPathForContainerInternal(oldContainer)}
+	migratorConfig.Cmd = []string{"migrate", "up"}
 	migratorConfig.ExposedPorts = nil
 	migratorConfig.Healthcheck = nil
 
@@ -552,6 +540,14 @@ func runMigratorContainerInternal(
 	return nil
 }
 
+func migrationBinaryPathForContainerInternal(cont container.InspectResponse) string {
+	if isAgentContainer(cont) {
+		return "/app/arcane-agent"
+	}
+
+	return "/app/arcane"
+}
+
 // looksLikeContainerID checks if a string looks like a Docker container ID
 // (12 or 64 lowercase hex characters, which Docker auto-generates as hostnames)
 func looksLikeContainerID(s string) bool {

backend/cli/upgrade/upgrade_test.go

@@ -0,0 +1,60 @@
+package upgrade
+
+import (
+	"testing"
+
+	"github.com/moby/moby/api/types/container"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMigrationBinaryPathForManagerContainer(t *testing.T) {
+	cont := container.InspectResponse{
+		Config: &container.Config{
+			Labels: map[string]string{
+				"com.getarcaneapp.arcane": "true",
+			},
+		},
+	}
+
+	assert.Equal(t, "/app/arcane", migrationBinaryPathForContainerInternal(cont))
+}
+
+func TestMigrationBinaryPathForAgentContainer(t *testing.T) {
+	tests := []struct {
+		name string
+		cont container.InspectResponse
+	}{
+		{
+			name: "agent label",
+			cont: container.InspectResponse{
+				Config: &container.Config{
+					Labels: map[string]string{
+						"com.getarcaneapp.arcane.agent": "true",
+					},
+				},
+			},
+		},
+		{
+			name: "direct agent env",
+			cont: container.InspectResponse{
+				Config: &container.Config{
+					Env: []string{"AGENT_MODE=true"},
+				},
+			},
+		},
+		{
+			name: "edge agent env",
+			cont: container.InspectResponse{
+				Config: &container.Config{
+					Env: []string{"EDGE_AGENT=true"},
+				},
+			},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, "/app/arcane-agent", migrationBinaryPathForContainerInternal(tt.cont))
+		})
+	}
+}