kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Merge pull request #27412 from loftylabs/26249-make-unused-args-warning

Browse source 
Convert Unused ARG error to warning
This commit is contained in:
Doug Davis 2016-11-01 08:47:03 -04:00 • committed by GitHub
commit f8d5d65fb8
4 changed files with 27 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
builder/dockerfile/builder.go
View file

@ -271,15 +271,16 @@ func (b *Builder) build(stdout io.Writer, stderr io.Writer, out io.Writer) (stri
} }
// check if there are any leftover build-args that were passed but not // check if there are any leftover build-args that were passed but not
// consumed during build. Return an error, if there are any. // consumed during build. Return a warning, if there are any.
leftoverArgs := []string{} leftoverArgs := []string{}
for arg := range b.options.BuildArgs { for arg := range b.options.BuildArgs {
if !b.isBuildArgAllowed(arg) { if !b.isBuildArgAllowed(arg) {
leftoverArgs = append(leftoverArgs, arg) leftoverArgs = append(leftoverArgs, arg)
} }
} }
if len(leftoverArgs) > 0 { if len(leftoverArgs) > 0 {
return "", fmt.Errorf("One or more build-args %v were not consumed, failing build.", leftoverArgs) fmt.Fprintf(b.Stderr, "[Warning] One or more build-args %v were not consumed\n", leftoverArgs)
} }
if b.image == "" { if b.image == "" {

8
docs/reference/builder.md
View file

@ -1286,12 +1286,12 @@ to create the directory in the Dockerfile. For example:
ARG <name>[=<default value>] ARG <name>[=<default value>]
The `ARG` instruction defines a variable that users can pass at build-time to The `ARG` instruction defines a variable that users can pass at build-time to
the builder with the `docker build` command using the the builder with the `docker build` command using the `--build-arg
`--build-arg <varname>=<value>` flag. If a user specifies a build argument <varname>=<value>` flag. If a user specifies a build argument that was not
that was not defined in the Dockerfile, the build outputs an error. defined in the Dockerfile, the build outputs a warning.
``` ```
One or more build-args were not consumed, failing build. [Warning] One or more build-args [foo] were not consumed.
``` ```
The Dockerfile author can define a single variable by specifying `ARG` once or many The Dockerfile author can define a single variable by specifying `ARG` once or many

11
integration-cli/docker_cli_build_test.go
View file

@ -6056,11 +6056,12 @@ func (s *DockerSuite) TestBuildBuildTimeArgUnconsumedArg(c *check.C) {
RUN echo $%s RUN echo $%s
CMD echo $%s`, envKey, envKey) CMD echo $%s`, envKey, envKey)
errStr := "One or more build-args" warnStr := "[Warning] One or more build-args"
if _, out, err := buildImageWithOut(imgName, dockerfile, true, args...); err == nil {
c.Fatalf("build succeeded, expected to fail. Output: %v", out) if _, out, err := buildImageWithOut(imgName, dockerfile, true, args...); !strings.Contains(out, warnStr) {
} else if !strings.Contains(out, errStr) { c.Fatalf("build completed without warning: %q %q", out, err)
c.Fatalf("Unexpected error. output: %q, expected error: %q", out, errStr) } else if err != nil {
c.Fatalf("build failed to complete: %q %q", out, err)
} }
} }

5
man/Dockerfile.5.md
View file

@ -326,10 +326,10 @@ A Dockerfile is similar to a Makefile.
The `ARG` instruction defines a variable that users can pass at build-time to The `ARG` instruction defines a variable that users can pass at build-time to
the builder with the `docker build` command using the `--build-arg the builder with the `docker build` command using the `--build-arg
<varname>=<value>` flag. If a user specifies a build argument that was not <varname>=<value>` flag. If a user specifies a build argument that was not
defined in the Dockerfile, the build outputs an error. defined in the Dockerfile, the build outputs a warning.
``` ```
One or more build-args were not consumed, failing build. [Warning] One or more build-args [foo] were not consumed
``` ```
The Dockerfile author can define a single variable by specifying `ARG` once or many The Dockerfile author can define a single variable by specifying `ARG` once or many
@ -471,3 +471,4 @@ A Dockerfile is similar to a Makefile.
*May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.com Dockerfile documentation. *May 2014, Compiled by Zac Dover (zdover at redhat dot com) based on docker.com Dockerfile documentation.
*Feb 2015, updated by Brian Goff (cpuguy83@gmail.com) for readability *Feb 2015, updated by Brian Goff (cpuguy83@gmail.com) for readability
*Sept 2015, updated by Sally O'Malley (somalley@redhat.com) *Sept 2015, updated by Sally O'Malley (somalley@redhat.com)
*Oct 2016, updated by Addam Hardy (addam.hardy@gmail.com)