feat(gazelle) generate conftest dependencies on parent folders

Author: amartani

gazelle/python/generate.go

@@ -667,16 +667,14 @@ func (py *Python) GenerateRules(args language.GenerateArgs) language.GenerateRes
 	}
 
 	for _, pyTestTarget := range pyTestTargets {
-		if conftest != nil {
-			conftestModule := Module{Name: importSpecFromSrc(pythonProjectRoot, args.Rel, conftestFilename).Imp}
-			if pyTestTarget.annotations.includePytestConftest == nil {
-				// unset; default behavior
-				pyTestTarget.addModuleDependency(conftestModule)
-			} else if *pyTestTarget.annotations.includePytestConftest {
-				// set; add if true, do not add if false
-				pyTestTarget.addModuleDependency(conftestModule)
+		if pyTestTarget.annotations.includePytestConftest == nil || *pyTestTarget.annotations.includePytestConftest {
+			// Add conftest files as module dependencies with proper Python module paths
+			parentConftestModules := findConftestFiles(args.Rel, pythonProjectRoot, args.Config.RepoRoot)
+			for _, module := range parentConftestModules {
+				pyTestTarget.addModuleDependency(module)
 			}
 		}
+
 		pyTest := pyTestTarget.build()
 
 		result.Gen = append(result.Gen, pyTest)
@@ -819,3 +817,50 @@ func generateProtoLibraries(args language.GenerateArgs, cfg *pythonconfig.Config
 	}
 
 }
+
+// findConftestFiles finds conftest.py files in parent directories up to and including the python_root.
+// It returns a list of Module objects with Python module paths relative to python_root.
+func findConftestFiles(currentRel string, pythonProjectRoot string, repoRoot string) []Module {
+	var conftestModules []Module
+
+	// Determine the python_root path relative to repo root
+	pythonRootRel := ""
+	if pythonProjectRoot != "" {
+		pythonRootRel = pythonProjectRoot
+	}
+
+	// Start from currentRel
+	current := currentRel
+
+	// Walk up the directory tree until we reach the repo root
+	for {
+		// Check if conftest.py exists in this directory
+		conftestPath := filepath.Join(repoRoot, current, conftestFilename)
+		if _, err := os.Stat(conftestPath); err == nil {
+			// Calculate the Python module path relative to python_root
+			var modulePath string
+			relPath, err := filepath.Rel(pythonRootRel, current)
+			if err != nil || relPath == "." {
+				// If we can't get relative path or it's the python_root itself
+				modulePath = "conftest"
+			} else {
+				modulePath = strings.ReplaceAll(relPath, "/", ".") + ".conftest"
+			}
+
+			module := Module{
+				Name: modulePath,
+			}
+			conftestModules = append(conftestModules, module)
+		}
+
+		// Stop if we've reached the python_root
+		if current == pythonRootRel || current == "." {
+			break
+		}
+
+		// Move to parent directory
+		current = filepath.Dir(current)
+	}
+
+	return conftestModules
+}

gazelle/python/testdata/simple_test_with_conftest/BUILD.out

@@ -11,19 +11,9 @@ py_library(
     visibility = ["//:__subpackages__"],
 )
 
-py_library(
-    name = "conftest",
-    testonly = True,
-    srcs = ["conftest.py"],
-    visibility = ["//:__subpackages__"],
-)
-
 py_test(
     name = "simple_test_with_conftest_test",
     srcs = ["__test__.py"],
     main = "__test__.py",
-    deps = [
-        ":conftest",
-        ":simple_test_with_conftest",
-    ],
+    deps = [":simple_test_with_conftest"],
 )

gazelle/python/testdata/simple_test_with_conftest/__init__.py

@@ -1,17 +0,0 @@
-# Copyright 2023 The Bazel Authors. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from foo import foo
-
-_ = foo

gazelle/python/testdata/simple_test_with_conftest/__test__.py

@@ -1,20 +1,6 @@
-# Copyright 2023 The Bazel Authors. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 import unittest
 
-from __init__ import foo
+from foo import foo
 
 
 class FooTest(unittest.TestCase):

gazelle/python/testdata/simple_test_with_conftest/bar/__init__.py

@@ -1,17 +0,0 @@
-# Copyright 2023 The Bazel Authors. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from bar.bar import bar
-
-_ = bar

gazelle/python/testdata/simple_test_with_conftest/bar/__test__.py

@@ -14,7 +14,7 @@
 
 import unittest
 
-from bar.__init__ import bar
+from bar import bar
 
 
 class BarTest(unittest.TestCase):

gazelle/python/testdata/simple_test_with_conftest/bar/bar.py

@@ -1,17 +1,2 @@
-# Copyright 2023 The Bazel Authors. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
 def bar():
     return "bar"

gazelle/python/testdata/simple_test_with_conftest/bar/baz/BUILD.in

@@ -0,0 +1 @@
+load("@rules_python//python:defs.bzl", "py_library")

gazelle/python/testdata/simple_test_with_conftest/bar/baz/BUILD.out

@@ -0,0 +1,24 @@
+load("@rules_python//python:defs.bzl", "py_library", "py_test")
+
+py_library(
+    name = "baz",
+    srcs = ["__init__.py"],
+    visibility = ["//:__subpackages__"],
+)
+
+py_library(
+    name = "conftest",
+    testonly = True,
+    srcs = ["conftest.py"],
+    visibility = ["//:__subpackages__"],
+)
+
+py_test(
+    name = "baz_test",
+    srcs = ["__test__.py"],
+    main = "__test__.py",
+    deps = [
+        ":conftest",
+        "//bar:conftest",
+    ],
+)