schema validation and improve tests

category_test.go

@@ -17,7 +17,7 @@ type Category struct {
 	CreatedAt  time.Time
 	UpdatedAt  time.Time
 	DeletedAt  sql.NullTime
-	ParentID   uuid.UUID
+	ParentID   *uuid.UUID
 	Name       string
 	IsDisabled bool
 }

cmd/goerd/main.go

@@ -59,7 +59,10 @@ func main() {
 		}
 		f.Close()
 
-		qs := goerd.GenerateMigrationSQL(src, dst)
+		qs, err := goerd.GenerateMigrationSQL(src, dst)
+		if err != nil {
+			log.Fatal(err)
+		}
 		if cmdIsPrint {
 			for _, q := range qs {
 				if !*drop {
@@ -93,7 +96,7 @@ func main() {
 		}
 		f.Close()
 
-		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -122,7 +125,10 @@ func main() {
 			log.Fatal(err)
 		}
 
-		qs := goerd.GenerateMigrationSQL(src, dst)
+		qs, err := goerd.GenerateMigrationSQL(src, dst)
+		if err != nil {
+			log.Fatal(err)
+		}
 		if cmdIsPrint {
 			for _, q := range qs {
 				if !*drop {
@@ -181,7 +187,7 @@ func main() {
 			log.Fatal(err)
 		}
 
-		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -198,7 +204,7 @@ func main() {
 			log.Fatal(err)
 		}
 
-		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644)
+		wr, err := os.OpenFile(*to, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -219,7 +225,10 @@ func main() {
 		if err != nil {
 			log.Fatal(err)
 		}
-		qs := goerd.GenerateMigrationSQL(src, dst)
+		qs, err := goerd.GenerateMigrationSQL(src, dst)
+		if err != nil {
+			log.Fatal(err)
+		}
 		if cmdIsPrint {
 			for _, q := range qs {
 				if !*drop {

goerd.go

@@ -25,10 +25,12 @@ func SchemaFromPostgresDB(db *sql.DB) (*schema.Schema, error) {
 
 // GenerateMigrationSQL generates an array of SQL DDL queries
 // for postgres that modify database tables, columns, indexes, etc.
-func GenerateMigrationSQL(sfrom, sto *schema.Schema) []string {
+func GenerateMigrationSQL(sfrom, sto *schema.Schema) ([]string, error) {
 	ptch := &schema.PatchSchema{CurrentSchema: sfrom.CurrentSchema}
-	ptch.Build(sfrom, sto)
-	return ptch.GenerateSQL()
+	if err := ptch.Build(sfrom, sto); err != nil {
+		return nil, err
+	}
+	return ptch.GenerateSQL(), nil
 }
 
 // SchemaToYAML saves the schema to a yaml file

goerd_test.go

@@ -62,13 +62,13 @@ func TestBasicUsage(t *testing.T) {
 
 	ctx := goerd.WithSqlxDb(context.Background(), db)
 
-	if err := prods.ProductToStore(ctx, p); err != nil {
-		t.Errorf("ProductToStore error: %s", err)
+	if err := cats.CategoryToStore(ctx, c); err != nil {
+		t.Errorf("CategoryToStore error: %s", err)
 		return
 	}
 
-	if err := cats.CategoryToStore(ctx, c); err != nil {
-		t.Errorf("CategoryToStore error: %s", err)
+	if err := prods.ProductToStore(ctx, p); err != nil {
+		t.Errorf("ProductToStore error: %s", err)
 		return
 	}
 
@@ -100,7 +100,10 @@ func Migrate(d *sqlx.DB, migsch *schema.Schema) error {
 	if err != nil {
 		return fmt.Errorf("cannot migrate database: %w", err)
 	}
-	qs := goerd.GenerateMigrationSQL(dbsch, migsch)
+	qs, err := goerd.GenerateMigrationSQL(dbsch, migsch)
+	if err != nil {
+		return err
+	}
 	tx, err := d.Begin()
 	if err != nil {
 		return fmt.Errorf("cannot migrate database: %w", err)
@@ -128,7 +131,7 @@ func Migrate(d *sqlx.DB, migsch *schema.Schema) error {
 			fmt.Println("target schema:")
 			migsch.SaveYaml(os.Stdout)
 
-			return fmt.Errorf("cannot migrate database: %w", err)
+			return fmt.Errorf("cannot migrate database %q: %w", q, err)
 		}
 	}
 	if err = tx.Commit(); err != nil {

objmodel.go

@@ -153,7 +153,10 @@ func (md *ModelSet) Migrate(d *sqlx.DB, dbSchema string) error {
 		return fmt.Errorf("cannot migrate database: %w", err)
 	}
 
-	qs := GenerateMigrationSQL(dbsch, migsch)
+	qs, err := GenerateMigrationSQL(dbsch, migsch)
+	if err != nil {
+		return fmt.Errorf("cannot migrate database: %w", err)
+	}
 	tx, err := d.Begin()
 	if err != nil {
 		return fmt.Errorf("cannot migrate database: %w", err)

schema/diff.go

@@ -237,6 +237,7 @@ func createIndexDDL(idx *Index) string {
 func (i *PatchIndex) create() []string {
 	return []string{createIndexDDL(i.to)}
 }
+
 func (i *PatchIndex) alter() []string {
 	if i.from.MethodName == "" {
 		i.from.MethodName = "btree"
@@ -249,6 +250,7 @@ func (i *PatchIndex) alter() []string {
 	}
 	return append(i.drop(), i.create()...)
 }
+
 func (i *PatchIndex) drop() []string {
 	// always drop unused indexes
 	return []string{
@@ -361,13 +363,15 @@ func createRelationDDL(r *Relation) string {
 func (r *PatchRelation) create() []string {
 	return []string{createRelationDDL(r.to)}
 }
+
 func (r *PatchRelation) alter() []string {
 	if strings.EqualFold(createRelationDDL(r.from),
 		createRelationDDL(r.to)) {
 		return nil
 	}
 	return append(r.drop(), r.create()...)
 }
+
 func (r *PatchRelation) drop() []string {
 	// TODO:
 	// declare r record;
@@ -391,7 +395,7 @@ type PatchSchema struct {
 }
 
 func (t *PatchSchema) GenerateSQL() (ret []string) {
-	// TODO: using CurrentSchema
+	// TODO: using CurrentSchema as schema prefix
 	for _, st := range t.tables {
 		ret = append(ret, st.GenerateSQL()...)
 	}
@@ -401,7 +405,13 @@ func (t *PatchSchema) GenerateSQL() (ret []string) {
 	return
 }
 
-func (s *PatchSchema) Build(from, to *Schema) {
+func (s *PatchSchema) Build(from, to *Schema) error {
+	if err := from.Validate(); err != nil {
+		return fmt.Errorf("source schema validation error: %w", err)
+	}
+	if err := to.Validate(); err != nil {
+		return fmt.Errorf("target schema validation error: %w", err)
+	}
 	s.CurrentSchema = to.CurrentSchema
 	s.tables = make([]*PatchTable, 0, len(from.Tables)+len(to.Tables))
 	s.relations = make([]*PatchRelation, 0, len(from.Relations)+len(to.Relations))
@@ -609,4 +619,5 @@ func (s *PatchSchema) Build(from, to *Schema) {
 			s.relations = append(s.relations, pt)
 		}
 	}
+	return nil
 }

schema/diff_test.go

@@ -6,7 +6,6 @@ import (
 )
 
 func TestPatchSchema_BuildDropAndNew(t *testing.T) {
-
 	t.Run("1", func(t *testing.T) {
 		from := &Schema{
 			CurrentSchema: "public",
@@ -65,7 +64,10 @@ func TestPatchSchema_BuildDropAndNew(t *testing.T) {
 		}
 
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `DROP TABLE IF EXISTS table_old
@@ -79,11 +81,9 @@ CREATE INDEX table1_col3 ON table1(column3)` {
 			t.Error(qss)
 		}
 	})
-
 }
 
 func TestPatchSchema_BuildAddColIdx(t *testing.T) {
-
 	t.Run("1", func(t *testing.T) {
 		from := &Schema{
 			CurrentSchema: "public",
@@ -152,7 +152,10 @@ func TestPatchSchema_BuildAddColIdx(t *testing.T) {
 		}
 
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `ALTER TABLE table1 ADD COLUMN column3 uuid NOT NULL
@@ -161,11 +164,9 @@ ALTER TABLE table1 ADD CONSTRAINT table1_constraint_check CHECK (true)` {
 			t.Error(qss)
 		}
 	})
-
 }
 
 func TestPatchSchema_BuildEq(t *testing.T) {
-
 	t.Run("1", func(t *testing.T) {
 		from := &Schema{
 			CurrentSchema: "public",
@@ -220,18 +221,19 @@ func TestPatchSchema_BuildEq(t *testing.T) {
 		}
 
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `` {
 			t.Error(qss)
 		}
 	})
-
 }
 
 func TestPatchSchema_BuildChangeCol(t *testing.T) {
-
 	t.Run("1", func(t *testing.T) {
 		from := &Schema{
 			CurrentSchema: "public",
@@ -286,18 +288,19 @@ func TestPatchSchema_BuildChangeCol(t *testing.T) {
 		}
 
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `ALTER TABLE table1 ALTER COLUMN column2 TYPE text` {
 			t.Error(qss)
 		}
 	})
-
 }
 
 func TestPatchSchema_BuildChangeIdx(t *testing.T) {
-
 	t.Run("1", func(t *testing.T) {
 		from := &Schema{
 			CurrentSchema: "public",
@@ -356,7 +359,10 @@ func TestPatchSchema_BuildChangeIdx(t *testing.T) {
 		}
 
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `ALTER TABLE table1 ADD COLUMN column3 uuid NOT NULL
@@ -365,7 +371,6 @@ CREATE INDEX table1_col2 ON table1(column2,column3)` {
 			t.Error(qss)
 		}
 	})
-
 }
 
 func TestPatchSchema_BuildChangeIdx2(t *testing.T) {
@@ -428,12 +433,14 @@ func TestPatchSchema_BuildChangeIdx2(t *testing.T) {
 
 	t.Run("1", func(t *testing.T) {
 		s := &PatchSchema{}
-		s.Build(from, to)
+		if err := s.Build(from, to); err != nil {
+			t.Error(err)
+			return
+		}
 		qs := s.GenerateSQL()
 		qss := strings.Join(qs, "\n")
 		if qss != `` {
 			t.Error(qss)
 		}
 	})
-
 }