[MAINTENANCE] Adjustments in unit test classes (kitodo#1659)

Author: beatrycze-volk

Tests/Functional/Api/OaiPmhTest.php

@@ -45,6 +45,8 @@ class OaiPmhTest extends FunctionalTestCase
     /**
      * Sets up the test case environment.
      *
+     * @access public
+     *
      * @return void
      *
      * @access public
@@ -293,6 +295,10 @@ public function canListAndResumeIdentifiers()
     /**
      * Parses a UTC date string into a DateTime object.
      *
+     * @access protected
+     *
+     * @static
+     *
      * @param string $dateTime The date string in UTC format (e.g., '2023-10-01T12:00:00Z')
      *
      * @return DateTime|false Returns a DateTime object or false on failure
@@ -309,6 +315,10 @@ protected static function parseUtc(string $dateTime): DateTime|false
     /**
      * Asserts that a given date string is a valid UTC date string.
      *
+     * @access protected
+     *
+     * @static
+     *
      * @param string $dateTime The date string to check
      *
      * @return void
@@ -325,6 +335,10 @@ protected static function assertUtcDateString(string $dateTime): void
     /**
      * Asserts that a given date string is in the future.
      *
+     * @access protected
+     *
+     * @static
+     *
      * @param string $dateTime The date string to check
      *
      * @return void

Tests/Functional/Api/PageViewProxyDisabledTest.php

@@ -23,6 +23,8 @@ class PageViewProxyDisabledTest extends FunctionalTestCase
     /**
      * Query the page view proxy with the given parameters.
      *
+     * @access protected
+     *
      * @param array $query The query parameters to send
      * @param string $method The HTTP method to use (default: 'GET')
      *

Tests/Functional/Api/PageViewProxyTest.php

@@ -26,6 +26,8 @@ class PageViewProxyTest extends FunctionalTestCase
      * This configuration is loaded from a .env file in the test directory.
      * It includes general settings, file groups, and Solr settings.
      *
+     * @access protected
+     *
      * @return array The DLF configuration
      *
      * @access protected
@@ -42,6 +44,8 @@ protected function getDlfConfiguration(): array
     /**
      * Query the page view proxy with the given parameters.
      *
+     * @access protected
+     *
      * @param array $query The query parameters to send
      * @param string $method The HTTP method to use (default: 'GET')
      *

Tests/Functional/FunctionalTestCase.php

@@ -108,6 +108,8 @@ public function __construct()
     /**
      * Sets up the test case environment.
      *
+     * @access public
+     *
      * @return void
      *
      * @access public
@@ -133,6 +135,8 @@ public function setUp(): void
      * This configuration is loaded from a .env file in the test directory.
      * It includes general settings, file groups, and Solr settings.
      *
+     * @access protected
+     *
      * @return array The DLF configuration
      *
      * @access protected
@@ -197,6 +201,8 @@ protected function getDlfConfiguration(): array
      * The configuration is loaded from a YAML file and includes
      * the base URL and language settings.
      *
+     * @access protected
+     *
      * @param string $identifier The identifier for the site configuration
      *
      * @return void
@@ -251,6 +257,8 @@ protected function initializeRepository(string $className, int $storagePid): Rep
      * This method reads a JSON file containing an array of documents,
      * creates Solr documents from them, and adds them to the Solr index.
      *
+     * @access protected
+     *
      * @param Solr $solr The Solr instance to import documents into
      * @param string $path The path to the JSON file containing the documents
      *
@@ -285,6 +293,8 @@ protected function importSolrDocuments(Solr $solr, string $path): void
      * which is then used by the LanguageServiceFactory to load the language
      * in backend mode.
      *
+     * @access protected
+     *
      * @param string $locale The locale to set for the backend user
      *
      * @return void
@@ -356,6 +366,10 @@ protected function setUpSolr(int $uid, int $storagePid, array $solrFixtures): So
     /**
      * Assert that $sub is recursively contained within $super.
      *
+     * @access protected
+     *
+     * @static
+     *
      * @param array $sub
      * @param array $super
      * @param string $message

Tests/Unit/Common/HelperTest.php

@@ -29,13 +29,20 @@ class HelperTest extends UnitTestCase
     /**
      * @var LogManager|MockObject
      */
-    protected $logManagerMock;
+    protected LogManager|MockObject $logManagerMock;
 
     /**
      * @var Logger|MockObject
      */
-    protected $loggerMock;
+    protected Logger|MockObject $loggerMock;
 
+    /**
+     * Sets up the test environment.
+     *
+     * @access protected
+     *
+     * @return void
+     */
     protected function setUp(): void
     {
         parent::setUp();
@@ -50,16 +57,32 @@ protected function setUp(): void
         GeneralUtility::setSingletonInstance(LogManager::class, $this->logManagerMock);
     }
 
+    /**
+     * Cleans up the test environment.
+     *
+     * @access protected
+     *
+     * @return void
+     */
     protected function tearDown(): void
     {
         GeneralUtility::purgeInstances();
         parent::tearDown();
     }
 
-    public function assertInvalidXml($xml)
+    /**
+     * Asserts that the given XML is invalid.
+     *
+     * @access private
+     *
+     * @param mixed $xml The XML to check
+     *
+     * @return void
+     */
+    private static function assertInvalidXml(mixed $xml): void
     {
         $result = Helper::getXmlFileAsString($xml);
-        self::assertEquals(false, $result);
+        self::assertFalse($result);
     }
 
     /**
@@ -115,22 +138,19 @@ public function filterFilesByMimeTypeHandlesInvalidInput(): void
         // Empty categories and types
         self::assertFalse(Helper::filterFilesByMimeType(
             ['mimetype' => 'image/jpeg'],
-            [],
-            null
+            []
         ));
 
         // Invalid file input
         self::assertFalse(Helper::filterFilesByMimeType(
             null,
-            ['image'],
-            null
+            ['image']
         ));
 
         // Missing mime type key
         self::assertFalse(Helper::filterFilesByMimeType(
             ['wrong_key' => 'image/jpeg'],
-            ['image'],
-            null
+            ['image']
         ));
     }
 

Tests/Unit/Format/AudioVideoMDTest.php

@@ -17,7 +17,7 @@
 
 class AudioVideoMDTest extends UnitTestCase
 {
-    protected $metadata = [];
+    protected array $metadata = [];
 
     public function setUp(): void
     {

Tests/Unit/Format/ModsTest.php

@@ -17,7 +17,7 @@
 
 class ModsTest extends UnitTestCase
 {
-    protected $metadata = [];
+    protected array $metadata = [];
 
     public function setUp(): void
     {

Tests/Unit/Format/TeiHeaderTest.php

@@ -16,7 +16,7 @@
 
 class TeiHeaderTest extends UnitTestCase
 {
-    protected $metadata = [];
+    protected array $metadata = [];
 
     public function setUp(): void
     {

Tests/Unit/Validation/DOMDocumentValidationStackTest.php

@@ -30,6 +30,13 @@
  */
 class DOMDocumentValidationStackTest extends UnitTestCase
 {
+    /**
+     * Sets up the test case environment.
+     *
+     * @access public
+     *
+     * @return void
+     */
     public function setUp(): void
     {
         parent::setUp();

Tests/Unit/Validation/DocumentValidatorTest.php

@@ -17,6 +17,13 @@
 
 class DocumentValidatorTest extends UnitTestCase
 {
+    /**
+     * Sets up the test case environment.
+     *
+     * @access public
+     *
+     * @return void
+     */
     public function setUp(): void
     {
         parent::setUp();
@@ -125,13 +132,29 @@ public function notPassesHasCorrectPhysicalStructure()
         self::assertFalse($documentValidator->hasCorrectPhysicalStructure());
     }
 
+    /**
+     * Returns an array of required metadata fields for validation.
+     *
+     * @access private
+     *
+     * @return array The required metadata fields.
+     */
     private function getRequiredMetadataFields(): array
     {
         return [
             'record_id'
         ];
     }
 
+    /**
+     * Loads an XML file from the fixtures directory and returns it as a SimpleXMLElement.
+     *
+     * @access private
+     *
+     * @param string $file The name of the XML file to load.
+     *
+     * @return SimpleXMLElement The loaded XML as a SimpleXMLElement object.
+     */
     private function getXml(string $file): SimpleXMLElement
     {
         $xml = simplexml_load_file(__DIR__ . '/../../Fixtures/MetsDocument/' . $file);