Version 1

[yaffs-website] / vendor / consolidation / output-formatters / tests / testAPIDocs.php

diff --git a/vendor/consolidation/output-formatters/tests/testAPIDocs.php b/vendor/consolidation/output-formatters/tests/testAPIDocs.php
new file mode 100644 (file)
index 0000000..ecb5eb0
--- /dev/null
+++ b/vendor/consolidation/output-formatters/tests/testAPIDocs.php
@@ -0,0 +1,32 @@
+<?php
+namespace Consolidation\OutputFormatters;
+
+use Consolidation\OutputFormatters\Options\FormatterOptions;
+use Symfony\Component\Console\Input\StringInput;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputDefinition;
+
+class APIDocsTests extends \PHPUnit_Framework_TestCase
+{
+    function testAPIDocs()
+    {
+        if (getenv('CI')) {
+            $this->markTestIncomplete(
+                'API generation has slight variations when run on CI server. This test is therefore skipped on CI until we can make the test results consistent.'
+            );
+        }
+
+        $testDocs = tempnam(sys_get_temp_dir(), 'TestAPIDocs.md');
+        $currentDocs = getcwd() . '/docs/api.md';
+        passthru("vendor/bin/phpdoc-md generate src > $testDocs");
+
+        $testDocsContent = file_get_contents($testDocs);
+        $currentDocsContent = file_get_contents($currentDocs);
+
+        $testDocsContent = str_replace (array("\r\n", "\r"), "\n", $testDocsContent);
+        $currentDocsContent = str_replace (array("\r\n", "\r"), "\n", $currentDocsContent);
+
+        $this->assertEquals($testDocsContent, $currentDocsContent, "API docuementation out of date. Run 'composer api' to update.");
+    }
+}