From 36cce3cf3fb4952ce6013a97aa7395e959cf7876 Mon Sep 17 00:00:00 2001
From: Jens Schuppe <schuppe@systopia.de>
Date: Wed, 3 Jul 2024 14:52:45 +0200
Subject: [PATCH] [#135] Update PHPUnit Tests to specify covers attribute and
 convert phpunit xml dist to be phpunit9 supported

---
 phpunit.xml.dist                              | 34 +++++++------------
 .../api/v4/EckEntity/EckEntityTest.php        | 12 +++++++
 2 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
index d1b677c..9afb059 100644
--- a/phpunit.xml.dist
+++ b/phpunit.xml.dist
@@ -1,33 +1,25 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
-         colors="true"
-         failOnRisky="true"
-         failOnWarning="true"
-         forceCoversAnnotation="true"
-         bootstrap="tests/phpunit/bootstrap.php">
-
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" colors="true" failOnRisky="true" failOnWarning="true" forceCoversAnnotation="true" bootstrap="tests/phpunit/bootstrap.php">
+  <coverage>
+    <include>
+      <directory suffix=".php">api</directory>
+      <directory suffix=".php">CRM</directory>
+      <directory suffix=".php">Civi</directory>
+    </include>
+    <exclude>
+      <directory>CRM/*/DAO</directory>
+      <directory suffix="Base.php">CRM/*/Upgrader</directory>
+    </exclude>
+  </coverage>
   <php>
-    <ini name="error_reporting" value="-1" />
+    <ini name="error_reporting" value="-1"/>
     <env name="SYMFONY_DEPRECATIONS_HELPER" value="max[direct]=0&amp;baselineFile=./tests/ignored-deprecations.json"/>
   </php>
-
   <testsuites>
     <testsuite name="Extension Test Suite">
       <directory>./tests/phpunit</directory>
     </testsuite>
   </testsuites>
-  <filter>
-    <whitelist>
-      <directory suffix=".php">api</directory>
-      <directory suffix=".php">CRM</directory>
-      <directory suffix=".php">Civi</directory>
-      <exclude>
-        <directory>CRM/*/DAO</directory>
-        <directory suffix="Base.php">CRM/*/Upgrader</directory>
-      </exclude>
-    </whitelist>
-  </filter>
   <listeners>
     <listener class="Civi\Test\CiviTestListener">
       <arguments/>
diff --git a/tests/phpunit/api/v4/EckEntity/EckEntityTest.php b/tests/phpunit/api/v4/EckEntity/EckEntityTest.php
index a3598d1..470a5af 100644
--- a/tests/phpunit/api/v4/EckEntity/EckEntityTest.php
+++ b/tests/phpunit/api/v4/EckEntity/EckEntityTest.php
@@ -21,6 +21,9 @@ public function setUpHeadless(): CiviEnvBuilder {
       ->apply();
   }
 
+  /**
+   * @covers \Civi\Api4\EckEntityType::create
+   */
   public function testCreateEntityType():void {
     $entityType = EckEntityType::create(FALSE)
       ->addValue('label', 'Test One Type')
@@ -77,6 +80,9 @@ public function testCreateEntityType():void {
     self::assertArrayNotHasKey('Eck_Test_One_Type', $extends['options']);
   }
 
+  /**
+   * @covers \Civi\Api4\EckEntityType::update
+   */
   public function testRenameEntityType():void {
     $entityType = EckEntityType::create(FALSE)
       ->addValue('label', 'Test Two Type')
@@ -110,6 +116,9 @@ public function testRenameEntityType():void {
     self::assertStringContainsString('not allowed', $e->getMessage());
   }
 
+  /**
+   * @covers \Civi\Api4\EckEntityType::get
+   */
   public function testTwoEntityTypes(): void {
     $firstEntity = $this->createEntity(['one' => 'One', 'two' => 'Two']);
     $secondEntity = $this->createEntity(['one' => 'One', 'three' => 'Three']);
@@ -191,6 +200,9 @@ public function testTwoEntityTypes(): void {
     self::assertEquals('three', $secondRecords[1]['subtype:name']);
   }
 
+  /**
+   * @covers \Civi\Api4\EckEntityType::get
+   */
   public function testEntityCustomFields(): void {
     $entityName = $this->createEntity(['one' => 'One', 'two' => 'Two']);