Entwurf: tests/DokumentationsstrukturTest.php

tests/DokumentationsstrukturTest.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Belevo\EnelixEMS\Tests;
+
+use PHPUnit\Framework\TestCase;
+
+final class DokumentationsstrukturTest extends TestCase
+{
+    /** @return list<string> */
+    public function modulReadmes(): array
+    {
+        return [
+            'Manager',
+            'Batterie',
+            'Wassererwaermer',
+            'Pufferspeicher',
+            'Verbraucher-1-Stufig',
+            'Waermepumpe',
+            'Ladestation-Stand-Alone',
+            'Ladestation-Gateway',
+            'Easee-Gateway',
+        ];
+    }
+
+    /** @dataProvider modulReadmes */
+    public function testJederModulentwurfHatEinReadme(string $modul): void
+    {
+        $pfad = __DIR__ . '/../docs/module/' . $modul . '/README.md';
+        self::assertFileExists($pfad);
+
+        $inhalt = file_get_contents($pfad);
+        self::assertNotFalse($inhalt);
+        self::assertStringContainsString('Status: Diskussionsentwurf', $inhalt);
+        self::assertStringContainsString('Properties', $inhalt);
+    }
+
+    public function testSchnittstellenDokumentiertSind(): void
+    {
+        self::assertFileExists(__DIR__ . '/../docs/Schnittstelle.md');
+        self::assertFileExists(__DIR__ . '/../docs/Obere-Anschluesse.md');
+        self::assertFileExists(__DIR__ . '/../libs/VerbraucherBasisTrait.php');
+    }
+}