Skip to content

fix: stacker convert should include ENV vars into the runtime config. - #784

Open
jmblatten wants to merge 1 commit into
project-stacker:mainfrom
geico:fix-convert-ENV
Open

fix: stacker convert should include ENV vars into the runtime config.#784
jmblatten wants to merge 1 commit into
project-stacker:mainfrom
geico:fix-convert-ENV

Conversation

@jmblatten

Copy link
Copy Markdown

Dockerfile ENV defines variables for both build and runtime. Stacker convert, converts ENV for build, but does not include runtime. Stacker uses "environment:" in yaml to define variables for runtime. So, include the ENV variables there so they will show up in the config when running the container.
See https://docs.docker.com/reference/dockerfile/#env

What type of PR is this?
bug

Which issue does this PR fix:
#757

What does this PR do / Why do we need it:
See above.

If an issue # is not available please add repro steps and logs showing the issue:
#757

Steps:

Dockerfile contents:

FROM alpine AS mybase
ENV HELLO=hello!
ENV GOODBYE=goodbye!
RUN echo $HELLO && \
    echo $GOODBYE

Converted stacker.yaml

mybase:
  build_env:
    arch: amd64
  from:
    type: docker
    url: docker://alpine
  run:
  - export HELLO=hello!
  - export GOODBYE=goodbye!
  - sh -e -c 'echo $HELLO &&     echo $GOODBYE'

Using skopeo inspect

"Env": [
        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
    ]

Note: env does not include HELLO and GOODBYE in image.

Testing done on this change:

  • CI
  • Manual:
    Dockerfile contents:
FROM alpine AS mybase
ENV HELLO=hello!
ENV GOODBYE=goodbye!
RUN echo $HELLO && \
    echo $GOODBYE

Converted stacker.yaml contents

mybase:
  build_env:
    arch: amd64
  environment:
    GOODBYE: goodbye!
    HELLO: hello!
  from:
    type: docker
    url: docker://alpine
  run:
  - export HELLO=hello!
  - export GOODBYE=goodbye!
  - sh -e -c 'echo $HELLO &&     echo $GOODBYE'

Using skopeo inspect,

"Env": [
        "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
        "GOODBYE=goodbye!",
        "HELLO=hello!"
    ]

Automation added to e2e:
None

Will this break upgrades or downgrades?
No

Does this PR introduce any user-facing change?:
Yes, but only for converted Dockerfiles. The resulting stacker.yaml file will now include an environment section if there were any ENVs in the Dockerfile. This will cause the image runtime to include the environment variables.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

Dockerfile ENV defines variables for both build and runtime.
Stacker convert, converts ENV for build, but does not include runtime.
Stacker uses "environment:" in yaml to define variables for runtime.
So, include the ENV variables there so they will show up in the config
when running the container.

Signed-off-by: Joy Latten <joylatten@geico.com>

@hallyn hallyn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm, thanks

c.output[c.currLayer] = &types.Layer{}
return c
}(),
cmd: &Command{Cmd: "env", Original: "ENV FOO", Value: []string{"FOO"}},

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't quite follow two things.

  1. if this test is named 'invalid env' ; what it is testing?
  2. Why is this hunk needed vs the original relating to the "invalid env" scenario?

I apologize here, I should study the test case here; but if you already know I'd appreciate some background on what this change is doing.

Lastly; I was hoping to see a test that demonstrates the failure so it's easy to reason about the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants