Parse dataset information from phpunit logs

Author: mdeweerd

.github/workflows/pre-commit.yml

@@ -37,7 +37,7 @@ jobs:
         run: |
           python ${LOG_TO_CS} ${RAW_LOG} ${CS_XML}
       - name: Convert Raw Log to Checkstyle format (launch action)
-        uses: mdeweerd/logToCheckStyle@v2024.3.5
+        uses: mdeweerd/logToCheckStyle@v2025.1.1
         if: ${{ failure() }}
         with:
           in: ${{ env.RAW_LOG }}

README.md

@@ -50,7 +50,7 @@ optional arguments:
 
 ```yaml
   - name: Convert Raw Log to Checkstyle format (launch action)
-    uses: mdeweerd/logToCheckStyle@v2024.3.5
+    uses: mdeweerd/logToCheckStyle@v2025.1.1
     if: ${{ failure() }}
     with:
       in: ${{ env.RAW_LOG }}

logToCs.py

@@ -333,7 +333,9 @@ def submit(  # pylint: disable=too-many-arguments
     rf"\s*(?P<classname>{IDENTIFIER_REGEX})"
     rf"::(?P<method>{IDENTIFIER_REGEX})\b\s*?"
 )
-
+PHPUNIT_DATASET_REGEX = (
+    r"(?P<dataset> with data set (?:#\d+|\"[^\"]+\") \([^\n]*\))"
+)
 
 # List of message patterns, add more specific patterns earlier in the list
 # Creating patterns by using constants makes them easier to define and read.
@@ -351,7 +353,7 @@ def submit(  # pylint: disable=too-many-arguments
     ),
     re.compile(rf"^There were \d+ {SEVERITYGROUP_REGEX}s?:$"),
     re.compile(
-        rf"^\d+\){CLASS_METHOD_REGEX}\n"
+        rf"^\d+\){CLASS_METHOD_REGEX}{PHPUNIT_DATASET_REGEX}?\n"
         rf"{MULTILINE_MSG_REGEX}${FILE_REGEX}:{LINE_REGEX}$"
     ),
     # beautysh
@@ -501,6 +503,13 @@ def parse_file(text):
         new_severity_group = result.pop("severity_group", None)
         severity_endgroup = result.pop("severity_endgroup", None)
         message = result.get("message", None)
+        dataset = result.get("dataset", None)
+
+        if dataset is not None:
+            if message is None:
+                message = ""
+            message += dataset
+            result["message"] = message
 
         has_group_instructions = False
 

tests/IN/phpunit_dataset.log

@@ -0,0 +1,38 @@
+Time: 01:58.025, Memory: 152.00 MB
+
+There were 6 failures:
+
+1) LangTest::testLang with data set "ca_ES" ('ca_ES')
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php:263
+
+2) LangTest::testLang with data set "da_DK" ('da_DK')
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php:263
+
+3) LangTest::testLang with data set "el_GR" ('el_GR')
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php:263
+
+4) LangTest::testLang with data set "fr_CA" ('fr_CA')
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php:263
+
+5) LangTest::testLang with data set "lv_LV" ('lv_LV')
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php:263
+
+6) CodingPhpTest::testPHP with data set #1375 (array('donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs.../class', 'class', 'don/class/donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs...ss.php', '', '', 'file'))
+Found non sanitized string in building of a IN or NOT IN sql request don/class/donstats.class.php - Bad.
+Failed asserting that false is true.
+
+D:\a\dolibarr\dolibarr\test\phpunit\CodingPhpTest.php:513
+
+FAILURES!
+Tests: 2935, Assertions: 112671, Failures: 6.
+""

tests/IN/phpunit_dataset.txt

@@ -0,0 +1,6 @@
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/LangTest.php,line=263::Failed asserting that false is true. with data set "ca_ES" ('ca_ES')
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/LangTest.php,line=263::Failed asserting that false is true. with data set "da_DK" ('da_DK')
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/LangTest.php,line=263::Failed asserting that false is true. with data set "el_GR" ('el_GR')
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/LangTest.php,line=263::Failed asserting that false is true. with data set "fr_CA" ('fr_CA')
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/LangTest.php,line=263::Failed asserting that false is true. with data set "lv_LV" ('lv_LV')
+::error file=D%3A/a/dolibarr/dolibarr/test/phpunit/CodingPhpTest.php,line=513::Found non sanitized string in building of a IN or NOT IN sql request don/class/donstats.class.php - Bad.%0AFailed asserting that false is true. with data set #1375 (array('donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs.../class', 'class', 'don/class/donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs...ss.php', '', '', 'file'))

tests/IN/phpunit_dataset.xml

@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='utf_8'?>
+<checkstyle version="6.5"><file name="D:\a\dolibarr\dolibarr\test\phpunit\LangTest.php"><error severity="error" line="263" message="Failed asserting that false is true. with data set &quot;ca_ES&quot; ('ca_ES')" /><error severity="error" line="263" message="Failed asserting that false is true. with data set &quot;da_DK&quot; ('da_DK')" /><error severity="error" line="263" message="Failed asserting that false is true. with data set &quot;el_GR&quot; ('el_GR')" /><error severity="error" line="263" message="Failed asserting that false is true. with data set &quot;fr_CA&quot; ('fr_CA')" /><error severity="error" line="263" message="Failed asserting that false is true. with data set &quot;lv_LV&quot; ('lv_LV')" /></file><file name="D:\a\dolibarr\dolibarr\test\phpunit\CodingPhpTest.php"><error severity="error" line="513" message="Found non sanitized string in building of a IN or NOT IN sql request don/class/donstats.class.php - Bad.&#10;Failed asserting that false is true. with data set #1375 (array('donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs.../class', 'class', 'don/class/donstats.class.php', 'D:\a\dolibarr\dolibarr\htdocs...ss.php', '', '', 'file'))" /></file></checkstyle>