Make basedir property (including its default "." value) is a relative…

… path to the project's root.
phingofficial · Mar 3, 2017 · dfdb0bc · dfdb0bc
1 parent 41b2f54
commit dfdb0bc
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 5 deletions.
diff --git a/classes/phing/parser/ProjectHandler.php b/classes/phing/parser/ProjectHandler.php
@@ -158,7 +158,7 @@ public function init($tag, $attrs)
                 if ($f->isAbsolute()) {
                     $project->setBasedir($baseDir);
                 } else {
-                    $project->setBaseDir($project->resolveFile($baseDir, new PhingFile(getcwd())));
+                    $project->setBaseDir($project->resolveFile($baseDir, $buildFileParent));
                 }
             }
         }

diff --git a/docs/docbook5/en/source/chapters/gettingstarted.xml b/docs/docbook5/en/source/chapters/gettingstarted.xml
@@ -154,10 +154,12 @@
                         </row>
                         <row>
                             <entry><literal>basedir</literal></entry>
-                            <entry>The base directory of the project, use &quot;.&quot; do denote
-                                the current directory. <emphasis role="bold">Note:</emphasis> if
-                                none is specified, the parent directory of the build file is
-                                used!</entry>
+                            <entry>The base directory of the project. This attribute controls the value of the
+                                <literal>${project.basedir}</literal> property which can be used to reference
+                                files with paths relative to the project root folder. Can be a path relative to
+                                the position of the buildfile itself. If omitted, &quot;.&quot; will be used,
+                                which means that the build file should be located in the project's root folder.
+                            </entry>
                             <entry>No</entry>
                         </row>
                         <row>

diff --git a/test/classes/phing/regression/309/Ticket309RegressionTest.php b/test/classes/phing/regression/309/Ticket309RegressionTest.php
@@ -0,0 +1,49 @@
+<?php
+
+/*
+ *  $Id$
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information please see
+ * <http://phing.info>.
+ */
+
+require_once 'phing/BuildFileTest.php';
+
+class Ticket309RegressionTest extends BuildFileTest
+{
+    /**
+     * The project.basedir property denotes the project root directory.
+     * This root directory can be set by the "basedir" attribute on the
+     * <project> tag. It denotes the path to the project root, relative to
+     * the buildfile.
+     *
+     * The default is ".", meaning that the build.xml file is locate in the
+     * project root.
+     *
+     * This test uses several buildfiles that reference the /etc/regression/309
+     * directory as their project root in various ways.
+     */
+    public function testPhingCallTask()
+    {
+        $testBasedir = PHING_TEST_BASE . "/etc/regression/309";
+
+        foreach (array('basedir-dot.xml', 'basedir-default.xml', 'sub/basedir-dotdot.xml') as $buildfile) {
+            $this->configureProject("$testBasedir/$buildfile");
+            $this->executeTarget("main");
+            $this->assertInLogs("project.basedir: $testBasedir");
+        }
+    }
+} 
diff --git a/test/etc/regression/309/basedir-default.xml b/test/etc/regression/309/basedir-default.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<project name="test" default="main">
+
+    <target name="main">
+        <echo>project.basedir: ${project.basedir}</echo>
+        <echo>application.startdir: ${application.startdir}</echo>
+    </target>
+
+</project>
diff --git a/test/etc/regression/309/basedir-dot.xml b/test/etc/regression/309/basedir-dot.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<project name="test" default="main" basedir=".">
+
+    <target name="main">
+        <echo>project.basedir: ${project.basedir}</echo>
+        <echo>application.startdir: ${application.startdir}</echo>
+    </target>
+
+</project>
diff --git a/test/etc/regression/309/sub/basedir-dotdot.xml b/test/etc/regression/309/sub/basedir-dotdot.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<project name="test" default="main" basedir="..">
+
+    <target name="main">
+        <echo>project.basedir: ${project.basedir}</echo>
+        <echo>application.startdir: ${application.startdir}</echo>
+    </target>
+
+</project>