From e66802a1e0c6991c2aa7f5ee620bd1fa6320e5b7 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Sun, 17 Nov 2024 02:22:11 +0100
Subject: [PATCH] Ruleset::processRuleset(): add tests for handling of broken
 rulesets

---
 ...ocessRulesetBrokenRulesetEmptyFileTest.xml |  0
 ...cessRulesetBrokenRulesetMultiErrorTest.xml | 10 ++
 ...essRulesetBrokenRulesetSingleErrorTest.xml |  2 +
 .../ProcessRulesetBrokenRulesetTest.php       | 92 +++++++++++++++++++
 4 files changed, 104 insertions(+)
 create mode 100644 tests/Core/Ruleset/ProcessRulesetBrokenRulesetEmptyFileTest.xml
 create mode 100644 tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml
 create mode 100644 tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml
 create mode 100644 tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php

diff --git a/tests/Core/Ruleset/ProcessRulesetBrokenRulesetEmptyFileTest.xml b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetEmptyFileTest.xml
new file mode 100644
index 0000000000..e69de29bb2
diff --git a/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml
new file mode 100644
index 0000000000..64294b9b78
--- /dev/null
+++ b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="ProcessRulesetBrokenRulesetTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
+
+    <rule ref="PSR12.Operators">
+        <properties>
+            <property name="setforallincategory" value="true" />
+            <property name="ignoreSpacingBeforeAssignments" value="false">
+    </rule>
+
+</ruleset>
diff --git a/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml
new file mode 100644
index 0000000000..e9c5bd7e47
--- /dev/null
+++ b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml
@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="ProcessRulesetBrokenRulesetTest" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/PHPCSStandards/PHP_CodeSniffer/master/phpcs.xsd">
diff --git a/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php
new file mode 100644
index 0000000000..95f67c21df
--- /dev/null
+++ b/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * Test handling of broken ruleset files.
+ *
+ * @author    Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
+ * @copyright 2024 PHPCSStandards and contributors
+ * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests\Core\Ruleset;
+
+use PHP_CodeSniffer\Ruleset;
+use PHP_CodeSniffer\Tests\ConfigDouble;
+use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase;
+
+/**
+ * Test handling of broken ruleset files.
+ *
+ * Note: these tests need to run in separate processes as otherwise they run into
+ * some weirdness with the libxml_get_errors()/libxml_clear_errors() functions
+ * (duplicate error messages).
+ *
+ * @runTestsInSeparateProcesses
+ * @preserveGlobalState         disabled
+ *
+ * @covers \PHP_CodeSniffer\Ruleset::processRuleset
+ */
+final class ProcessRulesetBrokenRulesetTest extends AbstractRulesetTestCase
+{
+
+
+    /**
+     * Test displaying an informative error message when an empty XML ruleset file is encountered.
+     *
+     * @return void
+     */
+    public function testBrokenRulesetEmptyFile()
+    {
+        $standard = __DIR__.'/ProcessRulesetBrokenRulesetEmptyFileTest.xml';
+        $config   = new ConfigDouble(["--standard=$standard"]);
+
+        $regex = '`^Ruleset \S+ProcessRulesetBrokenRulesetEmptyFileTest\.xml is not valid\R$`';
+        $this->expectRuntimeExceptionRegex($regex);
+
+        new Ruleset($config);
+
+    }//end testBrokenRulesetEmptyFile()
+
+
+    /**
+     * Test displaying an informative error message for a broken XML ruleset with a single XML error.
+     *
+     * @return void
+     */
+    public function testBrokenRulesetSingleError()
+    {
+        $standard = __DIR__.'/ProcessRulesetBrokenRulesetSingleErrorTest.xml';
+        $config   = new ConfigDouble(["--standard=$standard"]);
+
+        $regex  = '`^Ruleset \S+ProcessRulesetBrokenRulesetSingleErrorTest\.xml is not valid\R';
+        $regex .= '- On line 3, column 1: Premature end of data in tag ruleset line 2\R$`';
+
+        $this->expectRuntimeExceptionRegex($regex);
+
+        new Ruleset($config);
+
+    }//end testBrokenRulesetSingleError()
+
+
+    /**
+     * Test displaying an informative error message for a broken XML ruleset with multiple XML errors.
+     *
+     * @return void
+     */
+    public function testBrokenRulesetMultiError()
+    {
+        $standard = __DIR__.'/ProcessRulesetBrokenRulesetMultiErrorTest.xml';
+        $config   = new ConfigDouble(["--standard=$standard"]);
+
+        $regex  = '`^Ruleset \S+ProcessRulesetBrokenRulesetMultiErrorTest\.xml is not valid\R';
+        $regex .= '- On line 8, column 12: Opening and ending tag mismatch: property line 7 and rule\R';
+        $regex .= '- On line 10, column 11: Opening and ending tag mismatch: properties line 5 and ruleset\R';
+        $regex .= '- On line 11, column 1: Premature end of data in tag rule line 4\R$`';
+
+        $this->expectRuntimeExceptionRegex($regex);
+
+        new Ruleset($config);
+
+    }//end testBrokenRulesetMultiError()
+
+
+}//end class