DockerCLI/cli/command/network
Sebastiaan van Stijn f2424bd375
Fix labels copying value from environment variables
This patch fixes a bug where labels use the same behavior as `--env`, resulting
in a value to be copied from environment variables with the same name as the
label if no value is set (i.e. a simple key, no `=` sign, no value).

An earlier pull request addressed similar cases for `docker run`;
2b17f4c8a8, but this did not address the
same situation for (e.g.) `docker service create`.

Digging in history for this bug, I found that use of the `ValidateEnv`
function for  labels was added in the original implementation of the labels feature in
abb5e9a077 (diff-ae476143d40e21ac0918630f7365ed3cR34)

However, the design never intended it to expand environment variables,
and use of this function was either due to either a "copy/paste" of the
equivalent `--env` flags, or a misunderstanding (the name `ValidateEnv` does
not communicate that it also expands environment variables), and the existing
`ValidateLabel` was designed for _engine_ labels (which required a value to
be set).

Following the initial implementation, other parts of the code followed
the same (incorrect) approach, therefore leading the bug to be introduced
in services as well.

This patch:

- updates the `ValidateLabel` to match the expected validation
  rules (this function is no longer used since 31dc5c0a9a),
  and the daemon has its own implementation)
- corrects various locations in the code where `ValidateEnv` was used instead of `ValidateLabel`.

Before this patch:

```bash
export SOME_ENV_VAR=I_AM_SOME_ENV_VAR
docker service create --label SOME_ENV_VAR --tty --name test busybox

docker service inspect --format '{{json .Spec.Labels}}' test
{"SOME_ENV_VAR":"I_AM_SOME_ENV_VAR"}
```

After this patch:

```bash
export SOME_ENV_VAR=I_AM_SOME_ENV_VAR
docker service create --label SOME_ENV_VAR --tty --name test busybox

docker container inspect --format '{{json .Config.Labels}}' test
{"SOME_ENV_VAR":""}
```

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2019-03-19 03:01:57 +01:00
..
testdata use sortorder lib for sorting network list output 2018-08-08 12:06:59 -04:00
client_test.go Switch from x/net/context to context 2018-05-11 16:49:43 -07:00
cmd.go Hide "builder" and "network" commands on old API versions 2019-01-30 01:06:09 +01:00
connect.go Switch from x/net/context to context 2018-05-11 16:49:43 -07:00
connect_test.go Update tests to use gotest.tools 👼 2018-06-08 18:24:26 +02:00
create.go Fix labels copying value from environment variables 2019-03-19 03:01:57 +01:00
create_test.go Update tests to use gotest.tools 👼 2018-06-08 18:24:26 +02:00
disconnect.go Switch from x/net/context to context 2018-05-11 16:49:43 -07:00
disconnect_test.go Update tests to use gotest.tools 👼 2018-06-08 18:24:26 +02:00
formatter.go formatter package heavy refactoring 2018-10-23 17:05:44 +02:00
formatter_test.go formatter package heavy refactoring 2018-10-23 17:05:44 +02:00
inspect.go Switch from x/net/context to context 2018-05-11 16:49:43 -07:00
list.go formatter package heavy refactoring 2018-10-23 17:05:44 +02:00
list_test.go refactor network list unit tests to table-driven style 2018-08-02 14:07:06 -04:00
prune.go build: add options to builder prune 2018-09-05 00:01:16 +00:00
remove.go Switch from x/net/context to context 2018-05-11 16:49:43 -07:00