From de6eb8cc970d1271f6310af83ea7d0fcc13ae817 Mon Sep 17 00:00:00 2001
From: Sebastian Bergmann <sb@sebastian-bergmann.de>
Date: Sat, 23 Nov 2019 13:58:58 +0100
Subject: [PATCH] Reorganize build directory

---
 .github/workflows/ci.yml                      |  4 +-
 .gitignore                                    |  4 +-
 build.xml                                     | 43 ++++++++-----------
 build/{ => config}/github-ci-fail.xml         |  5 +--
 .../{scoper.inc.php => config/php-scoper.php} |  0
 build/{ => config}/phpdox.xml                 |  6 +--
 .../generate-global-assert-wrappers.php}      |  6 +--
 build/{ => scripts}/lint-xml-configuration    |  0
 build/{ => scripts}/phar-manifest.php         |  2 +-
 build/{ => scripts}/phar-version.php          |  4 +-
 build/{ => scripts}/sanity-check              |  2 +-
 build/{ => scripts}/version.php               |  6 +--
 .../binary-phar-autoload.php.in               |  0
 .../library-phar-autoload.php.in              |  0
 14 files changed, 36 insertions(+), 46 deletions(-)
 rename build/{ => config}/github-ci-fail.xml (73%)
 rename build/{scoper.inc.php => config/php-scoper.php} (100%)
 rename build/{ => config}/phpdox.xml (72%)
 rename build/{generate_global_assert_wrappers.php => scripts/generate-global-assert-wrappers.php} (96%)
 rename build/{ => scripts}/lint-xml-configuration (100%)
 rename build/{ => scripts}/phar-manifest.php (90%)
 rename build/{ => scripts}/phar-version.php (72%)
 rename build/{ => scripts}/sanity-check (81%)
 rename build/{ => scripts}/version.php (62%)
 rename build/{ => templates}/binary-phar-autoload.php.in (100%)
 rename build/{ => templates}/library-phar-autoload.php.in (100%)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 1996145e2c3..91a60db0ad5 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -68,7 +68,7 @@ jobs:
       - name: Lint XML configuration files
         uses: ./.docker/lint-xml-configuration
         with:
-          args: bash ./build/lint-xml-configuration
+          args: bash ./build/scripts/lint-xml-configuration
 
   tests:
     name: Tests
@@ -106,7 +106,7 @@ jobs:
         run: ${{ matrix.php-binary }} ./tools/composer update --no-ansi --no-interaction --no-progress --no-suggest
 
       - name: Run sanity check
-        run: PHP_BINARY=${{ matrix.php-binary }} bash ./build/sanity-check
+        run: PHP_BINARY=${{ matrix.php-binary }} bash ./build/scripts/sanity-check
 
       - name: Run tests with phpunit
         run: ${{ matrix.php-binary }} -d assert.exception=1 -d zend.assertions=1 ./phpunit --coverage-clover=coverage.xml
diff --git a/.gitignore b/.gitignore
index c1efcf18385..beeb00423ff 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,11 +3,9 @@
 /.php_cs
 /.php_cs.cache
 /.psalm/cache
-/build/documentation
-/build/logfiles
+/build/artifacts
 /build/phar
 /build/phar-scoped
-/build/phpdox
 /build/*.phar
 /build/*.phar.asc
 /build/binary-phar-autoload.php
diff --git a/build.xml b/build.xml
index 2952e62c811..45aa2f22e8a 100644
--- a/build.xml
+++ b/build.xml
@@ -7,23 +7,15 @@
         <delete dir="${basedir}/bin"/>
         <delete dir="${basedir}/vendor"/>
         <delete file="${basedir}/composer.lock"/>
-        <delete dir="${basedir}/build/documentation"/>
-        <delete dir="${basedir}/build/logfiles"/>
+        <delete dir="${basedir}/build/artifacts"/>
         <delete dir="${basedir}/build/phar"/>
         <delete dir="${basedir}/build/phar-scoped"/>
-        <delete>
-            <fileset dir="${basedir}/build">
-                <include name="**/phpunit*.phar"/>
-                <include name="**/phpunit*.phar.asc"/>
-            </fileset>
-        </delete>
 
         <property name="clean.done" value="true"/>
     </target>
 
     <target name="prepare" unless="prepare.done" depends="clean" description="Prepare for build">
-        <mkdir dir="${basedir}/build/documentation"/>
-        <mkdir dir="${basedir}/build/logfiles"/>
+        <mkdir dir="${basedir}/build/artifacts/logfiles"/>
         <property name="prepare.done" value="true"/>
     </target>
 
@@ -134,12 +126,13 @@
     </target>
 
     <target name="-phar-prepare" depends="clean,install-dependencies">
+        <mkdir dir="${basedir}/build/artifacts"/>
         <mkdir dir="${basedir}/build/phar"/>
         <mkdir dir="${basedir}/build/phar-scoped"/>
 
         <copy file="${basedir}/phpunit.xsd" tofile="${basedir}/build/phar/phpunit.xsd"/>
 
-        <exec executable="${basedir}/build/phar-manifest.php" output="${basedir}/build/phar/manifest.txt" failonerror="true"/>
+        <exec executable="${basedir}/build/scripts/phar-manifest.php" output="${basedir}/build/phar/manifest.txt" failonerror="true"/>
 
         <copy file="${basedir}/vendor/phpunit/php-code-coverage/LICENSE" tofile="${basedir}/build/phar/php-code-coverage/LICENSE"/>
         <copy todir="${basedir}/build/phar/php-code-coverage">
@@ -352,7 +345,7 @@
             </fileset>
         </copy>
 
-        <exec executable="${basedir}/build/phar-version.php" outputproperty="_version" failonerror="true">
+        <exec executable="${basedir}/build/scripts/phar-version.php" outputproperty="_version" failonerror="true">
             <arg value="${version}"/>
             <arg value="${type}"/>
         </exec>
@@ -362,7 +355,7 @@
             <arg value="--no-ansi" />
             <arg value="--force" />
             <arg value="--config" />
-            <arg path="${basedir}/build/scoper.inc.php" />
+            <arg path="${basedir}/build/config/php-scoper.php" />
             <arg value="--no-interaction" />
             <arg value="--stop-on-failure" />
             <arg value="--output-dir" />
@@ -386,13 +379,13 @@
             <arg value="--hash" />
             <arg value="SHA-1" />
             <arg value="--output" />
-            <arg path="${basedir}/build/phpunit-library-${_version}.phar" />
+            <arg path="${basedir}/build/artifacts/phpunit-library-${_version}.phar" />
             <arg value="--template" />
-            <arg path="${basedir}/build/library-phar-autoload.php.in" />
+            <arg path="${basedir}/build/templates/library-phar-autoload.php.in" />
             <arg path="${basedir}/build/phar-scoped" />
         </exec>
 
-        <copy file="${basedir}/build/binary-phar-autoload.php.in" tofile="${basedir}/build/binary-phar-autoload.php"/>
+        <copy file="${basedir}/build/templates/binary-phar-autoload.php.in" tofile="${basedir}/build/binary-phar-autoload.php"/>
         <replace file="${basedir}/build/binary-phar-autoload.php" token="X.Y.Z" value="${_version}"/>
 
         <exec executable="${basedir}/tools/phpab" taskname="phpab" failonerror="true">
@@ -403,13 +396,13 @@
             <arg value="--hash" />
             <arg value="SHA-1" />
             <arg value="--output" />
-            <arg path="${basedir}/build/phpunit-${_version}.phar" />
+            <arg path="${basedir}/build/artifacts/phpunit-${_version}.phar" />
             <arg value="--template" />
             <arg path="${basedir}/build/binary-phar-autoload.php" />
             <arg path="${basedir}/build/phar-scoped" />
         </exec>
 
-        <chmod file="${basedir}/build/phpunit-${_version}.phar" perm="ugo+rx"/>
+        <chmod file="${basedir}/build/artifacts/phpunit-${_version}.phar" perm="ugo+rx"/>
 
         <delete dir="${basedir}/build/phar"/>
         <delete dir="${basedir}/build/phar-scoped"/>
@@ -417,11 +410,11 @@
     </target>
 
     <target name="-phar-determine-version">
-        <exec executable="${basedir}/build/version.php" outputproperty="version" failonerror="true" />
+        <exec executable="${basedir}/build/scripts/version.php" outputproperty="version" failonerror="true" />
     </target>
 
     <target name="generate-project-documentation" depends="-phploc,-checkstyle,-phpunit">
-        <exec executable="${basedir}/tools/phpdox" dir="${basedir}/build" taskname="phpdox"/>
+        <exec executable="${basedir}/tools/phpdox" dir="${basedir}/build/config" taskname="phpdox"/>
     </target>
 
     <target name="update-tools">
@@ -436,7 +429,7 @@
     </target>
 
     <target name="generate-global-assert-wrappers" description="Generate global function wrappers for static methods in Assert and TestCase that are commonly used">
-        <exec executable="${basedir}/build/generate_global_assert_wrappers.php" taskname="generate-global-assert-wrappers" failonerror="true"/>
+        <exec executable="${basedir}/build/scripts/generate-global-assert-wrappers.php" taskname="generate-global-assert-wrappers" failonerror="true"/>
         <exec executable="${basedir}/tools/php-cs-fixer" taskname="php-cs-fixer" failonerror="true">
             <arg value="fix"/>
             <arg path="${basedir}/src/Framework/Assert/Functions.php"/>
@@ -447,14 +440,14 @@
         <exec executable="${basedir}/tools/phploc" output="/dev/null" taskname="phploc">
             <arg value="--count-tests"/>
             <arg value="--log-xml"/>
-            <arg path="${basedir}/build/logfiles/phploc.xml"/>
+            <arg path="${basedir}/build/artifacts/logfiles/phploc.xml"/>
             <arg path="${basedir}/src"/>
             <arg path="${basedir}/tests"/>
         </exec>
     </target>
 
     <target name="-checkstyle" depends="prepare">
-        <exec executable="${basedir}/tools/php-cs-fixer" output="${basedir}/build/logfiles/checkstyle.xml" error="/dev/null" taskname="php-cs-fixer">
+        <exec executable="${basedir}/tools/php-cs-fixer" output="${basedir}/build/artifacts/logfiles/checkstyle.xml" error="/dev/null" taskname="php-cs-fixer">
             <arg value="--diff"/>
             <arg value="--dry-run"/>
             <arg value="fix"/>
@@ -465,9 +458,9 @@
     <target name="-phpunit" depends="setup">
         <exec executable="${basedir}/phpunit" taskname="phpunit">
             <arg value="--coverage-xml"/>
-            <arg path="${basedir}/build/logfiles/coverage"/>
+            <arg path="${basedir}/build/artifacts/logfiles/coverage"/>
             <arg value="--log-junit"/>
-            <arg path="${basedir}/build/logfiles/junit.xml"/>
+            <arg path="${basedir}/build/artifacts/logfiles/junit.xml"/>
         </exec>
     </target>
 </project>
diff --git a/build/github-ci-fail.xml b/build/config/github-ci-fail.xml
similarity index 73%
rename from build/github-ci-fail.xml
rename to build/config/github-ci-fail.xml
index af071f767ef..94d1cda5331 100644
--- a/build/github-ci-fail.xml
+++ b/build/config/github-ci-fail.xml
@@ -1,12 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.4/phpunit.xsd"
-         bootstrap="../tests/bootstrap.php"
-         backupGlobals="false"
+         bootstrap="../../tests/bootstrap.php"
          verbose="true">
   <testsuites>
     <testsuite name="small">
-      <directory suffix=".phpt">../tests/fail</directory>
+      <directory suffix=".phpt">../../tests/fail</directory>
     </testsuite>
   </testsuites>
 
diff --git a/build/scoper.inc.php b/build/config/php-scoper.php
similarity index 100%
rename from build/scoper.inc.php
rename to build/config/php-scoper.php
diff --git a/build/phpdox.xml b/build/config/phpdox.xml
similarity index 72%
rename from build/phpdox.xml
rename to build/config/phpdox.xml
index 01c4d6789cb..40bbacec4af 100644
--- a/build/phpdox.xml
+++ b/build/config/phpdox.xml
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <phpdox xmlns="http://xml.phpdox.net/config">
-    <project name="PHPUnit" source="../src" workdir="phpdox">
+    <project name="PHPUnit" source="../../src" workdir="../artifacts/phpdox">
         <collector publiconly="false">
             <include mask="*.php" />
         </collector>
 
         <generator output=".">
-            <enrich base="logfiles">
+            <enrich base="../artifacts/logfiles">
                 <source type="build" />
                 <source type="git" />
                 <source type="phploc" />
@@ -14,7 +14,7 @@
                 <source type="phpunit" />
             </enrich>
 
-            <build engine="html" enabled="true" output="documentation">
+            <build engine="html" enabled="true" output="../artifacts/documentation">
                 <file extension="html" />
             </build>
         </generator>
diff --git a/build/generate_global_assert_wrappers.php b/build/scripts/generate-global-assert-wrappers.php
similarity index 96%
rename from build/generate_global_assert_wrappers.php
rename to build/scripts/generate-global-assert-wrappers.php
index 2202f400b27..897e32bd3f7 100755
--- a/build/generate_global_assert_wrappers.php
+++ b/build/scripts/generate-global-assert-wrappers.php
@@ -4,10 +4,10 @@
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\Constraint\Constraint;
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
 /** @var string[] $lines */
-$lines = \file(__DIR__ . '/../src/Framework/Assert.php');
+$lines = \file(__DIR__ . '/../../src/Framework/Assert.php');
 
 $buffer = '<?php declare(strict_types=1);
 /*
@@ -213,4 +213,4 @@ function onConsecutiveCalls(): ConsecutiveCallsStub
 }
 ';
 
-\file_put_contents(__DIR__ . '/../src/Framework/Assert/Functions.php', $buffer);
+\file_put_contents(__DIR__ . '/../../src/Framework/Assert/Functions.php', $buffer);
diff --git a/build/lint-xml-configuration b/build/scripts/lint-xml-configuration
similarity index 100%
rename from build/lint-xml-configuration
rename to build/scripts/lint-xml-configuration
diff --git a/build/phar-manifest.php b/build/scripts/phar-manifest.php
similarity index 90%
rename from build/phar-manifest.php
rename to build/scripts/phar-manifest.php
index 70795051516..a794e6ba515 100755
--- a/build/phar-manifest.php
+++ b/build/scripts/phar-manifest.php
@@ -14,7 +14,7 @@
 
 print "\n";
 
-$lock = \json_decode(\file_get_contents(__DIR__ . '/../composer.lock'));
+$lock = \json_decode(\file_get_contents(__DIR__ . '/../../composer.lock'));
 
 foreach ($lock->packages as $package) {
     print $package->name . ': ' . $package->version;
diff --git a/build/phar-version.php b/build/scripts/phar-version.php
similarity index 72%
rename from build/phar-version.php
rename to build/scripts/phar-version.php
index 29fda400668..4734678710d 100755
--- a/build/phar-version.php
+++ b/build/scripts/phar-version.php
@@ -6,11 +6,11 @@
 }
 
 \file_put_contents(
-    __DIR__ . '/phar/phpunit/Runner/Version.php',
+    __DIR__ . '/../phar/phpunit/Runner/Version.php',
     \str_replace(
         'private static $pharVersion;',
         'private static $pharVersion = "' . $argv[1] . '";',
-        \file_get_contents(__DIR__ . '/phar/phpunit/Runner/Version.php')
+        \file_get_contents(__DIR__ . '/../phar/phpunit/Runner/Version.php')
     )
 );
 
diff --git a/build/sanity-check b/build/scripts/sanity-check
similarity index 81%
rename from build/sanity-check
rename to build/scripts/sanity-check
index 7676900f5be..2ceb5ca9743 100755
--- a/build/sanity-check
+++ b/build/scripts/sanity-check
@@ -2,7 +2,7 @@
 
 PHP_BINARY=${PHP_BINARY:-php}
 
-${PHP_BINARY} -d assert.exception=On -d zend.assertions=1 ./phpunit --configuration ./build/github-ci-fail.xml
+${PHP_BINARY} -d assert.exception=On -d zend.assertions=1 ./phpunit --configuration ./build/config/github-ci-fail.xml
 
 if [ $? -eq 0 ]; then
   echo "This test should have failed.";
diff --git a/build/version.php b/build/scripts/version.php
similarity index 62%
rename from build/version.php
rename to build/scripts/version.php
index 21b65a0b7ea..d86bdb0a0da 100755
--- a/build/version.php
+++ b/build/scripts/version.php
@@ -1,14 +1,14 @@
 #!/usr/bin/env php
 <?php declare(strict_types=1);
 
-require __DIR__ . '/../vendor/autoload.php';
+require __DIR__ . '/../../vendor/autoload.php';
 
 use SebastianBergmann\Version;
 
-$buffer  = \file_get_contents(__DIR__ . '/../src/Runner/Version.php');
+$buffer  = \file_get_contents(__DIR__ . '/../../src/Runner/Version.php');
 $start   = \strpos($buffer, 'new VersionId(\'') + \strlen('new VersionId(\'');
 $end     = \strpos($buffer, '\'', $start);
 $version = \substr($buffer, $start, $end - $start);
-$version = new Version($version, __DIR__ . '/../');
+$version = new Version($version, __DIR__ . '/../../');
 
 print $version->getVersion();
diff --git a/build/binary-phar-autoload.php.in b/build/templates/binary-phar-autoload.php.in
similarity index 100%
rename from build/binary-phar-autoload.php.in
rename to build/templates/binary-phar-autoload.php.in
diff --git a/build/library-phar-autoload.php.in b/build/templates/library-phar-autoload.php.in
similarity index 100%
rename from build/library-phar-autoload.php.in
rename to build/templates/library-phar-autoload.php.in