Allow passing deps in py_pytest_main (#163)

aspect-build · Jul 31, 2023 · 88ebe87 · 88ebe87
1 parent 57ade45
commit 88ebe87
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 7 deletions.
diff --git a/docs/py_binary.md b/docs/py_binary.md
diff --git a/docs/py_library.md b/docs/py_library.md
diff --git a/docs/rules.md b/docs/rules.md
diff --git a/examples/pytest/BUILD.bazel b/examples/pytest/BUILD.bazel
@@ -1,7 +1,10 @@
 load("@rules_python//python:defs.bzl", "py_test")
 load("@//py:defs.bzl", "py_pytest_main")
 
-py_pytest_main(name = "__test__")
+py_pytest_main(
+    name = "__test__",
+    deps = ["@pypi_pytest//:pkg"],
+)
 
 py_test(
     name = "pytest_test",
@@ -13,6 +16,5 @@ py_test(
     main = ":__test__.py",
     deps = [
         ":__test__",
-        "@pypi_pytest//:pkg",
     ],
 )
diff --git a/examples/pytest/README.md b/examples/pytest/README.md
@@ -6,13 +6,16 @@ same way the `pytest` command-line does.
 
 ## How to use
 
-After importing this repository into your `WORKSPACE`, add to your Bazel packages containing
-`_test.py` files the following:
+After importing this repository into your `WORKSPACE`, add the following to your Bazel packages
+which contain `_test.py` files:
 
 ```python
 load("@aspect_rules_py//py:defs.bzl", "py_pytest_main")
 
-py_pytest_main(name = "__test__")
+py_pytest_main(
+    name = "__test__",
+    deps = ["@pypi_pytest//:pkg"], # change this to the pytest target in your repo.
+)
 ```
 
 When using this repository together with the Gazelle extension for Python from rules_python, Gazelle

diff --git a/py/private/py_pytest_main.bzl b/py/private/py_pytest_main.bzl
@@ -53,12 +53,13 @@ _py_pytest_main = rule(
     },
 )
 
-def py_pytest_main(name, py_library = default_py_library, **kwargs):
+def py_pytest_main(name, py_library = default_py_library, deps = [], **kwargs):
     """py_pytest_main wraps the template rendering target and the final py_library.
 
     Args:
         name: The name of the runable target that updates the test entry file.
         py_library: Use this attribute to override the default py_library rule.
+        deps: A list containing the pytest library target, e.g., @pypi_pytest//:pkg.
         **kwargs: The extra arguments passed to the template rendering target.
     """
 
@@ -79,4 +80,5 @@ def py_pytest_main(name, py_library = default_py_library, **kwargs):
         srcs = [test_main],
         tags = tags,
         visibility = visibility,
+        deps = deps,
     )