Add a conftest target type

Eric-Arellano · Eric-Arellano · commit c65e84339602 · 2020-08-14T11:38:43.000-07:00
# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
diff --git a/src/python/pants/backend/python/dependency_inference/rules_test.py b/src/python/pants/backend/python/dependency_inference/rules_test.py
@@ -10,6 +10,7 @@
 )
 from pants.backend.python.dependency_inference.rules import rules as dependency_inference_rules
 from pants.backend.python.target_types import (
+    ConftestTarget,
     PythonLibrary,
     PythonRequirementLibrary,
     PythonSources,
@@ -47,7 +48,7 @@ def rules(cls):
 
     @classmethod
     def target_types(cls):
-        return [PythonLibrary, PythonRequirementLibrary, PythonTests]
+        return [ConftestTarget, PythonLibrary, PythonRequirementLibrary, PythonTests]
 
     def test_infer_python_imports(self) -> None:
         self.add_to_build_file(
@@ -173,15 +174,15 @@ def test_infer_python_conftests(self) -> None:
         )
 
         self.create_file("src/python/root/conftest.py")
-        self.add_to_build_file("src/python/root", "python_library()")
+        self.add_to_build_file("src/python/root", "conftest()")
 
         self.create_file("src/python/root/mid/conftest.py")
-        self.add_to_build_file("src/python/root/mid", "python_library()")
+        self.add_to_build_file("src/python/root/mid", "conftest()")
 
         self.create_file("src/python/root/mid/leaf/conftest.py")
         self.create_file("src/python/root/mid/leaf/this_is_a_test.py")
         self.add_to_build_file(
-            "src/python/root/mid/leaf", "python_tests()\npython_library(name='conftest')"
+            "src/python/root/mid/leaf", "python_tests()\nconftest(name='conftest')"
         )
 
         def run_dep_inference(address: Address) -> InferredDependencies:
diff --git a/src/python/pants/backend/python/rules/pytest_runner_integration_test.py b/src/python/pants/backend/python/rules/pytest_runner_integration_test.py
@@ -11,7 +11,12 @@
 from pants.backend.python.rules import pex, pex_from_targets, pytest_runner, python_sources
 from pants.backend.python.rules.coverage import create_coverage_config
 from pants.backend.python.rules.pytest_runner import PythonTestFieldSet
-from pants.backend.python.target_types import PythonLibrary, PythonRequirementLibrary, PythonTests
+from pants.backend.python.target_types import (
+    ConftestTarget,
+    PythonLibrary,
+    PythonRequirementLibrary,
+    PythonTests,
+)
 from pants.build_graph.build_file_aliases import BuildFileAliases
 from pants.core.goals.test import Status, TestDebugRequest, TestResult
 from pants.core.util_rules import source_files, stripped_source_files
@@ -112,7 +117,7 @@ def alias_groups(cls) -> BuildFileAliases:
 
     @classmethod
     def target_types(cls):
-        return [PythonLibrary, PythonTests, PythonRequirementLibrary]
+        return [ConftestTarget, PythonLibrary, PythonTests, PythonRequirementLibrary]
 
     @classmethod
     def rules(cls):
@@ -369,7 +374,7 @@ def test_conftest_injection(self) -> None:
             relpath=PurePath(self.source_root, self.conftest_source.path).as_posix(),
             contents=self.conftest_source.content.decode(),
         )
-        self.add_to_build_file(self.source_root, "python_library()")
+        self.add_to_build_file(self.source_root, "conftest()")
 
         result = self.run_pytest(passthrough_args="-s")
         assert result.status == Status.SUCCESS
diff --git a/src/python/pants/backend/python/target_types.py b/src/python/pants/backend/python/target_types.py
@@ -300,7 +300,7 @@ class PythonTests(Target):
 
 
 class PythonLibrarySources(PythonSources):
-    default = ("*.py",) + tuple(f"!{pat}" for pat in PythonTestsSources.default)
+    default = ("*.py", "!conftest.py") + tuple(f"!{pat}" for pat in PythonTestsSources.default)
 
 
 class PythonLibrary(Target):
@@ -310,6 +310,26 @@ class PythonLibrary(Target):
     core_fields = (*COMMON_PYTHON_FIELDS, PythonLibrarySources)
 
 
+# -----------------------------------------------------------------------------------------------
+# `conftest` target
+# -----------------------------------------------------------------------------------------------
+
+
+class ConftestSources(PythonLibrarySources):
+    default = ("conftest.py",)
+
+
+class ConftestTarget(Target):
+    """A `conftest.py` file used by Pytest-style tests.
+
+    A `conftest` target behaves the same as a `python_library` target, and is sugar for
+    `python_library(sources=['conftest.py']`.
+    """
+
+    alias = "conftest"
+    core_fields = (*COMMON_PYTHON_FIELDS, ConftestSources)
+
+
 # -----------------------------------------------------------------------------------------------
 # `python_requirement_library` target
 # -----------------------------------------------------------------------------------------------
