Skip to content

Commit a0c81db

Browse files
committed
Refactor code to replace ioutil with os package for file operations and improve logging format
1 parent f2c7d77 commit a0c81db

14 files changed

Lines changed: 53 additions & 53 deletions

File tree

tests/create-projects/jenkinsfile_test.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ import (
55
"crypto/tls"
66
"encoding/json"
77
"fmt"
8-
"io/ioutil"
8+
"io"
99
"net/http"
10+
"os"
1011
"path"
1112
"runtime"
1213
"strings"
@@ -101,7 +102,7 @@ func TestCreateProjectThruWebhookProxyJenkinsFile(t *testing.T) {
101102

102103
defer reponse.Body.Close()
103104

104-
bodyBytes, _ := ioutil.ReadAll(reponse.Body)
105+
bodyBytes, _ := io.ReadAll(reponse.Body)
105106

106107
if reponse.StatusCode >= http.StatusAccepted {
107108
t.Fatalf("Could not post request: %s", string(bodyBytes))
@@ -154,7 +155,7 @@ func TestCreateProjectThruWebhookProxyJenkinsFile(t *testing.T) {
154155
t.Fatal(err)
155156
}
156157

157-
expected, err := ioutil.ReadFile("golden/jenkins-create-project-stages.json")
158+
expected, err := os.ReadFile("golden/jenkins-create-project-stages.json")
158159
if err != nil {
159160
t.Fatal(err)
160161
}

tests/quickstarter/quickstarter_test.go

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func TestQuickstarter(t *testing.T) {
7272
}
7373
dir, err := os.Getwd()
7474
if err != nil {
75-
logger.Error(fmt.Sprintf("Failed to get working directory: %v", err))
75+
logger.Error("Failed to get working directory: %v", err)
7676
return
7777
}
7878
quickstarterPaths = utils.RemoveExcludedQuickstarters(t, dir, quickstarterPaths)
@@ -138,17 +138,16 @@ func TestQuickstarter(t *testing.T) {
138138

139139
// Check if step should be skipped
140140
if steps.ShouldSkipStep(t, &step, tmplData) {
141-
logger.Info(fmt.Sprintf("⊘ Skipping step %d: %s (skip=%v, skipIf=%q)", i+1, step.Type, step.Skip, step.SkipIf))
142-
continue
143-
}
144-
145-
logger.Step(
146-
i+1,
147-
len(s.Steps),
148-
step.Type,
149-
step.Description,
150-
)
141+
logger.Info("⊘ Skipping step %d: %s (skip=%v, skipIf=%q)", i+1, step.Type, step.Skip, step.SkipIf)
142+
continue
143+
}
151144

145+
logger.Step(
146+
i+1,
147+
len(s.Steps),
148+
step.Type,
149+
step.Description,
150+
)
152151
report.RecordStepStart(i, step.Type, step.Description)
153152

154153
repoName := fmt.Sprintf("%s-%s", strings.ToLower(utils.PROJECT_NAME), step.ComponentID)

tests/quickstarter/reporting/export.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package reporting
33
import (
44
"encoding/json"
55
"fmt"
6-
"io/ioutil"
6+
"os"
77
)
88

99
// JUnitTestSuite represents a JUnit test suite
@@ -75,7 +75,7 @@ func ExportJUnitXML(report *TestReport, outputPath string) error {
7575
return err
7676
}
7777

78-
if err := ioutil.WriteFile(outputPath, data, 0644); err != nil {
78+
if err := os.WriteFile(outputPath, data, 0644); err != nil {
7979
return fmt.Errorf("failed to write JUnit report: %w", err)
8080
}
8181

@@ -89,7 +89,7 @@ func ExportJSON(report *TestReport, outputPath string) error {
8989
return err
9090
}
9191

92-
if err := ioutil.WriteFile(outputPath, data, 0644); err != nil {
92+
if err := os.WriteFile(outputPath, data, 0644); err != nil {
9393
return fmt.Errorf("failed to write JSON report: %w", err)
9494
}
9595

tests/quickstarter/steps.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import (
44
"bytes"
55
"encoding/json"
66
"fmt"
7-
"io/ioutil"
7+
"os"
88
"strings"
99

1010
"github.com/ghodss/yaml"
@@ -23,7 +23,7 @@ type TestSteps struct {
2323
// It does not allow extra fields to avoid typos, and checks if the given
2424
// step types are known.
2525
func readSteps(folder string) (*TestSteps, error) {
26-
yamlContent, err := ioutil.ReadFile(folder + "/steps.yml")
26+
yamlContent, err := os.ReadFile(folder + "/steps.yml")
2727
if err != nil {
2828
return nil, fmt.Errorf("Cannot read file: %w", err)
2929
}

tests/quickstarter/steps/bitbucket.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func executeBitbucketDeleteFiles(t *testing.T, step TestStep, params *TestStepBi
172172
logger.Waiting("Executing Bitbucket delete-files script")
173173
stdout, stderr, err := utils.RunScriptFromBaseDir("tests/scripts/delete-files-from-bitbucket-with-git.sh", scriptArgs, []string{})
174174
if err != nil {
175-
logger.Error(fmt.Sprintf("Bitbucket delete-files script output:\n%s", stdout))
175+
logger.Error("Bitbucket delete-files script output:\n%s", stdout)
176176
logger.Failure("Delete files from Bitbucket", err)
177177
t.Fatalf(
178178
"Execution of `delete-files-from-bitbucket-with-git.sh` failed: \nStdOut: %s\nStdErr: %s\nErr: %s\n",
@@ -261,7 +261,7 @@ func uploadFileToBitbucket(t *testing.T, uploadParams *TestStepUploadParams, tmp
261261
fmt.Sprintf("--filename=%s", filename),
262262
}, []string{})
263263
if err != nil {
264-
logger.Error(fmt.Sprintf("BitBucket upload script output:\n%s", stdout))
264+
logger.Error("BitBucket upload script output:\n%s", stdout)
265265
logger.Failure("Upload file to BitBucket", err)
266266
t.Fatalf(
267267
"Execution of `upload-file-to-bitbucket-with-git.sh` failed: \nStdOut: %s\nStdErr: %s\nErr: %s\n",
@@ -449,7 +449,7 @@ func recreateBitbucketRepo(config map[string]string, project string, repo string
449449

450450
// If deletion was scheduled (202), wait for it to complete
451451
if resp.StatusCode == http.StatusAccepted {
452-
logger.Info(fmt.Sprintf("Repository %s/%s scheduled for deletion, waiting...", project, repo))
452+
logger.Info("Repository %s/%s scheduled for deletion, waiting...", project, repo)
453453
// Wait for repository to be deleted
454454
for i := 0; i < 30; i++ {
455455
time.Sleep(2 * time.Second)
@@ -464,7 +464,7 @@ func recreateBitbucketRepo(config map[string]string, project string, repo string
464464
if i == 29 {
465465
return fmt.Errorf("Timeout waiting for repository %s/%s to be deleted", project, repo)
466466
}
467-
logger.Info(fmt.Sprintf("Waiting for repository deletion (attempt %d/30)...", i+1))
467+
logger.Info("Waiting for repository deletion (attempt %d/30)...", i+1)
468468
}
469469
}
470470

tests/quickstarter/steps/openshift.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ import (
1313
func deleteOpenShiftResources(projectID string, componentID string, namespace string) error {
1414
// Check if resources should be kept
1515
if os.Getenv("KEEP_RESOURCES") == "true" {
16-
logger.Warn(fmt.Sprintf("KEEP_RESOURCES=true: Skipping cleanup for component: %s in namespace: %s", componentID, namespace))
16+
logger.Warn("KEEP_RESOURCES=true: Skipping cleanup for component: %s in namespace: %s", componentID, namespace)
1717
return nil
1818
}
1919
logger.Running(fmt.Sprintf("Cleanup for component: %s in namespace: %s", componentID, namespace))
2020
label := fmt.Sprintf("app=%s-%s", projectID, componentID)
21-
logger.Debug(fmt.Sprintf("Delete resources labelled with: %s", label))
21+
logger.Debug("Delete resources labelled with: %s", label)
2222
stdout, stderr, err := runOcCmd([]string{
2323
"-n", namespace,
2424
"delete", "all", "-l", label,
@@ -41,7 +41,7 @@ func deleteOpenShiftResources(projectID string, componentID string, namespace st
4141
func deleteOpenShiftResourceByName(resourceType string, resourceName string, namespace string) error {
4242
// Check if resources should be kept
4343
if os.Getenv("KEEP_RESOURCES") == "true" {
44-
logger.Warn(fmt.Sprintf("KEEP_RESOURCES=true: Skipping cleanup for resource: %s/%s in namespace: %s", resourceType, resourceName, namespace))
44+
logger.Warn("KEEP_RESOURCES=true: Skipping cleanup for resource: %s/%s in namespace: %s", resourceType, resourceName, namespace)
4545
return nil
4646
}
4747
logger.Running(fmt.Sprintf("Cleanup for resource: %s/%s in %s", resourceType, resourceName, namespace))
@@ -70,7 +70,7 @@ func deleteOpenShiftResourceByName(resourceType string, resourceName string, nam
7070
func deleteHelmRelease(releaseName string, namespace string) error {
7171
// Check if resources should be kept
7272
if os.Getenv("KEEP_RESOURCES") == "true" {
73-
logger.Warn(fmt.Sprintf("KEEP_RESOURCES=true: Skipping cleanup for Helm release: %s in namespace: %s", releaseName, namespace))
73+
logger.Warn("KEEP_RESOURCES=true: Skipping cleanup for Helm release: %s in namespace: %s", releaseName, namespace)
7474
return nil
7575
}
7676
logger.Waiting(fmt.Sprintf("Checking for Helm release: %s in %s", releaseName, namespace))
@@ -95,7 +95,7 @@ func deleteHelmRelease(releaseName string, namespace string) error {
9595

9696
// If the release doesn't exist, skip cleanup
9797
if stdout == "" || len(bytes.TrimSpace([]byte(stdout))) == 0 {
98-
logger.Info(fmt.Sprintf("Helm release %s not found, skipping cleanup", releaseName))
98+
logger.Info("Helm release %s not found, skipping cleanup", releaseName)
9999
return nil
100100
}
101101

tests/quickstarter/steps/portforward.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ func (m *PortForwardManager) startPortForward(serviceName, namespace, remotePort
9494
if attempt > 1 {
9595
// Try next port
9696
currentPort = startPort + attempt - 1
97-
logger.Warn(fmt.Sprintf("Port %d in use, trying port %d...", currentPort-1, currentPort))
97+
logger.Warn("Port %d in use, trying port %d...", currentPort-1, currentPort)
9898
}
9999

100100
pf, err := m.startPortForwardAttempt(serviceName, namespace, remotePort, currentPort)

tests/quickstarter/steps/provision.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func ExecuteProvision(t *testing.T, step TestStep, testdataPath string, tmplData
5252
}
5353
namespace := fmt.Sprintf("%s-%s", projectName, tmpNamespace)
5454
if err := deleteOpenShiftResourceByName(it.ResourceType, it.ResourceName, namespace); err != nil {
55-
logger.Warn(fmt.Sprintf("Failed to cleanup resource %s/%s: %v", it.ResourceType, it.ResourceName, err))
55+
logger.Warn("Failed to cleanup resource %s/%s: %v", it.ResourceType, it.ResourceName, err)
5656
} else {
5757
logger.KeyValue(fmt.Sprintf("Cleaned %s", it.ResourceType), it.ResourceName)
5858
}
@@ -113,27 +113,27 @@ func ExecuteProvision(t *testing.T, step TestStep, testdataPath string, tmplData
113113
t.Cleanup(func() {
114114
// Check if resources should be kept
115115
if os.Getenv("KEEP_RESOURCES") == "true" {
116-
logger.Warn(fmt.Sprintf("KEEP_RESOURCES=true: Skipping resource cleanup for component %s", step.ComponentID))
116+
logger.Warn("KEEP_RESOURCES=true: Skipping resource cleanup for component %s", step.ComponentID)
117117
return
118118
}
119119
logger.Running(fmt.Sprintf("Cleaning up resources for component %s", step.ComponentID))
120120
if err := deleteOpenShiftResources(projectName, step.ComponentID, projectNameCD); err != nil {
121-
logger.Warn(fmt.Sprintf("Failed to cleanup CD resources: %v", err))
121+
logger.Warn("Failed to cleanup CD resources: %v", err)
122122
}
123123
if err := deleteOpenShiftResources(projectName, step.ComponentID, projectNameDev); err != nil {
124-
logger.Warn(fmt.Sprintf("Failed to cleanup DEV resources: %v", err))
124+
logger.Warn("Failed to cleanup DEV resources: %v", err)
125125
}
126126
if err := deleteOpenShiftResources(projectName, step.ComponentID, projectNameTest); err != nil {
127-
logger.Warn(fmt.Sprintf("Failed to cleanup TEST resources: %v", err))
127+
logger.Warn("Failed to cleanup TEST resources: %v", err)
128128
}
129129
if err := deleteHelmRelease(step.ComponentID, projectNameCD); err != nil {
130-
logger.Warn(fmt.Sprintf("Failed to cleanup Helm release in CD namespace: %v", err))
130+
logger.Warn("Failed to cleanup Helm release in CD namespace: %v", err)
131131
}
132132
if err := deleteHelmRelease(step.ComponentID, projectNameDev); err != nil {
133-
logger.Warn(fmt.Sprintf("Failed to cleanup Helm release in DEV namespace: %v", err))
133+
logger.Warn("Failed to cleanup Helm release in DEV namespace: %v", err)
134134
}
135135
if err := deleteHelmRelease(step.ComponentID, projectNameTest); err != nil {
136-
logger.Warn(fmt.Sprintf("Failed to cleanup Helm release in TEST namespace: %v", err))
136+
logger.Warn("Failed to cleanup Helm release in TEST namespace: %v", err)
137137
}
138138
logger.Success("Resource cleanup completed")
139139
})

tests/quickstarter/steps/template.go

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
package steps
22

33
import (
4-
"fmt"
54
"os"
65
"strconv"
76
"strings"
@@ -58,7 +57,7 @@ func CreateTemplateData(config map[string]string, componentID string, buildName
5857
if value, ok := os.LookupEnv(tmplVar); ok {
5958
key := strings.TrimPrefix(tmplVar, "TMPL_")
6059
data[key] = value
61-
logger.Debug(fmt.Sprintf("Loading environment variable: %s -> %s = '%s'", tmplVar, key, value))
60+
logger.Debug("Loading environment variable: %s -> %s = '%s'", tmplVar, key, value)
6261
}
6362
}
6463

@@ -71,7 +70,7 @@ func CreateTemplateData(config map[string]string, componentID string, buildName
7170
// Only add if not already added above
7271
if _, exists := data[key]; !exists {
7372
data[key] = pair[1]
74-
logger.Debug(fmt.Sprintf("Loading environment variable: %s -> %s = '%s'", pair[0], key, pair[1]))
73+
logger.Debug("Loading environment variable: %s -> %s = '%s'", pair[0], key, pair[1])
7574
}
7675
}
7776
}

tests/quickstarter/steps/url_resolver.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ func ResolveServiceURL(t *testing.T, rawURL string, tmplData TemplateData) strin
5252
serviceURL, err := parseInternalServiceURL(rendered)
5353
if err != nil {
5454
// Can't parse, return as-is and let it fail naturally
55-
logger.Warn(fmt.Sprintf("Could not parse service URL: %s (error: %v)", rendered, err))
55+
logger.Warn("Could not parse service URL: %s (error: %v)", rendered, err)
5656
return rendered
5757
}
5858

0 commit comments

Comments
 (0)