convert: do not escape $ into $$ when using the --no-interpolate option (#9703)

BergLucas · ulyssessouza · web-flow · commit 7a8d157871aa · 2022-09-08T16:25:23.000-04:00
Signed-off-by: Lucas Berg &lt;root.lucasberg@gmail.com&gt;
Signed-off-by: Ulysses Souza &lt;ulyssessouza@gmail.com&gt;
Co-authored-by: Ulysses Souza &lt;ulyssessouza@gmail.com&gt;
diff --git a/cmd/compose/convert.go b/cmd/compose/convert.go
@@ -18,6 +18,7 @@ package compose
 
 import (
 	"bufio"
+	"bytes"
 	"context"
 	"fmt"
 	"io"
@@ -112,7 +113,7 @@ func convertCommand(p *projectOptions, backend api.Service) *cobra.Command {
 }
 
 func runConvert(ctx context.Context, backend api.Service, opts convertOptions, services []string) error {
-	var json []byte
+	var content []byte
 	project, err := opts.toProject(services,
 		cli.WithInterpolation(!opts.noInterpolate),
 		cli.WithResolvedPaths(true),
@@ -136,27 +137,31 @@ func runConvert(ctx context.Context, backend api.Service, opts convertOptions, s
 		}
 	}
 
-	json, err = backend.Convert(ctx, project, api.ConvertOptions{
+	content, err = backend.Convert(ctx, project, api.ConvertOptions{
 		Format: opts.Format,
 		Output: opts.Output,
 	})
 	if err != nil {
 		return err
 	}
 
+	if !opts.noInterpolate {
+		content = escapeDollarSign(content)
+	}
+
 	if opts.quiet {
 		return nil
 	}
 
 	var out io.Writer = os.Stdout
-	if opts.Output != "" && len(json) > 0 {
+	if opts.Output != "" && len(content) > 0 {
 		file, err := os.Create(opts.Output)
 		if err != nil {
 			return err
 		}
 		out = bufio.NewWriter(file)
 	}
-	_, err = fmt.Fprint(out, string(json))
+	_, err = fmt.Fprint(out, string(content))
 	return err
 }
 
@@ -237,3 +242,9 @@ func runConfigImages(opts convertOptions, services []string) error {
 	}
 	return nil
 }
+
+func escapeDollarSign(marshal []byte) []byte {
+	dollar := []byte{'$'}
+	escDollar := []byte{'$', '$'}
+	return bytes.ReplaceAll(marshal, dollar, escDollar)
+}
diff --git a/pkg/compose/compose.go b/pkg/compose/compose.go
@@ -17,7 +17,6 @@
 package compose
 
 import (
-	"bytes"
 	"context"
 	"encoding/json"
 	"fmt"
@@ -95,28 +94,14 @@ func getContainerNameWithoutProject(c moby.Container) string {
 func (s *composeService) Convert(ctx context.Context, project *types.Project, options api.ConvertOptions) ([]byte, error) {
 	switch options.Format {
 	case "json":
-		marshal, err := json.MarshalIndent(project, "", "  ")
-		if err != nil {
-			return nil, err
-		}
-		return escapeDollarSign(marshal), nil
+		return json.MarshalIndent(project, "", "  ")
 	case "yaml":
-		marshal, err := yaml.Marshal(project)
-		if err != nil {
-			return nil, err
-		}
-		return escapeDollarSign(marshal), nil
+		return yaml.Marshal(project)
 	default:
 		return nil, fmt.Errorf("unsupported format %q", options)
 	}
 }
 
-func escapeDollarSign(marshal []byte) []byte {
-	dollar := []byte{'$'}
-	escDollar := []byte{'$', '$'}
-	return bytes.ReplaceAll(marshal, dollar, escDollar)
-}
-
 // projectFromName builds a types.Project based on actual resources with compose labels set
 func (s *composeService) projectFromName(containers Containers, projectName string, services ...string) (*types.Project, error) {
 	project := &types.Project{
diff --git a/pkg/e2e/compose_test.go b/pkg/e2e/compose_test.go
@@ -234,3 +234,25 @@ networks:
     name: compose-e2e-convert_default`, filepath.Join(wd, "fixtures", "simple-build-test", "nginx-build")), ExitCode: 0})
 	})
 }
+
+func TestConvertInterpolate(t *testing.T) {
+	const projectName = "compose-e2e-convert-interpolate"
+	c := NewParallelCLI(t)
+
+	wd, err := os.Getwd()
+	assert.NilError(t, err)
+
+	t.Run("convert", func(t *testing.T) {
+		res := c.RunDockerComposeCmd(t, "-f", "./fixtures/simple-build-test/compose-interpolate.yaml", "-p", projectName, "convert", "--no-interpolate")
+		res.Assert(t, icmd.Expected{Out: fmt.Sprintf(`services:
+  nginx:
+    build:
+      context: %s
+      dockerfile: ${MYVAR}
+    networks:
+      default: null
+networks:
+  default:
+    name: compose-e2e-convert-interpolate_default`, filepath.Join(wd, "fixtures", "simple-build-test", "nginx-build")), ExitCode: 0})
+	})
+}
diff --git a/pkg/e2e/fixtures/simple-build-test/compose-interpolate.yaml b/pkg/e2e/fixtures/simple-build-test/compose-interpolate.yaml
@@ -0,0 +1,5 @@
+services:
+  nginx:
+    build:
+      context: nginx-build
+      dockerfile: ${MYVAR}

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ package compose`
`18`	`18`
`19`	`19`	`import (`
`20`	`20`	`"bufio"`
	`21`	`+ "bytes"`
`21`	`22`	`"context"`
`22`	`23`	`"fmt"`
`23`	`24`	`"io"`
`@@ -112,7 +113,7 @@ func convertCommand(p projectOptions, backend api.Service) cobra.Command {`
`112`	`113`	`}`
`113`	`114`
`114`	`115`	`func runConvert(ctx context.Context, backend api.Service, opts convertOptions, services []string) error {`
`115`		`- var json []byte`
	`116`	`+ var content []byte`
`116`	`117`	`project, err := opts.toProject(services,`
`117`	`118`	`cli.WithInterpolation(!opts.noInterpolate),`
`118`	`119`	`cli.WithResolvedPaths(true),`
`@@ -136,27 +137,31 @@ func runConvert(ctx context.Context, backend api.Service, opts convertOptions, s`
`136`	`137`	`}`
`137`	`138`	`}`
`138`	`139`
`139`		`- json, err = backend.Convert(ctx, project, api.ConvertOptions{`
	`140`	`+ content, err = backend.Convert(ctx, project, api.ConvertOptions{`
`140`	`141`	`Format: opts.Format,`
`141`	`142`	`Output: opts.Output,`
`142`	`143`	`})`
`143`	`144`	`if err != nil {`
`144`	`145`	`return err`
`145`	`146`	`}`
`146`	`147`
	`148`	`+ if !opts.noInterpolate {`
	`149`	`+ content = escapeDollarSign(content)`
	`150`	`+ }`
	`151`	`+`
`147`	`152`	`if opts.quiet {`
`148`	`153`	`return nil`
`149`	`154`	`}`
`150`	`155`
`151`	`156`	`var out io.Writer = os.Stdout`
`152`		`- if opts.Output != "" && len(json) > 0 {`
	`157`	`+ if opts.Output != "" && len(content) > 0 {`
`153`	`158`	`file, err := os.Create(opts.Output)`
`154`	`159`	`if err != nil {`
`155`	`160`	`return err`
`156`	`161`	`}`
`157`	`162`	`out = bufio.NewWriter(file)`
`158`	`163`	`}`
`159`		`- _, err = fmt.Fprint(out, string(json))`
	`164`	`+ _, err = fmt.Fprint(out, string(content))`
`160`	`165`	`return err`
`161`	`166`	`}`
`162`	`167`
`@@ -237,3 +242,9 @@ func runConfigImages(opts convertOptions, services []string) error {`
`237`	`242`	`}`
`238`	`243`	`return nil`
`239`	`244`	`}`
	`245`	`+`
	`246`	`+func escapeDollarSign(marshal []byte) []byte {`
	`247`	`+ dollar := []byte{'$'}`
	`248`	`+ escDollar := []byte{'$', '$'}`
	`249`	`+ return bytes.ReplaceAll(marshal, dollar, escDollar)`
	`250`	`+}`