From 09ff94ae1db9214160c250b575114400085038b6 Mon Sep 17 00:00:00 2001
From: Dan Wallis <dan@wallis.nz>
Date: Tue, 14 May 2024 18:09:18 +0100
Subject: [PATCH] Config: add tests for the `--sniffs` and `--exclude` options
 (#474)

This PR adds tests covering the logic for handling the `--sniffs=...` and `--exclude=...` CLI options, which both take a comma-separated list of sniff codes and will error on anything which is not a sniff code.
---
 tests/Core/Config/SniffsExcludeArgsTest.php | 193 ++++++++++++++++++++
 1 file changed, 193 insertions(+)
 create mode 100644 tests/Core/Config/SniffsExcludeArgsTest.php

diff --git a/tests/Core/Config/SniffsExcludeArgsTest.php b/tests/Core/Config/SniffsExcludeArgsTest.php
new file mode 100644
index 0000000000..e7760b5f43
--- /dev/null
+++ b/tests/Core/Config/SniffsExcludeArgsTest.php
@@ -0,0 +1,193 @@
+<?php
+/**
+ * Tests for the \PHP_CodeSniffer\Config --sniffs and --exclude arguments.
+ *
+ * @author  Dan Wallis <dan@wallis.nz>
+ * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests\Core\Config;
+
+use PHP_CodeSniffer\Exceptions\DeepExitException;
+use PHP_CodeSniffer\Tests\ConfigDouble;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * Tests for the \PHP_CodeSniffer\Config --sniffs and --exclude arguments.
+ *
+ * @covers \PHP_CodeSniffer\Config::processLongArgument
+ */
+final class SniffsExcludeArgsTest extends TestCase
+{
+
+
+    /**
+     * Ensure that the expected error message is returned for invalid arguments.
+     *
+     * @param string $argument 'sniffs' or 'exclude'.
+     * @param string $value    List of sniffs to include / exclude.
+     * @param string $message  Expected error message text.
+     *
+     * @return       void
+     * @dataProvider dataInvalidSniffs
+     */
+    public function testInvalid($argument, $value, $message)
+    {
+        $this->expectException(DeepExitException::class);
+        $this->expectExceptionMessage($message);
+
+        new ConfigDouble(["--$argument=$value"]);
+
+    }//end testInvalid()
+
+
+    /**
+     * Data provider for testInvalid().
+     *
+     * @see    self::testInvalid()
+     * @return array<string, array<string, string>>
+     */
+    public static function dataInvalidSniffs()
+    {
+        $arguments = [
+            'sniffs',
+            'exclude',
+        ];
+        $data      = [];
+
+        $messageTemplate = 'ERROR: The specified sniff code "%s" is invalid'.PHP_EOL.PHP_EOL;
+
+        foreach ($arguments as $argument) {
+            // An empty string is not a valid sniff.
+            $data[$argument.'; empty string'] = [
+                'argument' => $argument,
+                'value'    => '',
+                'message'  => sprintf($messageTemplate, ''),
+            ];
+
+            // A standard is not a valid sniff.
+            $data[$argument.'; standard'] = [
+                'argument' => $argument,
+                'value'    => 'Standard',
+                'message'  => sprintf($messageTemplate, 'Standard'),
+            ];
+
+            // A category is not a valid sniff.
+            $data[$argument.'; category'] = [
+                'argument' => $argument,
+                'value'    => 'Standard.Category',
+                'message'  => sprintf($messageTemplate, 'Standard.Category'),
+            ];
+
+            // An error-code is not a valid sniff.
+            $data[$argument.'; error-code'] = [
+                'argument' => $argument,
+                'value'    => 'Standard.Category',
+                'message'  => sprintf($messageTemplate, 'Standard.Category'),
+            ];
+
+            // Only the first error is reported.
+            $data[$argument.'; two errors'] = [
+                'argument' => $argument,
+                'value'    => 'StandardOne,StandardTwo',
+                'message'  => sprintf($messageTemplate, 'StandardOne'),
+            ];
+            $data[$argument.'; valid followed by invalid'] = [
+                'argument' => $argument,
+                'value'    => 'StandardOne.Category.Sniff,StandardTwo.Category',
+                'message'  => sprintf($messageTemplate, 'StandardTwo.Category'),
+            ];
+        }//end foreach
+
+        return $data;
+
+    }//end dataInvalidSniffs()
+
+
+    /**
+     * Ensure that the valid data does not throw an exception, and the value is stored.
+     *
+     * @param string $argument 'sniffs' or 'exclude'.
+     * @param string $value    List of sniffs to include or exclude.
+     *
+     * @return       void
+     * @dataProvider dataValidSniffs
+     */
+    public function testValid($argument, $value)
+    {
+        $config = new ConfigDouble(["--$argument=$value"]);
+
+        $this->assertSame(explode(',', $value), $config->$argument);
+
+    }//end testValid()
+
+
+    /**
+     * Data provider for testValid().
+     *
+     * @see    self::testValid()
+     * @return array<string, array<string, string>>
+     */
+    public static function dataValidSniffs()
+    {
+        $arguments = [
+            'sniffs',
+            'exclude',
+        ];
+        $data      = [];
+
+        foreach ($arguments as $argument) {
+            $data[$argument.'; one valid sniff']  = [
+                'argument' => $argument,
+                'value'    => 'Standard.Category.Sniff',
+            ];
+            $data[$argument.'; two valid sniffs'] = [
+                'argument' => $argument,
+                'value'    => 'StandardOne.Category.Sniff,StandardTwo.Category.Sniff',
+            ];
+        }
+
+        return $data;
+
+    }//end dataValidSniffs()
+
+
+    /**
+     * Ensure that only the first argument is processed and others are ignored.
+     *
+     * @param string $argument 'sniffs' or 'exclude'.
+     *
+     * @return       void
+     * @dataProvider dataOnlySetOnce
+     */
+    public function testOnlySetOnce($argument)
+    {
+        $config = new ConfigDouble(
+            [
+                "--$argument=StandardOne.Category.Sniff",
+                "--$argument=StandardTwo.Category.Sniff",
+                "--$argument=Standard.AnotherCategory.Sniff",
+            ]
+        );
+
+        $this->assertSame(['StandardOne.Category.Sniff'], $config->$argument);
+
+    }//end testOnlySetOnce()
+
+
+    /**
+     * Data provider for testOnlySetOnce().
+     *
+     * @return array<string, array<string>>
+     */
+    public static function dataOnlySetOnce()
+    {
+        return [
+            'sniffs'  => ['sniffs'],
+            'exclude' => ['exclude'],
+        ];
+
+    }//end dataOnlySetOnce()
+
+
+}//end class