fix status detection (via allure-framework#64)

remorhaz · web-flow · commit 88bccf5a4638 · 2021-10-19T13:54:18.000+03:00
diff --git a/composer.json b/composer.json
@@ -30,7 +30,7 @@
   },
   "require": {
     "php": "^8",
-    "allure-framework/allure-php-commons": "^2.0.0-rc1",
+    "allure-framework/allure-php-commons": "2.0.0-rc3",
     "phpunit/phpunit": "^9"
   },
   "require-dev": {
diff --git a/src/AllureExtension.php b/src/AllureExtension.php
@@ -100,15 +100,15 @@ public function executeAfterTestFailure(string $test, string $message, float $ti
         $this
             ->testLifecycle
             ->switchTo($test)
-            ->updateDetectedStatus($message, Status::failed());
+            ->updateDetectedStatus($message, Status::failed(), Status::failed());
     }
 
     public function executeAfterTestError(string $test, string $message, float $time): void
     {
         $this
             ->testLifecycle
             ->switchTo($test)
-            ->updateDetectedStatus($message, Status::failed());
+            ->updateDetectedStatus($message, Status::broken());
     }
 
     public function executeAfterIncompleteTest(string $test, string $message, float $time): void
diff --git a/src/Internal/TestLifecycle.php b/src/Internal/TestLifecycle.php
@@ -115,8 +115,11 @@ public function updateStatus(?string $message = null, ?Status $status = null): s
         return $this;
     }
 
-    public function updateDetectedStatus(?string $message = null, ?Status $status = null): self
-    {
+    public function updateDetectedStatus(
+        ?string $message = null,
+        ?Status $status = null,
+        ?Status $overrideStatus = null,
+    ): self {
         $exception = $this->adapter->getLastException();
         if (!isset($exception)) {
             return $this->updateStatus($message, $status);
@@ -127,6 +130,7 @@ public function updateDetectedStatus(?string $message = null, ?Status $status =
                 $testResult,
                 $this->statusDetector,
                 $exception,
+                $overrideStatus,
             ),
             $this->adapter->getTestId($this->getCurrentTest()),
         );
diff --git a/src/Internal/TestLifecycleInterface.php b/src/Internal/TestLifecycleInterface.php
@@ -23,7 +23,11 @@ public function write(): TestLifecycleInterface;
 
     public function updateStatus(?string $message = null, ?Status $status = null): TestLifecycleInterface;
 
-    public function updateDetectedStatus(?string $message = null, ?Status $status = null): TestLifecycleInterface;
+    public function updateDetectedStatus(
+        ?string $message = null,
+        ?Status $status = null,
+        ?Status $overrideStatus = null,
+    ): TestLifecycleInterface;
 
     public function switchTo(string $test): TestLifecycleInterface;
 
diff --git a/src/Internal/TestUpdater.php b/src/Internal/TestUpdater.php
@@ -30,7 +30,7 @@ public function setInfo(TestResult $testResult, TestInfo $info): void
         $parser = $this->parseAnnotations($info);
 
         $testResult
-            ->setName($parser->getTitle() ?? $info->getName())
+            ->setName($parser->getDisplayName() ?? $info->getName())
             ->setFullName($info->getFullName())
             ->setDescriptionHtml($parser->getDescriptionHtml())
             ->setDescription($parser->getDescription())
@@ -122,10 +122,14 @@ public function setRunInfo(TestResult $testResult, TestRunInfo $runInfo): void
             ->setRerunOf($runInfo->getRerunOf());
     }
 
-    public function setDetectedStatus(TestResult $test, StatusDetectorInterface $statusDetector, Throwable $e): void
-    {
+    public function setDetectedStatus(
+        TestResult $test,
+        StatusDetectorInterface $statusDetector,
+        Throwable $e,
+        ?Status $overrideStatus = null,
+    ): void {
         $test
-            ->setStatus($statusDetector->getStatus($e))
+            ->setStatus($overrideStatus ?? $statusDetector->getStatus($e))
             ->setStatusDetails($statusDetector->getStatusDetails($e));
     }
 
diff --git a/src/Internal/TestUpdaterInterface.php b/src/Internal/TestUpdaterInterface.php
@@ -19,7 +19,12 @@ public function setInfo(TestResult $testResult, TestInfo $info): void;
 
     public function setRunInfo(TestResult $testResult, TestRunInfo $runInfo): void;
 
-    public function setDetectedStatus(TestResult $test, StatusDetectorInterface $statusDetector, Throwable $e): void;
+    public function setDetectedStatus(
+        TestResult $test,
+        StatusDetectorInterface $statusDetector,
+        Throwable $e,
+        ?Status $overrideStatus = null,
+    ): void;
 
     public function setStatus(TestResult $test, ?string $message = null, ?Status $status = null): void;
 }
diff --git a/test/report/Generate/Annotation/TitleClassLevelMixedTest.php b/test/report/Generate/Annotation/TitleClassLevelMixedTest.php
@@ -12,7 +12,7 @@
  * @Title ("This test has wrong title")
  */
 #[
-    Attribute\Title('Native class-level annotation overrides legacy one if both are used'),
+    Attribute\DisplayName('Native class-level annotation overrides legacy one if both are used'),
     Attribute\Epic('Annotations'),
     Attribute\Feature('Title'),
 ]
diff --git a/test/report/Generate/Annotation/TitleClassLevelNativeTest.php b/test/report/Generate/Annotation/TitleClassLevelNativeTest.php
@@ -8,7 +8,7 @@
 use Qameta\Allure\Attribute;
 
 #[
-    Attribute\Title('Test without title annotation uses class-level native title annotation'),
+    Attribute\DisplayName('Test without title annotation uses class-level native title annotation'),
     Attribute\Epic('Annotations'),
     Attribute\Feature('Title'),
 ]
diff --git a/test/report/Generate/Annotation/TitleTest.php b/test/report/Generate/Annotation/TitleTest.php
@@ -31,7 +31,7 @@ public function testLegacyTitleAnnotation(): void
         $this->expectNotToPerformAssertions();
     }
 
-    #[Attribute\Title('Native title annotation is reported as test title')]
+    #[Attribute\DisplayName('Native display name annotation is reported as test title')]
     public function testNativeTitleAnnotation(): void
     {
         $this->expectNotToPerformAssertions();
@@ -40,7 +40,7 @@ public function testNativeTitleAnnotation(): void
     /**
      * @Title ("This is wrong title for this test")
      */
-    #[Attribute\Title('Native title annotation overrides legacy one')]
+    #[Attribute\DisplayName('Native display name annotation overrides legacy one')]
     public function testMixedTitleAnnotation(): void
     {
         $this->expectNotToPerformAssertions();
diff --git a/test/report/Generate/AnnotationTest.php b/test/report/Generate/AnnotationTest.php
@@ -22,14 +22,14 @@ class AnnotationTest extends TestCase
     /**
      * @Description ("Legacy description with `markdown`", type = DescriptionType::MARKDOWN)
      */
-    #[Attribute\Title('Legacy description annotation is reported as test description')]
+    #[Attribute\DisplayName('Legacy description annotation is reported as test description')]
     public function testLegacyDescriptionAnnotation(): void
     {
         $this->expectNotToPerformAssertions();
     }
 
     #[
-        Attribute\Title('Native description annotation is reported as test description'),
+        Attribute\DisplayName('Native description annotation is reported as test description'),
         Attribute\Description('Test native description with `markdown`'),
     ]
     public function testNativeDescriptionAnnotation(): void
@@ -49,14 +49,14 @@ public function testMixedDescriptionAnnotation(): void
     /**
      * @Severity (level = SeverityLevel::MINOR)
      */
-    #[Attribute\Title('Legacy severity annotation is reported as test severity')]
+    #[Attribute\DisplayName('Legacy severity annotation is reported as test severity')]
     public function testLegacySeverityAnnotation(): void
     {
         $this->expectNotToPerformAssertions();
     }
 
     #[
-        Attribute\Title('Native severity annotation is reported as test severity'),
+        Attribute\DisplayName('Native severity annotation is reported as test severity'),
         Attribute\Severity(Attribute\Severity::CRITICAL),
     ]
     public function testNativeSeverityAnnotation(): void
@@ -68,7 +68,7 @@ public function testNativeSeverityAnnotation(): void
      * @Severity (level = SeverityLevel::MINOR)
      */
     #[
-        Attribute\Title('Legacy severity annotation overrides native one'),
+        Attribute\DisplayName('Legacy severity annotation overrides native one'),
         Attribute\Severity(Attribute\Severity::CRITICAL),
     ]
     public function testMixedSeverityAnnotation(): void
@@ -79,7 +79,7 @@ public function testMixedSeverityAnnotation(): void
     /**
      * @Parameter (name = "foo", value = "legacy foo")
      */
-    #[Attribute\Title('Legacy parameter')]
+    #[Attribute\DisplayName('Legacy parameter')]
     public function testLegacyParameterAnnotation(): void
     {
         $this->expectNotToPerformAssertions();
diff --git a/test/report/Generate/NegativeTest.php b/test/report/Generate/NegativeTest.php
@@ -6,70 +6,70 @@
 
 use PHPUnit\Framework\TestCase;
 use Qameta\Allure\Allure;
-use Qameta\Allure\Attribute\Title;
+use Qameta\Allure\Attribute\DisplayName;
 use Qameta\Allure\PHPUnit\ExceptionDetailsTrait;
 use RuntimeException;
 
 class NegativeTest extends TestCase
 {
     use ExceptionDetailsTrait;
 
-    #[Title('Test with failed assertion is reported as failed')]
+    #[DisplayName('Test with failed assertion is reported as failed')]
     public function testFailedWithoutSteps(): void
     {
         self::fail("Failure message");
     }
 
-    #[Title('Test with failed assertion in step is reported as failed')]
+    #[DisplayName('Test with failed assertion in step is reported as failed')]
     public function testFailedWithSteps(): void
     {
         Allure::addStep('Successful step');
         Allure::runStep(
-            #[Title('Failed step')]
+            #[DisplayName('Failed step')]
             function () {
                 self::fail('Failure message');
             }
         );
     }
 
-    #[Title('Test that throws exception is reported as failed')]
+    #[DisplayName('Test that throws exception is reported as failed')]
     public function testException(): void
     {
         throw new RuntimeException('Exception message');
     }
 
-    #[Title('Test that throws exception in step is reported as failed')]
+    #[DisplayName('Test that throws exception in step is reported as failed')]
     public function testExceptionWithSteps(): void
     {
         Allure::addStep('Successful step');
         Allure::runStep(
-            #[Title('Failed step')]
+            #[DisplayName('Failed step')]
             function () {
                 throw new RuntimeException('Exception message');
             }
         );
     }
 
-    #[Title('Test that emits warning is reported as broken')]
+    #[DisplayName('Test that emits warning is reported as broken')]
     public function testWarning(): void
     {
         /** @psalm-suppress InternalMethod */
         $this->addWarning('Warning message');
     }
 
-    #[Title('Skipped test is reported as skipped')]
+    #[DisplayName('Skipped test is reported as skipped')]
     public function testSkipped(): void
     {
         self::markTestSkipped('Skipped message');
     }
 
-    #[Title('Incomplete test is reported as broken')]
+    #[DisplayName('Incomplete test is reported as broken')]
     public function testIncomplete(): void
     {
         self::markTestIncomplete('Incomplete message');
     }
 
-    #[Title('Risky test is reported as failed')]
+    #[DisplayName('Risky test is reported as failed')]
     public function testRisky(): void
     {
         self::markAsRisky();
diff --git a/test/report/Generate/RetriesTest.php b/test/report/Generate/RetriesTest.php
@@ -7,7 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use Qameta\Allure\Allure;
 use Qameta\Allure\Attribute\Description;
-use Qameta\Allure\Attribute\Title;
+use Qameta\Allure\Attribute\DisplayName;
 use Qameta\Allure\PHPUnit\ExceptionDetailsTrait;
 
 class RetriesTest extends TestCase
@@ -19,13 +19,13 @@ class RetriesTest extends TestCase
      */
     private static array $runCounters = [];
 
-    #[Title('Reruns of successful test are reported correctly')]
+    #[DisplayName('Reruns of successful test are reported correctly')]
     public function testRerunsOfSuccessfulTest(): void
     {
         $this->expectNotToPerformAssertions();
     }
 
-    #[Title('Reruns of failed test are reported correctly')]
+    #[DisplayName('Reruns of failed test are reported correctly')]
     public function testRerunsOfFailedTest(): void
     {
         self::assertNotSame(1, $this->getRunIndex(__METHOD__));
@@ -35,7 +35,7 @@ public function testRerunsOfFailedTest(): void
      * @dataProvider providerData
      */
     #[
-        Title('Reruns of test with data provider are reported correctly'),
+        DisplayName('Reruns of test with data provider are reported correctly'),
         Description("Parameter `retry` has different value on each run but is excluded and doesn't have effect"),
     ]
     public function testRerunsOfTestWithDataProvider(string $firstValue, string $secondValue): void
diff --git a/test/unit/AllureExtensionTest.php b/test/unit/AllureExtensionTest.php
@@ -251,7 +251,11 @@ public function testExecuteAfterTestFailure_Constructed_SetsDetectedOrFailedStat
             ->expects(self::once())
             ->after('switch')
             ->method('updateDetectedStatus')
-            ->with(self::identicalTo('c'), self::identicalTo(Status::failed()));
+            ->with(
+                self::identicalTo('c'),
+                self::identicalTo(Status::failed()),
+                self::identicalTo(Status::failed()),
+            );
         $extension->executeAfterTestFailure('b', 'c', 1.2);
     }
 
@@ -274,7 +278,11 @@ public function testExecuteAfterTestError_Constructed_SetsDetectedOrFailedStatus
             ->expects(self::once())
             ->after('switch')
             ->method('updateDetectedStatus')
-            ->with(self::identicalTo('c'), self::identicalTo(Status::failed()));
+            ->with(
+                self::identicalTo('c'),
+                self::identicalTo(Status::broken()),
+                self::identicalTo(null),
+            );
         $extension->executeAfterTestError('b', 'c', 1.2);
     }
 
diff --git a/test/unit/TestTestLifecycle.php b/test/unit/TestTestLifecycle.php
@@ -35,8 +35,11 @@ public function switchTo(string $test): TestLifecycleInterface
         return $this;
     }
 
-    public function updateDetectedStatus(?string $message = null, ?Status $status = null): TestLifecycleInterface
-    {
+    public function updateDetectedStatus(
+        ?string $message = null,
+        ?Status $status = null,
+        ?Status $overrideStatus = null,
+    ): TestLifecycleInterface {
         return $this;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -100,15 +100,15 @@ public function executeAfterTestFailure(string $test, string $message, float $ti`
`100`	`100`	`$this`
`101`	`101`	`->testLifecycle`
`102`	`102`	`->switchTo($test)`
`103`		`- ->updateDetectedStatus($message, Status::failed());`
	`103`	`+ ->updateDetectedStatus($message, Status::failed(), Status::failed());`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`public function executeAfterTestError(string $test, string $message, float $time): void`
`107`	`107`	`{`
`108`	`108`	`$this`
`109`	`109`	`->testLifecycle`
`110`	`110`	`->switchTo($test)`
`111`		`- ->updateDetectedStatus($message, Status::failed());`
	`111`	`+ ->updateDetectedStatus($message, Status::broken());`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`public function executeAfterIncompleteTest(string $test, string $message, float $time): void`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`* @Title ("This test has wrong title")`
`13`	`13`	`*/`
`14`	`14`	`#[`
`15`		`- Attribute\Title('Native class-level annotation overrides legacy one if both are used'),`
	`15`	`+ Attribute\DisplayName('Native class-level annotation overrides legacy one if both are used'),`
`16`	`16`	`Attribute\Epic('Annotations'),`
`17`	`17`	`Attribute\Feature('Title'),`
`18`	`18`	`]`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`use Qameta\Allure\Attribute;`
`9`	`9`
`10`	`10`	`#[`
`11`		`- Attribute\Title('Test without title annotation uses class-level native title annotation'),`
	`11`	`+ Attribute\DisplayName('Test without title annotation uses class-level native title annotation'),`
`12`	`12`	`Attribute\Epic('Annotations'),`
`13`	`13`	`Attribute\Feature('Title'),`
`14`	`14`	`]`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function testLegacyTitleAnnotation(): void`
`31`	`31`	`$this->expectNotToPerformAssertions();`
`32`	`32`	`}`
`33`	`33`
`34`		`- #[Attribute\Title('Native title annotation is reported as test title')]`
	`34`	`+ #[Attribute\DisplayName('Native display name annotation is reported as test title')]`
`35`	`35`	`public function testNativeTitleAnnotation(): void`
`36`	`36`	`{`
`37`	`37`	`$this->expectNotToPerformAssertions();`
`@@ -40,7 +40,7 @@ public function testNativeTitleAnnotation(): void`
`40`	`40`	`/**`
`41`	`41`	`* @Title ("This is wrong title for this test")`
`42`	`42`	`*/`
`43`		`- #[Attribute\Title('Native title annotation overrides legacy one')]`
	`43`	`+ #[Attribute\DisplayName('Native display name annotation overrides legacy one')]`
`44`	`44`	`public function testMixedTitleAnnotation(): void`
`45`	`45`	`{`
`46`	`46`	`$this->expectNotToPerformAssertions();`