Skip to content

Commit 5e1b396

Browse files
Ash-expAsh-exp
authored
fix: multi line variable support for docker run cmd (#145)
* fix: multi line variable support for docker run cmd * oss dep updated
1 parent e61240c commit 5e1b396

24 files changed

Lines changed: 151 additions & 43 deletions

File tree

‎chart-sync/go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ go 1.22.4
55
toolchain go1.22.6
66

77
replace (
8-
github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
8+
github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66
99
helm.sh/helm/v3 v3.14.3 => github.com/devtron-labs/helm/v3 v3.14.1-0.20240401080259-90238cf69e42
1010
)
1111

‎chart-sync/go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr
5454
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
5555
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
5656
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
57-
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966 h1:BjQI4rvtPiafv6Cpghjqn8QriZMfv09zqy2JIyzSg28=
58-
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966/go.mod h1:1QJJLpgJSkb5Jm9xPeKAk+kXb0QgBOOOgJj0cgYhAVA=
57+
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66 h1:xPIBsJFv/txiSuP2OEJy8v0pf8h10IdJUTAZE7jCio4=
58+
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66/go.mod h1:1QJJLpgJSkb5Jm9xPeKAk+kXb0QgBOOOgJj0cgYhAVA=
5959
github.com/devtron-labs/helm/v3 v3.14.1-0.20240401080259-90238cf69e42 h1:pJmK44QaSztOiZe0iQHNf0sdy5KwkAeceydyhOG4RaY=
6060
github.com/devtron-labs/helm/v3 v3.14.1-0.20240401080259-90238cf69e42/go.mod h1:v6myVbyseSBJTzhmeE39UcPLNv6cQK6qss3dvgAySaE=
6161
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=

‎chart-sync/vendor/modules.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ github.com/containerd/platforms
9393
# github.com/davecgh/go-spew v1.1.1
9494
## explicit
9595
github.com/davecgh/go-spew/spew
96-
# github.com/devtron-labs/common-lib v0.0.0 => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
96+
# github.com/devtron-labs/common-lib v0.0.0 => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66
9797
## explicit; go 1.21
9898
github.com/devtron-labs/common-lib/fetchAllEnv
9999
github.com/devtron-labs/common-lib/git-manager/util
@@ -790,4 +790,4 @@ sigs.k8s.io/structured-merge-diff/v4/value
790790
# sigs.k8s.io/yaml v1.3.0
791791
## explicit; go 1.12
792792
sigs.k8s.io/yaml
793-
# github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
793+
# github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66

‎ci-runner/executor/StageExecutor_test.go‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package executor
1818

1919
import (
20+
util2 "github.com/devtron-labs/ci-runner/executor/util"
2021
"github.com/devtron-labs/ci-runner/helper"
2122
commonBean "github.com/devtron-labs/common-lib/workflow"
2223
"reflect"
@@ -100,7 +101,12 @@ func Test_deduceVariables(t *testing.T) {
100101
}
101102
for _, tt := range tests {
102103
t.Run(tt.name, func(t *testing.T) {
103-
got, err := deduceVariables(tt.args.desiredVars, tt.args.globalVars, tt.args.preeCiStageVariable, tt.args.postCiStageVariables, nil)
104+
scriptEnvVariables := &util2.ScriptEnvVariables{
105+
SystemEnv: map[string]string{},
106+
RuntimeEnv: tt.args.globalVars,
107+
ExistingScriptEnv: map[string]string{},
108+
}
109+
got, err := deduceVariables(tt.args.desiredVars, scriptEnvVariables, tt.args.preeCiStageVariable, tt.args.postCiStageVariables, nil)
104110
if (err != nil) != tt.wantErr {
105111
t.Errorf("deduceVariables() error = %v, wantErr %v", err, tt.wantErr)
106112
return
@@ -117,7 +123,7 @@ func TestRunCiSteps(t *testing.T) {
117123
stageType helper.StepType
118124
req *helper.CommonWorkflowRequest
119125
globalEnvironmentVariables map[string]string
120-
preeCiStageVariable map[int]map[string]*commonBean.VariableObject
126+
preCiStageVariable map[int]map[string]*commonBean.VariableObject
121127
}
122128
tests := []struct {
123129
name string
@@ -131,13 +137,18 @@ func TestRunCiSteps(t *testing.T) {
131137
for _, tt := range tests {
132138
stageExecutor := NewStageExecutorImpl(nil, nil)
133139
t.Run(tt.name, func(t *testing.T) {
134-
gotPreeCiStageVariableOut, gotPostCiStageVariable, _, err := stageExecutor.RunCiCdSteps(tt.args.stageType, nil, tt.args.req.PreCiSteps, nil, tt.args.globalEnvironmentVariables, tt.args.preeCiStageVariable)
140+
scriptEnvVariables := &util2.ScriptEnvVariables{
141+
SystemEnv: map[string]string{},
142+
RuntimeEnv: tt.args.globalEnvironmentVariables,
143+
ExistingScriptEnv: map[string]string{},
144+
}
145+
gotPreCiStageVariableOut, gotPostCiStageVariable, _, err := stageExecutor.RunCiCdSteps(tt.args.stageType, tt.args.req, tt.args.req.PreCiSteps, nil, scriptEnvVariables, tt.args.preCiStageVariable, false)
135146
if (err != nil) != tt.wantErr {
136147
t.Errorf("RunCiCdSteps() error = %v, wantErr %v", err, tt.wantErr)
137148
return
138149
}
139-
if !reflect.DeepEqual(gotPreeCiStageVariableOut, tt.wantPreeCiStageVariableOut) {
140-
t.Errorf("RunCiCdSteps() gotPreeCiStageVariableOut = %v, want %v", gotPreeCiStageVariableOut, tt.wantPreeCiStageVariableOut)
150+
if !reflect.DeepEqual(gotPreCiStageVariableOut, tt.wantPreeCiStageVariableOut) {
151+
t.Errorf("RunCiCdSteps() gotPreCiStageVariableOut = %v, want %v", gotPreCiStageVariableOut, tt.wantPreeCiStageVariableOut)
141152
}
142153
if !reflect.DeepEqual(gotPostCiStageVariable, tt.wantPostCiStageVariable) {
143154
t.Errorf("RunCiCdSteps() gotPostCiStageVariable = %v, want %v", gotPostCiStageVariable, tt.wantPostCiStageVariable)

‎ci-runner/executor/scriptExecutor.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ func formatEnvironmentVariables(envMap map[string]string) string {
340340
d, err := strconv.Atoi(v)
341341
if err != nil {
342342
//received string
343-
lines = append(lines, fmt.Sprintf(`%s=%s`, k, v))
343+
lines = append(lines, fmt.Sprintf(`%s=%q`, k, v))
344344
} else {
345345
//received integer
346346
lines = append(lines, fmt.Sprintf(`%s=%d`, k, d))

‎ci-runner/executor/scriptExecutor_test.go‎

Lines changed: 99 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717
package executor
1818

1919
import (
20+
context2 "context"
2021
"fmt"
22+
"github.com/devtron-labs/ci-runner/executor/context"
2123
"github.com/devtron-labs/ci-runner/helper"
2224
"io/ioutil"
2325
"os"
@@ -28,6 +30,8 @@ import (
2830

2931
func TestRunScripts(t *testing.T) {
3032
t.SkipNow()
33+
commandExecutorImpl := helper.NewCommandExecutorImpl()
34+
scriptExecutorImpl := NewScriptExecutorImpl(commandExecutorImpl)
3135
type args struct {
3236
workDirectory string
3337
scriptFileName string
@@ -78,7 +82,8 @@ func TestRunScripts(t *testing.T) {
7882
}
7983
for _, tt := range tests {
8084
t.Run(tt.name, func(t *testing.T) {
81-
got, err := RunScripts(tt.args.workDirectory, tt.args.scriptFileName, tt.args.script, tt.args.envVars, tt.args.outputVars)
85+
ciCtx := context.BuildCiContext(context2.Background(), false)
86+
got, err := scriptExecutorImpl.RunScripts(ciCtx, tt.args.workDirectory, tt.args.scriptFileName, tt.args.script, tt.args.envVars, tt.args.outputVars)
8287
if (err != nil) != tt.wantErr {
8388
t.Errorf("RunScripts() error = %v, wantErr %v", err, tt.wantErr)
8489
return
@@ -192,6 +197,9 @@ func TestRunScriptsInDocker(t *testing.T) {
192197
type args struct {
193198
executionConf *executionConf
194199
}
200+
commandExecutorImpl := helper.NewCommandExecutorImpl()
201+
scriptExecutorImpl := NewScriptExecutorImpl(commandExecutorImpl)
202+
stageExecutorImpl := NewStageExecutorImpl(commandExecutorImpl, scriptExecutorImpl)
195203
tests := []struct {
196204
name string
197205
args args
@@ -219,7 +227,8 @@ func TestRunScriptsInDocker(t *testing.T) {
219227
}
220228
for _, tt := range tests {
221229
t.Run(tt.name, func(t *testing.T) {
222-
got, err := RunScriptsInDocker(tt.args.executionConf)
230+
ciCtx := context.BuildCiContext(context2.Background(), false)
231+
got, err := RunScriptsInDocker(ciCtx, stageExecutorImpl, tt.args.executionConf)
223232
if (err != nil) != tt.wantErr {
224233
t.Errorf("RunScriptsInDocker() error = %v, wantErr %v", err, tt.wantErr)
225234
return
@@ -300,3 +309,91 @@ func Test_writeToEnvFile(t *testing.T) {
300309
})
301310
}
302311
}
312+
313+
func Test_writeToEnvFile1(t *testing.T) {
314+
type args struct {
315+
envMap map[string]string
316+
filename string
317+
}
318+
tests := []struct {
319+
name string
320+
args args
321+
wantErr bool
322+
fileContents []string
323+
}{
324+
{
325+
name: "empty_env_map",
326+
args: args{envMap: map[string]string{}, filename: "test1.env"},
327+
wantErr: false,
328+
fileContents: []string{},
329+
},
330+
{
331+
name: "single_env_var",
332+
args: args{envMap: map[string]string{"FOO": "BAR"}, filename: "test2.env"},
333+
wantErr: false,
334+
fileContents: []string{`FOO="BAR"`},
335+
},
336+
{
337+
name: "multiple_env_vars",
338+
args: args{envMap: map[string]string{"FOO": "BAR", "BAR": "FOO"}, filename: "test3.env"},
339+
wantErr: false,
340+
fileContents: []string{`FOO="BAR"`, `BAR="FOO"`},
341+
},
342+
{
343+
name: "error_creating_file",
344+
args: args{envMap: map[string]string{"FOO": "BAR"}, filename: "/dev/null/abcd"},
345+
wantErr: true,
346+
fileContents: []string{},
347+
},
348+
{
349+
name: "multiline_env_vars",
350+
args: args{envMap: map[string]string{"FOO": "BAR\n\"BAZ\"%%s\n\t\b", "BAR": "FOO"}, filename: "test4.env"},
351+
wantErr: false,
352+
fileContents: []string{`FOO="BAR\n\"BAZ\"%%s\n\t\b"`, `BAR="FOO"`},
353+
},
354+
{
355+
name: "emoji_env_vars",
356+
args: args{envMap: map[string]string{"FOO": "BA👍R\n\"BAZ\"%%s\n\t\b", "BAR": "FOO"}, filename: "test5.env"},
357+
wantErr: false,
358+
fileContents: []string{`FOO="BA👍R\n\"BAZ\"%%s\n\t\b"`, `BAR="FOO"`},
359+
},
360+
{
361+
name: "pos_integer_env_vars",
362+
args: args{envMap: map[string]string{"FOO": "1", "BAR": "2"}, filename: "test6.env"},
363+
wantErr: false,
364+
fileContents: []string{`FOO=1`, `BAR=2`},
365+
},
366+
{
367+
name: "neg_integer_env_vars",
368+
args: args{envMap: map[string]string{"FOO": "-1", "BAR": "-2"}, filename: "test7.env"},
369+
wantErr: false,
370+
fileContents: []string{`FOO=-1`, `BAR=-2`},
371+
},
372+
{
373+
name: "float_env_vars",
374+
args: args{envMap: map[string]string{"FOO": "1.0", "BAR": "2.0"}, filename: "test8.env"},
375+
wantErr: false,
376+
fileContents: []string{`FOO="1.0"`, `BAR="2.0"`},
377+
},
378+
}
379+
for _, tt := range tests {
380+
t.Run(tt.name, func(t *testing.T) {
381+
if err := writeToEnvFile(tt.args.envMap, tt.args.filename); (err != nil) != tt.wantErr {
382+
t.Errorf("writeToEnvFile() error = %v, wantErr %v", err, tt.wantErr)
383+
}
384+
content, err := os.ReadFile(tt.args.filename)
385+
if tt.wantErr && err == nil {
386+
t.Errorf("writeToEnvFile(); wanted error = %v; got nil", err)
387+
} else if !tt.wantErr && err != nil {
388+
t.Errorf("writeToEnvFile(); wanted no error; got = %v", err)
389+
}
390+
if err == nil {
391+
for _, line := range tt.fileContents {
392+
if !strings.Contains(string(content), line) {
393+
t.Errorf("writeToEnvFile() not found = %v, content = %v", line, string(content))
394+
}
395+
}
396+
}
397+
})
398+
}
399+
}

‎ci-runner/go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ go 1.21
44

55
toolchain go1.21.8
66

7-
replace github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
7+
replace github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66
88

99
require (
1010
github.com/Knetic/govaluate v3.0.0+incompatible

‎ci-runner/go.sum‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
5757
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
5858
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
5959
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
60-
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966 h1:BjQI4rvtPiafv6Cpghjqn8QriZMfv09zqy2JIyzSg28=
61-
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966/go.mod h1:1QJJLpgJSkb5Jm9xPeKAk+kXb0QgBOOOgJj0cgYhAVA=
60+
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66 h1:xPIBsJFv/txiSuP2OEJy8v0pf8h10IdJUTAZE7jCio4=
61+
github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66/go.mod h1:1QJJLpgJSkb5Jm9xPeKAk+kXb0QgBOOOgJj0cgYhAVA=
6262
github.com/distribution/reference v0.6.0 h1:0IXCQ5g4/QMHHkarYzh5l+u8T3t73zM5QvfrDyIgxBk=
6363
github.com/distribution/reference v0.6.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E=
6464
github.com/docker/cli v24.0.6+incompatible h1:fF+XCQCgJjjQNIMjzaSmiKJSCcfcXb3TWTcc7GAneOY=

‎ci-runner/vendor/modules.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ github.com/cespare/xxhash/v2
118118
# github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc
119119
## explicit
120120
github.com/davecgh/go-spew/spew
121-
# github.com/devtron-labs/common-lib v0.19.0 => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
121+
# github.com/devtron-labs/common-lib v0.19.0 => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66
122122
## explicit; go 1.21
123123
github.com/devtron-labs/common-lib/blob-storage
124124
github.com/devtron-labs/common-lib/constants
@@ -861,4 +861,4 @@ sigs.k8s.io/structured-merge-diff/v4/value
861861
# sigs.k8s.io/yaml v1.3.0
862862
## explicit; go 1.12
863863
sigs.k8s.io/yaml
864-
# github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
864+
# github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66

‎git-sensor/go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ go 1.21
44

55
toolchain go1.22.4
66

7-
replace github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250130074656-5668b60f0966
7+
replace github.com/devtron-labs/common-lib => github.com/devtron-labs/devtron-services/common-lib v0.0.0-20250211101001-6fa162a26f66
88

99
require (
1010
github.com/caarlos0/env v3.5.0+incompatible

0 commit comments

Comments
 (0)