Skip to content

Commit a0d5d93

Browse files
kyleconroykyleconroy
authored
feat(cmd/vet): Simplify environment variable substiution (#2393)
1 parent 0956107 commit a0d5d93

File tree

8 files changed

+48
-46
lines changed

8 files changed

+48
-46
lines changed

‎examples/authors/sqlc.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"queries": "postgresql/query.sql",
77
"engine": "postgresql",
88
"database": {
9-
"url": "'postgresql://%s:%s@%s:%s/authors'.format([env.PG_USER, env.PG_PASSWORD, env.PG_HOST, env.PG_PORT])"
9+
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/authors"
1010
},
1111
"gen": {
1212
"go": {
@@ -20,7 +20,7 @@
2020
"queries": "mysql/query.sql",
2121
"engine": "mysql",
2222
"database": {
23-
"url": "'root:%s@tcp(%s:%s)/authors?multiStatements=true&parseTime=true'.format([env.MYSQL_ROOT_PASSWORD, env.MYSQL_HOST, env.MYSQL_PORT])"
23+
"url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/authors?multiStatements=true&parseTime=true"
2424
},
2525
"gen": {
2626
"go": {
@@ -34,7 +34,7 @@
3434
"queries": "sqlite/query.sql",
3535
"engine": "sqlite",
3636
"database": {
37-
"url": "'file:authors?mode=memory&cache=shared'"
37+
"url": "file:authors?mode=memory&cache=shared"
3838
},
3939
"gen": {
4040
"go": {

‎examples/batch/sqlc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"queries": "postgresql/query.sql",
99
"engine": "postgresql",
1010
"database": {
11-
"url": "'postgresql://%s:%s@%s:%s/batch'.format([env.PG_USER, env.PG_PASSWORD, env.PG_HOST, env.PG_PORT])"
11+
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/batch"
1212
},
1313
"sql_package": "pgx/v4",
1414
"emit_json_tags": true,

‎examples/booktest/sqlc.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"queries": "postgresql/query.sql",
99
"engine": "postgresql",
1010
"database": {
11-
"url": "'postgresql://%s:%s@%s:%s/booktest'.format([env.PG_USER, env.PG_PASSWORD, env.PG_HOST, env.PG_PORT])"
11+
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/booktest"
1212
}
1313
},
1414
{
@@ -18,7 +18,7 @@
1818
"queries": "mysql/query.sql",
1919
"engine": "mysql",
2020
"database": {
21-
"url": "'root:%s@tcp(%s:%s)/booktest?multiStatements=true&parseTime=true'.format([env.MYSQL_ROOT_PASSWORD, env.MYSQL_HOST, env.MYSQL_PORT])"
21+
"url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/booktest?multiStatements=true&parseTime=true"
2222
}
2323
},
2424
{
@@ -28,7 +28,7 @@
2828
"queries": "sqlite/query.sql",
2929
"engine": "sqlite",
3030
"database": {
31-
"url": "'file:booktest?mode=memory&cache=shared'"
31+
"url": "file:booktest?mode=memory&cache=shared"
3232
}
3333
}
3434
]

‎examples/jets/sqlc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"queries": "postgresql/query-building.sql",
99
"engine": "postgresql",
1010
"database": {
11-
"url": "'postgresql://%s:%s@%s:%s/jets'.format([env.PG_USER, env.PG_PASSWORD, env.PG_HOST, env.PG_PORT])"
11+
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/jets"
1212
}
1313
}
1414
]

‎examples/ondeck/sqlc.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"queries": "postgresql/query",
99
"engine": "postgresql",
1010
"database": {
11-
"url": "'postgresql://%s:%s@%s:%s/ondeck'.format([env.PG_USER, env.PG_PASSWORD, env.PG_HOST, env.PG_PORT])"
11+
"url": "postgresql://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/ondeck"
1212
},
1313
"emit_json_tags": true,
1414
"emit_prepared_queries": true,
@@ -21,7 +21,7 @@
2121
"queries": "mysql/query",
2222
"engine": "mysql",
2323
"database": {
24-
"url": "'root:%s@tcp(%s:%s)/ondeck?multiStatements=true&parseTime=true'.format([env.MYSQL_ROOT_PASSWORD, env.MYSQL_HOST, env.MYSQL_PORT])"
24+
"url": "root:${MYSQL_ROOT_PASSWORD}@tcp(${MYSQL_HOST}:${MYSQL_PORT})/ondeck?multiStatements=true&parseTime=true"
2525
},
2626
"emit_json_tags": true,
2727
"emit_prepared_queries": true,
@@ -34,7 +34,7 @@
3434
"queries": "sqlite/query",
3535
"engine": "sqlite",
3636
"database": {
37-
"url": "'file:ondeck?mode=memory&cache=shared'"
37+
"url": "file:ondeck?mode=memory&cache=shared"
3838
},
3939
"emit_json_tags": true,
4040
"emit_prepared_queries": true,

‎internal/cmd/vet.go

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323
"github.com/kyleconroy/sqlc/internal/debug"
2424
"github.com/kyleconroy/sqlc/internal/opts"
2525
"github.com/kyleconroy/sqlc/internal/plugin"
26+
"github.com/kyleconroy/sqlc/internal/shfmt"
2627
"github.com/kyleconroy/sqlc/internal/sql/ast"
2728
)
2829

@@ -107,21 +108,9 @@ func Vet(ctx context.Context, e Env, dir, filename string, stderr io.Writer) err
107108
msgs[c.Name] = c.Msg
108109
}
109110

110-
dbenv, err := cel.NewEnv(
111-
cel.StdLib(),
112-
ext.Strings(ext.StringsVersion(1)),
113-
cel.Variable("env",
114-
cel.MapType(cel.StringType, cel.StringType),
115-
),
116-
)
117-
if err != nil {
118-
return fmt.Errorf("new dbenv; %s", err)
119-
}
120-
121111
c := checker{
122112
Checks: checks,
123113
Conf: conf,
124-
Dbenv: dbenv,
125114
Dir: dir,
126115
Env: env,
127116
Envmap: map[string]string{},
@@ -197,41 +186,22 @@ func (p *dbPreparer) Prepare(ctx context.Context, name, query string) error {
197186
type checker struct {
198187
Checks map[string]cel.Program
199188
Conf *config.Config
200-
Dbenv *cel.Env
201189
Dir string
202190
Env *cel.Env
203191
Envmap map[string]string
204192
Msgs map[string]string
205193
Stderr io.Writer
206194
}
207195

208-
func (c *checker) DSN(expr string) (string, error) {
209-
ast, issues := c.Dbenv.Compile(expr)
210-
if issues != nil && issues.Err() != nil {
211-
return "", fmt.Errorf("type-check error: database url %s", issues.Err())
212-
}
213-
prg, err := c.Dbenv.Program(ast)
214-
if err != nil {
215-
return "", fmt.Errorf("program construction error: database url %s", err)
216-
}
196+
func (c *checker) DSN(dsn string) (string, error) {
217197
// Populate the environment variable map if it is empty
218198
if len(c.Envmap) == 0 {
219199
for _, e := range os.Environ() {
220200
k, v, _ := strings.Cut(e, "=")
221201
c.Envmap[k] = v
222202
}
223203
}
224-
out, _, err := prg.Eval(map[string]any{
225-
"env": c.Envmap,
226-
})
227-
if err != nil {
228-
return "", fmt.Errorf("expression error: %s", err)
229-
}
230-
dsn, ok := out.Value().(string)
231-
if !ok {
232-
return "", fmt.Errorf("expression returned non-string value: %v", out.Value())
233-
}
234-
return dsn, nil
204+
return shfmt.Replace(dsn, c.Envmap), nil
235205
}
236206

237207
func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
@@ -312,9 +282,8 @@ func (c *checker) checkSQL(ctx context.Context, s config.SQL) error {
312282
if prep != nil && prepareable(s, original.RawStmt) {
313283
name := fmt.Sprintf("sqlc_vet_%d_%d", time.Now().Unix(), i)
314284
if err := prep.Prepare(ctx, name, query.Text); err != nil {
315-
fmt.Fprintf(c.Stderr, "%s: error preparing %s: %s\n", query.Filename, query.Name, err)
285+
fmt.Fprintf(c.Stderr, "%s: error preparing %s on %s: %s\n", query.Filename, query.Name, s.Engine, err)
316286
errored = true
317-
continue
318287
}
319288
}
320289
q := vetQuery(query)

‎internal/shfmt/shfmt.go

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
package shfmt
2+
3+
import (
4+
"regexp"
5+
"strings"
6+
)
7+
8+
var pat = regexp.MustCompile(`\$\{[A-Z_]+\}`)
9+
10+
func Replace(f string, vars map[string]string) string {
11+
return pat.ReplaceAllStringFunc(f, func(s string) string {
12+
s = strings.TrimPrefix(s, "${")
13+
s = strings.TrimSuffix(s, "}")
14+
return vars[s]
15+
})
16+
}

‎internal/shfmt/shfmt_test.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
package shfmt
2+
3+
import "testing"
4+
5+
func TestReplace(t *testing.T) {
6+
s := "POSTGRES_SQL://${PG_USER}:${PG_PASSWORD}@${PG_HOST}:${PG_PORT}/AUTHORS"
7+
env := map[string]string{
8+
"PG_USER": "user",
9+
"PG_PASSWORD": "password",
10+
"PG_HOST": "host",
11+
"PG_PORT": "port",
12+
}
13+
e := "POSTGRES_SQL://user:password@host:port/AUTHORS"
14+
if v := Replace(s, env); v != e {
15+
t.Errorf("%s != %s", v, e)
16+
}
17+
}

0 commit comments

Comments
 (0)