Skip to content

Commit

Permalink
fix replaceAgentimages from panicking, adjust the implementation of t…
Browse files Browse the repository at this point in the history 
…hat method and create different unit tests suites
  • Loading branch information
@NR4l3rt0
NR4l3rt0 committed Apr 23, 2022
1 parent 6a04b1f commit 4f7f1c1
Show file tree
Hide file tree
Showing 2 changed files with 109 additions and 10 deletions.
23 changes: 16 additions & 7 deletions replacer.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,25 @@ func replaceLibrary(content string) string {
return strings.Replace(content, "@Library('[email protected]') _", "@Library('[email protected]') _", -1)
}

// replaceAgentImages is a method that changes images which follows the pattern "ods/jenkins-agent*".
//It considers single, double quotes, and multiple images in the same Jenkinsfile without panicking.
func replaceAgentImages(content string) string {
re := regexp.MustCompile(`'ods/jenkins-agent-(.*):.*'`)

matches := re.FindAllStringSubmatch(content, -1)
fmt.Println(matches[0][1])
if string(matches[0][1]) == "nodejs10-angular" {
return re.ReplaceAllString(content, "'ods/jenkins-agent-nodejs12:4.x'")
}
re := regexp.MustCompile(`(['"]{1}ods/jenkins-agent-)(.*):(.*)(['"]{1})`)
lines := strings.Split(content, "\n")

return re.ReplaceAllString(content, "'ods/jenkins-agent-$1:4.x'")
for idx, line := range lines {
if match := re.FindStringSubmatch(line); match != nil {
lines[idx] = func(s1 string, s2 []string) string {
if string(s2[2]) == "nodejs10-angular" {
return re.ReplaceAllString(line, fmt.Sprintf("%s%s%s", s2[1], "nodejs12:4.x", s2[4]))
} else {
return re.ReplaceAllString(line, fmt.Sprintf("%s%s%s%s", s2[1], s2[2], ":4.x", s2[4]))
}
}(line, match)
}
}
return strings.Join(lines, "\n")
}

func replaceComponentStageImport(content string) string {
Expand Down
96 changes: 93 additions & 3 deletions replacer_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package main

import (
"fmt"
"io/ioutil"
"testing"
)
Expand All @@ -16,8 +17,7 @@ func TestReplace(t *testing.T) {
args args
want string
}{
{
name: "Stage Rollout Single Line",
{name: "Stage Rollout Single Line",
args: args{
inputFile: "internal/test/stage-rollout-single-line/Jenkinsfile",
convertedFile: "internal/test/stage-rollout-single-line/out/Jenkinsfile",
Expand Down Expand Up @@ -48,7 +48,7 @@ func TestReplace(t *testing.T) {

converted, err := ioutil.ReadFile(tt.args.convertedFile)
if err != nil {
t.Errorf("failed to open file: %w", err)
t.Errorf("failed to open file: %v", err)
}

if got := string(converted); got != string(tt.want) {
Expand All @@ -67,3 +67,93 @@ func readFile(goldenFile string) string {

return string(want)
}

// The focus has been: matching patterns, quotes, duplicity of images, combination of them
func TestTableReplaceAgentImages(t *testing.T) {

testsDouble := []struct {
input string
expected string
}{
{input: "ods/jenkins-agent-base:3.0.0", expected: "\"ods/jenkins-agent-base:4.x\""},
{input: "${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0", expected: "\"${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0\""},
{input: "ods/jenkins-agent-nodejs10-angular:3.0.0", expected: "\"ods/jenkins-agent-nodejs12:4.x\""},
{input: "odsalpha/jenkins-agent-nodejs10-angular:3.x", expected: "\"odsalpha/jenkins-agent-nodejs10-angular:3.x\""},
{input: "odsalpha/jenkins-agent-base:3.x", expected: "\"odsalpha/jenkins-agent-base:3.x\""},
{input: "", expected: "\"\""},
{input: "${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest", expected: "\"${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest\""},
}

fmt.Println()
t.Logf("#####################################")
t.Logf("## Test suite double quoted values ##")
t.Logf("#####################################\n")
fmt.Println()
for _, test := range testsDouble {
doubleQuoted := fmt.Sprintf("%q", test.input)
if output := replaceAgentImages(doubleQuoted); output != test.expected {
t.Errorf("FAILED; input: %v, expected: %v, received: %v.", doubleQuoted, test.expected, output)
} else {
t.Logf("PASSED; input: %v, expected: %v, received: %v", doubleQuoted, test.expected, output)
}
}

testsSingle := []struct {
input string
expected string
}{
{input: "alpha/jenkins-agent-nodejs10-angular:3.x", expected: "'alpha/jenkins-agent-nodejs10-angular:3.x'"},
{input: "ods/jenkins-agent-maven:3.0.0", expected: "'ods/jenkins-agent-maven:4.x'"},
{input: "${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0", expected: "'${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'"},
{input: "ods/jenkins-agent-nodejs10-angular:3.0.0", expected: "'ods/jenkins-agent-nodejs12:4.x'"},
{input: "", expected: "''"},
{input: "odsalpha/jenkins-agent-terraform:3.x", expected: "'odsalpha/jenkins-agent-terraform:3.x'"},
{input: "${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest", expected: "'${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest'"},
}

fmt.Println()
fmt.Println()
t.Logf("#####################################")
t.Logf("## Test suite single quoted values ##")
t.Logf("#####################################\n")
fmt.Println()
for _, test := range testsSingle {
singleQuoted := fmt.Sprintf("'%v'", test.input)
if output := replaceAgentImages(singleQuoted); output != test.expected {
t.Errorf("FAILED; input: %v, expected: %v, received: %v.", singleQuoted, test.expected, output)
} else {
t.Logf("PASSED; input: %v, expected: %v, received: %v", singleQuoted, test.expected, output)
}
}

testsMultiLines := []struct {
input string
expected string
}{
{input: " 'alpha/jenkins-agent-nodejs10-angular:3.x'\n 'alpha/jenkins-agent-nodejs10-angular:3.x'\n", expected: " 'alpha/jenkins-agent-nodejs10-angular:3.x'\n 'alpha/jenkins-agent-nodejs10-angular:3.x'\n"},
{input: " 'ods/jenkins-agent-maven:3.0.0'\n 'ods/jenkins-agent-maven:3.0.0'\n", expected: " 'ods/jenkins-agent-maven:4.x'\n 'ods/jenkins-agent-maven:4.x'\n"},
{input: " 'ods/jenkins-agent-base:3.0.0'\n 'ods/jenkins-agent-base:4.x'\n", expected: " 'ods/jenkins-agent-base:4.x'\n 'ods/jenkins-agent-base:4.x'\n"},
{input: " 'ods/jenkins-agent-base:4.x'\n 'ods/jenkins-agent-base:3.0.0'\n", expected: " 'ods/jenkins-agent-base:4.x'\n 'ods/jenkins-agent-base:4.x'\n"},
{input: " '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n", expected: " '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n"},
{input: " '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n '${dockerRegistry}/ods/jenkins-agent-nodejs12-angular:4.x'\n", expected: " '${dockerRegistry}/ods/jenkins-agent-nodejs10-angular:3.0.0'\n '${dockerRegistry}/ods/jenkins-agent-nodejs12-angular:4.x'\n"},
{input: " 'ods/jenkins-agent-nodejs10-angular:3.0.0'\n 'ods/jenkins-agent-nodejs12:4.x'\n", expected: " 'ods/jenkins-agent-nodejs12:4.x'\n 'ods/jenkins-agent-nodejs12:4.x'\n"},
{input: " 'ods/jenkins-agent-nodejs12:4.x'\n 'ods/jenkins-agent-nodejs10-angular:3.0.0'\n", expected: " 'ods/jenkins-agent-nodejs12:4.x'\n 'ods/jenkins-agent-nodejs12:4.x'\n"},
{input: " '${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest'\n '${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest'\n", expected: " '${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest'\n '${dockerRegistry}/edpp-cd/jenkins-agent-maven-chrome:latest'\n"},
}

fmt.Println()
fmt.Println()
t.Logf("######################################")
t.Logf("## Test suite multiple lines values ##")
t.Logf("######################################\n")
fmt.Println()
for _, test := range testsMultiLines {
multiLine := fmt.Sprintf("%v", test.input)
fmt.Println()
if output := replaceAgentImages(multiLine); output != test.expected {
t.Errorf("FAILED; input: %v, expected: %v, received: %v.", multiLine, test.expected, output)
} else {
t.Logf("PASSED; input: %v, expected: %v, received: %v", multiLine, test.expected, output)
}
}
}

0 comments on commit 4f7f1c1

Please sign in to comment.