Increase and add dev dependencies

d-s-codappix · d-s-codappix · commit bea021117f2d · 2025-10-20T09:59:14.000+02:00
This mostly involved PHPStan and pushes us to fix some PHPStan findings.
diff --git a/.gitattributes b/.gitattributes
@@ -6,6 +6,7 @@ Tests export-ignore
 
 .php-cs-fixer.dist.php export-ignore
 phpstan.neon export-ignore
+phpstan-baseline.neon export-ignore
 phpunit.xml.dist export-ignore
 
 shell.nix export-ignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,9 @@
   They modified `@internal` API and it is the fault of this package to use the API.
   We therefore now move to low level public API of doctrine/dbal instead of TYPO3 internal API.
   We also encapsulate the access to those APIs for easier maintenance.
+  We also raise dev dependencies to have automated CI verification that we do not use internal APIs anymore.
+- Proper errors if a record was found in DB, but not within assertions.
+- Do not include `phpstan-baseline.neon` in git exports / distribution.
 
 ### BREAKING
 
diff --git a/Classes/Command/ConvertFromCsv.php b/Classes/Command/ConvertFromCsv.php
@@ -55,7 +55,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $converter = new Csv();
-        foreach ($files as $file) {
+        foreach ($files as $index => $file) {
+            if (is_string($file) === false) {
+                $output->writeln(sprintf('File at index "%s" needs to be a string.', $index));
+                return Command::INVALID;
+            }
+
             try {
                 $converter->convert(realpath($file) ?: $file);
             } catch (\Exception $e) {
diff --git a/Classes/Command/ConvertFromXml.php b/Classes/Command/ConvertFromXml.php
@@ -55,7 +55,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $converter = new Xml();
-        foreach ($files as $file) {
+        foreach ($files as $index => $file) {
+            if (is_string($file) === false) {
+                $output->writeln(sprintf('File at index "%s" needs to be a string.', $index));
+                return Command::INVALID;
+            }
+
             try {
                 $converter->convert(realpath($file) ?: $file);
             } catch (\Exception $e) {
diff --git a/Classes/Connection.php b/Classes/Connection.php
@@ -23,6 +23,7 @@
 
 namespace Codappix\Typo3PhpDatasets;
 
+use Doctrine\DBAL\ParameterType;
 use TYPO3\CMS\Core\Database\Connection as Typo3Connection;
 
 /**
@@ -35,6 +36,10 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @param string[] $record
+     * @param ParameterType[] $types
+     */
     public function insert(string $tableName, array $record, array $types): void
     {
         $this->typo3Connection->insert($tableName, $record, $types);
@@ -44,7 +49,10 @@ public function getTable(string $tableName): Table
     {
         foreach ($this->typo3Connection->createSchemaManager()->listTables() as $table) {
             if ($table->getObjectName()->toString() === $tableName) {
-                return new Table($table);
+                return new Table(
+                    $tableName,
+                    $table
+                );
             }
         }
 
diff --git a/Classes/Converter/Xml.php b/Classes/Converter/Xml.php
@@ -24,7 +24,6 @@
 namespace Codappix\Typo3PhpDatasets\Converter;
 
 use InvalidArgumentException;
-use SimpleXMLElement;
 use SplFileObject;
 
 class Xml implements Converter
@@ -71,16 +70,8 @@ private function buildContent(string $xmlContent): string
             throw new \Exception('Could not parse XML content.', 1681287859);
         }
         foreach ($xml->children() as $table) {
-            if (!$table instanceof SimpleXMLElement) {
-                continue;
-            }
-
             $insertArray = [];
             foreach ($table->children() as $column) {
-                if (!$column instanceof SimpleXMLElement) {
-                    continue;
-                }
-
                 $columnName = $column->getName();
                 $columnValue = (string)$table->$columnName;
 
diff --git a/Classes/PhpDataSet.php b/Classes/PhpDataSet.php
@@ -30,6 +30,7 @@ class PhpDataSet
 {
     /**
      * @api
+     * @param array<string, array<string, string>[]> $dataSet
      */
     public function import(array $dataSet): void
     {
diff --git a/Classes/Table.php b/Classes/Table.php
@@ -33,6 +33,7 @@
 final readonly class Table
 {
     public function __construct(
+        private string $tableName,
         private DbalTable $dbalTable,
     ) {
     }
@@ -49,7 +50,7 @@ public function getTypeForColumn(string $columnName): ParameterType
             throw new \RuntimeException(sprintf(
                 'Column "%s" does not exist in table: %s',
                 $columnName,
-                $this->dbalTable->getName(),
+                $this->tableName,
             ), 1760941225);
         }
     }
diff --git a/Classes/TestingFramework.php b/Classes/TestingFramework.php
@@ -36,9 +36,7 @@ trait TestingFramework
      */
     protected function importPHPDataSet(string $filePath): void
     {
-        $this->ensureFileExists($filePath);
-
-        $dataSet = include $filePath;
+        $dataSet = $this->getDataSet($filePath);
         try {
             (new PhpDataSet())->import($dataSet);
         } catch (Exception $e) {
@@ -52,57 +50,106 @@ protected function importPHPDataSet(string $filePath): void
      */
     protected function assertPHPDataSet(string $filePath): void
     {
-        $this->ensureFileExists($filePath);
+        if (is_array($GLOBALS['TCA'] ?? null) === false) {
+            throw new \RuntimeException('TYPO3 GLOBALS["TCA"] is not defined.', 1760942400);
+        }
 
-        $dataSet = include $filePath;
         $failMessages = [];
-
-        foreach ($dataSet as $tableName => $expectedRecords) {
+        foreach ($this->getDataSet($filePath) as $tableName => $expectedRecords) {
             $records = $this->getAllRecords($tableName, (isset($GLOBALS['TCA'][$tableName])));
 
             foreach ($expectedRecords as $assertion) {
                 $result = $this->assertInRecords($assertion, $records);
                 if ($result === false) {
-                    // Handle error
-                    if (isset($assertion['uid']) && empty($records[$assertion['uid']])) {
-                        $failMessages[] = 'Record "' . $tableName . ':' . $assertion['uid'] . '" not found in database';
-                        continue;
-                    }
-                    if (isset($assertion['uid'])) {
-                        $recordIdentifier = $tableName . ':' . $assertion['uid'];
-                        $additionalInformation = $this->renderRecords($assertion, $records[$assertion['uid']]);
-                    } else {
-                        $recordIdentifier = $tableName;
-                        $additionalInformation = $this->arrayToString($assertion);
-                    }
-
-                    $failMessages[] = 'Assertion in data-set failed for "' . $recordIdentifier . '":' . PHP_EOL . $additionalInformation;
+                    $failMessages[] = $this->getAssertionErrorMessageForNoneMatchingRecord($assertion, $records, $tableName);
                     continue;
                 }
 
-                // Unset asserted record
+                // Unset already asserted record to only keep unexpected records.
                 unset($records[$result]);
+
                 // Increase assertion counter
-                self::assertTrue($result !== false);
+                self::assertTrue(true);
             }
 
-            if (!empty($records)) {
-                foreach ($records as $record) {
-                    $recordIdentifier = $tableName . ':' . ($record['uid'] ?? '');
-                    $failMessages[] = 'Not asserted record found for "' . $recordIdentifier . '".';
+            foreach ($records as $record) {
+                if (is_array($record) === false) {
+                    throw new \RuntimeException('Something went horribly wrong while fetching records, record was not an array.', 1760943536);
                 }
+
+                $failMessages[] = $this->getAssertionErrorMessageForUnexpectedRecord($record, $tableName);
             }
         }
 
+        $failMessages = array_filter($failMessages);
+
         if (!empty($failMessages)) {
             self::fail(implode(PHP_EOL, $failMessages));
         }
     }
 
+    /**
+     * @return array<string, array<string, string>[]>
+     */
+    private function getDataSet(string $filePath): array
+    {
+        $this->ensureFileExists($filePath);
+
+        $dataSet = require $filePath;
+        if (is_array($dataSet) === false) {
+            throw new \RuntimeException('Given file did not return an array: ' . $filePath, 1760942255);
+        }
+
+        return $dataSet;
+    }
+
     private function ensureFileExists(string $filePath): void
     {
         if (file_exists($filePath) === false) {
             throw new InvalidArgumentException('The requested PHP data-set file "' . $filePath . '" does not exist.', 1681207108);
         }
     }
+
+    /**
+     * @param array{uid: int|string|null} $assertion
+     * @param array<string|int, mixed[]> $records
+     */
+    private function getAssertionErrorMessageForNoneMatchingRecord(array $assertion, array $records, string $tableName): string
+    {
+        // Handle error
+        if (isset($assertion['uid']) && empty($records[$assertion['uid']])) {
+            return 'Record "' . $tableName . ':' . $assertion['uid'] . '" not found in database';
+        }
+
+        if (isset($assertion['uid'])) {
+            $record = $records[$assertion['uid']] ?? null;
+            if (is_array($record) === false) {
+                return 'Assertion in data-set failed for "' . $tableName . ':' . $assertion['uid'] . '": Uid missing in database' . PHP_EOL;
+            }
+
+            return 'Assertion in data-set failed for "' . $tableName . ':' . $assertion['uid'] . '":' . PHP_EOL . $this->renderRecords($assertion, $record);
+        }
+
+        return 'Assertion in data-set failed for "' . $tableName . '":' . PHP_EOL . $this->arrayToString($assertion);
+    }
+
+    /**
+     * @param mixed[] $record
+     */
+    private function getAssertionErrorMessageForUnexpectedRecord(array $record, string $tableName): string
+    {
+        if (is_numeric($record['uid'] ?? null)) {
+            return sprintf(
+                'Not asserted record with uid "%s" found for table "%s".',
+                $record['uid'],
+                $tableName
+            );
+        }
+
+        return sprintf(
+            'Not asserted record found for table "%s": %s',
+            $tableName,
+            PHP_EOL . var_export($record, true)
+        );
+    }
 }
diff --git a/Tests/Functional/AssertTest.php b/Tests/Functional/AssertTest.php
@@ -120,7 +120,15 @@ public function failsForAssertionForMmRelation(): void
             '   \'sorting_foreign\' => \'3\'',
             ')',
             '',
-            'Not asserted record found for "sys_category_record_mm:".',
+            'Not asserted record found for table "sys_category_record_mm": ',
+            'array (',
+            '  \'uid_local\' => 1,',
+            '  \'uid_foreign\' => 2,',
+            '  \'sorting\' => 0,',
+            '  \'sorting_foreign\' => 2,',
+            '  \'tablenames\' => \'pages\',',
+            '  \'fieldname\' => \'categories\',',
+            ')',
         ]));
         $this->assertPHPDataSet(__DIR__ . '/Fixtures/MmRelationBroken.php');
     }
@@ -131,7 +139,7 @@ public function failsForAdditionalNoneAssertedRecords(): void
         $this->importPHPDataSet(__DIR__ . '/Fixtures/WithDifferentColumns.php');
 
         $this->expectException(AssertionFailedError::class);
-        $this->expectExceptionMessage('Not asserted record found for "pages:2".');
+        $this->expectExceptionMessage('Not asserted record with uid "2" found for table "pages".');
         $this->assertPHPDataSet(__DIR__ . '/Fixtures/AssertAdditionalRecords.php');
     }
 
diff --git a/Tests/Functional/Converter/CsvTest.php b/Tests/Functional/Converter/CsvTest.php
@@ -46,17 +46,6 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    #[Test]
-    public function canBeCreated(): void
-    {
-        $subject = new Csv();
-
-        self::assertInstanceOf(
-            Csv::class,
-            $subject
-        );
-    }
-
     #[Test]
     public function throwsExceptionForNoneExistingFile(): void
     {
@@ -80,6 +69,9 @@ public function convertsCsvFileToPhpFile(
         self::assertFileEquals($expectedResultFile, $result);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function possibleCsvFiles(): array
     {
         return [
diff --git a/Tests/Functional/Converter/XmlTest.php b/Tests/Functional/Converter/XmlTest.php
@@ -46,17 +46,6 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    #[Test]
-    public function canBeCreated(): void
-    {
-        $subject = new Xml();
-
-        self::assertInstanceOf(
-            Xml::class,
-            $subject
-        );
-    }
-
     #[Test]
     public function throwsExceptionForNoneExistingFile(): void
     {
@@ -80,6 +69,9 @@ public function convertsXmlFileToPhpFile(
         self::assertFileEquals($expectedResultFile, $result);
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public static function possibleXmlFiles(): array
     {
         return [
diff --git a/Tests/Functional/ImportTest.php b/Tests/Functional/ImportTest.php
@@ -54,6 +54,7 @@ public function canImportWithNullValue(): void
         $this->importPHPDataSet(__DIR__ . '/Fixtures/WithNull.php');
 
         $records = $this->getAllRecords('pages', true);
+        self::assertIsArray($records[1]);
         self::assertNull($records[1]['description']);
     }
 
diff --git a/composer.json b/composer.json
@@ -35,9 +35,12 @@
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.4",
-        "phpstan/phpstan": "^1.10",
-        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/extension-installer": "^1.4",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-deprecation-rules": "^2.0",
+        "phpstan/phpstan-phpunit": "^2.0",
         "phpunit/phpunit": "^11.5 || ^12.2",
+        "tomasvotruba/cognitive-complexity": "^1.0",
         "typo3/testing-framework": "^9.2"
     },
     "extra": {
@@ -48,6 +51,7 @@
     },
     "config": {
         "allow-plugins": {
+            "phpstan/extension-installer": true,
             "typo3/class-alias-loader": true,
             "typo3/cms-composer-installers": true
         },
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
diff --git a/phpstan.neon b/phpstan.neon

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`
`24`	`24`	`namespace Codappix\Typo3PhpDatasets;`
`25`	`25`
	`26`	`+use Doctrine\DBAL\ParameterType;`
`26`	`27`	`use TYPO3\CMS\Core\Database\Connection as Typo3Connection;`
`27`	`28`
`28`	`29`	`/**`
`@@ -35,6 +36,10 @@ public function __construct(`
`35`	`36`	`) {`
`36`	`37`	`}`
`37`	`38`
	`39`	`+ /**`
	`40`	`+ * @param string[] $record`
	`41`	`+ * @param ParameterType[] $types`
	`42`	`+ */`
`38`	`43`	`public function insert(string $tableName, array $record, array $types): void`
`39`	`44`	`{`
`40`	`45`	`$this->typo3Connection->insert($tableName, $record, $types);`
`@@ -44,7 +49,10 @@ public function getTable(string $tableName): Table`
`44`	`49`	`{`
`45`	`50`	`foreach ($this->typo3Connection->createSchemaManager()->listTables() as $table) {`
`46`	`51`	`if ($table->getObjectName()->toString() === $tableName) {`
`47`		`- return new Table($table);`
	`52`	`+ return new Table(`
	`53`	`+ $tableName,`
	`54`	`+ $table`
	`55`	`+ );`
`48`	`56`	`}`
`49`	`57`	`}`
`50`	`58`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ class PhpDataSet`
`30`	`30`	`{`
`31`	`31`	`/**`
`32`	`32`	`* @api`
	`33`	`+ * @param array<string, array<string, string>[]> $dataSet`
`33`	`34`	`*/`
`34`	`35`	`public function import(array $dataSet): void`
`35`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`final readonly class Table`
`34`	`34`	`{`
`35`	`35`	`public function __construct(`
	`36`	`+ private string $tableName,`
`36`	`37`	`private DbalTable $dbalTable,`
`37`	`38`	`) {`
`38`	`39`	`}`
`@@ -49,7 +50,7 @@ public function getTypeForColumn(string $columnName): ParameterType`
`49`	`50`	`throw new \RuntimeException(sprintf(`
`50`	`51`	`'Column "%s" does not exist in table: %s',`
`51`	`52`	`$columnName,`
`52`		`- $this->dbalTable->getName(),`
	`53`	`+ $this->tableName,`
`53`	`54`	`), 1760941225);`
`54`	`55`	`}`
`55`	`56`	`}`