Add JSON schema struct generation (#210)

All structs matched well except for `PrimaryKey` which we mapped differently, I've refactored it to `Pk` as it doesn't seem to support different names for go and JSON --------- Signed-off-by: Alexis Rico <[email protected]> Co-authored-by: Andrew Farries <[email protected]>
xataio · Dec 1, 2023 · 788bac6 · 788bac6
1 parent 5812acc
commit 788bac6
Show file tree

Hide file tree

Showing 33 changed files with 766 additions and 238 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,8 @@
+.PHONY: generate
+generate:
+	# Generate the types from the JSON schema
+	docker run -v $$PWD/schema.json:/mnt/schema.json omissis/go-jsonschema:0.14.1 --only-models -p migrations --tags json /mnt/schema.json > pkg/migrations/types.go
+
+	# Add the license header
+	echo "// SPDX-License-Identifier: Apache-2.0" | cat - pkg/migrations/types.go > pkg/migrations/types.go.tmp
+	mv pkg/migrations/types.go.tmp pkg/migrations/types.go
diff --git a/pkg/migrations/check.go b/pkg/migrations/check.go
@@ -2,11 +2,6 @@
 
 package migrations
 
-type CheckConstraint struct {
-	Name       string `json:"name"`
-	Constraint string `json:"constraint"`
-}
-
 func (c *CheckConstraint) Validate() error {
 	if c.Name == "" {
 		return FieldRequiredError{Name: "name"}

diff --git a/pkg/migrations/fk_reference.go b/pkg/migrations/fk_reference.go
@@ -4,12 +4,6 @@ package migrations
 
 import "github.com/xataio/pgroll/pkg/schema"
 
-type ForeignKeyReference struct {
-	Name   string `json:"name"`
-	Table  string `json:"table"`
-	Column string `json:"column"`
-}
-
 func (f *ForeignKeyReference) Validate(s *schema.Schema) error {
 	if f.Name == "" {
 		return FieldRequiredError{Name: "name"}

diff --git a/pkg/migrations/op_add_column.go b/pkg/migrations/op_add_column.go
@@ -12,12 +12,6 @@ import (
 	"github.com/xataio/pgroll/pkg/schema"
 )
 
-type OpAddColumn struct {
-	Table  string  `json:"table"`
-	Up     *string `json:"up"`
-	Column Column  `json:"column"`
-}
-
 var _ Operation = (*OpAddColumn)(nil)
 
 func (o *OpAddColumn) Start(ctx context.Context, conn *sql.DB, stateSchema string, s *schema.Schema, cbs ...CallbackFn) error {
@@ -173,7 +167,7 @@ func (o *OpAddColumn) Validate(ctx context.Context, s *schema.Schema) error {
 		return FieldRequiredError{Name: "up"}
 	}
 
-	if o.Column.PrimaryKey {
+	if o.Column.Pk {
 		return errors.New("adding primary key columns is not supported")
 	}
 

diff --git a/pkg/migrations/op_add_column_test.go b/pkg/migrations/op_add_column_test.go
@@ -24,9 +24,9 @@ func TestAddColumn(t *testing.T) {
 						Name: "users",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:   "name",
@@ -121,9 +121,9 @@ func TestAddForeignKeyColumn(t *testing.T) {
 							Name: "users",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name:   "name",
@@ -136,9 +136,9 @@ func TestAddForeignKeyColumn(t *testing.T) {
 							Name: "orders",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name: "quantity",
@@ -223,9 +223,9 @@ func TestAddForeignKeyColumn(t *testing.T) {
 							Name: "users",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name:   "name",
@@ -238,9 +238,9 @@ func TestAddForeignKeyColumn(t *testing.T) {
 							Name: "orders",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name: "quantity",
@@ -332,9 +332,9 @@ func TestAddColumnWithUpSql(t *testing.T) {
 						Name: "products",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:   "name",
@@ -419,9 +419,9 @@ func TestAddNotNullColumnWithNoDefault(t *testing.T) {
 						Name: "products",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:   "name",
@@ -485,9 +485,9 @@ func TestAddColumnValidation(t *testing.T) {
 				Name: "users",
 				Columns: []migrations.Column{
 					{
-						Name:       "id",
-						Type:       "serial",
-						PrimaryKey: true,
+						Name: "id",
+						Type: "serial",
+						Pk:   true,
 					},
 					{
 						Name:   "name",
@@ -604,9 +604,9 @@ func TestAddColumnWithCheckConstraint(t *testing.T) {
 						Name: "users",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:   "name",

diff --git a/pkg/migrations/op_alter_column.go b/pkg/migrations/op_alter_column.go
@@ -10,19 +10,6 @@ import (
 	"github.com/xataio/pgroll/pkg/schema"
 )
 
-type OpAlterColumn struct {
-	Table      string               `json:"table"`
-	Column     string               `json:"column"`
-	Name       string               `json:"name"`
-	Type       string               `json:"type"`
-	Check      *CheckConstraint     `json:"check"`
-	References *ForeignKeyReference `json:"references"`
-	Nullable   *bool                `json:"nullable"`
-	Unique     *UniqueConstraint    `json:"unique"`
-	Up         string               `json:"up"`
-	Down       string               `json:"down"`
-}
-
 var _ Operation = (*OpAlterColumn)(nil)
 
 func (o *OpAlterColumn) Start(ctx context.Context, conn *sql.DB, stateSchema string, s *schema.Schema, cbs ...CallbackFn) error {

diff --git a/pkg/migrations/op_alter_column_test.go b/pkg/migrations/op_alter_column_test.go
@@ -18,9 +18,9 @@ func TestAlterColumnValidation(t *testing.T) {
 				Name: "users",
 				Columns: []migrations.Column{
 					{
-						Name:       "id",
-						Type:       "serial",
-						PrimaryKey: true,
+						Name: "id",
+						Type: "serial",
+						Pk:   true,
 					},
 					{
 						Name: "name",
@@ -32,9 +32,9 @@ func TestAlterColumnValidation(t *testing.T) {
 				Name: "posts",
 				Columns: []migrations.Column{
 					{
-						Name:       "id",
-						Type:       "serial",
-						PrimaryKey: true,
+						Name: "id",
+						Type: "serial",
+						Pk:   true,
 					},
 					{
 						Name: "title",

diff --git a/pkg/migrations/op_change_type_test.go b/pkg/migrations/op_change_type_test.go
@@ -24,9 +24,9 @@ func TestChangeColumnType(t *testing.T) {
 						Name: "reviews",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name: "username",
@@ -157,9 +157,9 @@ func TestChangeColumnTypeValidation(t *testing.T) {
 				Name: "reviews",
 				Columns: []migrations.Column{
 					{
-						Name:       "id",
-						Type:       "serial",
-						PrimaryKey: true,
+						Name: "id",
+						Type: "serial",
+						Pk:   true,
 					},
 					{
 						Name: "username",

diff --git a/pkg/migrations/op_create_index.go b/pkg/migrations/op_create_index.go
@@ -12,12 +12,6 @@ import (
 	"github.com/xataio/pgroll/pkg/schema"
 )
 
-type OpCreateIndex struct {
-	Name    string   `json:"name"`
-	Table   string   `json:"table"`
-	Columns []string `json:"columns"`
-}
-
 var _ Operation = (*OpCreateIndex)(nil)
 
 func (o *OpCreateIndex) Start(ctx context.Context, conn *sql.DB, stateSchema string, s *schema.Schema, cbs ...CallbackFn) error {

diff --git a/pkg/migrations/op_create_index_test.go b/pkg/migrations/op_create_index_test.go
@@ -22,9 +22,9 @@ func TestCreateIndex(t *testing.T) {
 						Name: "users",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:     "name",
@@ -73,9 +73,9 @@ func TestCreateIndexOnMultipleColumns(t *testing.T) {
 						Name: "users",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:     "name",

diff --git a/pkg/migrations/op_create_table.go b/pkg/migrations/op_create_table.go
@@ -13,22 +13,6 @@ import (
 
 var _ Operation = (*OpCreateTable)(nil)
 
-type OpCreateTable struct {
-	Name    string   `json:"name"`
-	Columns []Column `json:"columns"`
-}
-
-type Column struct {
-	Name       string               `json:"name"`
-	Type       string               `json:"type"`
-	Nullable   bool                 `json:"nullable"`
-	Unique     bool                 `json:"unique"`
-	PrimaryKey bool                 `json:"pk"`
-	Default    *string              `json:"default"`
-	Check      *CheckConstraint     `json:"check"`
-	References *ForeignKeyReference `json:"references"`
-}
-
 func (o *OpCreateTable) Start(ctx context.Context, conn *sql.DB, stateSchema string, s *schema.Schema, cbs ...CallbackFn) error {
 	tempName := TemporaryName(o.Name)
 	_, err := conn.ExecContext(ctx, fmt.Sprintf("CREATE TABLE %s (%s)",
@@ -117,7 +101,7 @@ func columnsToSQL(cols []Column) string {
 func ColumnToSQL(col Column) string {
 	sql := fmt.Sprintf("%s %s", pq.QuoteIdentifier(col.Name), col.Type)
 
-	if col.PrimaryKey {
+	if col.Pk {
 		sql += " PRIMARY KEY"
 	}
 	if col.Unique {

diff --git a/pkg/migrations/op_create_table_test.go b/pkg/migrations/op_create_table_test.go
@@ -25,9 +25,9 @@ func TestCreateTable(t *testing.T) {
 							Name: "users",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name:   "name",
@@ -84,9 +84,9 @@ func TestCreateTable(t *testing.T) {
 							Name: "users",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name:   "name",
@@ -104,9 +104,9 @@ func TestCreateTable(t *testing.T) {
 							Name: "orders",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name: "user_id",
@@ -181,9 +181,9 @@ func TestCreateTable(t *testing.T) {
 							Name: "users",
 							Columns: []migrations.Column{
 								{
-									Name:       "id",
-									Type:       "serial",
-									PrimaryKey: true,
+									Name: "id",
+									Type: "serial",
+									Pk:   true,
 								},
 								{
 									Name: "name",
@@ -246,9 +246,9 @@ func TestCreateTableValidation(t *testing.T) {
 						Name: "users",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name:   "name",
@@ -266,9 +266,9 @@ func TestCreateTableValidation(t *testing.T) {
 						Name: "orders",
 						Columns: []migrations.Column{
 							{
-								Name:       "id",
-								Type:       "serial",
-								PrimaryKey: true,
+								Name: "id",
+								Type: "serial",
+								Pk:   true,
 							},
 							{
 								Name: "user_id",