strip basic comments

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
         env:
           SPANNER_INSTANCE_ID: ${{env.SPANNER_INSTANCE_ID}}
           SPANNER_PROJECT_ID: ${{env.SPANNER_PROJECT_ID}}
-        image: roryq/spanner-emulator:0.8.2
+        image: roryq/spanner-emulator:1.1.0
     env:
       SPANNER_INSTANCE_ID: inst
       SPANNER_PROJECT_ID: proj

pkg/spanner/client_test.go

@@ -20,14 +20,16 @@
 package spanner
 
 import (
-	"cloud.google.com/go/spanner"
 	"context"
 	"fmt"
-	"github.com/google/uuid"
-	"google.golang.org/api/iterator"
 	"io/ioutil"
 	"os"
 	"testing"
+	"time"
+
+	"cloud.google.com/go/spanner"
+	"github.com/google/uuid"
+	"google.golang.org/api/iterator"
 )
 
 const (
@@ -261,7 +263,7 @@ func ensureMigrationColumn(t *testing.T, ctx context.Context, client *Client, co
 func ensureMigrationHistoryRecord(t *testing.T, ctx context.Context, client *Client, version int64, dirty bool) {
 	history, err := client.GetMigrationHistory(ctx, migrationTable)
 	for i := range history {
-		if history[i].Version == version && history[i].Dirty == dirty{
+		if history[i].Version == version && history[i].Dirty == dirty {
 			return
 		}
 	}
@@ -625,6 +627,9 @@ func testClientWithDatabase(t *testing.T, ctx context.Context) (*Client, func())
 		t.Fatalf("failed to create database: %v", err)
 	}
 
+	// emulator weirdness in CI
+	time.Sleep(100 * time.Millisecond)
+
 	return client, func() {
 		defer client.Close()
 

pkg/spanner/migration.go

@@ -48,11 +48,13 @@ var (
 	// as it must be idempotent. This probably isn't solvable with more regexes.
 	notPartitionedDmlRegex = regexp.MustCompile("INSERT")
 
+	// matches a single comment on its own line
+	oneLineSingleComment = regexp.MustCompile(`(?m)^\s*--.*$`)
 )
 
 const (
-	statementKindDDL statementKind = "DDL"
-	statementKindDML statementKind = "DML"
+	statementKindDDL            statementKind = "DDL"
+	statementKindDML            statementKind = "DML"
 	statementKindPartitionedDML statementKind = "PartitionedDML"
 )
 
@@ -132,12 +134,24 @@ func LoadMigrations(dir string) (Migrations, error) {
 	return migrations, nil
 }
 
+func stripComments(statement string) string {
+	return oneLineSingleComment.ReplaceAllString(statement, "")
+}
+
+func stripStatement(statement string) string {
+	return strings.TrimSpace(
+		stripComments(
+			strings.TrimSpace(
+				statement)))
+
+}
+
 func toStatements(file []byte) []string {
 	contents := bytes.Split(file, []byte(statementsSeparator))
 
 	statements := make([]string, 0, len(contents))
 	for _, c := range contents {
-		if statement := strings.TrimSpace(string(c)); statement != "" {
+		if statement := stripStatement(string(c)); statement != "" {
 			statements = append(statements, statement)
 		}
 	}
@@ -147,8 +161,8 @@ func toStatements(file []byte) []string {
 
 func inspectStatementsKind(statements []string) (statementKind, error) {
 	kindMap := map[statementKind]uint64{
-		statementKindDDL: 0,
-		statementKindDML: 0,
+		statementKindDDL:            0,
+		statementKindDML:            0,
 		statementKindPartitionedDML: 0,
 	}
 
@@ -175,19 +189,19 @@ func distinctKind(kindMap map[statementKind]uint64, kind statementKind) bool {
 	target := kindMap[kind]
 
 	var total uint64
-	for k:= range kindMap {
+	for k := range kindMap {
 		total = total + kindMap[k]
 	}
 
 	return target == total
 }
 
 func getStatementKind(statement string) statementKind {
-	if isPartitionedDMLOnly(statement){
+	if isPartitionedDMLOnly(statement) {
 		return statementKindPartitionedDML
 	}
 
-	if isDMLAny(statement){
+	if isDMLAny(statement) {
 		return statementKindDML
 	}
 

pkg/spanner/migration_test.go

@@ -167,3 +167,72 @@ func Test_inspectStatementsKind(t *testing.T) {
 		})
 	}
 }
+
+func Test_stripStatement(t *testing.T) {
+	tests := []struct {
+		name      string
+		statement string
+		want      string
+	}{
+		{
+			name: "Basic single line comment is removed",
+			statement: `-- THIS SHOULD BE REMOVED
+CREATE TABLE Singers (
+  SingerID STRING(36) NOT NULL,
+  FirstName STRING(1024),
+) PRIMARY KEY(SingerID)`,
+			want: `CREATE TABLE Singers (
+  SingerID STRING(36) NOT NULL,
+  FirstName STRING(1024),
+) PRIMARY KEY(SingerID)`,
+		},
+		{
+			name: "Maligned single line comment is removed",
+			statement: `  -- THIS SHOULD BE REMOVED
+CREATE TABLE Singers (
+  SingerID STRING(36) NOT NULL,
+  FirstName STRING(1024),
+) PRIMARY KEY(SingerID)`,
+			want: `CREATE TABLE Singers (
+  SingerID STRING(36) NOT NULL,
+  FirstName STRING(1024),
+) PRIMARY KEY(SingerID)`,
+		},
+		//		{
+		//			name: "Single line comment after SQL is removed",
+		//			statement: `CREATE TABLE SchemaMigrations (
+		//  Version INT64 NOT NULL,
+		//  Dirty BOOL NOT NULL, -- THIS SHOULD BE REMOVED
+		//) PRIMARY KEY(Version)`,
+		//			want: `CREATE TABLE SchemaMigrations (
+		//  Version INT64 NOT NULL,
+		//  Dirty BOOL NOT NULL,
+		//) PRIMARY KEY(Version)`,
+		//		},
+		//		{
+		//			name: "Double quoted comment remains",
+		//			statement: `INSERT INTO Singers(SingerID, FirstName) VALUES(1, "first name
+		//-- THIS STAYS IN DOUBLE QUOTES
+		//")`,
+		//			want: `INSERT INTO Singers(SingerID, FirstName) VALUES(1, "first name
+		//-- THIS STAYS IN DOUBLE QUOTES
+		//")`,
+		//		},
+		//		{
+		//			name: "Single quoted comment remains",
+		//			statement: `INSERT INTO Singers(SingerID, FirstName) VALUES(1, 'first name
+		//-- THIS STAYS IN DOUBLE QUOTES
+		//')`,
+		//			want: `INSERT INTO Singers(SingerID, FirstName) VALUES(1, 'first name
+		//-- THIS STAYS IN DOUBLE QUOTES
+		//')`,
+		//		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := stripStatement(tt.statement); got != tt.want {
+				t.Errorf("stripStatement() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}