added option to suppress warning about no performed assertions in a t…

…est method/test case

this closes #54

CHANGELOG.md

@@ -7,6 +7,7 @@ Version 8.0.0-dev
 - InfoExtension (when added to automated tests runner) prints active extensions
 - BC break: added method getSubscribedEvents to interface IResultsFormatter, removed methods report* (it is now an event subscriber)
 - data providers can now also return iterable objects not just arrays
+- added option to suppress warning about no performed assertions in a test method/test case
 
 Version 7.3.1
 - allowed installation konecnyjakub/event-dispatcher 2

README.md

@@ -208,7 +208,22 @@ final class Tests extends MyTester\TestCase
 ```
 #### Tests without assertions
 
-By default, if a test method performs no assertions, it is reported as passed with warnings. If you do not set a different results formatter (see below), it will print a warning `Method name passed with warning: No assertions were performed.`.
+By default, if a test method performs no assertions, it is reported as passed with warnings. If you do not set a different results formatter (see below), it will print a warning `Method name passed with warning: No assertions were performed.`. It is possible to suppress that warning by adding attribute NoAssertions on a test method or the whole class, then it is reported as passed (assuming there are no other issues). Example:
+
+```php
+<?php
+declare(strict_types=1);
+
+use MyTester\Attributes\NoAssertions;
+
+final class Tests extends MyTester\TestCase
+{
+    #[NoAssertions]
+    public function testNoAssertions(): void
+    {
+    }
+}
+```
 
 #### Unexpected errors/exceptions
 

RELEASE_NOTES

@@ -1,4 +1,4 @@
-A new version of My Tester is out. It is only for Composer 2.2 or later. It removes previously deprecated stuff. Data providers can now also return iterable objects not just arrays.
+A new version of My Tester is out. It is only for Composer 2.2 or later. It removes previously deprecated stuff. Data providers can now also return iterable objects not just arrays. It is possible to suppress warnings about no performed assertion on a test method/test case with attribute NoAssertions.
 
 Interface ITesterExtension was changed - it has new method getName and was changed into an event subscriber.
 

src/Attributes/NoAssertions.php

@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace MyTester\Attributes;
+
+use Attribute;
+
+/**
+ * No assertions attribute
+ *
+ * Suppresses a warning about no performed assertions in a test
+ *
+ * @author Jakub Konečný
+ */
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+final class NoAssertions
+{
+}

src/TestCase.php

@@ -27,6 +27,8 @@ abstract class TestCase
     public const string ANNOTATION_TEST_SUITE = "testSuite";
     /** @internal */
     public const string ANNOTATION_IGNORE_DEPRECATIONS = "ignoreDeprecations";
+    /** @internal */
+    public const string ANNOTATION_NO_ASSERTIONS = "noAssertions";
 
     protected ISkipChecker $skipChecker;
     protected IDataProvider $dataProvider;
@@ -68,16 +70,22 @@ function (ReflectionMethod $rm) {
 
     /**
      * Get list of callbacks that should be called after a job finishes
-     * Has to be the same for every job
      *
      * @return callable[]
      */
-    protected function getJobAfterExecuteCallbacks(): array
+    protected function getJobAfterExecuteCallbacks(string $methodName): array
     {
         return [
-            function (Job $job): void {
+            function (Job $job) use ($methodName): void {
                 $job->totalAssertions = $this->getCounter();
-                if ($job->totalAssertions === 0) {
+                $checkAssertions =
+                    !$this->annotationsReader->hasAnnotation(static::ANNOTATION_NO_ASSERTIONS, static::class) &&
+                    !$this->annotationsReader->hasAnnotation(
+                        static::ANNOTATION_NO_ASSERTIONS,
+                        static::class,
+                        $methodName
+                    );
+                if ($checkAssertions && $job->totalAssertions === 0) {
                     echo "Warning: No assertions were performed.\n";
                 }
             },
@@ -115,7 +123,7 @@ protected function getJobs(): array
                     "callback" => $callback,
                     "params" => [],
                     "skip" => $this->skipChecker->shouldSkip(static::class, $method),
-                    "onAfterExecute" => $this->getJobAfterExecuteCallbacks(),
+                    "onAfterExecute" => $this->getJobAfterExecuteCallbacks($method),
                     "dataSetName" => "",
                     "reportDeprecations" => $this->shouldReportDeprecations($method),
                 ];

tests/TestCaseTest.php

@@ -5,6 +5,7 @@
 
 use MyTester\Attributes\DataProvider as DataProviderAttribute;
 use MyTester\Attributes\IgnoreDeprecations;
+use MyTester\Attributes\NoAssertions;
 use MyTester\Attributes\RequiresOsFamily;
 use MyTester\Attributes\RequiresPhpExtension;
 use MyTester\Attributes\RequiresPhpVersion;
@@ -161,6 +162,7 @@ public function testSkipOsFamily(): void
     }
 
     #[Test("No assertions")]
+    #[NoAssertions]
     public function testNoAssertions(): void
     {
     }