Add --default-time-limit

phpunit.xsd

@@ -258,6 +258,7 @@
         <xs:attribute name="beStrictAboutTestsThatDoNotTestAnything" type="xs:boolean" default="true"/>
         <xs:attribute name="beStrictAboutTodoAnnotatedTests" type="xs:boolean" default="false"/>
         <xs:attribute name="beStrictAboutCoversAnnotation" type="xs:boolean" default="false"/>
+        <xs:attribute name="defaultTimeLimit" type="xs:integer" default="0"/>
         <xs:attribute name="enforceTimeLimit" type="xs:boolean" default="false"/>
         <xs:attribute name="ignoreDeprecatedCodeUnitsFromCodeCoverage" type="xs:boolean" default="false"/>
         <xs:attribute name="timeoutForSmallTests" type="xs:integer" default="1"/>

src/Framework/TestResult.php

@@ -139,6 +139,11 @@ class TestResult implements Countable
      */
     protected $beStrictAboutResourceUsageDuringSmallTests = false;
 
+    /**
+     * @var int
+     */
+    private $defaultTimeLimit = 0;
+
     /**
      * @var bool
      */
@@ -639,8 +644,8 @@ public function run(Test $test): void
 
         try {
             if (!$test instanceof WarningTestCase &&
-                $test->getSize() != \PHPUnit\Util\Test::UNKNOWN &&
                 $this->enforceTimeLimit &&
+                ($this->defaultTimeLimit || $test->getSize() != \PHPUnit\Util\Test::UNKNOWN) &&
                 \extension_loaded('pcntl') && \class_exists(Invoker::class)) {
                 switch ($test->getSize()) {
                     case \PHPUnit\Util\Test::SMALL:
@@ -656,6 +661,11 @@ public function run(Test $test): void
                     case \PHPUnit\Util\Test::LARGE:
                         $_timeout = $this->timeoutForLargeTests;
 
+                        break;
+
+                    case \PHPUnit\Util\Test::UNKNOWN:
+                        $_timeout = $this->defaultTimeLimit;
+
                         break;
                 }
 
@@ -1061,6 +1071,14 @@ public function wasSuccessful(): bool
         return empty($this->errors) && empty($this->failures) && empty($this->warnings);
     }
 
+    /**
+     * Sets the default timeout for tests
+     */
+    public function setDefaultTimeLimit(int $timeout): void
+    {
+        $this->defaultTimeLimit = $timeout;
+    }
+
     /**
      * Sets the timeout for small tests.
      */

src/TextUI/Command.php

@@ -84,6 +84,7 @@ class Command
         'disallow-test-output'      => null,
         'disallow-resource-usage'   => null,
         'disallow-todo-tests'       => null,
+        'default-time-limit='       => null,
         'enforce-time-limit'        => null,
         'exclude-group='            => null,
         'filter='                   => null,
@@ -692,6 +693,11 @@ protected function handleArguments(array $argv): void
 
                     break;
 
+                case '--default-time-limit':
+                    $this->arguments['defaultTimeLimit'] = (int) $option[1];
+
+                    break;
+
                 case '--enforce-time-limit':
                     $this->arguments['enforceTimeLimit'] = true;
 
@@ -1120,6 +1126,7 @@ protected function showHelp(): void
   --disallow-test-output      Be strict about output during tests
   --disallow-resource-usage   Be strict about resource usage during small tests
   --enforce-time-limit        Enforce time limit based on test size
+  --default-time-limit=<sec>  Timeout in seconds for tests without @small, @medium or @large
   --disallow-todo-tests       Disallow @todo-annotated tests
 
   --process-isolation         Run each test in a separate PHP process

src/TextUI/TestRunner.php

@@ -54,6 +54,7 @@
 use SebastianBergmann\CodeCoverage\Report\Xml\Facade as XmlReport;
 use SebastianBergmann\Comparator\Comparator;
 use SebastianBergmann\Environment\Runtime;
+use SebastianBergmann\Invoker\Invoker;
 
 /**
  * A TestRunner for the Command Line Interface (CLI)
@@ -579,7 +580,18 @@ public function doRun(Test $suite, array $arguments = [], bool $exit = true): Te
         $result->beStrictAboutOutputDuringTests($arguments['disallowTestOutput']);
         $result->beStrictAboutTodoAnnotatedTests($arguments['disallowTodoAnnotatedTests']);
         $result->beStrictAboutResourceUsageDuringSmallTests($arguments['beStrictAboutResourceUsageDuringSmallTests']);
+
+        if ($arguments['enforceTimeLimit'] === true) {
+            if (!\class_exists(Invoker::class)) {
+                $this->writeMessage('Error', 'Package phpunit/php-invoker is required for enforcing time limits');
+            }
+
+            if (!\extension_loaded('pcntl') || \strpos(\ini_get('disable_functions'), 'pcntl') !== false) {
+                $this->writeMessage('Error', 'PHP extension pcntl is required for enforcing time limits');
+            }
+        }
         $result->enforceTimeLimit($arguments['enforceTimeLimit']);
+        $result->setDefaultTimeLimit($arguments['defaultTimeLimit']);
         $result->setTimeoutForSmallTests($arguments['timeoutForSmallTests']);
         $result->setTimeoutForMediumTests($arguments['timeoutForMediumTests']);
         $result->setTimeoutForLargeTests($arguments['timeoutForLargeTests']);
@@ -942,6 +954,10 @@ protected function handleConfiguration(array &$arguments): void
                 $arguments['disallowTestOutput'] = $phpunitConfiguration['disallowTestOutput'];
             }
 
+            if (isset($phpunitConfiguration['defaultTimeLimit']) && !isset($arguments['defaultTimeLimit'])) {
+                $arguments['defaultTimeLimit'] = $phpunitConfiguration['defaultTimeLimit'];
+            }
+
             if (isset($phpunitConfiguration['enforceTimeLimit']) && !isset($arguments['enforceTimeLimit'])) {
                 $arguments['enforceTimeLimit'] = $phpunitConfiguration['enforceTimeLimit'];
             }
@@ -1179,6 +1195,7 @@ protected function handleConfiguration(array &$arguments): void
         $arguments['crap4jThreshold']                                 = $arguments['crap4jThreshold'] ?? 30;
         $arguments['disallowTestOutput']                              = $arguments['disallowTestOutput'] ?? false;
         $arguments['disallowTodoAnnotatedTests']                      = $arguments['disallowTodoAnnotatedTests'] ?? false;
+        $arguments['defaultTimeLimit']                                = $arguments['defaultTimeLimit'] ?? 0;
         $arguments['enforceTimeLimit']                                = $arguments['enforceTimeLimit'] ?? false;
         $arguments['excludeGroups']                                   = $arguments['excludeGroups'] ?? [];
         $arguments['failOnRisky']                                     = $arguments['failOnRisky'] ?? false;

src/Util/Configuration.php

@@ -59,6 +59,7 @@
  *          beStrictAboutResourceUsageDuringSmallTests="false"
  *          beStrictAboutTestsThatDoNotTestAnything="false"
  *          beStrictAboutTodoAnnotatedTests="false"
+ *          defaultTimeLimit="0"
  *          enforceTimeLimit="false"
  *          ignoreDeprecatedCodeUnitsFromCodeCoverage="false"
  *          timeoutForSmallTests="1"
@@ -855,6 +856,13 @@ public function getPHPUnitConfiguration(): array
             );
         }
 
+        if ($root->hasAttribute('defaultTimeLimit')) {
+            $result['defaultTimeLimit'] = $this->getInteger(
+                (string) $root->getAttribute('defaultTimeLimit'),
+                1
+            );
+        }
+
         if ($root->hasAttribute('enforceTimeLimit')) {
             $result['enforceTimeLimit'] = $this->getBoolean(
                 (string) $root->getAttribute('enforceTimeLimit'),

tests/Regression/GitHub/2085/Issue2085Test.php

@@ -0,0 +1,20 @@
+<?php
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+use PHPUnit\Framework\TestCase;
+
+class Issue2085Test extends TestCase
+{
+    public function testShouldAbortSlowTestByEnforcingTimeLimit(): void
+    {
+        $this->assertTrue(true);
+        \sleep(1.2);
+        $this->assertTrue(true);
+    }
+}

tests/Regression/GitHub/2085/configuration_enforce_time_limit_options.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit enforceTimeLimit="true" defaultTimeLimit="1" />

tests/Regression/GitHub/2085/enforce-time-limit-options-via-config-without-invoker.phpt

@@ -0,0 +1,31 @@
+--TEST--
+Test XML config enforceTimeLimit, defaultTimeLimit without php-invoker, with pcntl
+--SKIPIF--
+<?php
+if (\class_exists(Invoker::class)) {
+    print "Skip: package phpunit/php-invoker is installed" . PHP_EOL;
+}
+
+if (!\extension_loaded('pcntl') || \strpos(\ini_get('disable_functions'), 'pcntl') !== false) {
+    print "Skip: extension pcntl is required for enforcing time limits" . PHP_EOL;
+}
+--DESCRIPTION--
+https://github.com/sebastianbergmann/phpunit/issues/2085
+--FILE--
+<?php
+$_SERVER['argv'][1] = '-c';
+$_SERVER['argv'][2] = __DIR__ . '/configuration_enforce_time_limit_options.xml';
+$_SERVER['argv'][3] = __DIR__ . '/Issue2085Test.php';
+
+require __DIR__ . '/../../../bootstrap.php';
+PHPUnit\TextUI\Command::main();
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+
+Error:         Package phpunit/php-invoker is required for enforcing time limits
+.                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+OK (1 test, 2 assertions)

tests/Regression/GitHub/2085/issue-2085-test-without-invoker.phpt

@@ -0,0 +1,32 @@
+--TEST--
+Test CLI flags --enforce-time-limit --default-time-limit without php-invoker, with pcntl
+--DESCRIPTION--
+https://github.com/sebastianbergmann/phpunit/issues/2085
+--SKIPIF--
+<?php
+if (\class_exists(Invoker::class)) {
+    print "Skip: package phpunit/php-invoker is installed" . PHP_EOL;
+}
+
+if (!\extension_loaded('pcntl') || \strpos(\ini_get('disable_functions'), 'pcntl') !== false) {
+    print "Skip: extension pcntl is required for enforcing time limits" . PHP_EOL;
+}
+--FILE--
+<?php
+$_SERVER['argv'][1] = '--no-configuration';
+$_SERVER['argv'][2] = '--enforce-time-limit';
+$_SERVER['argv'][3] = '--default-time-limit=10';
+$_SERVER['argv'][4] = __DIR__ . '/Issue2085Test.php';
+
+require __DIR__ . '/../../../bootstrap.php';
+PHPUnit\TextUI\Command::main();
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+
+Error:         Package phpunit/php-invoker is required for enforcing time limits
+.                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+OK (1 test, 2 assertions)

tests/Regression/GitHub/2085/issue-2085-test.phpt

@@ -0,0 +1,36 @@
+--TEST--
+Test CLI flags --enforce-time-limit --default-time-limit
+--DESCRIPTION--
+https://github.com/sebastianbergmann/phpunit/issues/2085
+--SKIPIF--
+<?php
+if (!\class_exists(Invoker::class)) {
+    print "Skip: package phpunit/php-invoker is required for enforcing time limits" . PHP_EOL;
+}
+
+if (!\extension_loaded('pcntl') || \strpos(\ini_get('disable_functions'), 'pcntl') !== false) {
+    print "Skip: extension pcntl is required for enforcing time limits" . PHP_EOL;
+}
+--FILE--
+<?php
+$_SERVER['argv'][1] = '--no-configuration';
+$_SERVER['argv'][2] = '--enforce-time-limit';
+$_SERVER['argv'][3] = '--default-time-limit=1';
+$_SERVER['argv'][4] = __DIR__ . '/Issue2085Test.php';
+
+require __DIR__ . '/../../../bootstrap.php';
+PHPUnit\TextUI\Command::main();
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+R                                                                   1 / 1 (100%)
+
+Time: %s, Memory: %s
+
+There was 1 risky test:
+
+1) Issue2085Test::testShouldAbortSlowTestByEnforcingTimeLimit
+Execution aborted after 1 second
+
+OK, but incomplete, skipped, or risky tests!
+Tests: 1, Assertions: 1, Risky: 1.

tests/_files/configuration.xml

@@ -25,6 +25,7 @@
          beStrictAboutTestsThatDoNotTestAnything="false"
          beStrictAboutTodoAnnotatedTests="false"
          beStrictAboutCoversAnnotation="false"
+         defaultTimeLimit="123"
          enforceTimeLimit="false"
          ignoreDeprecatedCodeUnitsFromCodeCoverage="false"
          timeoutForSmallTests="1"

tests/_files/configuration_xinclude.xml

@@ -26,6 +26,7 @@
          beStrictAboutTestsThatDoNotTestAnything="false"
          beStrictAboutTodoAnnotatedTests="false"
          beStrictAboutCoversAnnotation="false"
+         defaultTimeLimit="123"
          enforceTimeLimit="false"
          ignoreDeprecatedCodeUnitsFromCodeCoverage="false"
          timeoutForSmallTests="1"

tests/end-to-end/help.phpt

@@ -56,6 +56,7 @@ Test Execution Options:
   --disallow-test-output      Be strict about output during tests
   --disallow-resource-usage   Be strict about resource usage during small tests
   --enforce-time-limit        Enforce time limit based on test size
+  --default-time-limit=<sec>  Timeout in seconds for tests without @small, @medium or @large
   --disallow-todo-tests       Disallow @todo-annotated tests
 
   --process-isolation         Run each test in a separate PHP process

tests/end-to-end/help2.phpt

@@ -57,6 +57,7 @@ Test Execution Options:
   --disallow-test-output      Be strict about output during tests
   --disallow-resource-usage   Be strict about resource usage during small tests
   --enforce-time-limit        Enforce time limit based on test size
+  --default-time-limit=<sec>  Timeout in seconds for tests without @small, @medium or @large
   --disallow-todo-tests       Disallow @todo-annotated tests
 
   --process-isolation         Run each test in a separate PHP process

tests/unit/Util/ConfigurationTest.php

@@ -471,6 +471,7 @@ public function testPHPUnitConfigurationIsReadCorrectly(): void
                 'reportUselessTests'                         => false,
                 'strictCoverage'                             => false,
                 'disallowTestOutput'                         => false,
+                'defaultTimeLimit'                           => 123,
                 'enforceTimeLimit'                           => false,
                 'extensionsDirectory'                        => '/tmp',
                 'printerClass'                               => 'PHPUnit\TextUI\ResultPrinter',