-
Notifications
You must be signed in to change notification settings - Fork 341
/
config.go
285 lines (234 loc) · 8.48 KB
/
config.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
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 config provides tools to load and validate configuration data for
// Traffic Ops API tests.
package config
import (
"encoding/json"
"fmt"
"io/ioutil"
"reflect"
"strings"
log "github.com/apache/trafficcontrol/lib/go-log"
"github.com/kelseyhightower/envconfig"
)
// Config reflects the structure of the test-to-api.conf file
type Config struct {
TrafficOps TrafficOps `json:"trafficOps"`
TrafficOpsDB TrafficOpsDB `json:"trafficOpsDB"`
Default Default `json:"default"`
UseIMS bool `json:"use_ims"`
// Sets whether or not to perform tests that involve ISO generation
NoISO bool `json:"noISO"`
}
// TrafficOps - config section
type TrafficOps struct {
// URL - The point to the Traffic Ops instance being tested
URL string `json:"URL" envconfig:"TO_URL"`
// UserPassword - The Traffic Ops test user password hitting the API
UserPassword string `json:"password" envconfig:"TO_USER_PASSWORD"`
// User - The Traffic Ops Users
Users Users `json:"users"`
// Insecure - ignores insecure ssls certs that were self-generated
Insecure bool `json:"sslInsecure" envconfig:"SSL_INSECURE"`
}
// Users "users" section of the test-to-api.conf file
type Users struct {
// DisallowedUser - The Traffic Ops Disallowed user
Disallowed string `json:"disallowed" envconfig:"TO_USER_DISALLOWED"`
// ReadOnly - The Traffic Ops Read Only user
ReadOnly string `json:"readOnly" envconfig:"TO_USER_READ_ONLY"`
// Operations - The Traffic Ops Operations user
Operations string `json:"operations" envconfig:"TO_USER_OPERATIONS"`
// AdminUser - The Traffic Ops Admin user
Admin string `json:"admin" envconfig:"TO_USER_ADMIN"`
// PortalUser - The Traffic Ops Portal user
Portal string `json:"portal" envconfig:"TO_USER_PORTAL"`
// FederationUser - The Traffic Ops Federation user
Federation string `json:"federation" envconfig:"TO_USER_FEDERATION"`
// Extension - The Traffic Ops Extension user
Extension string `json:"extension" envconfig:"TO_USER_EXTENSION"`
}
// TrafficOpsDB - config section
type TrafficOpsDB struct {
// Name - Traffic Ops Database name where the test data will be setup
Name string `json:"dbname" envconfig:"TODB_NAME"`
// Hostname - Traffic Ops Database hostname where Postgres is running
Hostname string `json:"hostname" envconfig:"TODB_HOSTNAME"`
// User - database user that Traffic Ops is using to point to the 'to_test' database
User string `json:"user" envconfig:"TODB_USER"`
// Password - database password for the User above
Password string `json:"password" envconfig:"TODB_PASSWORD"`
// Port - Postgres port running that has the to_test schema
Port string `json:"port" envconfig:"TODB_PORT"`
// DBType - will be 'Pg' by default but tells the Golang database driver
// the database type
DBType string `json:"type" envconfig:"TODB_TYPE"`
// SSL - Flag that tells the database driver that the Postgres instances has TLS enabled
SSL bool `json:"ssl" envconfig:"TODB_SSL"`
// Description - database description
Description string `json:"description" envconfig:"TODB_DESCRIPTION"`
}
// Default - config section
type Default struct {
Session Session `json:"session"`
Log Locations `json:"logLocations"`
IncludeSystemTests bool `json:"includeSystemTests"`
}
// Session - config section
type Session struct {
TimeoutInSecs int `json:"timeoutInSecs" envconfig:"SESSION_TIMEOUT_IN_SECS"`
}
// Locations - reflects the structure of the database.conf file
type Locations struct {
Debug string `json:"debug"`
Event string `json:"event"`
Error string `json:"error"`
Info string `json:"info"`
Warning string `json:"warning"`
}
// LoadConfig - reads the config file into the Config struct
func LoadConfig(confPath string) (Config, error) {
var cfg Config
confBytes, err := ioutil.ReadFile(confPath)
if err != nil {
return cfg, fmt.Errorf("failed to read CDN configuration: %v", err)
}
err = json.Unmarshal(confBytes, &cfg)
if err != nil {
return cfg, fmt.Errorf("failed to parse configuration from '%s': %v", confPath, err)
}
if err := validate(confPath, cfg); err != nil {
return cfg, fmt.Errorf("failed to validate configuration:\n%v", err)
}
if err := envconfig.Process("traffic-ops-client-tests", &cfg); err != nil {
return cfg, fmt.Errorf("failed to parse configuration from environment: %v", err)
}
return cfg, nil
}
type multiError []error
func (me multiError) Error() string {
var sb strings.Builder
for _, e := range me {
fmt.Fprintln(&sb, e)
}
return sb.String()
}
// validate all required fields in the config.
func validate(confPath string, config Config) error {
var errs multiError
var f string
f = "TrafficOps"
toTag, ok := getStructTag(config, f)
if !ok {
errs = append(errs, fmt.Errorf("'%s' must be configured in %s", toTag, confPath))
}
if config.TrafficOps.URL == "" {
f = "URL"
tag, ok := getStructTag(config.TrafficOps, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.Disallowed == "" {
f = "Disallowed"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.ReadOnly == "" {
f = "ReadOnly"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.Operations == "" {
f = "Operations"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.Admin == "" {
f = "Admin"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.Portal == "" {
f = "Portal"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if config.TrafficOps.Users.Federation == "" {
f = "Federation"
tag, ok := getStructTag(config.TrafficOps.Users, f)
if !ok {
errs = append(errs, fmt.Errorf("cannot lookup structTag: %s", f))
}
errs = append(errs, fmt.Errorf("'%s.%s' must be configured in %s", toTag, tag, confPath))
}
if len(errs) > 0 {
return errs
}
return nil
}
func getStructTag(thing interface{}, fieldName string) (string, bool) {
var tag string
var ok bool
t := reflect.TypeOf(thing)
if t != nil {
if f, ok := t.FieldByName(fieldName); ok {
tag = f.Tag.Get("json")
return tag, ok
}
}
return tag, ok
}
// ErrorLog - critical messages
func (c Config) ErrorLog() log.LogLocation {
return log.LogLocation(c.Default.Log.Error)
}
// WarningLog - warning messages
func (c Config) WarningLog() log.LogLocation {
return log.LogLocation(c.Default.Log.Warning)
}
// InfoLog - information messages
func (c Config) InfoLog() log.LogLocation {
return log.LogLocation(c.Default.Log.Info)
}
// DebugLog - troubleshooting messages
func (c Config) DebugLog() log.LogLocation {
return log.LogLocation(c.Default.Log.Debug)
}
// EventLog - access.log high level transactions
func (c Config) EventLog() log.LogLocation {
return log.LogLocation(c.Default.Log.Event)
}