Reintroduce code coverage report

DigitalTimK · DigitalTimK · commit 529974539e5f · 2024-03-03T08:26:27.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 composer.phar
 /vendor/
+/var/
 composer.lock
 .DS_Store
 
@@ -13,5 +14,4 @@ composer.lock
 # PHP CS Fixer cache file
 .php-cs-fixer.cache
 
-.phpunit.result.cache
-coverage/
+.phpunit.result.cache
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -48,6 +48,8 @@
     ->in(__DIR__ . '/tests')
 ;
 
+// see rules: https://mlocati.github.io/php-cs-fixer-configurator/#version:3.8
+
 $config = new Config();
 $config
     ->setRiskyAllowed(true)
@@ -62,8 +64,13 @@
         'single_quote'                     => true,
         'mb_str_functions'                 => true,
         'array_syntax'                     => ['syntax' => 'short'],
-        'binary_operator_spaces'           => ['operators' => ['=>' => 'align_single_space_minimal', '=' => 'align_single_space_minimal'],
+        'binary_operator_spaces'           => [
+            'operators' => [
+                '=>' => 'align_single_space_minimal',
+                '='  => 'align_single_space_minimal',
+            ],
         ],
+        'php_unit_test_class_requires_covers' => false,
     ])
     ->setFinder($finder)
 ;
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ For every implemented feature add unit tests and check all is green by running t
 
 ```bash
 # using an alias
-$ composer test
+$ composer code-test
 
 # or the same w/o alias
 ./vendor/bin/phpunit
@@ -67,11 +67,21 @@ To run a single test
 
 ```bash
 # using an alias
-$ composer test -- --filter BigBlueButtonTest::testApiVersion
+$ composer code-test -- --filter BigBlueButtonTest::testApiVersion
 
 # or the same w/o alias
 ./vendor/bin/phpunit --filter BigBlueButtonTest::testApiVersion
 ```
+A code-coverage report will be created along with the tests. This report will be stored in:
+````
+./var/coverage/
+````
+In case of trouble with the creation of the code-coverage report (e.g. local environment does not fulfill requirements) 
+the creation can be skipped with:
+```bash
+# using an alias
+$ composer code-test -- --no-coverage
+```
 
 **Remark:**
 
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
     "bbb",
     "api"
   ],
-  "homepage": "http://bigbluebutton.org/",
+  "homepage": "https://bigbluebutton.org/",
   "license": "LGPL-3.0-or-later",
   "authors": [
     {
@@ -42,12 +42,12 @@
     "wapmorgan/php-deprecation-detector": "^2.0.33",
     "phpstan/phpstan": "^1.10",
     "tracy/tracy": "^2.10",
-    "vlucas/phpdotenv": "^5.6"
+    "vlucas/phpdotenv": "^5.6",
+    "phpunit/php-code-coverage": "9.2.30"
   },
   "scripts": {
     "code-check": "./vendor/bin/phpstan analyse",
-    "test": "./vendor/bin/phpunit",
-    "test-cov": "XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html coverage",
+    "code-test": "./vendor/bin/phpunit",
     "cs-fix": "PHP_CS_FIXER_IGNORE_ENV=1 ./vendor/bin/php-cs-fixer fix --allow-risky yes",
     "sniffer": "./vendor/bin/phpcs src/",
     "phploc": "./vendor/bin/phploc src/",
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,16 +1,33 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" backupGlobals="false" backupStaticAttributes="false" bootstrap="./tests/bootstrap.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+        bootstrap="./tests/bootstrap.php"
+        backupGlobals="false"
+        backupStaticAttributes="false"
+        colors="true"
+        convertErrorsToExceptions="true"
+        convertNoticesToExceptions="true"
+        convertWarningsToExceptions="true"
+        convertDeprecationsToExceptions="true"
+        processIsolation="false"
+        stopOnFailure="false"
+        verbose="true"
+>
   <coverage processUncoveredFiles="true">
     <include>
-      <directory suffix=".php">./src/</directory>
+      <directory suffix=".php">src</directory>
     </include>
+    <report>
+      <html outputDirectory="./var/coverage/" />
+    </report>
   </coverage>
   <php>
     <env name="XDEBUG_MODE" value="coverage"/>
   </php>
   <testsuites>
     <testsuite name="BigBlueButton test suite">
-      <directory>./tests/</directory>
+      <directory>tests</directory>
     </testsuite>
   </testsuites>
 </phpunit>
diff --git a/src/Util/ParamsIterator.php b/src/Util/ParamsIterator.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class ParamsIterator extends TestCase
 {
diff --git a/tests/BigBlueButtonTest.php b/tests/BigBlueButtonTest.php
@@ -35,8 +35,6 @@
  * Class BigBlueButtonTest.
  *
  * @internal
- *
- * @coversNothing
  */
 class BigBlueButtonTest extends TestCase
 {
diff --git a/tests/Parameters/CreateMeetingParametersTest.php b/tests/Parameters/CreateMeetingParametersTest.php
@@ -27,7 +27,7 @@
  *
  * @internal
  *
- * @coversNothing
+ *
  */
 class CreateMeetingParametersTest extends TestCase
 {
diff --git a/tests/Parameters/DeleteRecordingsParametersTest.php b/tests/Parameters/DeleteRecordingsParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class DeleteRecordingsParametersTest extends TestCase
 {
diff --git a/tests/Parameters/EndMeetingParametersTest.php b/tests/Parameters/EndMeetingParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class EndMeetingParametersTest extends TestCase
 {
diff --git a/tests/Parameters/GetMeetingInfoParametersTest.php b/tests/Parameters/GetMeetingInfoParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class GetMeetingInfoParametersTest extends TestCase
 {
diff --git a/tests/Parameters/GetRecordingTextTracksParametersTest.php b/tests/Parameters/GetRecordingTextTracksParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class GetRecordingTextTracksParametersTest extends TestCase
 {
diff --git a/tests/Parameters/GetRecordingsParametersTest.php b/tests/Parameters/GetRecordingsParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class GetRecordingsParametersTest extends TestCase
 {
diff --git a/tests/Parameters/HooksCreateParametersTest.php b/tests/Parameters/HooksCreateParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class HooksCreateParametersTest extends TestCase
 {
diff --git a/tests/Parameters/HooksDestroyParametersTest.php b/tests/Parameters/HooksDestroyParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class HooksDestroyParametersTest extends TestCase
 {
diff --git a/tests/Parameters/InsertDocumentParametersTest.php b/tests/Parameters/InsertDocumentParametersTest.php
@@ -27,7 +27,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 final class InsertDocumentParametersTest extends TestCase
 {
diff --git a/tests/Parameters/IsMeetingRunningParametersTest.php b/tests/Parameters/IsMeetingRunningParametersTest.php
@@ -27,7 +27,7 @@
  *
  * @internal
  *
- * @coversNothing
+ *
  */
 class IsMeetingRunningParametersTest extends TestCase
 {
diff --git a/tests/Parameters/JoinMeetingParametersTest.php b/tests/Parameters/JoinMeetingParametersTest.php
@@ -27,7 +27,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class JoinMeetingParametersTest extends TestCase
 {
diff --git a/tests/Parameters/PublishRecordingsParametersTest.php b/tests/Parameters/PublishRecordingsParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class PublishRecordingsParametersTest extends TestCase
 {
diff --git a/tests/Parameters/PutRecordingTextTrackParametersTest.php b/tests/Parameters/PutRecordingTextTrackParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class PutRecordingTextTrackParametersTest extends TestCase
 {
diff --git a/tests/Parameters/UpdateRecordingsParametersTest.php b/tests/Parameters/UpdateRecordingsParametersTest.php
@@ -25,7 +25,7 @@
 /**
  * @internal
  *
- * @coversNothing
+ *
  */
 class UpdateRecordingsParametersTest extends TestCase
 {
diff --git a/tests/Responses/CreateMeetingResponseTest.php b/tests/Responses/CreateMeetingResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class CreateMeetingResponseTest extends TestCase
 {
diff --git a/tests/Responses/DeleteRecordingsResponseTest.php b/tests/Responses/DeleteRecordingsResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class DeleteRecordingsResponseTest extends TestCase
 {
diff --git a/tests/Responses/EndMeetingResponseTest.php b/tests/Responses/EndMeetingResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class EndMeetingResponseTest extends TestCase
 {
diff --git a/tests/Responses/GetMeetingInfoResponseTest.php b/tests/Responses/GetMeetingInfoResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class GetMeetingInfoResponseTest extends TestCase
 {
diff --git a/tests/Responses/GetMeetingsResponseTest.php b/tests/Responses/GetMeetingsResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class GetMeetingsResponseTest extends TestCase
 {
diff --git a/tests/Responses/GetRecordingsResponseTest.php b/tests/Responses/GetRecordingsResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class GetRecordingsResponseTest extends TestCase
 {
diff --git a/tests/Responses/GetRecordingsTextTracksResponseTest.php b/tests/Responses/GetRecordingsTextTracksResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class GetRecordingsTextTracksResponseTest extends TestCase
 {
diff --git a/tests/Responses/HooksCreateResponseTest.php b/tests/Responses/HooksCreateResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class HooksCreateResponseTest extends TestCase
 {
diff --git a/tests/Responses/HooksDestroyResponseTest.php b/tests/Responses/HooksDestroyResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class HooksDestroyResponseTest extends TestCase
 {
diff --git a/tests/Responses/HooksListResponseTest.php b/tests/Responses/HooksListResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class HooksListResponseTest extends TestCase
 {
diff --git a/tests/Responses/InsertDocumentResponseTest.php b/tests/Responses/InsertDocumentResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class InsertDocumentResponseTest extends TestCase
 {
diff --git a/tests/Responses/IsMeetingRunningResponseTest.php b/tests/Responses/IsMeetingRunningResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class IsMeetingRunningResponseTest extends TestCase
 {
diff --git a/tests/Responses/JoinMeetingResponseTest.php b/tests/Responses/JoinMeetingResponseTest.php
@@ -24,8 +24,6 @@
 
 /**
  * @internal
- *
- * @coversNothing
  */
 class JoinMeetingResponseTest extends TestCase
 {
diff --git a/tests/Responses/PublishRecordingsResponseTest.php b/tests/Responses/PublishRecordingsResponseTest.php
diff --git a/tests/Responses/UpdateRecordingsResponseTest.php b/tests/Responses/UpdateRecordingsResponseTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,6 @@`
`24`	`24`
`25`	`25`	`/**`
`26`	`26`	`* @internal`
`27`		`- *`
`28`		`- * @coversNothing`
`29`	`27`	`*/`
`30`	`28`	`class ParamsIterator extends TestCase`
`31`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,6 @@`
`35`	`35`	`* Class BigBlueButtonTest.`
`36`	`36`	`*`
`37`	`37`	`* @internal`
`38`		`- *`
`39`		`- * @coversNothing`
`40`	`38`	`*/`
`41`	`39`	`class BigBlueButtonTest extends TestCase`
`42`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`*`
`28`	`28`	`* @internal`
`29`	`29`	`*`
`30`		`- * @coversNothing`
	`30`	`+ *`
`31`	`31`	`*/`
`32`	`32`	`class CreateMeetingParametersTest extends TestCase`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`/**`
`26`	`26`	`* @internal`
`27`	`27`	`*`
`28`		`- * @coversNothing`
	`28`	`+ *`
`29`	`29`	`*/`
`30`	`30`	`class DeleteRecordingsParametersTest extends TestCase`
`31`	`31`	`{`