Add test coverage

Author: dereuromark

PSR2R/Tools/SniffsAndTests.php

@@ -0,0 +1,59 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Tools;
+
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use RecursiveRegexIterator;
+use RegexIterator;
+
+class SniffsAndTests
+{
+    /**
+     * @var array<string>
+     */
+    protected static $orgs = [
+        'PSR2R',
+    ];
+
+    /**
+     * @param string $path Path
+     *
+     * @return array<string, array<string, mixed>>
+     */
+    public function untested(string $path): array
+    {
+        $path = rtrim($path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
+
+        $sniffs = [];
+
+        foreach (static::$orgs as $org) {
+            $directoryIterator = new RecursiveDirectoryIterator($path . $org);
+            $recursiveIterator = new RecursiveIteratorIterator($directoryIterator);
+            $regexIterator = new RegexIterator($recursiveIterator, '#^.+/(\w+)/Sniffs/(\w+)/(\w+)Sniff\.php$#', RecursiveRegexIterator::GET_MATCH);
+
+            foreach ($regexIterator as $match) {
+                $org = $match[1];
+                $type = $match[2];
+                $name = $match[3];
+                $testFile = $path . 'tests' . DIRECTORY_SEPARATOR . $org . 'Sniffs' . DIRECTORY_SEPARATOR . $type . DIRECTORY_SEPARATOR . $name . 'SniffTest.php';
+                $hasTest = file_exists($testFile);
+                if ($hasTest) {
+                    continue;
+                }
+
+                $key = $org . '.' . $type . '.' . $name;
+                $sniffs[$key] = [
+                    'hasTest' => $hasTest,
+                ];
+            }
+        }
+
+        return $sniffs;
+    }
+}

composer.json

@@ -18,6 +18,7 @@
 		"squizlabs/php_codesniffer": "^3.7.0"
 	},
 	"require-dev": {
+		"phpunit/phpunit": "^9.5",
 		"phpstan/phpstan": "^1.0.0"
 	},
 	"autoload": {
@@ -27,10 +28,10 @@
 	},
 	"autoload-dev": {
 		"psr-4": {
-			"PSR2R\\Base\\": "tests/PSR2R/Base/",
-			"PSR2R\\Tests\\": "tests/PSR2R/Tests/"
+			"PSR2R\\Test\\": "tests/"
 		}
 	},
+	"prefer-stable": true,
 	"minimum-stability": "stable",
 	"bin": [
 		"bin/tokenize",
@@ -41,10 +42,8 @@
 		"docs-listing": "phpcs -e --standard=PSR2R/ruleset.xml",
 		"cs-check": "phpcs",
 		"cs-fix": "phpcbf",
-		"test": "php phpunit.phar",
-		"test-setup": "[ ! -f phpunit.phar ] && wget https://phar.phpunit.de/phpunit-9.5.10.phar && mv phpunit-9.5.10.phar phpunit.phar || true",
-		"test-setup-mac": "[ ! -f phpunit.phar ] && curl -OL https://phar.phpunit.de/phpunit-9.5.10.phar && mv phpunit-9.5.10.phar phpunit.phar || true",
-		"test-coverage": "php phpunit.phar --log-junit tmp/coverage/unitreport.xml --coverage-html tmp/coverage --coverage-clover tmp/coverage/coverage.xml",
+		"test": "phpunit",
+		"test-coverage": "phpunit --log-junit tmp/coverage/unitreport.xml --coverage-html tmp/coverage --coverage-clover tmp/coverage/coverage.xml",
 		"lowest": "validate-prefer-lowest",
 		"lowest-setup": "composer update --prefer-lowest --prefer-stable --prefer-dist --no-interaction && cp composer.json composer.backup && composer require --dev dereuromark/composer-prefer-lowest && mv composer.backup composer.json",
 		"stan": "phpstan analyse"

phpunit.xml.dist

@@ -1,25 +1,20 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="tests/bootstrap.php">
+	<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="tests/bootstrap.php" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+
 	<php>
 		<ini name="memory_limit" value="-1"/>
 		<ini name="apc.enable_cli" value="1"/>
 	</php>
 
-	<!-- Add any additional test suites you want to run here -->
 	<testsuites>
 		<testsuite name="psr2r">
-			<directory>tests/Sniffs/</directory>
-		</testsuite>
-		<testsuite name="Extension of PHP_CodeSniffer Test Suite">
-			<file>tests/AllTests.php</file>
+			<directory>tests/PSR2R/</directory>
 		</testsuite>
-		<!-- Add plugin test suites here. -->
 	</testsuites>
 
-	<filter>
-		<whitelist processUncoveredFilesFromWhitelist="true">
+	<coverage processUncoveredFiles="true">
+		<include>
 			<directory>PSR2R/</directory>
-		</whitelist>
-	</filter>
-
+		</include>
+	</coverage>
 </phpunit>

setup.sh

@@ -3,6 +3,3 @@
 
 # Download composer phar if not available yet
 [ ! -f composer.phar ] && curl -sS https://getcomposer.org/installer | php
-
-# Download phpunit phar if not available yet
-[ ! -f phpunit.phar ] && php composer.phar test-setup

tests/AllTests.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Sniffs;
+
+use PSR2R\Test\TestCase;
+
+/**
+ * Test integration of all sniffs together.
+ */
+class AllSniffTest extends TestCase
+{
+    /**
+     * @return void
+     */
+    public function testAllSniffs(): void
+    {
+        $before = $this->testFilePath() . 'All' . DS . 'before.php';
+        $after = $this->testFilePath() . 'All' . DS . 'after.php';
+
+        // Use --debug to display the errors found
+        $errors = $this->runFullFixer($before, $after);
+        $this->assertNotEmpty($errors);
+
+        $this->runFullFixer($before, $after, null, null, true);
+    }
+}

tests/PSR2R/Sniffs/AllSniffTest.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * MIT License
+ * For full license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+namespace PSR2R\Test\PSR2R\Sniffs\PHP;
+
+use PSR2R\Test\TestCase;
+use PSR2R\Sniffs\PHP\DuplicateSemicolonSniff;
+
+class DuplicateSemicolonSniffTest extends TestCase
+{
+    /**
+     * @return void
+     */
+    public function testDocBlockConstSniffer(): void
+    {
+        $this->assertSnifferFindsErrors(new DuplicateSemicolonSniff(), 2);
+    }
+
+    /**
+     * @return void
+     */
+    public function testDocBlockConstFixer(): void
+    {
+        $this->assertSnifferCanFixErrors(new DuplicateSemicolonSniff());
+    }
+}