fix: Small improvement to PK checking in codegen (#432)

hermanschaaf · web-flow · commit 15f7d1b4dfbd · 2022-11-24T14:33:08.000Z
diff --git a/codegen/table.go b/codegen/table.go
@@ -6,6 +6,7 @@ import (
 
 	"github.com/cloudquery/plugin-sdk/schema"
 	"github.com/rs/zerolog"
+	"github.com/thoas/go-funk"
 	"golang.org/x/exp/slices"
 )
 
@@ -105,7 +106,7 @@ func NewTableFromStruct(name string, obj interface{}, opts ...TableOption) (*Tab
 		columns = append(columns, column)
 	}
 	if len(t.extraPKColumns) > 0 {
-		return nil, fmt.Errorf("%s table definition has %d extra PK keys", t.Name, len(t.extraPKColumns))
+		return nil, fmt.Errorf("%s table definition has %d extra PK keys: %v", t.Name, len(t.extraPKColumns), funk.Keys(t.extraPKColumns))
 	}
 	t.Columns = columns
 
diff --git a/codegen/table_test.go b/codegen/table_test.go
@@ -245,9 +245,10 @@ func TestTableFromGoStruct(t *testing.T) {
 	}
 
 	tests := []struct {
-		name string
-		args args
-		want TableDefinition
+		name    string
+		args    args
+		want    TableDefinition
+		wantErr bool
 	}{
 		{
 			name: "should generate table from struct with default options",
@@ -355,13 +356,24 @@ func TestTableFromGoStruct(t *testing.T) {
 			},
 			want: expectedTestSliceStruct,
 		},
+		{
+			name: "should error if there are undefined pk columns",
+			args: args{
+				testStruct: testSliceStruct{},
+				options:    []TableOption{WithPKColumns("int_col", "some_col")},
+			},
+			wantErr: true,
+		},
 	}
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			table, err := NewTableFromStruct("test_struct", tt.args.testStruct, tt.args.options...)
-			if err != nil {
-				t.Fatal(err)
+			if (err != nil) != tt.wantErr {
+				t.Fatalf("error = %v, wantErr %v", err, tt.wantErr)
+			}
+			if tt.wantErr {
+				return
 			}
 			if diff := cmp.Diff(&tt.want, table,
 				cmpopts.IgnoreUnexported(TableDefinition{})); diff != "" {

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ import (`
`6`	`6`
`7`	`7`	`"github.com/cloudquery/plugin-sdk/schema"`
`8`	`8`	`"github.com/rs/zerolog"`
	`9`	`+ "github.com/thoas/go-funk"`
`9`	`10`	`"golang.org/x/exp/slices"`
`10`	`11`	`)`
`11`	`12`
`@@ -105,7 +106,7 @@ func NewTableFromStruct(name string, obj interface{}, opts ...TableOption) (*Tab`
`105`	`106`	`columns = append(columns, column)`
`106`	`107`	`}`
`107`	`108`	`if len(t.extraPKColumns) > 0 {`
`108`		`- return nil, fmt.Errorf("%s table definition has %d extra PK keys", t.Name, len(t.extraPKColumns))`
	`109`	`+ return nil, fmt.Errorf("%s table definition has %d extra PK keys: %v", t.Name, len(t.extraPKColumns), funk.Keys(t.extraPKColumns))`
`109`	`110`	`}`
`110`	`111`	`t.Columns = columns`
`111`	`112`