forked from operator-framework/operator-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
project_util.go
226 lines (196 loc) · 6.01 KB
/
project_util.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
// Copyright 2018 The Operator-SDK 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 projutil
import (
"fmt"
"os"
"path/filepath"
"regexp"
"strings"
homedir "github.com/mitchellh/go-homedir"
log "github.com/sirupsen/logrus"
"github.com/spf13/cobra"
)
const (
GoPathEnv = "GOPATH"
GoFlagsEnv = "GOFLAGS"
GoModEnv = "GO111MODULE"
SrcDir = "src"
fsep = string(filepath.Separator)
mainFile = "cmd" + fsep + "manager" + fsep + "main.go"
buildDockerfile = "build" + fsep + "Dockerfile"
rolesDir = "roles"
helmChartsDir = "helm-charts"
goModFile = "go.mod"
gopkgTOMLFile = "Gopkg.toml"
)
// OperatorType - the type of operator
type OperatorType = string
const (
// OperatorTypeGo - golang type of operator.
OperatorTypeGo OperatorType = "go"
// OperatorTypeAnsible - ansible type of operator.
OperatorTypeAnsible OperatorType = "ansible"
// OperatorTypeHelm - helm type of operator.
OperatorTypeHelm OperatorType = "helm"
// OperatorTypeUnknown - unknown type of operator.
OperatorTypeUnknown OperatorType = "unknown"
)
type ErrUnknownOperatorType struct {
Type string
}
func (e ErrUnknownOperatorType) Error() string {
if e.Type == "" {
return "unknown operator type"
}
return fmt.Sprintf(`unknown operator type "%v"`, e.Type)
}
type DepManagerType string
const (
DepManagerGoMod DepManagerType = "modules"
DepManagerDep DepManagerType = "dep"
)
type ErrInvalidDepManager string
func (e ErrInvalidDepManager) Error() string {
return fmt.Sprintf(`"%s" is not a valid dep manager; dep manager must be one of ["%v", "%v"]`, e, DepManagerDep, DepManagerGoMod)
}
var ErrNoDepManager = fmt.Errorf(`no valid dependency manager file found; dep manager must be one of ["%v", "%v"]`, DepManagerDep, DepManagerGoMod)
func GetDepManagerType() (DepManagerType, error) {
if IsDepManagerDep() {
return DepManagerDep, nil
} else if IsDepManagerGoMod() {
return DepManagerGoMod, nil
}
return "", ErrNoDepManager
}
func IsDepManagerDep() bool {
_, err := os.Stat(gopkgTOMLFile)
return err == nil || os.IsExist(err)
}
func IsDepManagerGoMod() bool {
_, err := os.Stat(goModFile)
return err == nil || os.IsExist(err)
}
// MustInProjectRoot checks if the current dir is the project root and returns
// the current repo's import path, ex github.com/example-inc/app-operator
func MustInProjectRoot() {
// If the current directory has a "build/dockerfile", then it is safe to say
// we are at the project root.
if _, err := os.Stat(buildDockerfile); err != nil {
if os.IsNotExist(err) {
log.Fatalf("Must run command in project root dir: project structure requires %s", buildDockerfile)
}
log.Fatalf("Error while checking if current directory is the project root: (%v)", err)
}
}
func CheckGoProjectCmd(cmd *cobra.Command) error {
if IsOperatorGo() {
return nil
}
return fmt.Errorf("'%s' can only be run for Go operators; %s does not exist.", cmd.CommandPath(), mainFile)
}
func MustGetwd() string {
wd, err := os.Getwd()
if err != nil {
log.Fatalf("Failed to get working directory: (%v)", err)
}
return wd
}
func getHomeDir() (string, error) {
hd, err := homedir.Dir()
if err != nil {
return "", err
}
return homedir.Expand(hd)
}
// CheckAndGetProjectGoPkg checks if this project's repository path is rooted under $GOPATH and returns the current directory's import path
// e.g: "github.com/example-inc/app-operator"
func CheckAndGetProjectGoPkg() string {
gopath := MustSetGopath(MustGetGopath())
goSrc := filepath.Join(gopath, SrcDir)
wd := MustGetwd()
currPkg := strings.Replace(wd, goSrc, "", 1)
// strip any "/" prefix from the repo path.
return strings.TrimPrefix(currPkg, fsep)
}
// GetOperatorType returns type of operator is in cwd.
// This function should be called after verifying the user is in project root.
func GetOperatorType() OperatorType {
switch {
case IsOperatorGo():
return OperatorTypeGo
case IsOperatorAnsible():
return OperatorTypeAnsible
case IsOperatorHelm():
return OperatorTypeHelm
}
return OperatorTypeUnknown
}
func IsOperatorGo() bool {
_, err := os.Stat(mainFile)
return err == nil
}
func IsOperatorAnsible() bool {
stat, err := os.Stat(rolesDir)
return err == nil && stat.IsDir()
}
func IsOperatorHelm() bool {
stat, err := os.Stat(helmChartsDir)
return err == nil && stat.IsDir()
}
// MustGetGopath gets GOPATH and ensures it is set and non-empty. If GOPATH
// is not set or empty, MustGetGopath exits.
func MustGetGopath() string {
gopath, ok := os.LookupEnv(GoPathEnv)
if !ok || len(gopath) == 0 {
log.Fatal("GOPATH env not set")
}
return gopath
}
// MustSetGopath sets GOPATH=currentGopath after processing a path list,
// if any, then returns the set path. If GOPATH cannot be set, MustSetGopath
// exits.
func MustSetGopath(currentGopath string) string {
var (
newGopath string
cwdInGopath bool
wd = MustGetwd()
)
for _, newGopath = range strings.Split(currentGopath, ":") {
if strings.HasPrefix(filepath.Dir(wd), newGopath) {
cwdInGopath = true
break
}
}
if !cwdInGopath {
log.Fatalf("Project not in $GOPATH")
}
if err := os.Setenv(GoPathEnv, newGopath); err != nil {
log.Fatal(err)
}
return newGopath
}
var flagRe = regexp.MustCompile("(.* )?-v(.* )?")
// SetGoVerbose sets GOFLAGS="${GOFLAGS} -v" if GOFLAGS does not
// already contain "-v" to make "go" command output verbose.
func SetGoVerbose() error {
gf, ok := os.LookupEnv(GoFlagsEnv)
if !ok || len(gf) == 0 {
return os.Setenv(GoFlagsEnv, "-v")
}
if !flagRe.MatchString(gf) {
return os.Setenv(GoFlagsEnv, gf+" -v")
}
return nil
}