cmd/operator-sdk/build: fix handling of spaces within quotes (#2312)

dustinspecker · Eric Stroczynski · commit b50f059f6d53 · 2019-12-11T16:16:30.000-08:00
Before when running `operator-sdk build` with an `--image-build-arg` of
something like `--label some.name="First Last"` then `operator-sdk`
would invoke the builder with ["--label", "some.name=First", "Last"],
when it was actually desired to be ["--label", "some.name=First Last"].

Using `shlex` handles all the appropriate parsing of spaces within quotes
unlike `strings.Fields` which just splits on any spaces regardless of
context like quotes.

Switching to `shlex` enables `operator-sdk build` to now properly handle
spaces within quotes.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@
 
 
 ### Bug Fixes
+- Fix `operator-sdk build`'s `--image-build-args` to support spaces within quotes like `--label some.name="First Last"`. ([#2312](https://github.com/operator-framework/operator-sdk/pull/2312))
 
 
 ## v0.13.0
diff --git a/cmd/operator-sdk/build/cmd.go b/cmd/operator-sdk/build/cmd.go
@@ -25,6 +25,7 @@ import (
 	"github.com/operator-framework/operator-sdk/internal/scaffold"
 	"github.com/operator-framework/operator-sdk/internal/util/projutil"
 
+	"github.com/google/shlex"
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -73,7 +74,10 @@ func createBuildCommand(imageBuilder, context, dockerFile, image string, imageBu
 
 	for _, bargs := range imageBuildArgs {
 		if bargs != "" {
-			splitArgs := strings.Fields(bargs)
+			splitArgs, err := shlex.Split(bargs)
+			if err != nil {
+				return nil, fmt.Errorf("image-build-args is not parseable: %w", err)
+			}
 			args = append(args, splitArgs...)
 		}
 	}
diff --git a/go.mod b/go.mod
@@ -16,6 +16,7 @@ require (
 	github.com/go-logr/zapr v0.1.1
 	github.com/gobuffalo/packr v1.30.1 // indirect
 	github.com/gobwas/glob v0.2.3 // indirect
+	github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
 	github.com/gregjones/httpcache v0.0.0-20190203031600-7a902570cb17 // indirect
 	github.com/huandu/xstrings v1.2.0 // indirect
 	github.com/iancoleman/strcase v0.0.0-20190422225806-e506e3ef7365
diff --git a/go.sum b/go.sum
@@ -320,6 +320,8 @@ github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaUGG7oYTSPP8MxqL4YI3kZKwcP4=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=
 github.com/google/uuid v1.1.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
diff --git a/hack/tests/subcommand.sh b/hack/tests/subcommand.sh
@@ -8,6 +8,9 @@ if [ -z "$KUBECONFIG" ]; then
 fi
 
 pushd test/test-framework
+# test building image with image-build-args having a space within quotes
+operator-sdk build operator-sdk-dev --image-build-args="--label some.name=\"First Last\""
+
 # test framework with defaults
 operator-sdk test local ./test/e2e
 
diff --git a/test/test-framework/go.sum b/test/test-framework/go.sum
@@ -281,6 +281,7 @@ github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/pprof v0.0.0-20181206194817-3ea8567a2e57/go.mod h1:zfwlbNMJ+OItoe0UupaVj+oy1omPYYDuagoSzA8v9mc=
 github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
+github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ=
 github.com/google/uuid v1.0.0 h1:b4Gk+7WdP/d3HZH8EJsZpvV7EtDOgaZLtnaNGIu1adA=
 github.com/google/uuid v1.0.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.1.1 h1:Gkbcsh/GbpXz7lPftLA3P6TYMwjCLYm83jiFQZF/3gY=

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`
`17`	`17`
`18`	`18`	`### Bug Fixes`
	`19`	+- Fix `operator-sdk build`'s `--image-build-args` to support spaces within quotes like `--label some.name="First Last"`. ([#2312](https://github.com/operator-framework/operator-sdk/pull/2312))
`19`	`20`
`20`	`21`
`21`	`22`	`## v0.13.0`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ import (`
`25`	`25`	`"github.com/operator-framework/operator-sdk/internal/scaffold"`
`26`	`26`	`"github.com/operator-framework/operator-sdk/internal/util/projutil"`
`27`	`27`
	`28`	`+ "github.com/google/shlex"`
`28`	`29`	`log "github.com/sirupsen/logrus"`
`29`	`30`	`"github.com/spf13/cobra"`
`30`	`31`	`)`
`@@ -73,7 +74,10 @@ func createBuildCommand(imageBuilder, context, dockerFile, image string, imageBu`
`73`	`74`
`74`	`75`	`for _, bargs := range imageBuildArgs {`
`75`	`76`	`if bargs != "" {`
`76`		`- splitArgs := strings.Fields(bargs)`
	`77`	`+ splitArgs, err := shlex.Split(bargs)`
	`78`	`+ if err != nil {`
	`79`	`+ return nil, fmt.Errorf("image-build-args is not parseable: %w", err)`
	`80`	`+ }`
`77`	`81`	`args = append(args, splitArgs...)`
`78`	`82`	`}`
`79`	`83`	`}`