Add integration and unit tests for YAML writing, Asciidoc formatting, and filesystem operations

Author: sebastian-iancu

tests/Integration/BmmYamlSmokeTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Integration;
+
+use OpenEHR\BmmPublisher\BmmSchemaCollection;
+use OpenEHR\BmmPublisher\Helper\OutputDir;
+use OpenEHR\BmmPublisher\Writer\BmmYaml;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+final class BmmYamlSmokeTest extends TestCase
+{
+    private string $tempOutput;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->tempOutput = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'bmm_publisher_yaml_smoke_' . uniqid('', true);
+        self::assertTrue(mkdir($this->tempOutput, 0700, true));
+        putenv('BMM_OUTPUT_DIR=' . $this->tempOutput);
+        OutputDir::reset();
+    }
+
+    protected function tearDown(): void
+    {
+        putenv('BMM_OUTPUT_DIR');
+        OutputDir::reset();
+        if (is_dir($this->tempOutput)) {
+            $this->deleteTree($this->tempOutput);
+        }
+        parent::tearDown();
+    }
+
+    private function deleteTree(string $dir): void
+    {
+        $items = @scandir($dir);
+        if ($items === false) {
+            return;
+        }
+        foreach (array_diff($items, ['.', '..']) as $item) {
+            $path = $dir . DIRECTORY_SEPARATOR . $item;
+            is_dir($path) && !is_link($path) ? $this->deleteTree($path) : @unlink($path);
+        }
+        @rmdir($dir);
+    }
+
+    #[Test]
+    public function writesYamlFileForLoadedSchema(): void
+    {
+        $collection = new BmmSchemaCollection();
+        $collection->load('openehr_term_3.0.0');
+
+        (new BmmYaml($collection))();
+
+        $expectedFile = $this->tempOutput . DIRECTORY_SEPARATOR . 'BMM-YAML' . DIRECTORY_SEPARATOR . 'openehr_term_3.0.0.bmm.yaml';
+        self::assertFileExists($expectedFile);
+        $content = (string) file_get_contents($expectedFile);
+        self::assertNotSame('', $content);
+        self::assertStringContainsString('rm_publisher', $content);
+    }
+}

tests/Unit/AsciidocDefinitionFormatTest.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use OpenEHR\BmmPublisher\BmmSchemaCollection;
+use OpenEHR\BmmPublisher\Writer\Formatter\AsciidocDefinition;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+final class AsciidocDefinitionFormatTest extends TestCase
+{
+    private function makeFormatter(bool $legacyFormat = false): AsciidocDefinition
+    {
+        return new AsciidocDefinition(new BmmSchemaCollection(), $legacyFormat);
+    }
+
+    #[Test]
+    public function formatTextReturnsEmptyStringForNull(): void
+    {
+        $f = $this->makeFormatter();
+
+        self::assertSame('', $f->formatText(null));
+    }
+
+    #[Test]
+    public function formatTextTrimsWhitespace(): void
+    {
+        $f = $this->makeFormatter();
+
+        self::assertSame('x', $f->formatText("  x \n"));
+    }
+
+    #[Test]
+    public function formatTextAppliesTextReplacementMap(): void
+    {
+        $f = $this->makeFormatter();
+
+        self::assertSame('a&#124;b', $f->formatText('a|b'));
+        self::assertSame('a\<=b', $f->formatText('a<=b'));
+        self::assertSame('a.&#42;b', $f->formatText('a.*b'));
+    }
+
+    #[Test]
+    public function formatXrefReturnsEmptyWhenNoOpenehrMarker(): void
+    {
+        $f = $this->makeFormatter();
+        $results = [];
+
+        self::assertSame('', $f->formatXref('', $results));
+        self::assertSame([], $results);
+
+        self::assertSame('', $f->formatXref('com.example.only', $results));
+    }
+
+    #[Test]
+    public function formatXrefBuildsComponentModulePageAndResults(): void
+    {
+        $f = $this->makeFormatter();
+        $results = [];
+
+        $xref = $f->formatXref('openehr_base_1.0.4.org.openehr.base.foundation_types.identification', $results);
+
+        self::assertSame('BASE:foundation_types:identification', $xref);
+        self::assertSame(['BASE', 'foundation_types', 'identification'], $results);
+    }
+
+    #[Test]
+    public function formatXrefOmitsEmptySegmentsInOutput(): void
+    {
+        $f = $this->makeFormatter();
+        $results = [];
+
+        $xref = $f->formatXref('x.org.openehr.base.foundation_types', $results);
+
+        self::assertSame('BASE:foundation_types', $xref);
+        self::assertSame(['BASE', 'foundation_types', ''], $results);
+    }
+}

tests/Unit/FilesystemTest.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Unit;
+
+use OpenEHR\BmmPublisher\Helper\Filesystem;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+use Psr\Log\NullLogger;
+use RuntimeException;
+
+final class FilesystemTest extends TestCase
+{
+    private string $tempBase;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->tempBase = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'bmm_publisher_fs_test_' . uniqid('', true);
+        self::assertTrue(mkdir($this->tempBase, 0700, true));
+    }
+
+    protected function tearDown(): void
+    {
+        if (!is_dir($this->tempBase)) {
+            parent::tearDown();
+
+            return;
+        }
+        $this->deleteTree($this->tempBase);
+        parent::tearDown();
+    }
+
+    private function deleteTree(string $dir): void
+    {
+        $items = @scandir($dir);
+        if ($items === false) {
+            return;
+        }
+        foreach (array_diff($items, ['.', '..']) as $item) {
+            $path = $dir . DIRECTORY_SEPARATOR . $item;
+            is_dir($path) && !is_link($path) ? $this->deleteTree($path) : @unlink($path);
+        }
+        @rmdir($dir);
+    }
+
+    #[Test]
+    public function assureDirCreatesNestedPath(): void
+    {
+        $dir = $this->tempBase . DIRECTORY_SEPARATOR . 'a' . DIRECTORY_SEPARATOR . 'b' . DIRECTORY_SEPARATOR . 'c';
+
+        Filesystem::assureDir($dir);
+
+        self::assertDirectoryExists($dir);
+        self::assertTrue(is_writable($dir));
+    }
+
+    #[Test]
+    public function assureDirSucceedsWhenDirectoryAlreadyExists(): void
+    {
+        $dir = $this->tempBase . DIRECTORY_SEPARATOR . 'existing';
+        self::assertTrue(mkdir($dir, 0700, true));
+
+        Filesystem::assureDir($dir);
+
+        self::assertDirectoryExists($dir);
+    }
+
+    #[Test]
+    public function assureDirThrowsWhenPathIsAFile(): void
+    {
+        $path = $this->tempBase . DIRECTORY_SEPARATOR . 'not_a_dir';
+        self::assertSame(1, file_put_contents($path, 'x'));
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('already exists but is not a directory');
+
+        Filesystem::assureDir($path);
+    }
+
+    #[Test]
+    public function writeFileWritesContent(): void
+    {
+        $file = $this->tempBase . DIRECTORY_SEPARATOR . 'out.txt';
+        $content = "line1\nline2\n";
+
+        Filesystem::writeFile($file, $content, new NullLogger());
+
+        self::assertFileExists($file);
+        self::assertSame($content, (string) file_get_contents($file));
+    }
+}