Simplify test cases with BaseTestCase

Author: sirbrillig

VariableAnalysis/Tests/BaseTestCase.php

@@ -0,0 +1,32 @@
+<?php
+namespace VariableAnalysis\Tests;
+
+use PHPUnit\Framework\TestCase;
+use PHP_CodeSniffer\Files\LocalFile;
+use PHP_CodeSniffer\Ruleset;
+use PHP_CodeSniffer\Config;
+
+class BaseTestCase extends TestCase {
+  public function prepareLocalFileForSniffs($sniffFiles, string $fixtureFile): LocalFile {
+    $config = new Config();
+    $ruleset = new Ruleset($config);
+    if (! is_array($sniffFiles)) {
+      $sniffFiles = [$sniffFiles];
+    }
+    $ruleset->registerSniffs($sniffFiles, [], []);
+    $ruleset->populateTokenListeners();
+    return new LocalFile($fixtureFile, $ruleset, $config);
+  }
+
+  public function getLineNumbersFromMessages(array $messages): array {
+    return array_keys($messages);
+  }
+
+  public function getWarningLineNumbersFromFile(LocalFile $phpcsFile): array {
+    return $this->getLineNumbersFromMessages($phpcsFile->getWarnings());
+  }
+
+  public function getErrorLineNumbersFromFile(LocalFile $phpcsFile): array {
+    return $this->getLineNumbersFromMessages($phpcsFile->getErrors());
+  }
+}

VariableAnalysis/Tests/CodeAnalysis/VariableAnalysisUnitTest.php

@@ -1,23 +1,17 @@
 <?php
 namespace VariableAnalysis\Tests;
 
-use PHPUnit\Framework\TestCase;
 use PHP_CodeSniffer\Files\LocalFile;
 use PHP_CodeSniffer\Ruleset;
 use PHP_CodeSniffer\Config;
 
-class VariableAnalysisUnitTest extends TestCase {
+class VariableAnalysisUnitTest extends BaseTestCase {
   public function testAllErrors() {
     $fixtureFile = __DIR__ . '/VariableAnalysisUnitTestFixture.php';
     $sniffFiles = [__DIR__ . '/../../../VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php'];
-    $config = new Config();
-    $ruleset = new Ruleset($config);
-    $ruleset->registerSniffs($sniffFiles, [], []);
-    $ruleset->populateTokenListeners();
-    $phpcsFile = new LocalFile($fixtureFile, $ruleset, $config);
+    $phpcsFile = $this->prepareLocalFileForSniffs($sniffFiles, $fixtureFile);
     $phpcsFile->process();
-    $foundErrors = $phpcsFile->getErrors();
-    $lines = array_keys($foundErrors);
+    $lines = $this->getErrorLineNumbersFromFile($phpcsFile);
     $expectedErrors = [
       185,
       189,
@@ -29,14 +23,9 @@ public function testAllErrors() {
   public function testAllWarnings() {
     $fixtureFile = __DIR__ . '/VariableAnalysisUnitTestFixture.php';
     $sniffFiles = [__DIR__ . '/../../../VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php'];
-    $config = new Config();
-    $ruleset = new Ruleset($config);
-    $ruleset->registerSniffs($sniffFiles, [], []);
-    $ruleset->populateTokenListeners();
-    $phpcsFile = new LocalFile($fixtureFile, $ruleset, $config);
+    $phpcsFile = $this->prepareLocalFileForSniffs($sniffFiles, $fixtureFile);
     $phpcsFile->process();
-    $foundWarnings = $phpcsFile->getWarnings();
-    $lines = array_keys($foundWarnings);
+    $lines = $this->getWarningLineNumbersFromFile($phpcsFile);
     $expectedWarnings = [
       4,
       5,

VariableAnalysis/Tests/bootstrap.php

@@ -1,2 +1,3 @@
 <?php
 require_once(__DIR__ . '/../../vendor/squizlabs/php_codesniffer/tests/bootstrap.php');
+require_once(__DIR__ . '/BaseTestCase.php');