Config: add tests for the reportWidth setting

package.xml

@@ -119,6 +119,9 @@ http://pear.php.net/dtd/package-2.0.xsd">
        </dir>
        <file baseinstalldir="" name="DetermineLoadedClassTest.php" role="test" />
      </dir>
+     <dir name="Config">
+      <file baseinstalldir="" name="ReportWidthTest.php" role="test" />
+     </dir>
      <dir name="File">
       <file baseinstalldir="" name="FindEndOfStatementTest.inc" role="test" />
       <file baseinstalldir="" name="FindEndOfStatementTest.php" role="test" />
@@ -2109,6 +2112,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="CodeSniffer/Core/Autoloader/TestFiles/B.inc" name="tests/Core/Autoloader/TestFiles/B.inc" />
    <install as="CodeSniffer/Core/Autoloader/TestFiles/C.inc" name="tests/Core/Autoloader/TestFiles/C.inc" />
    <install as="CodeSniffer/Core/Autoloader/TestFiles/Sub/C.inc" name="tests/Core/Autoloader/TestFiles/Sub/C.inc" />
+   <install as="CodeSniffer/Core/Config/ReportWidthTest.php" name="tests/Core/Config/ReportWidthTest.php" />
    <install as="CodeSniffer/Core/File/FindEndOfStatementTest.php" name="tests/Core/File/FindEndOfStatementTest.php" />
    <install as="CodeSniffer/Core/File/FindEndOfStatementTest.inc" name="tests/Core/File/FindEndOfStatementTest.inc" />
    <install as="CodeSniffer/Core/File/FindExtendedClassNameTest.php" name="tests/Core/File/FindExtendedClassNameTest.php" />
@@ -2217,6 +2221,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
    <install as="CodeSniffer/Core/Autoloader/TestFiles/B.inc" name="tests/Core/Autoloader/TestFiles/B.inc" />
    <install as="CodeSniffer/Core/Autoloader/TestFiles/C.inc" name="tests/Core/Autoloader/TestFiles/C.inc" />
    <install as="CodeSniffer/Core/Autoloader/TestFiles/Sub/C.inc" name="tests/Core/Autoloader/TestFiles/Sub/C.inc" />
+   <install as="CodeSniffer/Core/Config/ReportWidthTest.php" name="tests/Core/Config/ReportWidthTest.php" />
    <install as="CodeSniffer/Core/File/FindEndOfStatementTest.php" name="tests/Core/File/FindEndOfStatementTest.php" />
    <install as="CodeSniffer/Core/File/FindEndOfStatementTest.inc" name="tests/Core/File/FindEndOfStatementTest.inc" />
    <install as="CodeSniffer/Core/File/FindExtendedClassNameTest.php" name="tests/Core/File/FindExtendedClassNameTest.php" />

tests/Core/Config/ReportWidthTest.php

@@ -0,0 +1,304 @@
+<?php
+/**
+ * Tests for the \PHP_CodeSniffer\Config reportWidth value.
+ *
+ * @author    Juliette Reinders Folmer <[email protected]>
+ * @copyright 2006-2023 Squiz Pty Ltd (ABN 77 084 670 600)
+ * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
+ */
+
+namespace PHP_CodeSniffer\Tests\Core\Config;
+
+use PHP_CodeSniffer\Config;
+use PHPUnit\Framework\TestCase;
+use ReflectionProperty;
+
+class ReportWidthTest extends TestCase
+{
+
+
+    /**
+     * Set static properties in the Config class to prevent tests influencing each other.
+     *
+     * @before
+     *
+     * @return void
+     */
+    public static function cleanConfig()
+    {
+        // Set to the property's default value to clear out potentially set values from other tests.
+        self::setStaticProperty('executablePaths', []);
+
+        // Set to a usable value to circumvent Config trying to find a phpcs.xml config file.
+        self::setStaticProperty('overriddenDefaults', ['standards' => ['PSR1']]);
+
+        // Set to values which prevent the test-runner user's `CodeSniffer.conf` file
+        // from being read and influencing the tests.
+        self::setStaticProperty('configData', []);
+        self::setStaticProperty('configDataFile', '');
+
+    }//end cleanConfig()
+
+
+    /**
+     * Clean up after each finished test.
+     *
+     * @after
+     *
+     * @return void
+     */
+    public function resetConfig()
+    {
+        $_SERVER['argv'] = [];
+
+    }//end resetConfig()
+
+
+    /**
+     * Reset the static properties in the Config class to their true defaults to prevent this class
+     * from unfluencing other tests.
+     *
+     * @afterClass
+     *
+     * @return void
+     */
+    public static function resetConfigToDefaults()
+    {
+        self::setStaticProperty('overriddenDefaults', []);
+        self::setStaticProperty('executablePaths', []);
+        self::setStaticProperty('configData', null);
+        self::setStaticProperty('configDataFile', null);
+        $_SERVER['argv'] = [];
+
+    }//end resetConfigToDefaults()
+
+
+    /**
+     * Test that report width without overrules will always be set to a non-0 positive integer.
+     *
+     * @return void
+     */
+    public function testReportWidthDefault()
+    {
+        $config = new Config();
+
+        // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
+        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
+
+    }//end testReportWidthDefault()
+
+
+    /**
+     * Test that the report width will be set to a non-0 positive integer when not found in the CodeSniffer.conf file.
+     *
+     * @return void
+     */
+    public function testReportWidthWillBeSetFromAutoWhenNotFoundInConfFile()
+    {
+        $phpCodeSnifferConfig = [
+            'default_standard' => 'PSR2',
+            'show_warnings'    => '0',
+        ];
+
+        $this->setStaticProperty('configData', $phpCodeSnifferConfig);
+
+        $config = new Config();
+
+        // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
+        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
+
+    }//end testReportWidthWillBeSetFromAutoWhenNotFoundInConfFile()
+
+
+    /**
+     * Test that the report width will be set correctly when found in the CodeSniffer.conf file.
+     *
+     * @return void
+     */
+    public function testReportWidthCanBeSetFromConfFile()
+    {
+        $phpCodeSnifferConfig = [
+            'default_standard' => 'PSR2',
+            'report_width'     => '120',
+        ];
+
+        $this->setStaticProperty('configData', $phpCodeSnifferConfig);
+
+        $config = new Config();
+        $this->assertSame(120, $config->reportWidth);
+
+    }//end testReportWidthCanBeSetFromConfFile()
+
+
+    /**
+     * Test that the report width will be set correctly when passed as a CLI argument.
+     *
+     * @return void
+     */
+    public function testReportWidthCanBeSetFromCLI()
+    {
+        $_SERVER['argv'] = [
+            'phpcs',
+            '--report-width=100',
+        ];
+
+        $config = new Config();
+        $this->assertSame(100, $config->reportWidth);
+
+    }//end testReportWidthCanBeSetFromCLI()
+
+
+    /**
+     * Test that the report width will be set correctly when multiple report widths are passed on the CLI.
+     *
+     * @return void
+     */
+    public function testReportWidthWhenSetFromCLIFirstValuePrevails()
+    {
+        $_SERVER['argv'] = [
+            'phpcs',
+            '--report-width=100',
+            '--report-width=200',
+        ];
+
+        $config = new Config();
+        $this->assertSame(100, $config->reportWidth);
+
+    }//end testReportWidthWhenSetFromCLIFirstValuePrevails()
+
+
+    /**
+     * Test that a report width passed as a CLI argument will overrule a report width set in a CodeSniffer.conf file.
+     *
+     * @return void
+     */
+    public function testReportWidthSetFromCLIOverrulesConfFile()
+    {
+        $phpCodeSnifferConfig = [
+            'default_standard' => 'PSR2',
+            'report_format'    => 'summary',
+            'show_warnings'    => '0',
+            'show_progress'    => '1',
+            'report_width'     => '120',
+        ];
+
+        $this->setStaticProperty('configData', $phpCodeSnifferConfig);
+
+        $cliArgs = [
+            'phpcs',
+            '--report-width=180',
+        ];
+
+        $config = new Config($cliArgs);
+        $this->assertSame(180, $config->reportWidth);
+
+    }//end testReportWidthSetFromCLIOverrulesConfFile()
+
+
+    /**
+     * Test that the report width will be set to a non-0 positive integer when set to "auto".
+     *
+     * @return void
+     */
+    public function testReportWidthInputHandlingForAuto()
+    {
+        $config = new Config();
+        $config->reportWidth = 'auto';
+
+        // Can't test the exact value as "auto" will resolve differently depending on the machine running the tests.
+        $this->assertTrue(is_int($config->reportWidth), 'Report width is not an integer');
+        $this->assertGreaterThan(0, $config->reportWidth, 'Report width is not greater than 0');
+
+    }//end testReportWidthInputHandlingForAuto()
+
+
+    /**
+     * Test that the report width will be set correctly for various types of input.
+     *
+     * @param mixed $input    Input value received.
+     * @param int   $expected Expected report width.
+     *
+     * @dataProvider dataReportWidthInputHandling
+     *
+     * @return void
+     */
+    public function testReportWidthInputHandling($input, $expected)
+    {
+        $config = new Config();
+        $config->reportWidth = $input;
+
+        $this->assertSame($expected, $config->reportWidth);
+
+    }//end testReportWidthInputHandling()
+
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function dataReportWidthInputHandling()
+    {
+        return [
+            'No value (empty string)'                                 => [
+                'value'    => '',
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: invalid input type null'                          => [
+                'value'    => null,
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: invalid input type false'                         => [
+                'value'    => false,
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: invalid input type float'                         => [
+                'value'    => 100.50,
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: invalid string value "invalid"'                   => [
+                'value'    => 'invalid',
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: invalid string value, non-integer string "50.25"' => [
+                'value'    => '50.25',
+                'expected' => Config::DEFAULT_REPORT_WIDTH,
+            ],
+            'Value: valid numeric string value'                       => [
+                'value'    => '250',
+                'expected' => 250,
+            ],
+            'Value: valid int value'                                  => [
+                'value'    => 220,
+                'expected' => 220,
+            ],
+            'Value: negative int value becomes positive int'          => [
+                'value'    => -180,
+                'expected' => 180,
+            ],
+        ];
+
+    }//end dataReportWidthInputHandling()
+
+
+    /**
+     * Helper function to set a static property on the Config class.
+     *
+     * @param string $name  The name of the property to set.
+     * @param mixed  $value The value to set the propert to.
+     *
+     * @return void
+     */
+    public static function setStaticProperty($name, $value)
+    {
+        $property = new ReflectionProperty('PHP_CodeSniffer\Config', $name);
+        $property->setAccessible(true);
+        $property->setValue($value);
+        $property->setAccessible(false);
+
+    }//end setStaticProperty()
+
+
+}//end class