-
Notifications
You must be signed in to change notification settings - Fork 20
/
gorm.go
345 lines (285 loc) · 9.97 KB
/
gorm.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
// Copyright 2016-2022 Fraunhofer AISEC
//
// 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.
//
// $$\ $$\ $$\ $$\
// $$ | $$ |\__| $$ |
// $$$$$$$\ $$ | $$$$$$\ $$\ $$\ $$$$$$$ |$$\ $$$$$$\ $$$$$$\ $$$$$$\
// $$ _____|$$ |$$ __$$\ $$ | $$ |$$ __$$ |$$ |\_$$ _| $$ __$$\ $$ __$$\
// $$ / $$ |$$ / $$ |$$ | $$ |$$ / $$ |$$ | $$ | $$ / $$ |$$ | \__|
// $$ | $$ |$$ | $$ |$$ | $$ |$$ | $$ |$$ | $$ |$$\ $$ | $$ |$$ |
// \$$$$$$\ $$ |\$$$$$ |\$$$$$ |\$$$$$$ |$$ | \$$$ |\$$$$$ |$$ |
// \_______|\__| \______/ \______/ \_______|\__| \____/ \______/ \__|
//
// This file is part of Clouditor Community Edition.
package gorm
import (
"errors"
"fmt"
"strings"
"clouditor.io/clouditor/api/assessment"
"clouditor.io/clouditor/api/discovery"
"clouditor.io/clouditor/api/evaluation"
"clouditor.io/clouditor/api/evidence"
"clouditor.io/clouditor/api/orchestrator"
"clouditor.io/clouditor/persistence"
"github.com/glebarez/sqlite"
"github.com/sirupsen/logrus"
"gorm.io/driver/postgres"
"gorm.io/gorm"
"gorm.io/gorm/clause"
"gorm.io/gorm/logger"
"gorm.io/gorm/schema"
)
var log *logrus.Entry
type DB = gorm.DB
type storage struct {
db *gorm.DB
// for options: (set default when not in opts)
dialector gorm.Dialector
config gorm.Config
// types contains all types that we need to auto-migrate into database tables
types []any
// maxConn is the maximum number of connections. 0 means unlimited.
maxConn int
}
// DefaultTypes contains a list of internal types that need to be migrated by default
var DefaultTypes = []any{
&assessment.MetricImplementation{},
&assessment.Metric{},
&assessment.AssessmentResult{},
&discovery.Resource{},
&evidence.Evidence{},
&orchestrator.CloudService{},
&orchestrator.Certificate{},
&orchestrator.State{},
&orchestrator.Catalog{},
&orchestrator.Category{},
&orchestrator.Control{},
&evaluation.EvaluationResult{},
}
// StorageOption is a functional option type to configure the GORM storage. E.g. WithInMemory or WithPostgres
type StorageOption func(*storage)
// WithInMemory is an option to configure Storage to use an in memory DB
func WithInMemory() StorageOption {
return func(s *storage) {
s.dialector = sqlite.Open(":memory:?_pragma=foreign_keys(1)")
}
}
// WithMaxOpenConns is an option to configure the maximum number of open connections
func WithMaxOpenConns(max int) StorageOption {
return func(s *storage) {
s.maxConn = max
}
}
// WithPostgres is an option to configure Storage to use a Postgres DB
func WithPostgres(host string, port uint16, user string, pw string, db string, sslmode string) StorageOption {
return func(s *storage) {
s.dialector = postgres.Open(fmt.Sprintf("postgres://%s:%s@%s:%d/%s?sslmode=%s", user, pw, host, port, db, sslmode))
}
}
// WithLogger is an option to configure Storage to use a Logger
func WithLogger(logger logger.Interface) StorageOption {
return func(s *storage) {
s.config.Logger = logger
}
}
// WithAdditionalAutoMigration is an option to add additional types to GORM's auto-migration.
func WithAdditionalAutoMigration(types ...any) StorageOption {
return func(s *storage) {
s.types = append(s.types, types...)
}
}
func init() {
log = logrus.WithField("component", "storage")
}
// NewStorage creates a new storage using GORM (which DB to use depends on the StorageOption)
func NewStorage(opts ...StorageOption) (s persistence.Storage, err error) {
log.Println("Creating storage")
// Create storage with default gorm config
g := &storage{
// We ignore Deepsource issue GO-W1004 (SkipDefaultTransaction of config is "false"): skipcq: GO-W1004
config: gorm.Config{
Logger: logger.Default.LogMode(logger.Silent),
},
types: DefaultTypes,
}
// Add options and/or override default ones
for _, o := range opts {
o(g)
}
if g.dialector == nil {
WithInMemory()(g)
}
g.db, err = gorm.Open(g.dialector, &g.config)
if err != nil {
return nil, err
}
if g.maxConn > 0 {
sql, err := g.db.DB()
if err != nil {
return nil, fmt.Errorf("could not retrieve sql.DB: %v", err)
}
sql.SetMaxOpenConns(g.maxConn)
}
schema.RegisterSerializer("timestamppb", &TimestampSerializer{})
schema.RegisterSerializer("valuepb", &ValueSerializer{})
schema.RegisterSerializer("anypb", &AnySerializer{})
if err = g.db.SetupJoinTable(&orchestrator.CloudService{}, "CatalogsInScope", &orchestrator.TargetOfEvaluation{}); err != nil {
err = fmt.Errorf("error during join-table: %w", err)
return
}
if err = g.db.SetupJoinTable(orchestrator.CloudService{}, "ConfiguredMetrics", assessment.MetricConfiguration{}); err != nil {
err = fmt.Errorf("error during join-table: %w", err)
return
}
if err = g.db.SetupJoinTable(orchestrator.TargetOfEvaluation{}, "ControlsInScope", orchestrator.ControlInScope{}); err != nil {
err = fmt.Errorf("error during join-table: %w", err)
return
}
// After successful DB initialization, migrate the schema
if err = g.db.AutoMigrate(g.types...); err != nil {
err = fmt.Errorf("error during auto-migration: %w", err)
return
}
s = g
return
}
func (s *storage) Create(r any) (err error) {
err = s.db.Create(r).Error
if err != nil && (strings.Contains(err.Error(), "constraint failed: UNIQUE constraint failed") ||
strings.Contains(err.Error(), "duplicate key value violates unique constraint")) {
return persistence.ErrUniqueConstraintFailed
}
if err != nil && strings.Contains(err.Error(), "constraint failed") {
return persistence.ErrConstraintFailed
}
return
}
type preload struct {
query string
args []any
}
type QueryOption interface{}
// WithPreload allows the customization of Gorm's preload feature with the specified query and arguments.
func WithPreload(query string, args ...any) QueryOption {
return &preload{query: query, args: args}
}
// WithoutPreload disables any kind of preloading of Gorm. This is necessary, if custom join tables are used, otherwise
// Gorm will throws errors.
func WithoutPreload() QueryOption {
return &preload{query: ""}
}
func (s *storage) Get(r any, conds ...any) (err error) {
// Preload all associations of r if necessary
db, conds := applyPreload(s.db, conds...)
err = db.First(r, conds...).Error
// if record is not found, use the error message defined in the persistence package
if errors.Is(err, gorm.ErrRecordNotFound) {
err = persistence.ErrRecordNotFound
}
return
}
// applyWhere applies the conditional arguments to db.Where. We now basically distinguish between three cases:
// - an empty conditions list means no db.Where function is called
// - one condition specified means that it is takes as the query parameter. This will query for the specified primary key
// - otherwise, the first condition will be taken as the query parameter and all others will be taken as additional args.
func applyWhere(db *gorm.DB, conds ...any) *gorm.DB {
if len(conds) == 0 {
return db
} else if len(conds) == 1 {
return db.Where(conds[0])
} else {
return db.Where(conds[0], conds[1:]...)
}
}
// applyPreload checks for any preload options and prepends them to the DB query. If no extra option is specified,
// "clause.Associations" is used as the default preload.
func applyPreload(db *gorm.DB, conds ...any) (*gorm.DB, []any) {
if len(conds) > 0 {
if preload, ok := conds[0].(*preload); ok {
if preload.query != "" {
return db.Preload(preload.query, preload.args...), conds[1:]
} else {
return db, conds[1:]
}
}
}
return db.Preload(clause.Associations), conds
}
func (s *storage) List(r any, orderBy string, asc bool, offset int, limit int, conds ...any) error {
var query = s.db
// Set default direction to "ascending"
var orderDirection = "asc"
if limit != -1 {
query = s.db.Limit(limit)
}
// Set direction to "descending"
if !asc {
orderDirection = "desc"
}
orderStmt := orderBy + " " + orderDirection
// No explicit ordering
if orderBy == "" {
orderStmt = ""
}
// Preload all associations of r if necessary
query, conds = applyPreload(query.Offset(offset), conds...)
return query.Order(orderStmt).Find(r, conds...).Error
}
func (s *storage) Raw(r any, query string, args ...any) error {
return s.db.Raw(query, args...).Scan(r).Error
}
func (s *storage) Count(r any, conds ...any) (count int64, err error) {
db := applyWhere(s.db.Model(r), conds...)
err = db.Count(&count).Error
return
}
func (s *storage) Save(r any, conds ...any) error {
tx := applyWhere(s.db, conds...).Save(r)
err := tx.Error
if err != nil && strings.Contains(err.Error(), "constraint failed") {
return persistence.ErrConstraintFailed
}
return err
}
// Update will update the record with non-zero fields. Note that to get the entire updated record you have to call Get
func (s *storage) Update(r any, conds ...any) error {
tx := s.db.Session(&gorm.Session{FullSaveAssociations: true}).Model(r)
tx = applyWhere(tx, conds...).Updates(r)
if err := tx.Error; err != nil { // db error
if strings.Contains(err.Error(), "constraint failed") {
return persistence.ErrConstraintFailed
} else {
return err
}
}
// No record with given ID found
if tx.RowsAffected == 0 {
return persistence.ErrRecordNotFound
}
return nil
}
// Delete deletes record with given id. If no record was found, returns ErrRecordNotFound
func (s *storage) Delete(r any, conds ...any) error {
// Remove record r with given ID
tx := s.db.Delete(r, conds...)
if err := tx.Error; err != nil { // db error
return err
}
// No record with given ID found
if tx.RowsAffected == 0 {
return persistence.ErrRecordNotFound
}
return nil
}