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)
} }
} }

27
man/Dockerfile.5.md
View file

@ -26,7 +26,7 @@ For example:
# DESCRIPTION # DESCRIPTION
A Dockerfile is a file that automates the steps of creating a Docker image. A Dockerfile is a file that automates the steps of creating a Docker image.
A Dockerfile is similar to a Makefile. A Dockerfile is similar to a Makefile.
# USAGE # USAGE
@ -71,10 +71,10 @@ A Dockerfile is similar to a Makefile.
multiple images. Make a note of the last image ID output by the commit before multiple images. Make a note of the last image ID output by the commit before
each new **FROM** command. each new **FROM** command.
-- If no tag is given to the **FROM** instruction, Docker applies the -- If no tag is given to the **FROM** instruction, Docker applies the
`latest` tag. If the used tag does not exist, an error is returned. `latest` tag. If the used tag does not exist, an error is returned.
-- If no digest is given to the **FROM** instruction, Docker applies the -- If no digest is given to the **FROM** instruction, Docker applies the
`latest` tag. If the used tag does not exist, an error is returned. `latest` tag. If the used tag does not exist, an error is returned.
**MAINTAINER** **MAINTAINER**
@ -148,7 +148,7 @@ A Dockerfile is similar to a Makefile.
``` ```
-- To make the container run the same executable every time, use **ENTRYPOINT** in -- To make the container run the same executable every time, use **ENTRYPOINT** in
combination with **CMD**. combination with **CMD**.
If the user specifies arguments to `docker run`, the specified commands If the user specifies arguments to `docker run`, the specified commands
override the default in **CMD**. override the default in **CMD**.
Do not confuse **RUN** with **CMD**. **RUN** runs a command and commits the result. Do not confuse **RUN** with **CMD**. **RUN** runs a command and commits the result.
@ -156,7 +156,7 @@ A Dockerfile is similar to a Makefile.
the image. the image.
**LABEL** **LABEL**
-- `LABEL <key>=<value> [<key>=<value> ...]`or -- `LABEL <key>=<value> [<key>=<value> ...]`or
``` ```
LABEL <key>[ <value>] LABEL <key>[ <value>]
LABEL <key>[ <value>] LABEL <key>[ <value>]
@ -176,8 +176,8 @@ A Dockerfile is similar to a Makefile.
``` ```
An image can have more than one label. To specify multiple labels, separate An image can have more than one label. To specify multiple labels, separate
each key-value pair by a space. each key-value pair by a space.
Labels are additive including `LABEL`s in `FROM` images. As the system Labels are additive including `LABEL`s in `FROM` images. As the system
encounters and then applies a new label, new `key`s override any previous encounters and then applies a new label, new `key`s override any previous
labels with identical keys. labels with identical keys.
@ -194,7 +194,7 @@ A Dockerfile is similar to a Makefile.
**ENV** **ENV**
-- `ENV <key> <value>` -- `ENV <key> <value>`
The **ENV** instruction sets the environment variable <key> to The **ENV** instruction sets the environment variable <key> to
the value `<value>`. This value is passed to all future the value `<value>`. This value is passed to all future
**RUN**, **ENTRYPOINT**, and **CMD** instructions. This is **RUN**, **ENTRYPOINT**, and **CMD** instructions. This is
functionally equivalent to prefixing the command with `<key>=<value>`. The functionally equivalent to prefixing the command with `<key>=<value>`. The
environment variables that are set with **ENV** persist when a container is run environment variables that are set with **ENV** persist when a container is run
@ -243,7 +243,7 @@ A Dockerfile is similar to a Makefile.
being built (the context of the build) or a remote file URL. The `<dest>` is an being built (the context of the build) or a remote file URL. The `<dest>` is an
absolute path, or a path relative to **WORKDIR**, into which the source will absolute path, or a path relative to **WORKDIR**, into which the source will
be copied inside the target container. If you **COPY** an archive file it will be copied inside the target container. If you **COPY** an archive file it will
land in the container exactly as it appears in the build context without any land in the container exactly as it appears in the build context without any
attempt to unpack it. All new files and directories are created with mode **0755** attempt to unpack it. All new files and directories are created with mode **0755**
and with the uid and gid of **0**. and with the uid and gid of **0**.
@ -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
@ -454,7 +454,7 @@ A Dockerfile is similar to a Makefile.
you are defining an image to use as a base for building other images. For you are defining an image to use as a base for building other images. For
example, if you are defining an application build environment or a daemon that example, if you are defining an application build environment or a daemon that
is customized with a user-specific configuration. is customized with a user-specific configuration.
Consider an image intended as a reusable python application builder. It must Consider an image intended as a reusable python application builder. It must
add application source code to a particular directory, and might need a build add application source code to a particular directory, and might need a build
script called after that. You can't just call **ADD** and **RUN** now, because script called after that. You can't just call **ADD** and **RUN** now, because
@ -470,4 +470,5 @@ A Dockerfile is similar to a Makefile.
# HISTORY # HISTORY
*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)