Make the `pack build` warn that the positional argument will not be treated as the source directory path #2256

hhiroshell · 2024-09-02T07:12:29Z

Summary

This PR makes the pack build warn that the positional argument specifying the image name will not be treated as the source directory path, addressing #2231.

Output

Before

$ pack build sample-app --builder cnbs/sample-builder:jammy
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

After

pack build warns it if both of the following criteria are met:

The build artifact is not specified as an OCI file layout.
The --path flag is not used.

$ pack build sample-app --builder cnbs/sample-builder:jammy
Warning: You are building an image named 'sample-app'. If you mean it as an app directory path, run 'pack build <args> --path sample-app'
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

pack build doesn't warn it if the build artifact is specified as an OCI file layout.

$ pack config experimental true
Experimental features enabled!

$ pack build oci:sample-app --builder cnbs/sample-builder:jammy
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

pack build doesn't warn it if the --path flag is specified.

$ pack build sample-app --builder cnbs/sample-builder:jammy --path apps/java-maven
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

Documentation

Should this change be documented?
- Yes, see #___
- No

$ test -e apps/java-maven && echo "exists" || echo "does not exist"
exists

$ pack build apps/java-maven --builder cnbs/sample-builder:jammy
Warning: You are building an image named 'apps/java-maven'. If you mean it as an app directory path, run 'pack build <args> --path apps/java-maven'
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

pack build doesn't warn it if a local path with the same string as the specified image name doesn't exist.

$ test -e aaaa && echo "exists" || echo "does not exist"
does not exist

$ pack build aaaa --builder cnbs/sample-builder:jammy
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

pack build doesn't warn it if a local path with the same string as the specified image name exists, and --path is used.

$ test -e apps/java-maven && echo "exists" || echo "does not exist"
exists

$ pack build apps/java-maven --path apps/java-maven --builder cnbs/sample-builder:jammy
jammy: Pulling from cnbs/sample-builder
Digest: sha256:9db376e26252b6cbc75190c88ea24571da36ec0d373136be233b32fd174962fc
Status: Image is up to date for cnbs/sample-builder:jammy
...

Signed-off-by: hhiroshell <hhiroshell@gmail.com>

hhiroshell · 2024-09-18T10:38:58Z

internal/commands/build_test.go

+				// avoid using paths generated by os.MkdirTemp() as they cause test failures on macOS.
+				dir = "my-app-dir" + h.RandString(8)
+				err := os.Mkdir(dir, 0700)


A path created by os.MkdirTemp() on macOS is like: /var/folders/vh/0l94sp8n6hx8qwhb6wsy_xrh0000gr/T/tmp.4ffiJJd5rq
It triggers an error in the validation of the image name when specified as a positional argument (image name), and results in test failure.

Are we creating the my-app-dir folder in the current directory? if for some reason the test fails and I am running the tests locally, will I see this new my-app-dir like a new file not being tracked by git?

I agree that creating a new directory in the local source is a bit weird. An alternative would be to invoke pack build testdata since (I'm pretty sure) this test runs in the context of /internal/commands/. We could also try some combination of os.MkdirTemp and os.Chdir to create a directory with a sensible reference, but that might be a bit heavy-handed for what we need.

@jjbustamante @natalieparellano
Thank you for your comments and suggestions! I'll try to fix it to use the testdata. 🙏

Done: 3aee96e

Now the code looks clean, and there will be no residue left in case of test failures. 😌

hhiroshell · 2024-10-01T13:16:59Z

@natalieparellano
I believe all comments have been resolved. Would you please confirm that?

If I need to explain some recent changes (#2256 (comment), #2256 (comment) ), I'll happily do so. So please let me know.

natalieparellano · 2024-10-02T17:47:54Z

@hhiroshell thank you for your work on this, and apologies for being slow to get back to you with a review. I think we should address the concern here: #2256 (comment) (added some suggestions)

…s for each '--path' flag case to ensure no temp directories are left behind in case of a test failure. Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

natalieparellano · 2024-10-07T14:13:53Z

LCOW failure seems unrelated, we are looking into it...

hhiroshell · 2024-10-09T07:45:33Z

Thank you for your effort, @natalieparellano.
If there is anything I can do about LCOW failure, please let me know.

hhiroshell · 2024-10-31T08:14:06Z

@natalieparellano @jjbustamante
Thank you for all your effort in reviewing and fixing the CI failure. I'm honored to have my PR merged!

natalieparellano · 2024-11-01T14:25:28Z

Thank you for your contribution @hhiroshell!

Make the 'pack build' command warn that the positional argument will …

0a5cf9c

…not be treated as the source directory path. Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

hhiroshell requested review from a team as code owners September 2, 2024 07:12

github-actions bot added this to the 0.36.0 milestone Sep 2, 2024

github-actions bot added the type/enhancement Issue that requests a new feature or improvement. label Sep 2, 2024

hhiroshell commented Sep 2, 2024

View reviewed changes

internal/commands/build_test.go Outdated Show resolved Hide resolved

hhiroshell marked this pull request as draft September 3, 2024 16:07

hhiroshell added 2 commits September 5, 2024 20:08

Add a test case for when the 'pack build' is called with the '--path'…

7066e52

… flag. Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

Improve descriptions for some test cases.

66982d0

Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

hhiroshell marked this pull request as ready for review September 5, 2024 11:58

natalieparellano reviewed Sep 13, 2024

View reviewed changes

internal/commands/build.go Outdated Show resolved Hide resolved

hhiroshell added 2 commits September 17, 2024 12:47

Make it warns only when a local path with the same string as the spec…

cee65f2

…ified image name exists Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

rephrase the test description

59a0abf

Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

avoid using os.MkdirTemp() to prevent test failures on macOS

569e992

Signed-off-by: hhiroshell <hhiroshell@gmail.com>

hhiroshell commented Sep 18, 2024

View reviewed changes

Merge branch 'main' into fix-pack-2231

98c32ed

Use an existing directory instead of creating and deleting directorie…

3aee96e

…s for each '--path' flag case to ensure no temp directories are left behind in case of a test failure. Signed-off-by: Hiroshi Hayakawa <hhiroshell@gmail.com>

natalieparellano approved these changes Oct 25, 2024

View reviewed changes

natalieparellano merged commit 270eb1e into buildpacks:main Oct 25, 2024
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make the `pack build` warn that the positional argument will not be treated as the source directory path #2256

Make the `pack build` warn that the positional argument will not be treated as the source directory path #2256

hhiroshell commented Sep 2, 2024 •

edited

Loading

hhiroshell commented Sep 3, 2024 •

edited

Loading

hhiroshell commented Sep 5, 2024

hhiroshell commented Sep 17, 2024 •

edited

Loading

hhiroshell Sep 18, 2024 •

edited

Loading

jjbustamante Oct 2, 2024

natalieparellano Oct 2, 2024

hhiroshell Oct 4, 2024

hhiroshell Oct 4, 2024

hhiroshell commented Oct 1, 2024

natalieparellano commented Oct 2, 2024

natalieparellano commented Oct 7, 2024

hhiroshell commented Oct 9, 2024 •

edited

Loading

hhiroshell commented Oct 31, 2024

natalieparellano commented Nov 1, 2024

Make the pack build warn that the positional argument will not be treated as the source directory path #2256

Make the pack build warn that the positional argument will not be treated as the source directory path #2256

Conversation

hhiroshell commented Sep 2, 2024 • edited Loading

Summary

Output

Before

After

Documentation

Related

hhiroshell commented Sep 3, 2024 • edited Loading

hhiroshell commented Sep 5, 2024

hhiroshell commented Sep 17, 2024 • edited Loading

hhiroshell Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

jjbustamante Oct 2, 2024

Choose a reason for hiding this comment

natalieparellano Oct 2, 2024

Choose a reason for hiding this comment

hhiroshell Oct 4, 2024

Choose a reason for hiding this comment

hhiroshell Oct 4, 2024

Choose a reason for hiding this comment

hhiroshell commented Oct 1, 2024

natalieparellano commented Oct 2, 2024

natalieparellano commented Oct 7, 2024

hhiroshell commented Oct 9, 2024 • edited Loading

hhiroshell commented Oct 31, 2024

natalieparellano commented Nov 1, 2024

Make the `pack build` warn that the positional argument will not be treated as the source directory path #2256

Make the `pack build` warn that the positional argument will not be treated as the source directory path #2256

hhiroshell commented Sep 2, 2024 •

edited

Loading

hhiroshell commented Sep 3, 2024 •

edited

Loading

hhiroshell commented Sep 17, 2024 •

edited

Loading

hhiroshell Sep 18, 2024 •

edited

Loading

hhiroshell commented Oct 9, 2024 •

edited

Loading