Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove extra files from py_binary DefaultInfo #467

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Remove extra files from py_binary DefaultInfo #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7dc181f
Remove extra files from py_binary DefaultInfo
keith Dec 5, 2024
511217c
fixture
keith Dec 9, 2024
1caa0f0
chore: add smoke test for executing pex binary
alexeagle Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions examples/py_pex_binary/BUILD.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,37 @@
load("@aspect_bazel_lib//lib:testing.bzl", "assert_contains")
load("//py:defs.bzl", "py_binary", "py_pex_binary")

py_binary(
name = "binary",
srcs = ["say.py"],
data = ["data.txt"],
env = {
"TEST": "1"
"TEST": "1",
},
deps = [
"@pypi_cowsay//:pkg",
"@bazel_tools//tools/python/runfiles",
"@pypi_cowsay//:pkg",
],
)

py_pex_binary(
name = "py_pex_binary",
binary = ":binary",
inject_env = {
"TEST": "1"
}
"TEST": "1",
},
)

genrule(
name = "execute_pex",
srcs = [],
outs = ["pex.out"],
cmd = "$(execpath py_pex_binary) >$@",
tools = ["py_pex_binary"],
)

assert_contains(
name = "smoke_test_pex",
actual = "pex.out",
expected = "Mooo!",
)
6 changes: 1 addition & 5 deletions py/private/py_binary.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,7 @@ def _py_binary_rule_impl(ctx):

return [
DefaultInfo(
files = depset([
executable_launcher,
ctx.file.main,
site_packages_pth_file,
]),
files = depset([executable_launcher]),
executable = executable_launcher,
runfiles = runfiles,
),
Expand Down
2 changes: 0 additions & 2 deletions py/tests/py_image_layer/my_app_layers.listing
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2439,8 +2439,6 @@ drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/
drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/tests/
drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/tests/py_image_layer/
-rwxr-xr-x 0 0 0 2887 Jan 1 2023 ./py/tests/py_image_layer/my_app_bin
-rwxr-xr-x 0 0 0 16 Jan 1 2023 ./py/tests/py_image_layer/main.py
Copy link
Member

Choose a reason for hiding this comment

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

it looks to me like this will break the ability to execute a container from this image - the entry point is gone. @thesayyn do you know if we have a test here that the py_image_layer can execute? Do we need to add a TestContainers Cloud or something so we have a docker daemon to run that assertion?

Copy link
Member

Choose a reason for hiding this comment

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

This will not affect containers, but i am afraid it might break PEX

rules_py/py/private/run.tmpl.sh

Lines 5 to 6 in d49da0f

# This is a special comment for py_pex_binary to find the python entrypoint.
# __PEX_PY_BINARY_ENTRYPOINT__ {{ENTRYPOINT}}
,

Under pex, the shell generated by py_binary is not used at all, and we invoke the main.py directly with the given interpreter. It would be good to manually test https://github.com/aspect-build/rules_py/tree/main/examples/py_pex_binary and confirm it doesn't break.

Copy link
Member

Choose a reason for hiding this comment

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

I tested it manually, and also added a commit here which does a simple genrule/assert_contains to automate that test.

-rwxr-xr-x 0 0 0 40 Jan 1 2023 ./py/tests/py_image_layer/my_app_bin.venv.pth
drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/tests/py_image_layer/my_app_bin.runfiles/
drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/tests/py_image_layer/my_app_bin.runfiles/aspect_rules_py/
drwxr-xr-x 0 0 0 0 Jan 1 2023 ./py/tests/py_image_layer/my_app_bin.runfiles/aspect_rules_py/py/
Expand Down
Loading