Skip to content

Commit f5dc03e

Browse files
committed
Change const to upper case so it can be used
Signed-off-by: Vu Dinh <vdinh@redhat.com>
1 parent ee575b1 commit f5dc03e

File tree

4 files changed

+53
-53
lines changed

4 files changed

+53
-53
lines changed

pkg/lib/bundle/build.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
func BuildBundleImage(directory, imageTag, imageBuilder string) (*exec.Cmd, error) {
1414
var args []string
1515

16-
dockerfilePath := path.Join(directory, dockerFile)
16+
dockerfilePath := path.Join(directory, DockerFile)
1717

1818
switch imageBuilder {
1919
case "docker", "podman":

pkg/lib/bundle/generate.go

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,20 @@ import (
1313
)
1414

1515
const (
16-
defaultPermission = 0644
17-
registryV1Type = "registry+v1"
18-
plainType = "plain"
19-
helmType = "helm"
20-
annotationsFile = "annotations.yaml"
21-
dockerFile = "Dockerfile"
22-
manifestsDir = "manifests/"
23-
metadataDir = "metadata/"
24-
manifestsLabel = "operators.operatorframework.io.bundle.manifests.v1"
25-
metadataLabel = "operators.operatorframework.io.bundle.metadata.v1"
26-
mediatypeLabel = "operators.operatorframework.io.bundle.mediatype.v1"
27-
packageLabel = "operators.operatorframework.io.bundle.package.v1"
28-
channelsLabel = "operators.operatorframework.io.bundle.channels.v1"
29-
channelDefaultLabel = "operators.operatorframework.io.bundle.channel.default.v1"
16+
DefaultPermission = 0644
17+
RegistryV1Type = "registry+v1"
18+
PlainType = "plain"
19+
HelmType = "helm"
20+
AnnotationsFile = "annotations.yaml"
21+
DockerFile = "Dockerfile"
22+
ManifestsDir = "manifests/"
23+
MetadataDir = "metadata/"
24+
ManifestsLabel = "operators.operatorframework.io.bundle.manifests.v1"
25+
MetadataLabel = "operators.operatorframework.io.bundle.metadata.v1"
26+
MediatypeLabel = "operators.operatorframework.io.bundle.mediatype.v1"
27+
PackageLabel = "operators.operatorframework.io.bundle.package.v1"
28+
ChannelsLabel = "operators.operatorframework.io.bundle.channels.v1"
29+
ChannelDefaultLabel = "operators.operatorframework.io.bundle.channel.default.v1"
3030
)
3131

3232
type AnnotationMetadata struct {
@@ -54,14 +54,14 @@ func GenerateFunc(directory, packageName, channels, channelDefault string, overw
5454
log.Info("Building annotations.yaml")
5555

5656
// Generate annotations.yaml
57-
content, err := GenerateAnnotations(mediaType, manifestsDir, metadataDir, packageName, channels, channelDefault)
57+
content, err := GenerateAnnotations(mediaType, ManifestsDir, MetadataDir, packageName, channels, channelDefault)
5858
if err != nil {
5959
return err
6060
}
6161

62-
file, err := ioutil.ReadFile(filepath.Join(directory, metadataDir, annotationsFile))
62+
file, err := ioutil.ReadFile(filepath.Join(directory, MetadataDir, AnnotationsFile))
6363
if os.IsNotExist(err) || overwrite {
64-
err = WriteFile(annotationsFile, filepath.Join(directory, metadataDir), content)
64+
err = WriteFile(AnnotationsFile, filepath.Join(directory, MetadataDir), content)
6565
if err != nil {
6666
return err
6767
}
@@ -77,12 +77,12 @@ func GenerateFunc(directory, packageName, channels, channelDefault string, overw
7777
log.Info("Building Dockerfile")
7878

7979
// Generate Dockerfile
80-
content, err = GenerateDockerfile(directory, mediaType, manifestsDir, metadataDir, packageName, channels, channelDefault)
80+
content, err = GenerateDockerfile(directory, mediaType, ManifestsDir, MetadataDir, packageName, channels, channelDefault)
8181
if err != nil {
8282
return err
8383
}
8484

85-
err = WriteFile(dockerFile, directory, content)
85+
err = WriteFile(DockerFile, directory, content)
8686
if err != nil {
8787
return err
8888
}
@@ -113,15 +113,15 @@ func GetMediaType(directory string) (string, error) {
113113
// Validate the file names to determine media type
114114
for _, file := range files {
115115
if file == "Chart.yaml" {
116-
return helmType, nil
116+
return HelmType, nil
117117
} else if strings.HasSuffix(file, "clusterserviceversion.yaml") {
118-
return registryV1Type, nil
118+
return RegistryV1Type, nil
119119
} else {
120120
continue
121121
}
122122
}
123123

124-
return plainType, nil
124+
return PlainType, nil
125125
}
126126

127127
// ValidateAnnotations validates existing annotations.yaml against generated
@@ -199,12 +199,12 @@ func ValidateChannelDefault(channels, channelDefault string) (string, error) {
199199
func GenerateAnnotations(mediaType, manifests, metadata, packageName, channels, channelDefault string) ([]byte, error) {
200200
annotations := &AnnotationMetadata{
201201
Annotations: map[string]string{
202-
mediatypeLabel: mediaType,
203-
manifestsLabel: manifests,
204-
metadataLabel: metadata,
205-
packageLabel: packageName,
206-
channelsLabel: channels,
207-
channelDefaultLabel: channelDefault,
202+
MediatypeLabel: mediaType,
203+
ManifestsLabel: manifests,
204+
MetadataLabel: metadata,
205+
PackageLabel: packageName,
206+
ChannelsLabel: channels,
207+
ChannelDefaultLabel: channelDefault,
208208
},
209209
}
210210

@@ -213,7 +213,7 @@ func GenerateAnnotations(mediaType, manifests, metadata, packageName, channels,
213213
return nil, err
214214
}
215215

216-
annotations.Annotations[channelDefaultLabel] = chanDefault
216+
annotations.Annotations[ChannelDefaultLabel] = chanDefault
217217

218218
afile, err := yaml.Marshal(annotations)
219219
if err != nil {
@@ -238,16 +238,16 @@ func GenerateDockerfile(directory, mediaType, manifests, metadata, packageName,
238238
fileContent += "FROM scratch\n\n"
239239

240240
// LABEL
241-
fileContent += fmt.Sprintf("LABEL %s=%s\n", mediatypeLabel, mediaType)
242-
fileContent += fmt.Sprintf("LABEL %s=%s\n", manifestsLabel, manifests)
243-
fileContent += fmt.Sprintf("LABEL %s=%s\n", metadataLabel, metadata)
244-
fileContent += fmt.Sprintf("LABEL %s=%s\n", packageLabel, packageName)
245-
fileContent += fmt.Sprintf("LABEL %s=%s\n", channelsLabel, channels)
246-
fileContent += fmt.Sprintf("LABEL %s=%s\n\n", channelDefaultLabel, chanDefault)
241+
fileContent += fmt.Sprintf("LABEL %s=%s\n", MediatypeLabel, mediaType)
242+
fileContent += fmt.Sprintf("LABEL %s=%s\n", ManifestsLabel, manifests)
243+
fileContent += fmt.Sprintf("LABEL %s=%s\n", MetadataLabel, metadata)
244+
fileContent += fmt.Sprintf("LABEL %s=%s\n", PackageLabel, packageName)
245+
fileContent += fmt.Sprintf("LABEL %s=%s\n", ChannelsLabel, channels)
246+
fileContent += fmt.Sprintf("LABEL %s=%s\n\n", ChannelDefaultLabel, chanDefault)
247247

248248
// CONTENT
249249
fileContent += fmt.Sprintf("ADD %s %s\n", filepath.Join(directory, "*.yaml"), "/manifests")
250-
fileContent += fmt.Sprintf("ADD %s %s%s\n", filepath.Join(directory, metadata, annotationsFile), "/metadata/", annotationsFile)
250+
fileContent += fmt.Sprintf("ADD %s %s%s\n", filepath.Join(directory, metadata, AnnotationsFile), "/metadata/", AnnotationsFile)
251251

252252
return []byte(fileContent), nil
253253
}
@@ -259,7 +259,7 @@ func WriteFile(fileName, directory string, content []byte) error {
259259
os.Mkdir(directory, os.ModePerm)
260260
}
261261

262-
err := ioutil.WriteFile(filepath.Join(directory, fileName), content, defaultPermission)
262+
err := ioutil.WriteFile(filepath.Join(directory, fileName), content, DefaultPermission)
263263
if err != nil {
264264
return err
265265
}

pkg/lib/bundle/generate_test.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,17 @@ func TestGetMediaType(t *testing.T) {
2121
}{
2222
{
2323
testDir,
24-
registryV1Type,
24+
RegistryV1Type,
2525
"",
2626
},
2727
{
2828
testDir,
29-
helmType,
29+
HelmType,
3030
"",
3131
},
3232
{
3333
testDir,
34-
plainType,
34+
PlainType,
3535
"",
3636
},
3737
{
@@ -183,12 +183,12 @@ func TestGenerateAnnotationsFunc(t *testing.T) {
183183
// Create test annotations struct
184184
testAnnotations := &AnnotationMetadata{
185185
Annotations: map[string]string{
186-
mediatypeLabel: "test1",
187-
manifestsLabel: "test2",
188-
metadataLabel: "test3",
189-
packageLabel: "test4",
190-
channelsLabel: "test5",
191-
channelDefaultLabel: "test5",
186+
MediatypeLabel: "test1",
187+
ManifestsLabel: "test2",
188+
MetadataLabel: "test3",
189+
PackageLabel: "test4",
190+
ChannelsLabel: "test5",
191+
ChannelDefaultLabel: "test5",
192192
},
193193
}
194194
// Create result annotations struct
@@ -213,10 +213,10 @@ func TestGenerateDockerfileFunc(t *testing.T) {
213213
"LABEL operators.operatorframework.io.bundle.channels.v1=test5\n"+
214214
"LABEL operators.operatorframework.io.bundle.channel.default.v1=test5\n\n"+
215215
"ADD %s/*.yaml /manifests\n"+
216-
"ADD %s/annotations.yaml /metadata/annotations.yaml\n", metadataDir, getTestDir(),
217-
filepath.Join(getTestDir(), metadataDir))
216+
"ADD %s/annotations.yaml /metadata/annotations.yaml\n", MetadataDir, getTestDir(),
217+
filepath.Join(getTestDir(), MetadataDir))
218218

219-
content, err := GenerateDockerfile(getTestDir(), "test1", "test2", metadataDir, "test4", "test5", "")
219+
content, err := GenerateDockerfile(getTestDir(), "test1", "test2", MetadataDir, "test4", "test5", "")
220220
require.NoError(t, err)
221221
require.Equal(t, output, string(content))
222222
}

pkg/lib/bundle/utils_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,13 @@ func createDir(dir string) {
4343
func createFiles(dir, input string) {
4444
// Create test files in test directory
4545
switch input {
46-
case registryV1Type:
46+
case RegistryV1Type:
4747
file, _ := os.Create(filepath.Join(dir, csvFile))
4848
file.Close()
49-
case helmType:
49+
case HelmType:
5050
file, _ := os.Create(filepath.Join(dir, helmFile))
5151
file.Close()
52-
case plainType:
52+
case PlainType:
5353
file, _ := os.Create(filepath.Join(dir, crdFile))
5454
file.Close()
5555
default:

0 commit comments

Comments
 (0)