feat: Better summary of schema changes (#21169)

erezrokah · web-flow · commit dc4786a79aa0 · 2025-07-29T14:43:56.000Z
#### Summary Similar to #21165. Updated the contributing docs with a docker compose stack to make it easier to test the plugin.
diff --git a/plugins/destination/mssql/CONTRIBUTING.md b/plugins/destination/mssql/CONTRIBUTING.md
@@ -15,25 +15,7 @@ Tests require an SQL Server instance available.
 You can run the following script to start the local server & create the required database:
 
 ```bash
-docker run \
-  --platform=linux/amd64 \
-  -e ACCEPT_EULA=Y \
-  -e MSSQL_PID=Express \
-  -e MSSQL_SA_PASSWORD='yourStrongP@ssword' \
-  -e DB_USER=SA \
-  -e DB_NAME=cloudquery \
-  -p 1433:1433 \
-  -d mcr.microsoft.com/mssql/server:2017-latest
-```
-
-After that, ensure that the database is created:
-
-```bash
-docker exec $(docker ps -alq) \
-  /opt/mssql-tools/bin/sqlcmd \
-  -U "SA" \
-  -P 'yourStrongP@ssword' \
-  -Q "CREATE DATABASE cloudquery;"
+docker compose up --wait
 ```
 
 Then you can run tests:
@@ -46,4 +28,10 @@ make test
 
 ```bash
 make lint
+```
+
+To clean up:
+
+```bash
+docker compose down --volumes
 ```
diff --git a/plugins/destination/mssql/client/changes.go b/plugins/destination/mssql/client/changes.go
@@ -2,22 +2,11 @@ package client
 
 import (
 	"slices"
-	"strings"
 
 	"github.com/apache/arrow-go/v18/arrow"
 	"github.com/cloudquery/plugin-sdk/v4/schema"
 )
 
-func prettifyChanges(name string, changes []schema.TableColumnChange) string {
-	builder := new(strings.Builder)
-	builder.WriteString(name + ":")
-	for _, change := range changes {
-		builder.WriteString("\n")
-		builder.WriteString(change.String())
-	}
-	return builder.String()
-}
-
 func unsafeChanges(changes []schema.TableColumnChange) []schema.TableColumnChange {
 	unsafe := make([]schema.TableColumnChange, 0, len(changes))
 	for _, c := range changes {
diff --git a/plugins/destination/mssql/client/migrate.go b/plugins/destination/mssql/client/migrate.go
@@ -3,7 +3,7 @@ package client
 import (
 	"context"
 	"database/sql"
-	"errors"
+	"fmt"
 	"strings"
 
 	"github.com/cloudquery/cloudquery/plugins/destination/mssql/v5/queries"
@@ -20,7 +20,7 @@ func (c *Client) MigrateTables(ctx context.Context, messages message.WriteMigrat
 
 	want := normalizedTables(messages)
 
-	if err := c.checkForced(have, want, messages); err != nil {
+	if err := checkForced(have, want, messages); err != nil {
 		return err
 	}
 
@@ -49,8 +49,8 @@ func (c *Client) MigrateTables(ctx context.Context, messages message.WriteMigrat
 	return nil
 }
 
-func (c *Client) checkForced(have, want schema.Tables, messages message.WriteMigrateTables) error {
-	forcedErr := false
+func checkForced(have, want schema.Tables, messages message.WriteMigrateTables) error {
+	nonAutoMigratableTables := make(map[string][]schema.TableColumnChange)
 	for _, m := range messages {
 		if m.MigrateForce {
 			continue
@@ -63,16 +63,12 @@ func (c *Client) checkForced(have, want schema.Tables, messages message.WriteMig
 		}
 		want := want.Get(m.Table.Name) // and it should never be nil
 		if unsafe := unsafeChanges(want.GetChanges(have)); len(unsafe) > 0 {
-			c.logger.Error().
-				Str("table", m.Table.Name).
-				Str("changes", prettifyChanges(m.Table.Name, unsafe)).
-				Msg("migrate manually or consider using 'migrate_mode: forced'")
-			forcedErr = true
+			nonAutoMigratableTables[m.Table.Name] = unsafe
 		}
 	}
 
-	if forcedErr {
-		return errors.New("migrate manually or consider using 'migrate_mode: forced'")
+	if len(nonAutoMigratableTables) > 0 {
+		return fmt.Errorf("\nCan't migrate tables automatically, migrate manually or consider using 'migrate_mode: forced'. Non auto migratable tables changes:\n\n%s", schema.GetChangesSummary(nonAutoMigratableTables))
 	}
 	return nil
 }
diff --git a/plugins/destination/mssql/docker-compose.yml b/plugins/destination/mssql/docker-compose.yml
@@ -0,0 +1,24 @@
+services:
+  mssql:
+    image: mcr.microsoft.com/mssql/server:2019-latest
+    platform: linux/amd64
+    environment:
+      ACCEPT_EULA: Y
+      MSSQL_PID: Express
+      MSSQL_SA_PASSWORD: yourStrongP@ssword
+      DB_USER: SA
+      DB_NAME: cloudquery
+    ports:
+      - 1433:1433
+    healthcheck:
+      test: ["CMD", "/opt/mssql-tools18/bin/sqlcmd", "-C", "-U", "SA", "-P", "yourStrongP@ssword", "-Q", "SELECT 1"]
+      interval: 15s
+      timeout: 30s
+      retries: 10
+  init:
+    image: mcr.microsoft.com/mssql/server:2019-latest
+    platform: linux/amd64
+    command: /opt/mssql-tools18/bin/sqlcmd -C -S tcp:mssql,1433 -U SA -P yourStrongP@ssword -Q "CREATE DATABASE cloudquery;"
+    depends_on:
+      mssql:
+        condition: service_healthy
