Migrate workflow-plugin-migrations to strict gRPC proto contracts

.github/workflows/ci.yml

@@ -35,3 +35,69 @@ jobs:
       - run: go build ./...
       - run: go test ./... -v -race -count=1
       - run: go vet ./...
+
+  strict-contracts:
+    name: Validate strict plugin contracts
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+      - name: Validate strict plugin contracts
+        run: go run github.com/GoCodeAlone/workflow/cmd/wfctl@v0.20.1 plugin validate --file plugin.json --strict-contracts
+      - name: Build plugin binaries
+        run: |
+          set -euo pipefail
+          mkdir -p dist
+          go build -o dist/workflow-plugin-migrations ./cmd/workflow-plugin-migrations
+          go build -o dist/workflow-plugin-atlas-migrate ./cmd/workflow-plugin-atlas-migrate
+      - name: Build packaged plugin artifacts
+        run: |
+          set -euo pipefail
+
+          main_package="$(mktemp -d)"
+          cp plugin.json plugin.contracts.json LICENSE "$main_package"
+          cp dist/workflow-plugin-migrations "$main_package/"
+          sed -i.bak \
+            -e 's/"version": ".*"/"version": "0.3.6-SNAPSHOT-ci"/' \
+            -e 's|/releases/download/v[0-9][^/]*/|/releases/download/v0.3.6-SNAPSHOT-ci/|g' \
+            "$main_package/plugin.json"
+          rm -f "$main_package/plugin.json.bak"
+          tar -C "$main_package" -czf dist/workflow-plugin-migrations-linux-amd64.tar.gz workflow-plugin-migrations plugin.json plugin.contracts.json LICENSE
+
+          atlas_package="$(mktemp -d)"
+          cp plugin.atlas.json "$atlas_package/plugin.json"
+          cp plugin.atlas.contracts.json "$atlas_package/plugin.contracts.json"
+          cp dist/workflow-plugin-atlas-migrate "$atlas_package/"
+          cp LICENSE "$atlas_package"
+          sed -i.bak \
+            -e 's/"version": ".*"/"version": "0.3.6-SNAPSHOT-ci"/' \
+            -e 's|/releases/download/v[0-9][^/]*/|/releases/download/v0.3.6-SNAPSHOT-ci/|g' \
+            "$atlas_package/plugin.json"
+          rm -f "$atlas_package/plugin.json.bak"
+          tar -C "$atlas_package" -czf dist/workflow-plugin-atlas-migrate-linux-amd64.tar.gz workflow-plugin-atlas-migrate plugin.json plugin.contracts.json LICENSE
+      - name: Validate packaged plugin artifact
+        run: |
+          set -euo pipefail
+          main_archive="$(find dist -name 'workflow-plugin-migrations-linux-amd64.tar.gz' -print -quit)"
+          test -n "$main_archive"
+          tmp="$(mktemp -d)"
+          tar -xzf "$main_archive" -C "$tmp"
+          test -f "$tmp/workflow-plugin-migrations"
+          test -f "$tmp/plugin.json"
+          test -f "$tmp/plugin.contracts.json"
+          grep -q '/releases/download/v0.3.6-SNAPSHOT-ci/' "$tmp/plugin.json"
+          go run github.com/GoCodeAlone/workflow/cmd/wfctl@v0.20.1 plugin validate --file "$tmp/plugin.json" --strict-contracts
+
+          atlas_archive="$(find dist -name 'workflow-plugin-atlas-migrate-linux-amd64.tar.gz' -print -quit)"
+          test -n "$atlas_archive"
+          atlas_tmp="$(mktemp -d)"
+          tar -xzf "$atlas_archive" -C "$atlas_tmp"
+          test -f "$atlas_tmp/workflow-plugin-atlas-migrate"
+          test -f "$atlas_tmp/plugin.json"
+          test -f "$atlas_tmp/plugin.contracts.json"
+          grep -q '/releases/download/v0.3.6-SNAPSHOT-ci/' "$atlas_tmp/plugin.json"
+          go run github.com/GoCodeAlone/workflow/cmd/wfctl@v0.20.1 plugin validate --file "$atlas_tmp/plugin.json" --strict-contracts

.goreleaser.yaml

@@ -3,7 +3,7 @@ version: 2
 before:
   hooks:
     - go mod tidy
-    - "sed -i.bak 's/\"version\": \".*\"/\"version\": \"{{ .Version }}\"/' plugin.json && rm -f plugin.json.bak"
+    - "for manifest in plugin.json plugin.atlas.json; do sed -i.bak -e 's/\"version\": \".*\"/\"version\": \"{{ .Version }}\"/' -e 's|/releases/download/v[0-9][^/]*/|/releases/download/v{{ .Version }}/|g' \"$manifest\" && rm -f \"$manifest.bak\"; done"
 
 builds:
   # Main plugin binary: golang-migrate + goose + wfctl CLI
@@ -63,14 +63,18 @@ archives:
     name_template: "workflow-plugin-migrations-{{ .Os }}-{{ .Arch }}"
     files:
       - plugin.json
+      - plugin.contracts.json
       - LICENSE
 
   - id: workflow-plugin-atlas-migrate
     builds: [workflow-plugin-atlas-migrate]
     formats: [tar.gz]
     name_template: "workflow-plugin-atlas-migrate-{{ .Os }}-{{ .Arch }}"
     files:
-      - plugin.json
+      - src: plugin.atlas.json
+        dst: plugin.json
+      - src: plugin.atlas.contracts.json
+        dst: plugin.contracts.json
       - LICENSE
 
   - id: workflow-migrate

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/jackc/pgx/v5 v5.9.2
 	github.com/pressly/goose/v3 v3.27.0
 	github.com/spf13/cobra v1.10.2
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
@@ -205,7 +206,6 @@ require (
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20260406210006-6f92a3bedf2d // indirect
 	google.golang.org/grpc v1.80.0 // indirect
 	google.golang.org/protobuf v1.36.11 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 	modernc.org/libc v1.70.0 // indirect
 	modernc.org/mathutil v1.7.1 // indirect
 	modernc.org/memory v1.11.0 // indirect

internal/atlasplugin/modules.go

@@ -82,7 +82,7 @@ func (m *atlasMigrationsModule) InvokeMethod(method string, args map[string]any)
 		if err != nil {
 			return nil, err
 		}
-		return map[string]any{"applied": result.Applied, "duration_ms": result.DurationMs}, nil
+		return map[string]any{"applied": result.Applied, "skipped": result.Skipped, "duration_ms": result.DurationMs}, nil
 	case "down":
 		steps := 1
 		if v, ok := args["steps"].(int); ok {
@@ -93,7 +93,7 @@ func (m *atlasMigrationsModule) InvokeMethod(method string, args map[string]any)
 		if err != nil {
 			return nil, err
 		}
-		return map[string]any{"applied": result.Applied, "duration_ms": result.DurationMs}, nil
+		return map[string]any{"applied": result.Applied, "skipped": result.Skipped, "duration_ms": result.DurationMs}, nil
 	case "status":
 		st, err := d.Status(ctx, req)
 		if err != nil {
@@ -109,7 +109,7 @@ func (m *atlasMigrationsModule) InvokeMethod(method string, args map[string]any)
 		if err != nil {
 			return nil, err
 		}
-		return map[string]any{"applied": result.Applied, "duration_ms": result.DurationMs}, nil
+		return map[string]any{"applied": result.Applied, "skipped": result.Skipped, "duration_ms": result.DurationMs}, nil
 	default:
 		return nil, fmt.Errorf("database.migrations %q: unknown method %q", m.name, method)
 	}
@@ -125,7 +125,7 @@ func (m *driverModule) Start(_ context.Context) error { return nil }
 func (m *driverModule) Stop(_ context.Context) error  { return nil }
 func (m *driverModule) InvokeMethod(method string, _ map[string]any) (map[string]any, error) {
 	if method == "driver_name" {
-		return map[string]any{"name": m.driver.Name()}, nil
+		return map[string]any{"driver": m.driver.Name()}, nil
 	}
 	return nil, fmt.Errorf("database.migration_driver: unknown method %q", method)
 }