Merge pull request #6 from Submitty/Added_tests

[Testing:Developer] Adding php unit tests

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  run:
+    runs-on: 'ubuntu-latest'
+    strategy:
+      matrix:
+        php-versions: ['7.4', '8.0']
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup PHP
+      uses: shivammathur/setup-php@v2
+      with:
+        php-version: ${{ matrix.php-versions }}
+        coverage: xdebug
+
+    - run: mkdir -p build/logs
+
+    - name: Install composer dependencies
+      uses: ramsey/composer-install@v1
+
+    - name: Run Tests
+      run: vendor/bin/phpunit

phpunit.xml.dist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         bootstrap="vendor/autoload.php"
+>
+    <testsuites>
+        <testsuite name="Aptoma Markdown Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory>src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Submitty/Twig/Extension/PHPLeagueMarkdownEngine.php

@@ -40,7 +40,7 @@ public function __construct(MarkdownConverter $converter = null)
      */
     public function transform($content)
     {
-        return $this->converter->convertToHtml($content);
+        return $this->converter->convert($content)->getContent();
     }
 
     /**

tests/Submitty/Twig/Extension/MarkdownExtensionTest.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Submitty\Twig\Extension;
+
+use Submitty\Twig\Extension\PHPLeagueMarkdownEngine;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Gunnar Liun <[email protected]>
+ */
+class MarkdownExtensionTest extends TestCase
+{
+    /**
+     * @dataProvider getParseMarkdownTests
+     */
+    public function testParseMarkdown($template, $expected, $context = array())
+    {
+        $this->assertEquals($expected, $this->getTemplate($template)->render($context));
+    }
+
+    public function getParseMarkdownTests()
+    {
+        return array(
+            array('{{ "# Main Title"|markdown }}', '<h1>Main Title</h1>' . PHP_EOL),
+            array('{{ content|markdown }}', '<h1>Main Title</h1>' . PHP_EOL, array('content' => '# Main Title'))
+        );
+    }
+
+    protected function getEngine()
+    {
+        return new PHPLeagueMarkdownEngine();
+    }
+
+    protected function getTemplate($template)
+    {
+        $loader = new \Twig\Loader\ArrayLoader(array('index' => $template));
+        $twig = new \Twig\Environment($loader, array('debug' => true, 'cache' => false));
+        $twig->addExtension(new MarkdownExtension($this->getEngine()));
+
+        return $twig->load('index');
+    }
+}

tests/Submitty/Twig/TokenParser/MarkdownTokenParserTest.php

@@ -0,0 +1,139 @@
+<?php
+
+namespace Submitty\Twig\TokenParser;
+
+use Submitty\Twig\Extension\PHPLeagueMarkdownEngine;
+use Submitty\Twig\Node\MarkdownNode;
+use PHPUnit\Framework\TestCase;
+use Twig\Compiler;
+use Twig\Environment;
+use Twig\Loader\ArrayLoader;
+use Twig\Node\Node;
+use Twig\Node\TextNode;
+
+/**
+ * @author Gunnar Lium <[email protected]>
+ */
+class MarkdownTokenParserTest extends TestCase
+{
+    public function testConstructor()
+    {
+        $body = new Node(array(new TextNode("#Title\n\nparagraph\n", 1)));
+        $node = new MarkdownNode($body, 1);
+
+        $this->assertEquals($body, $node->getNode('body'));
+    }
+
+    /**
+     * Test that the generated code actually do what we expect
+     *
+     * The contents of this test is the same that we write in the compile method.
+     * This requires manual synchronization, which we should probably not rely on.
+     */
+    public function testMarkdownPrepareBehavior()
+    {
+        $body = "    #Title\n\n    paragraph\n\n        code";
+        $bodyPrepared = "#Title\n\nparagraph\n\n    code";
+
+        ob_start();
+        echo $body;
+        $content = ob_get_clean();
+        preg_match("/^\s*/", $content, $matches);
+        $lines = explode("\n", $content);
+        $content = preg_replace('/^' . $matches[0]. '/', "", $lines);
+        $content = join("\n", $content);
+
+        // Assert prepared content looks right
+        $this->assertEquals($bodyPrepared, $content);
+
+        // Assert Markdown output
+        $expectedOutput = "<h1>Title</h1>\n\n<p>paragraph</p>\n\n<pre><code>code\n</code></pre>\n";
+        $output = $this->getEngine()->transform($content);
+        $this->assertIsString($output,$expectedOutput);
+        $this->assertEquals($output, $this->getEngine()->transform($content));
+    }
+
+    /**
+     * Test that the generated code looks as expected
+     *
+     * @dataProvider getTests
+     */
+    public function testCompile($node, $source, $environment = null, $isPattern = false)
+    {
+        $this->assertNodeCompilation($source, $node, $environment, $isPattern = false);
+    }
+
+    protected function getEngine()
+    {
+        return new PHPLeagueMarkdownEngine();
+    }
+
+    public function getTests()
+    {
+        $tests = array();
+
+        $body = new Node(array(new TextNode("#Title\n\nparagraph\n", 1)));
+        $node = new MarkdownNode($body, 1);
+
+        $tests['simple text'] = array($node, <<<EOF
+// line 1
+ob_start();
+echo "#Title
+
+paragraph
+";
+\$content = ob_get_clean();
+preg_match("/^\s*/", \$content, \$matches);
+\$lines = explode("\\n", \$content);
+\$content = preg_replace('/^' . \$matches[0]. '/', "", \$lines);
+\$content = join("\\n", \$content);
+echo \$this->env->getExtension('Submitty\Twig\Extension\MarkdownExtension')->parseMarkdown(\$content);
+EOF
+            );
+
+        $body = new Node(array(new TextNode("    #Title\n\n    paragraph\n\n        code\n", 1)));
+        $node = new MarkdownNode($body, 1);
+
+        $tests['text with leading indent'] = array($node, <<<EOF
+// line 1
+ob_start();
+echo "    #Title
+
+    paragraph
+
+        code
+";
+\$content = ob_get_clean();
+preg_match("/^\s*/", \$content, \$matches);
+\$lines = explode("\\n", \$content);
+\$content = preg_replace('/^' . \$matches[0]. '/', "", \$lines);
+\$content = join("\\n", \$content);
+echo \$this->env->getExtension('Submitty\Twig\Extension\MarkdownExtension')->parseMarkdown(\$content);
+EOF
+        );
+
+        return $tests;
+    }
+
+    public function assertNodeCompilation($source, Node $node, Environment $environment = null, $isPattern = false)
+    {
+        $compiler = $this->getCompiler($environment);
+        $compiler->compile($node);
+
+        if ($isPattern) {
+            $this->assertStringMatchesFormat($source, trim($compiler->getSource()));
+        } else {
+            $this->assertEquals($source, trim($compiler->getSource()));
+        }
+    }
+
+    protected function getCompiler(Environment $environment = null)
+    {
+        return new Compiler(null === $environment ? $this->getEnvironment() : $environment);
+    }
+
+    protected function getEnvironment()
+    {
+        return new Environment(new ArrayLoader(array()));
+    }
+}