fail for unknown yaml fields

Author: MerlinVeritas

internal/config.go

@@ -1,5 +1,12 @@
 package python
 
+import (
+	"bytes"
+	json "encoding/json"
+	"fmt"
+	"strings"
+)
+
 type OverrideColumn struct {
 	Column   string `json:"column"`
 	DbType   string `json:"db_type"`
@@ -20,3 +27,19 @@ type Config struct {
 	InflectionExcludeTableNames []string         `json:"inflection_exclude_table_names"`
 	Overrides                   []OverrideColumn `json:"overrides"`
 }
+
+func parseConfig(raw []byte) (Config, error) {
+	var conf Config
+	if len(raw) == 0 {
+		return conf, nil
+	}
+
+	dec := json.NewDecoder(bytes.NewReader(raw))
+	dec.DisallowUnknownFields()
+	if err := dec.Decode(&conf); err != nil {
+		msg := strings.TrimPrefix(err.Error(), "json: ")
+		return Config{}, fmt.Errorf("invalid plugin options: %s", msg)
+	}
+
+	return conf, nil
+}

internal/config_test.go

@@ -0,0 +1,32 @@
+package python
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestParseConfigDisallowUnknownFields(t *testing.T) {
+	_, err := parseConfig([]byte(`{"emit_sync_querier":true,"db_typ":"jsonb"}`))
+	if err == nil {
+		t.Fatal("expected unknown field error, got nil")
+	}
+	if !strings.Contains(err.Error(), "invalid plugin options") {
+		t.Fatalf("expected error to reference plugin options, got: %v", err)
+	}
+	if !strings.Contains(err.Error(), `unknown field "db_typ"`) {
+		t.Fatalf("expected unknown field in error, got: %v", err)
+	}
+}
+
+func TestParseConfigValid(t *testing.T) {
+	conf, err := parseConfig([]byte(`{"emit_sync_querier":true,"overrides":[{"db_type":"jsonb","py_type":"str"}]}`))
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if !conf.EmitSyncQuerier {
+		t.Fatal("expected emit_sync_querier to be true")
+	}
+	if len(conf.Overrides) != 1 || conf.Overrides[0].DbType != "jsonb" || conf.Overrides[0].PyType != "str" {
+		t.Fatal("unexpected parsed overrides")
+	}
+}

internal/endtoend/testdata/dataclasses_with_reserved_keywords/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
   - name: py
     wasm:
       url: file://../../../../bin/sqlc-gen-python.wasm
-      sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+      sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
   - schema: schema.sql
     queries: query.sql

internal/endtoend/testdata/emit_pydantic_models/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
 - name: py
   wasm:
     url: file://../../../../bin/sqlc-gen-python.wasm
-    sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+    sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
 - schema: schema.sql
   queries: query.sql

internal/endtoend/testdata/emit_pydantic_models_with_reserved_keywords/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
 - name: py
   wasm:
     url: file://../../../../bin/sqlc-gen-python.wasm
-    sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+    sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
 - schema: schema.sql
   queries: query.sql

internal/endtoend/testdata/emit_str_enum/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
   - name: py
     wasm:
       url: file://../../../../bin/sqlc-gen-python.wasm
-      sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+      sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
   - schema: schema.sql
     queries: query.sql

internal/endtoend/testdata/emit_type_overrides/db/query.py

@@ -37,6 +37,13 @@
 """
 
 
+SEARCH_BOOKS = """-- name: search_books \\:many
+SELECT id, title, status, payload, metadata FROM books
+WHERE payload @> COALESCE(:p1\\:\\:jsonb, '{}'\\:\\:jsonb)
+ORDER BY title
+"""
+
+
 class Querier:
     def __init__(self, conn: sqlalchemy.engine.Connection):
         self._conn = conn
@@ -84,6 +91,17 @@ def list_books(self) -> Iterator[models.Book]:
                 metadata=row[4],
             )
 
+    def search_books(self, *, payload_filter: Optional[my_lib.models.JsonValue]) -> Iterator[models.Book]:
+        result = self._conn.execute(sqlalchemy.text(SEARCH_BOOKS), {"p1": payload_filter})
+        for row in result:
+            yield models.Book(
+                id=row[0],
+                title=row[1],
+                status=row[2],
+                payload=row[3],
+                metadata=row[4],
+            )
+
 
 class AsyncQuerier:
     def __init__(self, conn: sqlalchemy.ext.asyncio.AsyncConnection):
@@ -131,3 +149,14 @@ async def list_books(self) -> AsyncIterator[models.Book]:
                 payload=row[3],
                 metadata=row[4],
             )
+
+    async def search_books(self, *, payload_filter: Optional[my_lib.models.JsonValue]) -> AsyncIterator[models.Book]:
+        result = await self._conn.stream(sqlalchemy.text(SEARCH_BOOKS), {"p1": payload_filter})
+        async for row in result:
+            yield models.Book(
+                id=row[0],
+                title=row[1],
+                status=row[2],
+                payload=row[3],
+                metadata=row[4],
+            )

internal/endtoend/testdata/emit_type_overrides/query.sql

@@ -16,3 +16,8 @@ INSERT INTO books (
 -- name: DeleteBook :exec
 DELETE FROM books
 WHERE id = $1;
+
+-- name: SearchBooks :many
+SELECT * FROM books
+WHERE payload @> COALESCE(sqlc.narg('payload_filter')::jsonb, '{}'::jsonb)
+ORDER BY title;

internal/endtoend/testdata/emit_type_overrides/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
   - name: py
     wasm:
       url: file://../../../../bin/sqlc-gen-python.wasm
-      sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+      sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
   - schema: schema.sql
     queries: query.sql

internal/endtoend/testdata/exec_result/sqlc.yaml

@@ -3,7 +3,7 @@ plugins:
 - name: py
   wasm:
     url: file://../../../../bin/sqlc-gen-python.wasm
-    sha256: "77e9665cec6efe4e1871218c27a09143eb0f23fb509855c881757022383813e0"
+    sha256: "a5d1ad0ead1ecadb0608684d7c7a04327762299b769e6cca9c8f838c5df89788"
 sql:
 - schema: schema.sql
   queries: query.sql