/
genutil.go
207 lines (188 loc) · 6 KB
/
genutil.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
// Copyright 2020 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 genutil
import (
"bytes"
"errors"
"fmt"
"io"
"os"
"path/filepath"
"strings"
"github.com/blang/semver/v4"
"github.com/operator-framework/operator-sdk/internal/util/projutil"
apiextv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apiextv1beta1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
"sigs.k8s.io/controller-runtime/pkg/client"
cfgv2 "sigs.k8s.io/kubebuilder/v3/pkg/config/v2"
"sigs.k8s.io/yaml"
)
// ValidateVersion returns an error if version is not a strict semantic version.
func ValidateVersion(version string) error {
v, err := semver.Parse(version)
if err != nil {
return fmt.Errorf("%s is not a valid semantic version: %v", version, err)
}
// Ensures numerical values composing csvVersion don't contain leading 0's,
// ex. 01.01.01
if v.String() != version {
return fmt.Errorf("version %s contains bad values (parses to %s)", version, v)
}
return nil
}
// IsPipeReader returns true if stdin is an open pipe, i.e. the caller can
// accept input from stdin.
func IsPipeReader() bool {
info, err := os.Stdin.Stat()
if err != nil {
return false
}
return info.Mode()&os.ModeNamedPipe != 0
}
// WriteObjects writes each object in objs to w.
func WriteObjects(w io.Writer, objs ...client.Object) error {
for _, obj := range objs {
if err := writeObject(w, obj); err != nil {
return err
}
}
return nil
}
// WriteObjectsToFiles creates dir then writes each object in objs to a file in dir.
func WriteObjectsToFiles(dir string, objs ...client.Object) error {
if err := os.MkdirAll(dir, 0755); err != nil {
return err
}
seenFiles := make(map[string]struct{})
// Use the number of dupliates in file names so users can debug duplicate file behavior.
dupCount := 0
for _, obj := range objs {
var fileName string
switch t := obj.(type) {
case *apiextv1.CustomResourceDefinition:
if t.Spec.Group != "" && t.Spec.Names.Plural != "" {
fileName = makeCRDFileName(t.Spec.Group, t.Spec.Names.Plural)
} else {
fileName = makeObjectFileName(t)
}
case *apiextv1beta1.CustomResourceDefinition:
if t.Spec.Group != "" && t.Spec.Names.Plural != "" {
fileName = makeCRDFileName(t.Spec.Group, t.Spec.Names.Plural)
} else {
fileName = makeObjectFileName(t)
}
default:
fileName = makeObjectFileName(t)
}
if _, hasFile := seenFiles[fileName]; hasFile {
fileName = fmt.Sprintf("dup%d_%s", dupCount, fileName)
dupCount++
}
if err := writeObjectToFile(dir, obj, fileName); err != nil {
return err
}
seenFiles[fileName] = struct{}{}
}
return nil
}
func makeCRDFileName(group, resource string) string {
return fmt.Sprintf("%s_%s.yaml", group, resource)
}
func makeObjectFileName(obj client.Object) string {
gvk := obj.GetObjectKind().GroupVersionKind()
if gvk.Group == "" {
return fmt.Sprintf("%s_%s_%s.yaml", obj.GetName(), gvk.Version, strings.ToLower(gvk.Kind))
}
return fmt.Sprintf("%s_%s_%s_%s.yaml", obj.GetName(), gvk.Group, gvk.Version, strings.ToLower(gvk.Kind))
}
// writeObjectToFile marshals crd to bytes and writes them to dir in file.
func writeObjectToFile(dir string, obj interface{}, fileName string) error {
f, err := os.Create(filepath.Join(dir, fileName))
if err != nil {
return err
}
defer f.Close()
return writeObject(f, obj)
}
// writeObject marshals crd to bytes and writes them to w.
func writeObject(w io.Writer, obj interface{}) error {
b, err := yaml.Marshal(obj)
if err != nil {
return err
}
_, err = w.Write(b)
return err
}
// multiManifestWriter writes a multi-part manifest by prepending "---"
// to the argument of io.Writer.Write().
type multiManifestWriter struct {
io.Writer
}
func (w *multiManifestWriter) Write(b []byte) (int, error) {
return w.Writer.Write(append([]byte("\n---\n"), bytes.TrimSpace(b)...))
}
// NewMultiManifestWriter returns a multi-part manifest writer. Use this writer
// if writing a package or bundle to stdout or a single file.
func NewMultiManifestWriter(w io.Writer) io.Writer {
return &multiManifestWriter{w}
}
// IsNotExist returns true if path does not exist on disk.
func IsNotExist(path string) bool {
if path == "" {
return true
}
_, err := os.Stat(path)
return err != nil && errors.Is(err, os.ErrNotExist)
}
// IsExist returns true if path exists on disk.
func IsExist(path string) bool {
if path == "" {
return false
}
_, err := os.Stat(path)
return err == nil || errors.Is(err, os.ErrExist)
}
// GetPackageNameAndLayout returns packageName and layout, if any, for a project.
// These values are determined by project version and whether a PROJECT file exists.
func GetPackageNameAndLayout(defaultPackageName string) (packageName string, layout string, _ error) {
packageName = defaultPackageName
if projutil.HasProjectFile() {
cfg, err := projutil.ReadConfig()
if err != nil {
return "", "", err
}
if packageName == "" {
switch {
case cfg.GetVersion().Compare(cfgv2.Version) == 0:
wd, err := os.Getwd()
if err != nil {
return "", "", err
}
packageName = strings.ToLower(filepath.Base(wd))
default:
packageName = cfg.GetProjectName()
if packageName == "" {
return "", "", errors.New("--package <name> must be set if \"projectName\" is not set in the PROJECT config file")
}
}
}
layout = projutil.GetProjectLayout(cfg)
} else {
if packageName == "" {
return "", "", errors.New("--package <name> must be set if PROJECT config file is not present")
}
layout = "unknown"
}
return packageName, layout, nil
}