Merge pull request #165 from marinaglancy/phpunitwarnings

PHPUnit should fail if there are warnings

.github/workflows/test.yml

@@ -101,6 +101,6 @@ jobs:
             "$MOODLE_BRANCH" != 'master' -a \
             "$MOODLE_BRANCH" != 'MOODLE_400_STABLE' ]
         moodle-plugin-ci phpdoc
-        moodle-plugin-ci phpunit --verbose --coverage-text
+        moodle-plugin-ci phpunit --verbose --coverage-text --fail-on-warning
         moodle-plugin-ci behat --profile default
         moodle-plugin-ci behat --profile chrome

.travis.dist.yml

@@ -45,6 +45,6 @@ script:
   - moodle-plugin-ci savepoints
   - moodle-plugin-ci mustache
   - moodle-plugin-ci grunt
-  - moodle-plugin-ci phpdoc
+  - moodle-plugin-ci phpdoc --fail-on-warning
   - moodle-plugin-ci phpunit
   - moodle-plugin-ci behat

.travis.yml

@@ -59,7 +59,7 @@ script:
         "$MOODLE_BRANCH" != 'MOODLE_310_STABLE' -a \
         "$MOODLE_BRANCH" != 'MOODLE_39_STABLE' ]
   - moodle-plugin-ci phpdoc
-  - moodle-plugin-ci phpunit --coverage-text
+  - moodle-plugin-ci phpunit --coverage-text --fail-on-warning
   - moodle-plugin-ci behat --profile default
   - moodle-plugin-ci behat --profile chrome
 

docs/CHANGELOG.md

@@ -9,6 +9,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 The format of this change log follows the advice given at [Keep a CHANGELOG](http://keepachangelog.com).
 
 ## [Unreleased]
+### Changed
+- It is possible to specify more test execution options to the 'phpunit' command, such as "--fail-on-warning"
 
 ## [3.2.5] - 2022-03-31
 ### Changed

docs/CLI.md

@@ -1735,7 +1735,7 @@ Run PHPUnit on a plugin
 
 ### Usage
 
-* `phpunit [-m|--moodle MOODLE] [--coverage-text] [--coverage-clover] [--] <plugin>`
+* `phpunit [-m|--moodle MOODLE] [--coverage-text] [--coverage-clover] [--fail-on-incomplete] [--fail-on-risky] [--fail-on-skipped] [--fail-on-warning] [--] <plugin>`
 
 Run PHPUnit on a plugin
 
@@ -1778,6 +1778,42 @@ Generate code coverage report in Clover XML format
 * Is multiple: no
 * Default: `false`
 
+#### `--fail-on-incomplete`
+
+Treat incomplete tests as failures
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Default: `false`
+
+#### `--fail-on-risky`
+
+Treat risky tests as failures
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Default: `false`
+
+#### `--fail-on-skipped`
+
+Treat skipped tests as failures
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Default: `false`
+
+#### `--fail-on-warning`
+
+Treat tests with warnings as failures
+
+* Accept value: no
+* Is value required: no
+* Is multiple: no
+* Default: `false`
+
 #### `--help|-h`
 
 Display this help message

gha.dist.yml

@@ -103,7 +103,7 @@ jobs:
 
       - name: PHPUnit tests
         if: ${{ always() }}
-        run: moodle-plugin-ci phpunit
+        run: moodle-plugin-ci phpunit --fail-on-warning
 
       - name: Behat features
         if: ${{ always() }}

src/Command/PHPUnitCommand.php

@@ -30,7 +30,11 @@ protected function configure()
         $this->setName('phpunit')
             ->setDescription('Run PHPUnit on a plugin')
             ->addOption('coverage-text', null, InputOption::VALUE_NONE, 'Generate and print code coverage report in text format')
-            ->addOption('coverage-clover', null, InputOption::VALUE_NONE, 'Generate code coverage report in Clover XML format');
+            ->addOption('coverage-clover', null, InputOption::VALUE_NONE, 'Generate code coverage report in Clover XML format')
+            ->addOption('fail-on-incomplete', null, InputOption::VALUE_NONE, 'Treat incomplete tests as failures')
+            ->addOption('fail-on-risky', null, InputOption::VALUE_NONE, 'Treat risky tests as failures')
+            ->addOption('fail-on-skipped', null, InputOption::VALUE_NONE, 'Treat skipped tests as failures')
+            ->addOption('fail-on-warning', null, InputOption::VALUE_NONE, 'Treat tests with warnings as failures');
     }
 
     protected function initialize(InputInterface $input, OutputInterface $output)
@@ -74,6 +78,11 @@ private function resolveOptions(InputInterface $input)
         if ($this->supportsCoverage() && $input->getOption('coverage-clover')) {
             $options[] = sprintf('--coverage-clover %s/coverage.xml', getcwd());
         }
+        foreach (['fail-on-warning', 'fail-on-risky', 'fail-on-skipped', 'fail-on-warning'] as $option) {
+            if ($input->getOption($option)) {
+                $options[] = '--'.$option;
+            }
+        }
         if (is_file($this->plugin->directory.'/phpunit.xml')) {
             $options[] = sprintf('--configuration %s', $this->plugin->directory);
         } else {

tests/Fixture/moodle-local_ci/tests/lib_test.php

@@ -52,7 +52,7 @@ public function test_local_ci_add() {
     /**
      * Test subtraction.
      *
-     * @covers ::local_ci_substract
+     * @covers ::local_ci_subtract
      */
     public function test_local_ci_subtract() {
         $this->assertEquals(0, local_ci_subtract(2, 2));
@@ -63,7 +63,7 @@ public function test_local_ci_subtract() {
     /**
      * Test math class.
      *
-     * @covers \local_ci\math\add
+     * @covers \local_ci\math::add
      */
     public function test_local_ci_math() {
         $math = new \local_ci_math();
@@ -75,7 +75,7 @@ public function test_local_ci_math() {
     /**
      * Test math class.
      *
-     * @covers \local_ci\math\add
+     * @covers \local_ci\math::add
      */
     public function test_local_ci_math_class() {
         $math = new math();