Repository navigation
Expand file tree
/
Copy pathconfig_test.go
More file actions
319 lines (274 loc) · 8.29 KB
/
Copy pathconfig_test.go
File metadata and controls
319 lines (274 loc) · 8.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
package main
import (
"net/url"
"os"
"path/filepath"
"testing"
"github.com/jackc/pgx/v5"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestMergeConnectionStringSettings(t *testing.T) {
overrides := map[string]string{
"PGHOST": "override.example.com",
"PGPORT": "6543",
"PGDATABASE": "override database",
"PGUSER": "override user",
"PGPASSWORD": "override \\ ' password",
"PGSSLMODE": "require",
}
tests := []struct {
name string
connString string
}{
{
name: "keyword value",
connString: "host=base.example.com port=5432 dbname=base_database user=base_user password=base_password sslmode=disable application_name=tern_test",
},
{
name: "URL",
connString: "postgresql://base_user:base_password@base.example.com:5432/base_database?sslmode=disable&application_name=tern_test",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
connString, err := mergeConnectionStringSettings(tt.connString, overrides)
require.NoError(t, err)
config, err := pgx.ParseConfig(connString)
require.NoError(t, err)
assert.Equal(t, "override.example.com", config.Host)
assert.Equal(t, uint16(6543), config.Port)
assert.Equal(t, "override database", config.Database)
assert.Equal(t, "override user", config.User)
assert.Equal(t, "override \\ ' password", config.Password)
assert.Equal(t, "tern_test", config.RuntimeParams["application_name"])
assert.NotNil(t, config.TLSConfig)
assert.Empty(t, config.Fallbacks)
})
}
}
func TestMergeConnectionStringSettingsRemovesURLDatabaseAlias(t *testing.T) {
clearTestPGEnv(t)
connString, err := mergeConnectionStringSettings(
"postgresql://baseuser:basepassword@basehost:5432/?database=basedb&sslmode=disable",
map[string]string{"PGDATABASE": "configdb"},
)
require.NoError(t, err)
u, err := url.Parse(connString)
require.NoError(t, err)
assert.Empty(t, u.Query().Get("database"))
assert.Equal(t, "configdb", u.Query().Get("dbname"))
// pgx iterates URL query parameters as a map. Repeated parsing guards
// against a canonical alias collision making the selected database random.
for range 100 {
config, err := pgx.ParseConfig(connString)
require.NoError(t, err)
assert.Equal(t, "configdb", config.Database)
}
}
func TestMergeConnectionStringSettingsSkipsEmptyNonPasswordValues(t *testing.T) {
clearTestPGEnv(t)
t.Setenv("PGUSER", "ambient_user")
for _, connString := range []string{
"dbname=test_database sslmode=disable",
"postgresql:///test_database?sslmode=disable",
} {
merged, err := mergeConnectionStringSettings(connString, map[string]string{
"PGHOST": "",
"PGUSER": "",
})
require.NoError(t, err)
config, err := pgx.ParseConfig(merged)
require.NoError(t, err)
assert.NotEmpty(t, config.Host)
assert.Equal(t, "ambient_user", config.User)
}
}
func TestLoadConfigCLIArgsOverridePGService(t *testing.T) {
serviceFile := writeTestServiceFile(t, `
[precedence_test]
host=service.example.com
port=5432
dbname=service_database
user=service_user
password=service_password
sslmode=disable
`)
setTestPGService(t, serviceFile)
setTestCLIOptions(t, func() {
cliOptions.host = "cli.example.com"
cliOptions.port = 6543
cliOptions.database = "cli_database"
cliOptions.user = "cli_user"
cliOptions.password = "cli_password"
cliOptions.sslmode = "require"
})
config, err := LoadConfig()
require.NoError(t, err)
assert.Equal(t, "cli.example.com", config.ConnConfig.Host)
assert.Equal(t, uint16(6543), config.ConnConfig.Port)
assert.Equal(t, "cli_database", config.ConnConfig.Database)
assert.Equal(t, "cli_user", config.ConnConfig.User)
assert.Equal(t, "cli_password", config.ConnConfig.Password)
assert.NotNil(t, config.ConnConfig.TLSConfig)
assert.Empty(t, config.ConnConfig.Fallbacks)
}
func TestLoadConfigCLIUserSelectsMatchingPassfileEntry(t *testing.T) {
serviceFile := writeTestServiceFile(t, `
[precedence_test]
host=service.example.com
port=5432
dbname=service_database
user=service_user
sslmode=disable
`)
setTestPGService(t, serviceFile)
passfile := filepath.Join(t.TempDir(), "pgpass")
err := os.WriteFile(passfile, []byte(
"service.example.com:5432:service_database:service_user:service_password\n"+
"service.example.com:5432:service_database:cli_user:cli_password\n",
), 0o600)
require.NoError(t, err)
t.Setenv("PGPASSFILE", passfile)
setTestCLIOptions(t, func() {
cliOptions.user = "cli_user"
})
config, err := LoadConfig()
require.NoError(t, err)
assert.Equal(t, "cli_user", config.ConnConfig.User)
assert.Equal(t, "cli_password", config.ConnConfig.Password)
}
func TestLoadConfigCLIConnStringOverridesConfigFileSettings(t *testing.T) {
clearTestPGEnv(t)
configFile := writeTestConfigFile(t, `
[database]
host=confighost
port=5432
database=configdb
user=configuser
password=configpassword
sslmode=disable
`)
setTestCLIOptions(t, func() {
cliOptions.configPaths = []string{configFile}
cliOptions.connString = "postgresql://cliuser:clipassword@clihost:6000/clidb?sslmode=require"
})
config, err := LoadConfig()
require.NoError(t, err)
assert.Equal(t, "clihost", config.ConnConfig.Host)
assert.Equal(t, uint16(6000), config.ConnConfig.Port)
assert.Equal(t, "clidb", config.ConnConfig.Database)
assert.Equal(t, "cliuser", config.ConnConfig.User)
assert.Equal(t, "clipassword", config.ConnConfig.Password)
assert.NotNil(t, config.ConnConfig.TLSConfig)
}
func TestLoadConfigUpdatesConnStringWithConfigFileOverrides(t *testing.T) {
clearTestPGEnv(t)
configFile := writeTestConfigFile(t, `
[database]
conn_string=postgresql://baseuser:basepassword@basehost:5432/basedb?sslmode=disable
host=confighost
database=configdb
`)
setTestCLIOptions(t, func() {
cliOptions.configPaths = []string{configFile}
})
config, err := LoadConfig()
require.NoError(t, err)
printedConfig, err := pgx.ParseConfig(config.ConnString)
require.NoError(t, err)
assert.Equal(t, config.ConnConfig.Host, printedConfig.Host)
assert.Equal(t, config.ConnConfig.Database, printedConfig.Database)
assert.Equal(t, "confighost", printedConfig.Host)
assert.Equal(t, "configdb", printedConfig.Database)
}
func TestLoadConfigEmptyPasswordMasksEnvironment(t *testing.T) {
clearTestPGEnv(t)
t.Setenv("PGPASSWORD", "ambient_secret")
configFile := writeTestConfigFile(t, `
[database]
host=confighost
database=configdb
user=configuser
password=
sslmode=disable
`)
setTestCLIOptions(t, func() {
cliOptions.configPaths = []string{configFile}
})
config, err := LoadConfig()
require.NoError(t, err)
assert.Equal(t, "configuser", config.ConnConfig.User)
assert.Empty(t, config.ConnConfig.Password)
}
func TestLoadConfigEmptyHostFallsBackToDefault(t *testing.T) {
clearTestPGEnv(t)
configFile := writeTestConfigFile(t, `
[database]
host=
database=configdb
user=configuser
sslmode=disable
`)
setTestCLIOptions(t, func() {
cliOptions.configPaths = []string{configFile}
})
config, err := LoadConfig()
require.NoError(t, err)
assert.NotEmpty(t, config.ConnConfig.Host)
assert.Equal(t, "configdb", config.ConnConfig.Database)
assert.Equal(t, "configuser", config.ConnConfig.User)
}
func writeTestServiceFile(t *testing.T, contents string) string {
t.Helper()
path := filepath.Join(t.TempDir(), "pg_service.conf")
err := os.WriteFile(path, []byte(contents), 0o600)
require.NoError(t, err)
return path
}
func writeTestConfigFile(t *testing.T, contents string) string {
t.Helper()
path := filepath.Join(t.TempDir(), "tern.conf")
err := os.WriteFile(path, []byte(contents), 0o600)
require.NoError(t, err)
return path
}
func setTestPGService(t *testing.T, serviceFile string) {
t.Helper()
clearTestPGEnv(t)
t.Setenv("PGSERVICE", "precedence_test")
t.Setenv("PGSERVICEFILE", serviceFile)
}
func clearTestPGEnv(t *testing.T) {
t.Helper()
for _, envvar := range []string{
"PGHOST",
"PGPORT",
"PGDATABASE",
"PGUSER",
"PGPASSWORD",
"PGPASSFILE",
"PGSSLMODE",
"PGSSLROOTCERT",
"PGSERVICE",
"PGSERVICEFILE",
"TERN_CONFIG",
"TERN_MIGRATIONS",
} {
t.Setenv(envvar, "")
}
}
func setTestCLIOptions(t *testing.T, set func()) {
t.Helper()
previous := cliOptions
cliOptions = cliOptionsConfig{}
t.Cleanup(func() {
cliOptions = previous
})
emptyConfig := writeTestConfigFile(t, "[database]\n")
cliOptions.configPaths = []string{emptyConfig}
if cliOptions.migrationsPath == "" {
cliOptions.migrationsPath = t.TempDir()
}
set()
}