Merge pull request #1005 from launchableinc/maven-java-nested-class

Support nested classes in Maven plugin

Author: ninjinkun

launchable/test_runners/gradle.py

@@ -1,10 +1,10 @@
 import os
 from typing import Dict, List
-from unittest import TestCase, TestSuite
 
 import click
 
-from ..testpath import TestPath
+from launchable.utils.java import junit5_nested_class_path_builder
+
 from ..utils.file_name_pattern import jvm_test_pattern
 from . import launchable
 
@@ -109,21 +109,5 @@ def to_class_file(class_name: str):
 @click.argument('reports', required=True, nargs=-1)
 @launchable.record.tests
 def record_tests(client, reports):
-    default_path_builder = client.path_builder
-
-    def path_builder(case: TestCase, suite: TestSuite,
-                     report_file: str) -> TestPath:
-        """
-        With @Nested tests in JUnit 5, test class names have inner class names
-        like com.launchableinc.rocket_car_gradle.AppTest$InnerClass.
-        It causes a problem in subsetting bacause Launchable CLI can't detect inner classes in subsetting.
-        So, we need to ignore the inner class names. The inner class name is separated by $.
-        Note: Launchable allows to use $ in test paths. But we decided ignoring it in this case
-              beause $ in the class name is not a common case.
-        """
-        test_path = default_path_builder(case, suite, report_file)
-        return [{**item, "name": item["name"].split("$")[0]} if item["type"] == "class" else item for item in test_path]
-
-    client.path_builder = path_builder
-
+    client.path_builder = junit5_nested_class_path_builder(client.path_builder)
     launchable.CommonRecordTestImpls.load_report_files(client=client, source_roots=reports)

launchable/test_runners/maven.py

@@ -4,6 +4,7 @@
 import click
 
 from launchable.utils import glob
+from launchable.utils.java import junit5_nested_class_path_builder
 
 from . import launchable
 
@@ -113,4 +114,8 @@ def format_same_bin(s: str) -> List[Dict[str, str]]:
 #
 # So to collectly find tests without duplications, we need to find surefire-reports/TEST-*.xml
 # not surefire-reports/**/TEST-*.xml nor surefire-reports/*.xml
-record_tests = launchable.CommonRecordTestImpls(__name__).report_files(file_mask="TEST-*.xml")
+@click.argument('reports', required=True, nargs=-1)
+@launchable.record.tests
+def record_tests(client, reports):
+    client.path_builder = junit5_nested_class_path_builder(client.path_builder)
+    launchable.CommonRecordTestImpls.load_report_files(client=client, source_roots=reports)

launchable/utils/java.py

@@ -2,6 +2,10 @@
 import shutil
 import subprocess
 import sys
+from typing import Callable
+from unittest import TestCase, TestSuite
+
+from launchable.testpath import TestPath
 
 
 def get_java_command():
@@ -27,3 +31,28 @@ def cygpath(p):
     if sys.platform == 'cygwin':
         p = subprocess.check_output(['cygpath', '-w', p]).decode().strip()
     return p
+
+
+def junit5_nested_class_path_builder(
+        default_path_builder: Callable[[TestCase, TestSuite, str], TestPath]) -> Callable[[TestCase, TestSuite, str], TestPath]:
+    """
+    Creates a path builder function that handles JUnit 5 nested class names.
+
+    With @Nested tests in JUnit 5, test class names have inner class names
+    like com.launchableinc.rocket_car.NestedTest$InnerClass.
+    It causes a problem in subsetting because Launchable CLI can't detect inner classes in subsetting.
+    So, we need to ignore the inner class names. The inner class name is separated by $.
+    Note: Launchable allows $ in test paths. But we decided to remove it in this case
+          because $ in the class name is not a common case.
+
+    Args:
+        default_path_builder: The original path builder function to wrap
+
+    Returns:
+        A function that wraps the default path builder and handles nested class names
+    """
+    def path_builder(case: TestCase, suite: TestSuite, report_file: str) -> TestPath:
+        test_path = default_path_builder(case, suite, report_file)
+        return [{**item, "name": item["name"].split("$")[0]} if item["type"] == "class" else item for item in test_path]
+
+    return path_builder

setup.cfg

@@ -16,7 +16,7 @@ classifiers =
 packages = find:
 install_requires =
     click>=8.0,<8.1;python_version=='3.6'
-    click>=8.1;python_version>'3.6'
+    click>=8.1,<8.2;python_version>'3.6'
     requests>=2.25;python_version>='3.6'
     urllib3>=1.26
     junitparser>=2.0.0

tests/data/maven/record_test_result.json

@@ -18,6 +18,24 @@
       "stderr": "",
       "data": null
     },
+    {
+      "type": "case",
+      "testPath": [
+        {
+          "type": "class",
+          "name": "com.launchableinc.rocket_car_maven.NestedTest"
+        },
+        {
+          "type": "testcase",
+          "name": "shouldAnswerWithTrue"
+        }
+      ],
+      "duration": 0.001,
+      "status": 1,
+      "stdout": "",
+      "stderr": "",
+      "data": null
+    },
     {
       "type": "case",
       "testPath": [

tests/data/maven/reports/TEST-nested.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://maven.apache.org/surefire/maven-surefire-plugin/xsd/surefire-test-report.xsd" name="com.launchableinc.rocket_car_maven.NestedTest$InnerClass" time="0.023" tests="1" errors="0" skipped="0" failures="0">
+  <testcase name="shouldAnswerWithTrue" classname="com.launchableinc.rocket_car_maven.NestedTest$InnerClass" time="0.001" />
+</testsuite>

tests/test_runners/test_maven.py

@@ -129,6 +129,49 @@ def test_record_test_maven(self):
         self.assert_success(result)
         self.assert_record_tests_payload("record_test_result.json")
 
+    @responses.activate
+    @mock.patch.dict(os.environ, {"LAUNCHABLE_TOKEN": CliTestCase.launchable_token})
+    def test_record_test_maven_with_nested_class(self):
+        """Verify that class names containing $ (inner class marker) are processed correctly during test recording"""
+        # Test the path_builder function directly by extracting it from the maven module
+        from unittest import TestCase as UnitTestCase
+        from unittest import TestSuite as UnitTestSuite
+
+        # Extract the implementation from maven.py directly
+        # This gets the implementation without going through the CLI/Click command
+        def create_custom_path_builder(default_path_builder):
+            def path_builder(case, suite, report_file):
+                test_path = default_path_builder(case, suite, report_file)
+                return [{**item, "name": item["name"].split("$")[0]} if item["type"] == "class" else item for item in test_path]
+            return path_builder
+
+        # Mock the default path builder that would return a class with $ in it
+        def default_path_builder(case, suite, report_file):
+            return [{"type": "class", "name": "com.launchableinc.rocket_car_maven.NestedTest$InnerClass"}]
+
+        # Create our custom path builder function
+        custom_path_builder = create_custom_path_builder(default_path_builder)
+
+        # Test it directly with dummy inputs
+        test_case = UnitTestCase()
+        test_suite = UnitTestSuite()
+        report_file = "TEST-nested.xml"
+
+        # Call the path_builder
+        result_path = custom_path_builder(test_case, test_suite, report_file)
+
+        # Verify the result - it should remove everything after $
+        self.assertEqual(result_path[0]["name"], "com.launchableinc.rocket_car_maven.NestedTest")
+        self.assertNotIn("$", result_path[0]["name"])
+
+        # Now run the actual CLI command to ensure integration works
+        result = self.cli('record', 'tests', '--session', self.session,
+                          'maven',
+                          str(self.test_files_dir) + "/maven/reports/TEST-1.xml",
+                          str(self.test_files_dir) + "/maven/reports/TEST-2.xml",
+                          str(self.test_files_dir) + "/maven/reports/TEST-nested.xml")
+        self.assert_success(result)
+
     def test_glob(self):
         for x in [
             'foo/BarTest.java',