Merge pull request #359 from paslandau/GH_347

Style issues, failing sqlite tests, testuites with "," (#347)

README.md

@@ -70,7 +70,7 @@ Options:
  --stop-on-failure     Don't start any more processes after a failure.
  --log-junit           Log test execution in JUnit XML format to file.
  --colors              Displays a colored bar as a test result.
- --testsuite           Filter which testsuite to run.
+ --testsuite           Filter which testsuite to run. Run multiple suits by separating them with ",". Example:  --testsuite suite1,suite2
  --path                An alias for the path argument.
  --parallel-suite      Run testsuites in parallel as opposed to running test classes / test functions in parallel.
 ```
@@ -190,22 +190,37 @@ For Contributors: Testing paratest itself
 
 ParaTest's test suite depends on PHPUnit being installed via composer. Make sure you run `composer install` after cloning.
 
-**Note that The `display_errors` php.ini directive must be set to `stderr` to run
-the test suite.**
+**Note that The `display_errors` php.ini directive must be set to `stderr` to run the test suite.**
+
+You can use composer scripts for convenient access to style checks and tests. Run `compose run-script -l` to list the
+available commands:
+
+````
+composer run-script -l
+scripts:
+  style            Run style checks (only dry run - no fixing!)
+  style-fix        Run style checks and fix violations
+  test             Run all tests
+  test-unit        Run only unit tests
+  test-functional  Run only functional tests
+  test-paratest    Run all tests with paratest itself
+````
 
 To run unit tests:
-`vendor/bin/phpunit test/unit`
+`composer test-unit` OR `vendor/bin/phpunit test/unit`
 
 To run functional tests:
-`vendor/bin/phpunit test/functional`
+`composer test-functional` OR `vendor/bin/phpunit test/functional`
+
+You can run all tests at once by running phpunit from the project directory:
+`composer test` OR `vendor/bin/phpunit`
 
-You can run all tests at once by running phpunit from the project directory.
-`vendor/bin/phpunit`
+ParaTest can run its own test suite by running it from the `bin` directory:
+`composer test` OR `bin/paratest`
 
-ParaTest can run its own test suite by running it from the `bin` directory.
-`bin/paratest`
+Before creating a Pull Request be sure to run the style checks and commit the eventual changes:
+`composer style-fix` OR `vendor/bin/php-cs-fixer fix`
 
-Before creating a Pull Request be sure to run `vendor/bin/php-cs-fixer fix` and
-commit the eventual changes.
+Use `composer style` to only show violations without fixing.
 
 For an example of ParaTest out in the wild check out the [example](https://github.com/brianium/paratest-selenium).

composer.json

@@ -42,5 +42,33 @@
         "psr-4": {
             "ParaTest\\": "test/unit/"
         }
+    },
+    "scripts": {
+        "style": [
+            "php-cs-fixer fix --dry-run --verbose"
+        ],
+        "style-fix": [
+            "php-cs-fixer fix"
+        ],
+        "test": [
+            "phpunit"
+        ],
+        "test-unit": [
+            "phpunit test/unit"
+        ],
+        "test-functional": [
+            "phpunit test/functional"
+        ],
+        "test-paratest": [
+            "bin/paratest"
+        ]
+    },
+    "scripts-descriptions": {
+        "style": "Run style checks (only dry run - no fixing!)",
+        "style-fix": "Run style checks and fix violations",
+        "test": "Run all tests",
+        "test-unit": "Run only unit tests",
+        "test-functional": "Run only functional tests",
+        "test-paratest": "Run all tests with paratest itself"
     }
 }

src/Console/Testers/PHPUnit.php

@@ -8,6 +8,7 @@
 use ParaTest\Runners\PHPUnit\BaseRunner;
 use ParaTest\Runners\PHPUnit\Configuration;
 use ParaTest\Runners\PHPUnit\Runner;
+use ParaTest\Util\Str;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -46,7 +47,8 @@ public function configure(Command $command)
             ->addOption('colors', null, InputOption::VALUE_NONE, 'Displays a colored bar as a test result.')
             ->addOption('testsuite', null, InputOption::VALUE_OPTIONAL, 'Filter which testsuite to run')
             ->addArgument('path', InputArgument::OPTIONAL, 'The path to a directory or file containing tests. <comment>(default: current directory)</comment>')
-            ->addOption('path', null, InputOption::VALUE_REQUIRED, 'An alias for the path argument.');
+            ->addOption('path', null, InputOption::VALUE_REQUIRED, 'An alias for the path argument.')
+        ;
         $this->command = $command;
     }
 
@@ -107,7 +109,7 @@ protected function hasConfig(InputInterface $input): bool
      */
     protected function getConfig(InputInterface $input)
     {
-        $cwd = getcwd() . DIRECTORY_SEPARATOR;
+        $cwd = getcwd() . \DIRECTORY_SEPARATOR;
 
         if ($input->getOption('configuration')) {
             $configFilename = $input->getOption('configuration');
@@ -144,6 +146,10 @@ public function getRunnerOptions(InputInterface $input): array
             $options = array_merge(['path' => $path], $options);
         }
 
+        if (array_key_exists('testsuite', $options)) {
+            $options['testsuite'] = Str::explodeWithCleanup(Configuration::TEST_SUITE_FILTER_SEPARATOR, $options['testsuite']);
+        }
+
         return $options;
     }
 

src/Console/VersionProvider.php

@@ -64,12 +64,12 @@ public function getComposerInstalledVersion($package)
         }
 
         $struct = json_decode($result, true, 16);
-        if (!is_array($struct)) {
+        if (!\is_array($struct)) {
             return;
         }
 
         foreach ($struct as $entry) {
-            if (!is_array($entry)) {
+            if (!\is_array($entry)) {
                 continue;
             }
             $name = $entry['name'] ?? null;

src/Coverage/CoverageMerger.php

@@ -61,7 +61,7 @@ public function addCoverageFromFile(string $coverageFile = null)
         if (0 === $file->getSize()) {
             $extra = 'This means a PHPUnit process has crashed.';
 
-            if (!function_exists('xdebug_get_code_coverage')) {
+            if (!\function_exists('xdebug_get_code_coverage')) {
                 $extra = 'Xdebug is disabled! Enable for coverage.';
             }
 

src/Logging/JUnit/Reader.php

@@ -174,14 +174,14 @@ protected function caseNodesToSuiteProperties(array $nodeArray, array &$testCase
         $cb = [TestCase::class, 'caseFromNode'];
 
         return array_reduce($nodeArray, function ($result, $c) use (&$testCases, $cb) {
-            $testCases[] = call_user_func_array($cb, [$c]);
+            $testCases[] = \call_user_func_array($cb, [$c]);
             $result['name'] = (string) $c['class'];
             $result['file'] = (string) $c['file'];
-            $result['tests'] += 1;
+            ++$result['tests'];
             $result['assertions'] += (int) $c['assertions'];
-            $result['failures'] += count($c->xpath('failure'));
-            $result['errors'] += count($c->xpath('error'));
-            $result['skipped'] += count($c->xpath('skipped'));
+            $result['failures'] += \count($c->xpath('failure'));
+            $result['errors'] += \count($c->xpath('error'));
+            $result['skipped'] += \count($c->xpath('skipped'));
             $result['time'] += (float) $c['time'];
 
             return $result;
@@ -217,7 +217,7 @@ protected function getCaseNodes(): array
     protected function initSuite()
     {
         $suiteNodes = $this->xml->xpath('/testsuites/testsuite/testsuite');
-        $this->isSingle = count($suiteNodes) === 0;
+        $this->isSingle = \count($suiteNodes) === 0;
         $node = current($this->xml->xpath('/testsuites/testsuite'));
 
         if ($node !== false) {

src/Logging/JUnit/Writer.php

@@ -181,7 +181,7 @@ protected function getSuiteRoot(array $suites): \DOMElement
     {
         $testsuites = $this->document->createElement('testsuites');
         $this->document->appendChild($testsuites);
-        if (count($suites) === 1) {
+        if (\count($suites) === 1) {
             return $testsuites;
         }
         $rootSuite = $this->document->createElement('testsuite');

src/Logging/LogInterpreter.php

@@ -124,11 +124,11 @@ public function flattenCases(): array
                 $dict[$case->file] = new TestSuite($case->class, 0, 0, 0, 0, 0, 0);
             }
             $dict[$case->file]->cases[] = $case;
-            $dict[$case->file]->tests += 1;
+            ++$dict[$case->file]->tests;
             $dict[$case->file]->assertions += $case->assertions;
-            $dict[$case->file]->failures += count($case->failures);
-            $dict[$case->file]->errors += count($case->errors);
-            $dict[$case->file]->skipped += count($case->skipped);
+            $dict[$case->file]->failures += \count($case->failures);
+            $dict[$case->file]->errors += \count($case->errors);
+            $dict[$case->file]->skipped += \count($case->skipped);
             $dict[$case->file]->time += $case->time;
             $dict[$case->file]->file = $case->file;
         }

src/Parser/Parser.php

@@ -57,7 +57,7 @@ public function __construct(string $srcPath)
      * Returns the fully constructed class
      * with methods or null if the class is abstract.
      *
-     * @return null|ParsedClass
+     * @return ParsedClass|null
      */
     public function getClass()
     {

src/Runners/PHPUnit/BaseRunner.php

@@ -180,19 +180,17 @@ protected function getCoverage()
 
     /**
      * Overrides envirenment variables if needed.
-     *
-     * @return null
      */
     protected function overrideEnvironmentVariables()
     {
-        if (! isset($this->options->filtered['configuration'])) {
+        if (!isset($this->options->filtered['configuration'])) {
             return;
         }
 
         $variables = $this->options->filtered['configuration']->getEnvironmentVariables();
 
         foreach ($variables as $key => $value) {
-            \putenv(sprintf('%s=%s', $key, $value));
+            putenv(sprintf('%s=%s', $key, $value));
 
             $_ENV[$key] = $value;
         }

src/Runners/PHPUnit/Configuration.php

@@ -12,6 +12,12 @@
  */
 class Configuration
 {
+    /**
+     * @see \PHPUnit\Util\Configuration
+     * @see https://github.com/sebastianbergmann/phpunit/commit/80754cf323fe96003a2567f5e57404fddecff3bf
+     */
+    const TEST_SUITE_FILTER_SEPARATOR = ',';
+
     /**
      * Path to the configuration file.
      *
@@ -100,16 +106,22 @@ public function getSuites()
         return $suites;
     }
 
+    public function hasSuites()
+    {
+        return !empty($this->getSuitesName());
+    }
+
     public function getSuitesName()
     {
         if (!$this->xml) {
-            return null;
+            return;
         }
         $nodes = $this->xml->xpath('//testsuites/testsuite');
         $names = [];
         foreach ($nodes as $node) {
-           $names[] = (string)$node['name'];
+            $names[] = (string) $node['name'];
         }
+
         return $names;
     }
 
@@ -173,7 +185,7 @@ public function getSuiteByName(string $suiteName)
      */
     public function getConfigDir(): string
     {
-        return dirname($this->path) . DIRECTORY_SEPARATOR;
+        return \dirname($this->path) . \DIRECTORY_SEPARATOR;
     }
 
     /**
@@ -212,7 +224,7 @@ public function getSuitePaths(string $path)
      */
     public function getEnvironmentVariables(): array
     {
-        if (! isset($this->xml->php->env)) {
+        if (!isset($this->xml->php->env)) {
             return [];
         }
 

src/Runners/PHPUnit/ExecutableTest.php

@@ -274,10 +274,10 @@ public function setTempFile(string $temp)
      */
     protected function assertValidCommandLineLength(string $cmd)
     {
-        if (DIRECTORY_SEPARATOR === '\\') { // windows
+        if (\DIRECTORY_SEPARATOR === '\\') { // windows
             // symfony's process wrapper
             $cmd = 'cmd /V:ON /E:ON /C "(' . $cmd . ')';
-            if (strlen($cmd) > 32767) {
+            if (\strlen($cmd) > 32767) {
                 throw new \RuntimeException('Command line is too long, try to decrease max batch size');
             }
         }

src/Runners/PHPUnit/FullSuite.php

@@ -1,12 +1,13 @@
 <?php
 
+declare(strict_types=1);
 
 namespace ParaTest\Runners\PHPUnit;
 
 class FullSuite extends ExecutableTest
 {
     /**
-     * @var  string
+     * @var string
      */
     protected $suiteName;