Add tests for process-based plugins

sqlc-dev · kyleconroy · Aug 29, 2023 · Aug 29, 2023 · Aug 29, 2023 · Aug 29, 2023
commit c1ce837b92b1e712b8c7c67b89358394ae97dfb7
diff --git a/cmd/sqlc-gen-env/main.go b/cmd/sqlc-gen-env/main.go
@@ -0,0 +1,45 @@
+package main
+
+import (
+	"bufio"
+	"encoding/json"
+	"fmt"
+	"os"
+
+	"github.com/sqlc-dev/sqlc/internal/plugin"
+)
+
+func main() {
+	if err := run(); err != nil {
+		fmt.Fprintf(os.Stderr, "error generating env: %s", err)
+		os.Exit(2)
+	}
+}
+
+func run() error {
+	env := os.Environ()
+	blob, err := json.Marshal(env)
+	if err != nil {
+		return err
+	}
+	resp := &plugin.CodeGenResponse{
+		Files: []*plugin.File{
+			{
+				Name:     "env.json",
+				Contents: append(blob, '\n'),
+			},
+		},
+	}
+	respBlob, err := resp.MarshalVT()
+	if err != nil {
+		return err
+	}
+	w := bufio.NewWriter(os.Stdout)
+	if _, err := w.Write(respBlob); err != nil {
+		return err
+	}
+	if err := w.Flush(); err != nil {
+		return err
+    	}
+	return nil
+}
diff --git a/internal/endtoend/endtoend_test.go b/internal/endtoend/endtoend_test.go
@@ -75,6 +75,10 @@ func BenchmarkExamples(b *testing.B) {
 }
 
 func TestReplay(t *testing.T) {
+	// Ensure that this environment variable is always set to true when running
+	// end-to-end tests
+	os.Setenv("SQLC_DUMMY_VALUE", "true")
+
 	t.Parallel()
 	ctx := context.Background()
 	var dirs []string

diff --git a/internal/endtoend/testdata/process_plugin_sqlc_gen_env/exec.json b/internal/endtoend/testdata/process_plugin_sqlc_gen_env/exec.json
@@ -0,0 +1,3 @@
+{
+  "process": "sqlc-gen-env"
+}
diff --git a/internal/endtoend/testdata/process_plugin_sqlc_gen_env/gen/env.json b/internal/endtoend/testdata/process_plugin_sqlc_gen_env/gen/env.json
@@ -0,0 +1 @@
+["SQLC_VERSION=v1.20.0","SQLC_DUMMY_VALUE=true"]
diff --git a/internal/endtoend/testdata/process_plugin_sqlc_gen_env/query.sql b/internal/endtoend/testdata/process_plugin_sqlc_gen_env/query.sql
@@ -0,0 +1,19 @@
+-- name: GetAuthor :one
+SELECT * FROM authors
+WHERE id = $1 LIMIT 1;
+
+-- name: ListAuthors :many
+SELECT * FROM authors
+ORDER BY name;
+
+-- name: CreateAuthor :one
+INSERT INTO authors (
+          name, bio
+) VALUES (
+  $1, $2
+)
+RETURNING *;
+
+-- name: DeleteAuthor :exec
+DELETE FROM authors
+WHERE id = $1;
diff --git a/internal/endtoend/testdata/process_plugin_sqlc_gen_env/schema.sql b/internal/endtoend/testdata/process_plugin_sqlc_gen_env/schema.sql
@@ -0,0 +1,5 @@
+CREATE TABLE authors (
+          id   BIGSERIAL PRIMARY KEY,
+          name text      NOT NULL,
+          bio  text
+);
diff --git a/internal/endtoend/testdata/process_plugin_sqlc_gen_env/sqlc.json b/internal/endtoend/testdata/process_plugin_sqlc_gen_env/sqlc.json
@@ -0,0 +1,25 @@
+{
+  "version": "2",
+  "sql": [
+    {
+      "schema": "schema.sql",
+      "queries": "query.sql",
+      "engine": "postgresql",
+      "codegen": [
+        {
+          "out": "gen",
+          "plugin": "env"
+        }
+      ]
+    }
+  ],
+  "plugins": [
+    {
+      "name": "env",
+      "env": ["SQLC_DUMMY_VALUE"],
+      "process": {
+        "cmd": "sqlc-gen-env"
+      }
+    }
+  ]
+}
diff --git a/scripts/regenerate/main.go b/scripts/regenerate/main.go
@@ -56,6 +56,7 @@ func regenerate(dir string) error {
 			}
 
 			cmd := exec.Command("sqlc-dev", "generate")
+			cmd.Env = append(cmd.Env, "SQLC_DUMMY_VALUE=true")
 			cmd.Dir = cwd
 			out, failed := cmd.CombinedOutput()
 			if failed != nil && !expectFailure {
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		["SQLC_VERSION=v1.20.0","SQLC_DUMMY_VALUE=true"]