/
postgres-data-access.go
556 lines (466 loc) · 13.8 KB
/
postgres-data-access.go
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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
/*
* Copyright 2021 The Gort Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package postgres
import (
"context"
"database/sql"
"fmt"
"github.com/getgort/gort/data"
"github.com/getgort/gort/dataaccess/errs"
gerr "github.com/getgort/gort/errors"
"github.com/getgort/gort/telemetry"
_ "github.com/lib/pq" // Load the Postgres drivers
"go.opentelemetry.io/otel"
)
const (
DatabaseGort = "gort"
)
// PostgresDataAccess is a data access implementation backed by a database.
type PostgresDataAccess struct {
configs data.DatabaseConfigs
}
// NewPostgresDataAccess returns a new PostgresDataAccess based on the
// supplied config.
func NewPostgresDataAccess(configs data.DatabaseConfigs) PostgresDataAccess {
return PostgresDataAccess{configs: configs}
}
// Initialize sets up the database.
func (da PostgresDataAccess) Initialize(ctx context.Context) error {
tr := otel.GetTracerProvider().Tracer(telemetry.ServiceName)
ctx, sp := tr.Start(ctx, "postgres.Initialize")
defer sp.End()
if err := da.initializeGortData(ctx); err != nil {
return gerr.Wrap(fmt.Errorf("failed to initialize gort data"), err)
}
if err := da.initializeAuditData(ctx); err != nil {
return gerr.Wrap(fmt.Errorf("failed to initialize audit data"), err)
}
return nil
}
func (da PostgresDataAccess) initializeAuditData(ctx context.Context) error {
// Does the database exist? If not, create it.
err := da.ensureDatabaseExists(ctx, DatabaseGort)
if err != nil {
return gerr.Wrap(fmt.Errorf("cannot ensure gort database exists"), err)
}
// Establish a connection to the "gort" database
db, err := da.connect(ctx, DatabaseGort)
if err != nil {
return gerr.Wrap(fmt.Errorf("cannot connect to gort database"), err)
}
defer db.Close()
// Check whether the users table exists
exists, err := da.tableExists(ctx, "commands", db)
if err != nil {
return err
}
// If not, assume none of them do. Create them all.
if !exists {
err = da.createCommandsTable(ctx, db)
if err != nil {
return gerr.Wrap(fmt.Errorf("failed to create commands table"), err)
}
}
return nil
}
func (da PostgresDataAccess) initializeGortData(ctx context.Context) error {
// Does the database exist? If not, create it.
err := da.ensureDatabaseExists(ctx, DatabaseGort)
if err != nil {
return err
}
// Establish a connection to the "gort" database
db, err := da.connect(ctx, DatabaseGort)
if err != nil {
return err
}
defer db.Close()
db.SetMaxIdleConns(da.configs.MaxIdleConnections)
db.SetMaxOpenConns(da.configs.MaxOpenConnections)
db.SetConnMaxIdleTime(da.configs.ConnectionMaxIdleTime)
db.SetConnMaxLifetime(da.configs.ConnectionMaxLifetime)
// Check whether the users table exists
exists, err := da.tableExists(ctx, "users", db)
if err != nil {
return err
}
if !exists {
err = da.createUsersTable(ctx, db)
if err != nil {
return err
}
}
// Check whether the user adapter ids table exists
if exists, err = da.tableExists(ctx, "user_adapter_ids", db); err != nil {
return err
} else if !exists {
err = da.createUsersAdapterIDsTable(ctx, db)
if err != nil {
return err
}
}
// Check whether the groups table exists
exists, err = da.tableExists(ctx, "groups", db)
if err != nil {
return err
}
if !exists {
err = da.createGroupsTable(ctx, db)
if err != nil {
return err
}
}
// Check whether the groupusers table exists
exists, err = da.tableExists(ctx, "groupusers", db)
if err != nil {
return err
}
if !exists {
err = da.createGroupUsersTable(ctx, db)
if err != nil {
return err
}
}
// Check whether the tokens table exists
exists, err = da.tableExists(ctx, "tokens", db)
if err != nil {
return err
}
if !exists {
err = da.createTokensTable(ctx, db)
if err != nil {
return err
}
}
// Check whether the bundles table exists
exists, err = da.tableExists(ctx, "bundles", db)
if err != nil {
return err
}
if !exists {
err = da.createBundlesTables(ctx, db)
if err != nil {
return err
}
}
// Check whether the bundles_kubernetes table exists
exists, err = da.tableExists(ctx, "bundle_kubernetes", db)
if err != nil {
return err
}
if !exists {
err = da.createBundleKubernetesTables(ctx, db)
if err != nil {
return err
}
}
// Check whether the roles table exists
exists, err = da.tableExists(ctx, "roles", db)
if err != nil {
return err
}
if !exists {
err = da.createRolesTables(ctx, db)
if err != nil {
return err
}
}
return nil
}
func (da PostgresDataAccess) databaseExists(ctx context.Context, db *sql.DB, dbName string) (bool, error) {
const query = `SELECT datname
FROM pg_database
WHERE datistemplate = false AND datname = $1`
rows, err := db.QueryContext(ctx, query, dbName)
if err != nil {
return false, gerr.Wrap(errs.ErrDataAccess, err)
}
defer rows.Close()
datname := ""
for rows.Next() {
rows.Scan(&datname)
if datname == dbName {
return true, nil
}
}
if err := rows.Err(); err != nil {
return false, gerr.Wrap(errs.ErrDataAccess, err)
}
return false, nil
}
func (da PostgresDataAccess) connect(ctx context.Context, dbname string) (*sql.DB, error) {
psqlInfo := fmt.Sprintf("host=%s port=%d user=%s "+
"password=%s dbname=%s sslmode=disable",
da.configs.Host, da.configs.Port, da.configs.User,
da.configs.Password, dbname)
db, err := sql.Open("postgres", psqlInfo)
if err != nil {
return nil, gerr.Wrap(errs.ErrDataAccess, err)
}
err = db.PingContext(ctx)
if err != nil {
return nil, gerr.Wrap(errs.ErrDataAccess, err)
}
return db, nil
}
func (da PostgresDataAccess) createBundlesTables(ctx context.Context, db *sql.DB) error {
var err error
createBundlesQuery := `CREATE TABLE bundles (
gort_bundle_version INT NOT NULL CHECK(gort_bundle_version > 0),
name TEXT NOT NULL CHECK(name <> ''),
version TEXT NOT NULL CHECK(version <> ''),
author TEXT,
homepage TEXT,
description TEXT NOT NULL CHECK(description <> ''),
long_description TEXT,
image_repository TEXT,
image_tag TEXT,
install_timestamp TIMESTAMP WITH TIME ZONE,
install_user TEXT,
CONSTRAINT unq_bundle UNIQUE(name, version),
PRIMARY KEY (name, version)
);
ALTER TABLE bundles ALTER COLUMN install_timestamp SET DEFAULT now();
CREATE TABLE bundle_enabled (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
CONSTRAINT unq_bundle_enabled UNIQUE(bundle_name),
PRIMARY KEY (bundle_name),
FOREIGN KEY (bundle_name, bundle_version) REFERENCES bundles(name, version)
ON DELETE CASCADE
);
CREATE TABLE bundle_permissions (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
index INT NOT NULL CHECK(index >= 0),
permission TEXT,
CONSTRAINT unq_bundle_permission UNIQUE(bundle_name, bundle_version, index),
PRIMARY KEY (bundle_name, bundle_version, index),
FOREIGN KEY (bundle_name, bundle_version) REFERENCES bundles(name, version)
ON DELETE CASCADE
);
CREATE TABLE bundle_templates (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
command TEXT,
command_error TEXT,
message TEXT,
message_error TEXT,
CONSTRAINT unq_bundle_template UNIQUE(bundle_name, bundle_version),
PRIMARY KEY (bundle_name, bundle_version),
FOREIGN KEY (bundle_name, bundle_version) REFERENCES bundles(name, version)
ON DELETE CASCADE
);
CREATE TABLE bundle_commands (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
name TEXT NOT NULL CHECK(name <> ''),
description TEXT NOT NULL,
executable TEXT NOT NULL,
long_description TEXT,
CONSTRAINT unq_bundle_command UNIQUE(bundle_name, bundle_version, name),
PRIMARY KEY (bundle_name, bundle_version, name),
FOREIGN KEY (bundle_name, bundle_version) REFERENCES bundles(name, version)
ON DELETE CASCADE
);
CREATE TABLE bundle_command_rules (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
command_name TEXT NOT NULL,
rule TEXT NOT NULL CHECK(rule <> ''),
PRIMARY KEY (bundle_name, bundle_version, command_name, rule),
FOREIGN KEY (bundle_name, bundle_version, command_name)
REFERENCES bundle_commands(bundle_name, bundle_version, name)
ON DELETE CASCADE
);
CREATE TABLE bundle_command_templates (
bundle_name TEXT NOT NULL,
bundle_version TEXT NOT NULL,
command_name TEXT NOT NULL,
command TEXT,
command_error TEXT,
message TEXT,
message_error TEXT,
CONSTRAINT unq_bundle_command_templates UNIQUE(bundle_name, bundle_version, command_name),
PRIMARY KEY (bundle_name, bundle_version, command_name),
FOREIGN KEY (bundle_name, bundle_version, command_name)
REFERENCES bundle_commands(bundle_name, bundle_version, name)
ON DELETE CASCADE
);
`
_, err = db.ExecContext(ctx, createBundlesQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createBundleKubernetesTables(ctx context.Context, db *sql.DB) error {
var err error
createBundlesQuery := `CREATE TABLE bundle_kubernetes (
bundle_version TEXT NOT NULL,
bundle_name TEXT NOT NULL,
service_account_name TEXT NOT NULL
);
`
_, err = db.ExecContext(ctx, createBundlesQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createGroupsTable(ctx context.Context, db *sql.DB) error {
var err error
createGroupQuery := `CREATE TABLE groups (
groupname TEXT PRIMARY KEY
);`
_, err = db.ExecContext(ctx, createGroupQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createGroupUsersTable(ctx context.Context, db *sql.DB) error {
var err error
createGroupUsersQuery := `CREATE TABLE groupusers (
groupname TEXT REFERENCES groups,
username TEXT REFERENCES users,
PRIMARY KEY (groupname, username)
);`
_, err = db.ExecContext(ctx, createGroupUsersQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createRolesTables(ctx context.Context, db *sql.DB) error {
var err error
createRolesQuery := `CREATE TABLE roles (
role_name TEXT NOT NULL,
PRIMARY KEY (role_name)
);
CREATE TABLE group_roles (
group_name TEXT NOT NULL,
role_name TEXT NOT NULL,
CONSTRAINT unq_group_role UNIQUE(group_name, role_name),
PRIMARY KEY (group_name, role_name),
FOREIGN KEY (group_name) REFERENCES groups(groupname)
ON DELETE CASCADE
);
CREATE TABLE role_permissions (
role_name TEXT NOT NULL,
bundle_name TEXT NOT NULL,
permission TEXT NOT NULL,
CONSTRAINT unq_role_permission UNIQUE(role_name, bundle_name, permission),
PRIMARY KEY (role_name, bundle_name, permission),
FOREIGN KEY (role_name) REFERENCES roles(role_name)
ON DELETE CASCADE
);
`
_, err = db.ExecContext(ctx, createRolesQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createTokensTable(ctx context.Context, db *sql.DB) error {
var err error
createTokensQuery := `CREATE TABLE tokens (
token TEXT,
username TEXT REFERENCES users,
valid_from TIMESTAMP WITH TIME ZONE,
valid_until TIMESTAMP WITH TIME ZONE,
PRIMARY KEY (username)
);
CREATE UNIQUE INDEX tokens_token ON tokens (token);
`
_, err = db.ExecContext(ctx, createTokensQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createUsersTable(ctx context.Context, db *sql.DB) error {
var err error
createUserQuery := `CREATE TABLE users (
email TEXT UNIQUE NOT NULL,
full_name TEXT,
password_hash TEXT,
username TEXT PRIMARY KEY
);`
_, err = db.ExecContext(ctx, createUserQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
func (da PostgresDataAccess) createUsersAdapterIDsTable(ctx context.Context, db *sql.DB) error {
var err error
createTableQuery := `CREATE TABLE user_adapter_ids (
username TEXT NOT NULL,
adapter TEXT NOT NULL,
id TEXT NOT NULL,
CONSTRAINT unq_adapter_id UNIQUE(username, adapter),
PRIMARY KEY (adapter, id),
FOREIGN KEY (username) REFERENCES users(username)
ON DELETE CASCADE
);
`
_, err = db.ExecContext(ctx, createTableQuery)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess, err)
}
return nil
}
// ensureGortDatabaseExists simply checks whether the "gort" database exists,
// and creates the empty database if it doesn't.
func (da PostgresDataAccess) ensureDatabaseExists(ctx context.Context, dbName string) error {
db, err := da.connect(ctx, "postgres")
if err != nil {
return err
}
defer db.Close()
exists, err := da.databaseExists(ctx, db, dbName)
if err != nil {
return err
}
if !exists {
_, err := db.ExecContext(ctx, "CREATE DATABASE $1", dbName)
if err != nil {
return gerr.Wrap(errs.ErrDataAccess,
gerr.Wrap(fmt.Errorf("failed to create database"),
err))
}
}
return nil
}
func (da PostgresDataAccess) tableExists(ctx context.Context, table string, db *sql.DB) (bool, error) {
var result string
rows, err := db.QueryContext(ctx, fmt.Sprintf("SELECT to_regclass('public.%s');", table))
if err != nil {
return false, gerr.Wrap(errs.ErrDataAccess, err)
}
defer rows.Close()
for rows.Next() {
rows.Scan(&result)
if result == table {
return true, nil
}
}
if err := rows.Err(); err != nil {
return false, gerr.Wrap(errs.ErrDataAccess, err)
}
return false, err
}