Merge pull request #2052 from jaapio/test/config-target

Add test for target config

Author: jaapio

behat.yml

@@ -18,6 +18,13 @@ default:
             paths:    [ "%paths.base%/tests/features/cli" ]
             filters:
                 tags: "~@php5.6+"
+        config_features:
+          contexts:
+            - phpDocumentor\Behat\Contexts\EnvironmentContext:
+                workingDir: /tmp/phpdoc-behat/config
+          paths:    [ "%paths.base%/tests/features/config" ]
+          filters:
+            tags: "~@php5.6+"
         php56_features:
             contexts:
               - phpDocumentor\Behat\Contexts\EnvironmentContext:
@@ -43,6 +50,15 @@ phar:
               workingDir: /tmp/phpdoc-behat/cli
               pharPath: /build/phpDocumentor.phar
           - phpDocumentor\Behat\Contexts\Ast\ApiContext
+    config_features:
+      contexts:
+        - phpDocumentor\Behat\Contexts\EnvironmentContext:
+            workingDir: /tmp/phpdoc-behat/config
+            pharPath: /build/phpDocumentor.phar
+      paths:    [ "%paths.base%/tests/features/config" ]
+      filters:
+        tags: "~@php5.6+"
+
     php56_features:
         contexts:
           - phpDocumentor\Behat\Contexts\EnvironmentContext:

tests/features/assets/config/v2Target.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+  ~ This file is part of phpDocumentor.
+  ~
+  ~ For the full copyright and license information, please view the LICENSE
+  ~ file that was distributed with this source code.
+  ~
+  ~ @author    Mike van Riel <mike.vanriel@naenius.com>
+  ~ @copyright 2010-2019 Mike van Riel / Naenius (http://www.naenius.com)
+  ~ @license   http://www.opensource.org/licenses/mit-license.php MIT
+  ~ @link      http://phpdoc.org
+  ~
+  ~
+  -->
+
+<phpdocumentor>
+    <parser>
+        <default-package-name>Default</default-package-name>
+        <encoding>utf-8</encoding>
+        <target>build/docs</target>
+    </parser>
+    <files>
+        <directory>src</directory>
+    </files>
+    <transformer>
+        <target>build/api/docs</target>
+    </transformer>
+    <logging>
+        <level>error</level>
+    </logging>
+    <transformations>
+        <template name="clean"/>
+    </transformations>
+</phpdocumentor>

tests/features/bootstrap/EnvironmentContext.php

@@ -13,6 +13,7 @@
 namespace phpDocumentor\Behat\Contexts;
 
 use Behat\Behat\Context;
+use Behat\Behat\Tester\Exception\PendingException;
 use FilesystemIterator;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
@@ -113,6 +114,29 @@ public function loadAProject($dest, $source)
         }
     }
 
+
+    /**
+     * @Given /^configuration file based on "([^"]*)" in "([^"]*)"$/
+     */
+    public function configurationFileBasedOnIn($configFile, $destDir)
+    {
+        Assert::fileExists(__DIR__ . '/../assets/config/' . $configFile);
+        copy(
+            __DIR__ . '/../assets/config/' . $configFile,
+            $this->getWorkingDir() . DIRECTORY_SEPARATOR . $destDir . DIRECTORY_SEPARATOR . 'phpdoc.xml'
+        );
+    }
+
+    /**
+     * @Given /^working directory is "([^"]*)"$/
+     */
+    public function workingDirectoryIs($dir)
+    {
+        $fullDir = $this->getWorkingDir() . DIRECTORY_SEPARATOR . $dir;
+        $this->process->setWorkingDirectory($fullDir);
+        chdir($fullDir);
+    }
+
     /**
      * @Given /^I ran "phpdoc(?: ((?:\"|[^"])*))?"$/
      * @When /^I run "phpdoc(?: ((?:\"|[^"])*))?"$/
@@ -178,4 +202,12 @@ public function getErrorOutput()
     {
         return $this->process->getErrorOutput();
     }
+
+    /**
+     * @Then /^documentation should be found in "([^"]*)"$/
+     */
+    public function documentationShouldBeFoundIn($expectedDir)
+    {
+        Assert::directory($this->getWorkingDir() . DIRECTORY_SEPARATOR . $expectedDir);
+    }
 }

tests/features/config/v2.feature

@@ -0,0 +1,11 @@
+Feature: phpdocumentor should be able to use v2 format config file.
+  To make the step to phpdoc v3 as small as possible we want to be backwards compatible in the configuration
+  of phpdocumentor.
+
+  Scenario: User has provided a custom target directory in the config
+    Given A project named "v2" based on "simple"
+    And configuration file based on "v2Target.xml" in "v2"
+    And working directory is "v2"
+    When I run "phpdoc"
+    Then the application must have run successfully
+    And documentation should be found in "v2/build/api/docs"