feat: add py_pytest_main entrypoint by mattem · Pull Request #723 · bazel-contrib/rules_python

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem · 2022-06-06T18:16:59Z

Adds a py_pytest_main entrypoint rule for templating a launcher for pytest that works in conjunction with the Gazelle extension.

thundergolfer · 2022-06-08T11:09:17Z

+ print("Pytest exit code: " + str(exit_code))
+ print("Ran pytest.main with " + str(args))


Suggested change
print("Pytest exit code: "+str(exit_code))
print("Ran pytest.main with "+str(args))
print("Pytest exit code: "+str(exit_code), file=sys.stderr)
print("Ran pytest.main with "+str(args), file=sys.stderr)
I may be missing a reason that we wouldn't send error logs to stderr. But normally you should.

thundergolfer · 2022-06-08T12:44:30Z

+ ctx.actions.expand_template(
+ template = ctx.file.template,
+ output = ctx.outputs.out,
+ substitutions = dict(substitutions, **ctx.var),


How does this **ctx.var overriding get used?

Via --define generally

thundergolfer · 2022-06-08T12:56:36Z

@@ -1 +1,2 @@
 requests==2.25.1
+pytest


Why not pin the version, at least to ~=?

Can do, given this is locked by pip_compile and it won't change we shouldn't really care about the version of pytest, so the open ended version here seemed fine, but I'm not strongly opinionated about it.

thundergolfer · 2022-06-08T12:59:48Z

+import pytest
+
+if __name__ == "__main__":
+ $$CHDIR$$


Is there a benefit/difference to subbing in an os.chdir(...) string here vs. passing the directory as the first argument to pytest.main? (Passing as 1st arg is how we do it at our company)

thundergolfer · 2022-06-08T13:01:17Z

+# Generates an entrypoint for pytest that is picked up by Gazelle for the py_test target below.
+py_pytest_main(
+ name = "__test__",
+)


How come py_pytest_main becomes a dependency to a py_test, instead of subsuming the py_test rule?
Wholly replacing the py_test rule with a macro/rule/rule+macro seems a cleaner user interface.

This provides an entry point for pytest, the Python test runner, and doesn't force changing loads or existing rules, and keepspy_test the bazel rule a generic "run a python binary that will return 0 or 1". There are other launchers, perhaps a nose entrypoint etc.
This model also fits with the gazelle generation already present here.

mattem · 2022-07-07T18:00:06Z

Well that merge went wrong :(

…#739)

Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

domenic-donato · 2022-08-09T09:00:28Z

What is the status of this PR, is it still being worked on?

f0rmiga · 2022-11-08T18:35:39Z

Following the decision that rules_python will not be test-framework-specific, this effort landed in aspect-build/rules_py@6b1fcb7.

mattem requested review from brandjon, f0rmiga, lberki and thundergolfer as code owners June 6, 2022 18:16

f0rmiga approved these changes Jun 6, 2022
View reviewed changes

thundergolfer removed request for brandjon and lberki June 7, 2022 23:34

thundergolfer reviewed Jun 8, 2022
View reviewed changes

domenic-donato mentioned this pull request Jun 9, 2022
_test.py files being included in py_library rather than py_test #714
Closed

thundergolfer mentioned this pull request Jun 22, 2022
Add a pytest rules #464
Closed
13 tasks

mattem mentioned this pull request Jun 30, 2022
refactor: move all re-exports to private/reexports.bzl #739
Merged

alexeagle mentioned this pull request Jul 7, 2022
upstream py_test_main to rules_python aspect-build/rules_py#53
Closed

mattem added 6 commits July 11, 2022 15:50

feat: add py_pytest_main entrypoint
eea59e9

cleanup, run buildifier
5fb4975

refactor: move all re-exports to private/reexports.bzl (bazel-contrib…
aea44b5
…#739)

feat: add py_pytest_main entrypoint
a16bfa7

cleanup, run buildifier
ed124c6

tidy
3f10990

f0rmiga force-pushed the feat/py_pytest_main branch from 0213618 to 3f10990Compare July 11, 2022 22:51

fix: load order
4e9bd00
Signed-off-by: Thulio Ferraz Assis <3149049+f0rmiga@users.noreply.github.com>

f0rmiga closed this Nov 8, 2022

f0rmiga deleted the feat/py_pytest_main branch November 8, 2022 18:35

arrdem mentioned this pull request Feb 6, 2023
pytest support #240
Closed

adam-azarchs mentioned this pull request May 20, 2024
Rule for running tests with pytest #1910
Closed

alexeagle mentioned this pull request Jun 14, 2024
gazelle: generate py_pytest_main #1972
Closed

adam-azarchs mentioned this pull request Sep 16, 2024
Python code formatting rule #509
Closed