forked from grafana/k6
-
Notifications
You must be signed in to change notification settings - Fork 0
/
base_config.go
103 lines (92 loc) · 3.52 KB
/
base_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
/*
*
* k6 - a next-generation load testing tool
* Copyright (C) 2019 Load Impact
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package scheduler
import (
"fmt"
"time"
"github.com/loadimpact/k6/lib/types"
null "gopkg.in/guregu/null.v3"
)
const minPercentage = 0.01
// The maximum time k6 will wait after an iteration is supposed to be done
const maxIterationTimeout = 300 * time.Second
// BaseConfig contains the common config fields for all schedulers
type BaseConfig struct {
Name string `json:"-"` // set via the JS object key
Type string `json:"type"`
StartTime types.NullDuration `json:"startTime"`
Interruptible null.Bool `json:"interruptible"`
IterationTimeout types.NullDuration `json:"iterationTimeout"`
Env map[string]string `json:"env"`
Exec null.String `json:"exec"` // function name, externally validated
Percentage float64 `json:"-"` // 100, unless Split() was called
//TODO: future extensions like tags, distribution, others?
}
// NewBaseConfig returns a default base config with the default values
func NewBaseConfig(name, configType string, interruptible bool) BaseConfig {
return BaseConfig{
Name: name,
Type: configType,
Interruptible: null.NewBool(interruptible, false),
IterationTimeout: types.NewNullDuration(30*time.Second, false),
Percentage: 100,
}
}
// Validate checks some basic things like present name, type, and a positive start time
func (bc BaseConfig) Validate() (errors []error) {
// Some just-in-case checks, since those things are likely checked in other places or
// even assigned by us:
if bc.Name == "" {
errors = append(errors, fmt.Errorf("scheduler name shouldn't be empty"))
}
if bc.Type == "" {
errors = append(errors, fmt.Errorf("missing or empty type field"))
}
if bc.Percentage < minPercentage || bc.Percentage > 100 {
errors = append(errors, fmt.Errorf(
"percentage should be between %f and 100, but is %f", minPercentage, bc.Percentage,
))
}
if bc.Exec.Valid && bc.Exec.String == "" {
errors = append(errors, fmt.Errorf("exec value cannot be empty"))
}
// The actually reasonable checks:
if bc.StartTime.Duration < 0 {
errors = append(errors, fmt.Errorf("scheduler start time can't be negative"))
}
iterTimeout := time.Duration(bc.IterationTimeout.Duration)
if iterTimeout < 0 || iterTimeout > maxIterationTimeout {
errors = append(errors, fmt.Errorf(
"the iteration timeout should be between 0 and %s, but is %s", maxIterationTimeout, iterTimeout,
))
}
return errors
}
// GetBaseConfig just returns itself
func (bc BaseConfig) GetBaseConfig() BaseConfig {
return bc
}
// CopyWithPercentage is a helper function that just sets the percentage to
// the specified amount.
func (bc BaseConfig) CopyWithPercentage(percentage float64) *BaseConfig {
c := bc
c.Percentage = percentage
return &c
}