Merge branch 'main' into patch-1

Author: apuly

.github/instructions/python-quality-checks.instructions.md

@@ -69,8 +69,29 @@ nox --session install_python_libs
 
 **Type errors in ignored files**: Legacy files in `pyproject.toml` ignore list—fix if working on them
 
+## When Writing Tests
+
+**Always format your test files before committing:**
+
+```bash
+cd python_files
+ruff format tests/  # Format all test files
+# or format specific files:
+ruff format tests/unittestadapter/test_utils.py
+```
+
+**Best practice workflow:**
+
+1. Write your test code
+2. Run `ruff format` on the test files
+3. Run the tests to verify they pass
+4. Run `npm run check-python` to catch any remaining issues
+
+This ensures your tests pass both functional checks and quality checks in CI.
+
 ## Learnings
 
 -   Always run `npm run check-python` before pushing to catch CI failures early (1)
 -   Use `ruff check . --fix` to auto-fix most linting issues before manual review (1)
 -   Pyright version must match CI (1.1.308) to avoid inconsistent results between local and CI runs (1)
+-   Always run `ruff format` on test files after writing them to avoid formatting CI failures (1)

python_files/tests/pytestadapter/expected_discovery_test_output.py

@@ -1,6 +1,11 @@
 import os
 
-from .helpers import TEST_DATA_PATH, find_test_line_number, get_absolute_test_id
+from .helpers import (
+    TEST_DATA_PATH,
+    find_class_line_number,
+    find_test_line_number,
+    get_absolute_test_id,
+)
 
 # This file contains the expected output dictionaries for tests discovery and is used in test_discovery.py.
 
@@ -95,6 +100,7 @@
                         "unittest_pytest_same_file.py::TestExample",
                         unit_pytest_same_file_path,
                     ),
+                    "lineno": find_class_line_number("TestExample", unit_pytest_same_file_path),
                 },
                 {
                     "name": "test_true_pytest",
@@ -207,6 +213,7 @@
                                 "unittest_folder/test_add.py::TestAddFunction",
                                 test_add_path,
                             ),
+                            "lineno": find_class_line_number("TestAddFunction", test_add_path),
                         },
                         {
                             "name": "TestDuplicateFunction",
@@ -235,6 +242,9 @@
                                 "unittest_folder/test_add.py::TestDuplicateFunction",
                                 test_add_path,
                             ),
+                            "lineno": find_class_line_number(
+                                "TestDuplicateFunction", test_add_path
+                            ),
                         },
                     ],
                 },
@@ -288,6 +298,9 @@
                                 "unittest_folder/test_subtract.py::TestSubtractFunction",
                                 test_subtract_path,
                             ),
+                            "lineno": find_class_line_number(
+                                "TestSubtractFunction", test_subtract_path
+                            ),
                         },
                         {
                             "name": "TestDuplicateFunction",
@@ -316,6 +329,9 @@
                                 "unittest_folder/test_subtract.py::TestDuplicateFunction",
                                 test_subtract_path,
                             ),
+                            "lineno": find_class_line_number(
+                                "TestDuplicateFunction", test_subtract_path
+                            ),
                         },
                     ],
                 },
@@ -553,6 +569,7 @@
                         "parametrize_tests.py::TestClass",
                         parameterize_tests_path,
                     ),
+                    "lineno": find_class_line_number("TestClass", parameterize_tests_path),
                     "children": [
                         {
                             "name": "test_adding",
@@ -929,6 +946,7 @@
                         "test_multi_class_nest.py::TestFirstClass",
                         TEST_MULTI_CLASS_NEST_PATH,
                     ),
+                    "lineno": find_class_line_number("TestFirstClass", TEST_MULTI_CLASS_NEST_PATH),
                     "children": [
                         {
                             "name": "TestSecondClass",
@@ -938,6 +956,9 @@
                                 "test_multi_class_nest.py::TestFirstClass::TestSecondClass",
                                 TEST_MULTI_CLASS_NEST_PATH,
                             ),
+                            "lineno": find_class_line_number(
+                                "TestSecondClass", TEST_MULTI_CLASS_NEST_PATH
+                            ),
                             "children": [
                                 {
                                     "name": "test_second",
@@ -982,6 +1003,9 @@
                                 "test_multi_class_nest.py::TestFirstClass::TestSecondClass2",
                                 TEST_MULTI_CLASS_NEST_PATH,
                             ),
+                            "lineno": find_class_line_number(
+                                "TestSecondClass2", TEST_MULTI_CLASS_NEST_PATH
+                            ),
                             "children": [
                                 {
                                     "name": "test_second2",
@@ -1227,6 +1251,9 @@
                         "same_function_new_class_param.py::TestNotEmpty",
                         TEST_DATA_PATH / "same_function_new_class_param.py",
                     ),
+                    "lineno": find_class_line_number(
+                        "TestNotEmpty", TEST_DATA_PATH / "same_function_new_class_param.py"
+                    ),
                 },
                 {
                     "name": "TestEmpty",
@@ -1298,6 +1325,9 @@
                         "same_function_new_class_param.py::TestEmpty",
                         TEST_DATA_PATH / "same_function_new_class_param.py",
                     ),
+                    "lineno": find_class_line_number(
+                        "TestEmpty", TEST_DATA_PATH / "same_function_new_class_param.py"
+                    ),
                 },
             ],
         }
@@ -1371,6 +1401,9 @@
                         "test_param_span_class.py::TestClass1",
                         TEST_DATA_PATH / "test_param_span_class.py",
                     ),
+                    "lineno": find_class_line_number(
+                        "TestClass1", TEST_DATA_PATH / "test_param_span_class.py"
+                    ),
                 },
                 {
                     "name": "TestClass2",
@@ -1427,6 +1460,9 @@
                         "test_param_span_class.py::TestClass2",
                         TEST_DATA_PATH / "test_param_span_class.py",
                     ),
+                    "lineno": find_class_line_number(
+                        "TestClass2", TEST_DATA_PATH / "test_param_span_class.py"
+                    ),
                 },
             ],
         }
@@ -1503,6 +1539,7 @@
                                 "pytest_describe_plugin/describe_only.py::describe_A",
                                 describe_only_path,
                             ),
+                            "lineno": find_class_line_number("describe_A", describe_only_path),
                         }
                     ],
                 }
@@ -1586,6 +1623,9 @@
                                         "pytest_describe_plugin/nested_describe.py::describe_list::describe_append",
                                         nested_describe_path,
                                     ),
+                                    "lineno": find_class_line_number(
+                                        "describe_append", nested_describe_path
+                                    ),
                                 },
                                 {
                                     "name": "describe_remove",
@@ -1614,12 +1654,16 @@
                                         "pytest_describe_plugin/nested_describe.py::describe_list::describe_remove",
                                         nested_describe_path,
                                     ),
+                                    "lineno": find_class_line_number(
+                                        "describe_remove", nested_describe_path
+                                    ),
                                 },
                             ],
                             "id_": get_absolute_test_id(
                                 "pytest_describe_plugin/nested_describe.py::describe_list",
                                 nested_describe_path,
                             ),
+                            "lineno": find_class_line_number("describe_list", nested_describe_path),
                         }
                     ],
                 }

python_files/tests/pytestadapter/helpers.py

@@ -370,6 +370,28 @@ def find_test_line_number(test_name: str, test_file_path) -> str:
     raise ValueError(error_str)
 
 
+def find_class_line_number(class_name: str, test_file_path) -> str:
+    """Function which finds the correct line number for a class definition.
+
+    Args:
+    class_name: The name of the class to find the line number for.
+    test_file_path: The path to the test file where the class is located.
+    """
+    # Look for the class definition line (or function for pytest-describe)
+    with open(test_file_path) as f:  # noqa: PTH123
+        for i, line in enumerate(f):
+            # Match "class ClassName" or "class ClassName(" or "class ClassName:"
+            # Also match "def ClassName(" for pytest-describe blocks
+            if (
+                line.strip().startswith(f"class {class_name}")
+                or line.strip().startswith(f"class {class_name}(")
+                or line.strip().startswith(f"def {class_name}(")
+            ):
+                return str(i + 1)
+    error_str: str = f"Class {class_name!r} not found on any line in {test_file_path}"
+    raise ValueError(error_str)
+
+
 def get_absolute_test_id(test_id: str, test_path: pathlib.Path) -> str:
     """Get the absolute test id by joining the testPath with the test_id."""
     split_id = test_id.split("::")[1:]

python_files/tests/unittestadapter/.data/doctest_patched_module.py

@@ -0,0 +1,17 @@
+"""
+Patched doctest module.
+This module's doctests will be patched to have proper IDs.
+
+>>> 2 + 2
+4
+"""
+
+
+def example_function():
+    """
+    Example function with doctest.
+
+    >>> example_function()
+    'works'
+    """
+    return "works"

python_files/tests/unittestadapter/.data/doctest_standard.py

@@ -0,0 +1,7 @@
+"""
+Standard doctest module that should be blocked.
+This has a simple doctest with short ID.
+
+>>> 2 + 2
+4
+"""

python_files/tests/unittestadapter/.data/test_doctest_patched.py

@@ -0,0 +1,50 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+"""Test file with patched doctest integration that should work."""
+
+import unittest
+import doctest
+import sys
+import doctest_patched_module
+
+
+# Patch DocTestCase to modify test IDs to be compatible with the extension
+original_init = doctest.DocTestCase.__init__
+
+
+def patched_init(self, test, optionflags=0, setUp=None, tearDown=None, checker=None):
+    """Patch to modify doctest names to have proper hierarchy."""
+    if hasattr(test, 'name'):
+        # Get module name
+        module_hierarchy = test.name.split('.')
+        module_name = module_hierarchy[0] if module_hierarchy else 'unknown'
+
+        # Reconstruct with proper formatting to have enough components
+        # Format: module.file.class.function
+        if test.filename.endswith('.py'):
+            file_base = test.filename.split('/')[-1].replace('.py', '')
+            test_name = test.name.split('.')[-1] if '.' in test.name else test.name
+            # Create a properly formatted ID with enough components
+            test.name = f"{module_name}.{file_base}._DocTests.{test_name}"
+
+    # Call original init
+    original_init(self, test, optionflags, setUp, tearDown, checker)
+
+
+# Apply the patch
+doctest.DocTestCase.__init__ = patched_init
+
+
+def load_tests(loader, tests, ignore):
+    """
+    Standard hook for unittest to load tests.
+    This uses patched doctest to create compatible test IDs.
+    """
+    tests.addTests(doctest.DocTestSuite(doctest_patched_module))
+    return tests
+
+
+# Clean up the patch after loading
+def tearDownModule():
+    """Restore original DocTestCase.__init__"""
+    doctest.DocTestCase.__init__ = original_init

python_files/tests/unittestadapter/.data/test_doctest_standard.py

@@ -0,0 +1,16 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+"""Test file with standard doctest integration that should be blocked."""
+
+import unittest
+import doctest
+import doctest_standard
+
+
+def load_tests(loader, tests, ignore):
+    """
+    Standard hook for unittest to load tests.
+    This uses standard doctest without any patching.
+    """
+    tests.addTests(doctest.DocTestSuite(doctest_standard))
+    return tests

python_files/tests/unittestadapter/expected_discovery_test_output.py

@@ -9,6 +9,25 @@
 TEST_DATA_PATH = pathlib.Path(__file__).parent / ".data"
 
 
+def find_class_line_number(class_name: str, test_file_path) -> str:
+    """Function which finds the correct line number for a class definition.
+
+    Args:
+    class_name: The name of the class to find the line number for.
+    test_file_path: The path to the test file where the class is located.
+    """
+    # Look for the class definition line
+    with pathlib.Path(test_file_path).open() as f:
+        for i, line in enumerate(f):
+            # Match "class ClassName" or "class ClassName(" or "class ClassName:"
+            if line.strip().startswith(f"class {class_name}") or line.strip().startswith(
+                f"class {class_name}("
+            ):
+                return str(i + 1)
+    error_str: str = f"Class {class_name!r} not found on any line in {test_file_path}"
+    raise ValueError(error_str)
+
+
 skip_unittest_folder_discovery_output = {
     "path": os.fspath(TEST_DATA_PATH / "unittest_skip"),
     "name": "unittest_skip",
@@ -49,6 +68,10 @@
                     ],
                     "id_": os.fspath(TEST_DATA_PATH / "unittest_skip" / "unittest_skip_function.py")
                     + "\\SimpleTest",
+                    "lineno": find_class_line_number(
+                        "SimpleTest",
+                        TEST_DATA_PATH / "unittest_skip" / "unittest_skip_function.py",
+                    ),
                 }
             ],
             "id_": os.fspath(TEST_DATA_PATH / "unittest_skip" / "unittest_skip_function.py"),
@@ -114,6 +137,16 @@
                                         },
                                     ],
                                     "id_": complex_tree_file_path + "\\" + "TreeOne",
+                                    "lineno": find_class_line_number(
+                                        "TreeOne",
+                                        pathlib.PurePath(
+                                            TEST_DATA_PATH,
+                                            "utils_complex_tree",
+                                            "test_outer_folder",
+                                            "test_inner_folder",
+                                            "test_utils_complex_tree.py",
+                                        ),
+                                    ),
                                 }
                             ],
                             "id_": complex_tree_file_path,