/
project_util.go
158 lines (137 loc) · 4.27 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
// 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"
"io/ioutil"
"os"
"regexp"
"strings"
log "github.com/sirupsen/logrus"
"sigs.k8s.io/kubebuilder/pkg/model/config"
)
const (
// Useful file modes.
DirMode = 0755
FileMode = 0644
ExecFileMode = 0755
)
const (
// Go env vars.
GoFlagsEnv = "GOFLAGS"
GoModEnv = "GO111MODULE"
)
// Default config file path.
const configFile = "PROJECT"
// 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)
}
// HasProjectFile returns true if the project is configured as a kubebuilder
// project.
func HasProjectFile() bool {
_, err := os.Stat(configFile)
if err != nil {
if os.IsNotExist(err) {
return false
}
log.Fatalf("Failed to read PROJECT file to detect kubebuilder project: %v", err)
}
return true
}
// ReadConfig returns a configuration if a file containing one exists at the
// default path (project root).
func ReadConfig() (*config.Config, error) {
b, err := ioutil.ReadFile(configFile)
if err != nil {
return nil, err
}
c := &config.Config{}
if err = c.Unmarshal(b); err != nil {
return nil, err
}
return c, nil
}
// PluginKeyToOperatorType converts a plugin key string to an operator project type.
// TODO(estroz): this can probably be made more robust by checking known plugin keys directly.
func PluginKeyToOperatorType(pluginKey string) OperatorType {
switch {
case strings.HasPrefix(pluginKey, "go"):
return OperatorTypeGo
case strings.HasPrefix(pluginKey, "helm"):
return OperatorTypeHelm
case strings.HasPrefix(pluginKey, "ansible"):
return OperatorTypeAnsible
}
return OperatorTypeUnknown
}
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
}
// RewriteFileContents adds newContent to the line after the last occurrence of target in filename's contents,
// then writes the updated contents back to disk.
func RewriteFileContents(filename, target, newContent string) error {
text, err := ioutil.ReadFile(filename)
if err != nil {
return fmt.Errorf("error in getting contents from the file, %v", err)
}
modifiedContent, err := appendContent(string(text), target, newContent)
if err != nil {
return err
}
err = ioutil.WriteFile(filename, []byte(modifiedContent), FileMode)
if err != nil {
return fmt.Errorf("error writing modified contents to file, %v", err)
}
return nil
}
func appendContent(fileContents, target, newContent string) (string, error) {
labelIndex := strings.LastIndex(fileContents, target)
if labelIndex == -1 {
return "", fmt.Errorf("no prior string %s in newContent", target)
}
separationIndex := strings.Index(fileContents[labelIndex:], "\n")
if separationIndex == -1 {
return "", fmt.Errorf("no new line at the end of string %s", fileContents[labelIndex:])
}
index := labelIndex + separationIndex + 1
return fileContents[:index] + newContent + fileContents[index:], nil
}