Added / updated tests.

Author: Mistralys

tests/TestClasses/ViewerTestCase.php

@@ -6,6 +6,8 @@
 
 use Mistralys\MarkdownViewer\DocFile;
 use Mistralys\MarkdownViewer\DocParser;
+use Mistralys\MarkdownViewer\DocsConfig;
+use Mistralys\MarkdownViewer\DocsManager;
 use PHPUnit\Framework\TestCase;
 
 abstract class ViewerTestCase extends TestCase
@@ -36,6 +38,12 @@ protected function createTestParser(string $relativePath='', ?string $title='')
             $title = 'Title';
         }
 
-        return new DocParser(new DocFile($title, $this->getPath($relativePath)));
+        $config = (new DocsConfig())
+            ->addIncludePath($this->filesFolder.'/includes')
+            ->addIncludeExtension('php');
+
+        $manager = new DocsManager($config);
+
+        return new DocParser(new DocFile($manager, $title, $this->getPath($relativePath)));
     }
 }

tests/TestSuites/Parser/IncludeTests.php

@@ -11,11 +11,11 @@ final class IncludeTests extends ViewerTestCase
 {
     public function test_findIncludes() : void
     {
-        $includes = $this->createTestParser('document-with-includes.md')
+        $includes = $this->createTestParser('document-with-errors.md')
             ->getIncludes();
 
         $this->assertNotEmpty($includes);
-        $this->assertArrayHasKey('includes/test-php-highlight.php', $includes);
+        $this->assertArrayHasKey('not-a-file.md', $includes);
     }
 
     public function test_includeReplacements() : void
@@ -24,15 +24,28 @@ public function test_includeReplacements() : void
             ->render();
 
         $this->assertStringContainsString('sample PHP file', $html);
-        $this->assertStringContainsString('#'.DocParser::ERROR_INCLUDE_FILE_NOT_FOUND, $html);
     }
 
-    public function test_includeSizeTooBig() : void
+    public function test_includeErrorTooBig() : void
     {
-        $html = $this->createTestParser('document-with-includes.md')
-            ->setMaxIncludeSize(20)
-            ->render();
+        $parser = $this->createTestParser('document-with-includes.md');
+        $parser->getConfig()->setMaxIncludeSize(20);
+
+        $html = $parser->render();
 
         $this->assertStringContainsString('#'.DocParser::ERROR_INCLUDE_FILE_TOO_BIG, $html);
     }
+
+    public function test_includeErrors() : void
+    {
+        $parser = $this->createTestParser('document-with-errors.md');
+        $parser->getConfig()->setMaxIncludeSize(20);
+
+        $html = $parser->render();
+
+        $this->assertStringContainsString('#'.DocParser::ERROR_INCLUDE_FILE_NOT_FOUND, $html, 'File not found');
+        $this->assertStringContainsString('#'.DocParser::ERROR_ATTEMPTED_NAVIGATING_UP, $html, 'Navigating upwards');
+        $this->assertStringContainsString('#'.DocParser::ERROR_INVALID_INCLUDE_EXTENSION, $html, 'Unknown extension');
+        $this->assertStringContainsString('#'.DocParser::ERROR_INCLUDE_IS_NOT_A_FILE, $html, 'Not a file');
+    }
 }

tests/TestSuites/Parser/OptionTests.php

@@ -4,34 +4,35 @@
 
 namespace Mistralys\MarkdownViewerTests\TestSuites\Parser;
 
+use Mistralys\MarkdownViewer\DocsConfig;
 use Mistralys\MarkdownViewerTests\TestClasses\ViewerTestCase;
 
 final class OptionTests extends ViewerTestCase
 {
     public function test_addIncludeExtension() : void
     {
-        $parser = $this->createTestParser();
+        $config = new DocsConfig();
 
-        $this->assertNotContains('json', $parser->getIncludeExtensions());
-        $this->assertNotContains('rtf', $parser->getIncludeExtensions());
+        $this->assertNotContains('json', $config->getIncludeExtensions());
+        $this->assertNotContains('rtf', $config->getIncludeExtensions());
 
-        $parser->addIncludeExtension('json');
-        $parser->addIncludeExtension('.rtf');
+        $config->addIncludeExtension('json');
+        $config->addIncludeExtension('.rtf');
 
-        $this->assertContains('json', $parser->getIncludeExtensions());
-        $this->assertContains('rtf', $parser->getIncludeExtensions());
+        $this->assertContains('json', $config->getIncludeExtensions());
+        $this->assertContains('rtf', $config->getIncludeExtensions());
     }
 
     public function test_addIncludeExtensions() : void
     {
-        $parser = $this->createTestParser();
+        $config = new DocsConfig();
 
-        $this->assertNotContains('json', $parser->getIncludeExtensions());
+        $this->assertNotContains('json', $config->getIncludeExtensions());
 
-        $parser->addIncludeExtension('json');
-        $parser->addIncludeExtension('.rtf');
+        $config->addIncludeExtension('json');
+        $config->addIncludeExtension('.rtf');
 
-        $this->assertContains('json', $parser->getIncludeExtensions());
-        $this->assertContains('rtf', $parser->getIncludeExtensions());
+        $this->assertContains('json', $config->getIncludeExtensions());
+        $this->assertContains('rtf', $config->getIncludeExtensions());
     }
 }

tests/files/document-with-errors.md

@@ -0,0 +1,20 @@
+# Errors while including files
+
+If an error occurs when loading an include file, the command 
+is replaced by an error message.
+
+## Include an unknown file
+
+{include-file: unknown-file.txt}
+
+## Include a folder
+
+{include-file: not-a-file.md}
+
+## Include an unsupported extension
+
+{include-file: disallowed-extension.ext}
+
+## Navigate up in relative path
+
+{include-file: ../includes/document-with-includes.md}

tests/files/document-with-includes.md

@@ -4,17 +4,4 @@ Doc viewer files can be processed to include external files
 anywhere. For example to load sample code from files instead
 of maintaining them in the markdown.
 
-{include-file: includes/test-php-highlight.php}
-
-If a file does not exist, the command is replaced by an
-error message.
-
-{include-file: unknown-file.txt}
-
-Same thing for trying to include a folder:
-
-{include-file: includes/}
-
-Or files that are too big:
-
-
+{include-file: test-php-highlight.php}

tests/files/includes/disallowed-extension.ext

@@ -0,0 +1,2 @@
+Folder used in the unit tests to ensure target
+is not a folder looking like a file.