-
Notifications
You must be signed in to change notification settings - Fork 233
/
preflight.go
166 lines (143 loc) · 3.89 KB
/
preflight.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
package preflight
import (
"fmt"
cfg "github.com/code-ready/crc/pkg/crc/config"
"github.com/code-ready/crc/pkg/crc/errors"
"github.com/code-ready/crc/pkg/crc/logging"
)
type PreflightCheckFlags uint32
// Enables the use of experimental features
var EnableExperimentalFeatures bool
const (
// Indicates a PreflightCheck should only be run as part of "crc setup"
SetupOnly PreflightCheckFlags = 1 << iota
// Indicates a PreflightCheck should only be run as part of "crc start"
StartOnly
NoFix
CleanUpOnly
)
type PreflightCheckFunc func() error
type PreflightFixFunc func() error
type PreflightCleanUpFunc func() error
type PreflightCheck struct {
configKeySuffix string
checkDescription string
check PreflightCheckFunc
fixDescription string
fix PreflightFixFunc
flags PreflightCheckFlags
cleanupDescription string
cleanup PreflightCleanUpFunc
}
func (check *PreflightCheck) getSkipConfigName() string {
if check.configKeySuffix == "" {
return ""
}
return "skip-" + check.configKeySuffix
}
func (check *PreflightCheck) shouldSkip() bool {
if check.configKeySuffix == "" {
return false
}
return cfg.GetBool(check.getSkipConfigName())
}
func (check *PreflightCheck) getWarnConfigName() string {
if check.configKeySuffix == "" {
return ""
}
return "warn-" + check.configKeySuffix
}
func (check *PreflightCheck) shouldWarn() bool {
if check.configKeySuffix == "" {
return false
}
return cfg.GetBool(check.getWarnConfigName())
}
func (check *PreflightCheck) doCheck() error {
if check.checkDescription == "" {
panic(fmt.Sprintf("Should not happen, empty description for check '%s'", check.configKeySuffix))
} else {
logging.Infof("%s", check.checkDescription)
}
if check.shouldSkip() {
logging.Warn("Skipping above check ...")
return nil
}
err := check.check()
if err != nil {
logging.Debug(err.Error())
}
return err
}
func (check *PreflightCheck) doFix() error {
if check.fixDescription == "" {
panic(fmt.Sprintf("Should not happen, empty description for fix '%s'", check.configKeySuffix))
}
if check.flags&NoFix == NoFix {
return errors.Newf(check.fixDescription)
}
logging.Infof("%s", check.fixDescription)
return check.fix()
}
func (check *PreflightCheck) doCleanUp() error {
if check.cleanupDescription == "" {
panic(fmt.Sprintf("Should not happen, empty description for cleanup '%s'", check.configKeySuffix))
}
logging.Infof("%s", check.cleanupDescription)
return check.cleanup()
}
func doPreflightChecks(checks []PreflightCheck) {
for _, check := range checks {
if check.flags&SetupOnly == SetupOnly || check.flags&CleanUpOnly == CleanUpOnly {
continue
}
err := check.doCheck()
if err != nil {
if check.shouldWarn() {
logging.Warn(err.Error())
} else {
logging.Fatal(err.Error())
}
}
}
}
func doFixPreflightChecks(checks []PreflightCheck) {
for _, check := range checks {
if check.flags&StartOnly == StartOnly || check.flags&CleanUpOnly == CleanUpOnly {
continue
}
err := check.doCheck()
if err == nil {
continue
}
err = check.doFix()
if err != nil {
if check.shouldWarn() {
logging.Warn(err.Error())
} else {
logging.Fatal(err.Error())
}
}
}
}
func doCleanUpPreflightChecks(checks []PreflightCheck) {
// Do the cleanup in reverse order to avoid any dependency during cleanup
for i := len(checks) - 1; i >= 0; i-- {
check := checks[i]
if check.cleanup == nil {
continue
}
err := check.doCleanUp()
if err != nil {
logging.Fatal(err.Error())
}
}
}
func doRegisterSettings(checks []PreflightCheck) {
for _, check := range checks {
if check.configKeySuffix != "" {
cfg.AddSetting(check.getSkipConfigName(), false, []cfg.ValidationFnType{cfg.ValidateBool}, []cfg.SetFn{cfg.SuccessfullyApplied})
cfg.AddSetting(check.getWarnConfigName(), false, []cfg.ValidationFnType{cfg.ValidateBool}, []cfg.SetFn{cfg.SuccessfullyApplied})
}
}
}