├── .gitattributes
├── dist
    ├── bootstrap.php.dist
    ├── behat.yml.dist
    ├── phpmd.xml.dist
    ├── phpunit.xml.dist
    └── phpdox.xml.dist
├── .gitignore
├── composer.properties
├── composer.json
├── composer.xml
├── README.md
├── php-build-tools.properties
└── tests.xml


/.gitattributes:
--------------------------------------------------------------------------------
1 | # Normalize line endings
2 | *html text eol=lf
3 | 


--------------------------------------------------------------------------------
/dist/bootstrap.php.dist:
--------------------------------------------------------------------------------
1 | <?php
2 | // PHPUnit bootstrap
3 | require_once @phptools.phpunit.autoload@;
4 | 


--------------------------------------------------------------------------------
/dist/behat.yml.dist:
--------------------------------------------------------------------------------
1 | default:
2 |     paths:
3 |         features: @phptools.behat.features@
4 |         bootstrap: @phptools.behat.bootstrap@
5 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .*
 2 | # OS generated files #
 3 | ######################
 4 | .DS_Store
 5 | ehthumbs.db
 6 | Icon
 7 | Thumbs.db
 8 | .tmtags
 9 | tags
10 | vendor.tags
11 | tmtagsHistory
12 | 
13 | # IDE generated files #
14 | #######################
15 | 
16 | .project
17 | *.iml
18 | .idea/
19 | *.sublime-project
20 | *.sublime-workspace
21 | atlassian-ide-plugin.xml
22 | 
23 | composer.lock
24 | build
25 | vendor
26 | data
27 | !/.git*
28 | !/.travis.yml
29 | 
30 | 


--------------------------------------------------------------------------------
/composer.properties:
--------------------------------------------------------------------------------
1 | composer.project.dir           = ${basedir}
2 | composer.phar.path             = ${composer.project.dir}
3 | composer.phar.file             = composer.phar
4 | composer.phar                  = ${composer.phar.path}/${composer.phar.file}
5 | composer.lock.path             = ${phptools.project.dir}
6 | composer.lock.file             = composer.lock
7 | composer.lock                  = ${composer.lock.path}/${composer.lock.file}
8 | composer.vendordir             = ${composer.project.dir}/vendor
9 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "shrikeh/ant-phptools",
 3 |     "description": "Composer-friendly implementation of Jenkins PHP build tools",
 4 |     "homepage": "https://github.com/shrikeh/ant-phptools",
 5 |     "type": "library",
 6 |     "license": "MIT",
 7 |     "authors": [
 8 |         {
 9 |             "name": "Richard George",
10 |             "email": "Richard.George@fitchlearning.com"
11 |         },
12 |         {
13 |             "name": "Barney Hanlon",
14 |             "email": "TBC@somwhere.com"
15 |         }
16 |     ]
17 | 
18 | }
19 | 


--------------------------------------------------------------------------------
/dist/phpmd.xml.dist:
--------------------------------------------------------------------------------
 1 | <ruleset name="name-of-your-coding-standard"
 2 |   xmlns="http://pmd.sf.net/ruleset/1.0.0"
 3 |   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |   xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0
 5 |                       http://pmd.sf.net/ruleset_xml_schema.xsd"
 6 |   xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
 7 |   <description>Description of your coding standard</description>
 8 | 
 9 |   <rule ref="@phptools.phpmd.rulesets@/codesize.xml" />
10 |   <rule ref="@phptools.phpmd.rulesets@/unusedcode.xml" />
11 |   <rule ref="@phptools.phpmd.rulesets@/design.xml" />
12 |   <rule ref="@phptools.phpmd.rulesets@/controversial.xml" />
13 |   <rule ref="@phptools.phpmd.rulesets@/naming.xml" />
14 |   <!-- ... -->
15 | </ruleset>
16 | 


--------------------------------------------------------------------------------
/dist/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | 
 3 | <!-- http://www.phpunit.de/manual/current/en/appendixes.configuration.html -->
 4 | <phpunit
 5 |     backupGlobals               = "false"
 6 |     backupStaticAttributes      = "false"
 7 |     strict                      = "true"
 8 |     colors                      = "true"
 9 |     convertErrorsToExceptions   = "true"
10 |     convertNoticesToExceptions  = "true"
11 |     convertWarningsToExceptions = "true"
12 |     processIsolation            = "false"
13 |     stopOnFailure               = "false"
14 |     syntaxCheck                 = "false"
15 |     bootstrap                   = "@phptools.phpunit.bootstrap@"
16 |     >
17 | 
18 |     <filter>
19 |         <whitelist>
20 |             <directory>@phptools.phpunit.srcdir@</directory>
21 |         </whitelist>
22 |     </filter>
23 |     <logging>
24 |         <log type="junit" target="@phptools.phpunit.junit@"/>
25 |         <log type="coverage-html" target="@phptools.phpunit.coverage@" />
26 |         <log type="coverage-clover" target="@phptools.phpunit.clover@" />
27 |     </logging>
28 | </phpunit>
29 | 


--------------------------------------------------------------------------------
/dist/phpdox.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8" ?>
 2 | <phpdox xmlns="http://phpdox.de/config" silent="true">
 3 |     <project name="phpDox" source="@phptools.phpdox.srcdir@" workdir="@phptools.phpdox.workdir@">
 4 |         <collector publiconly="false" backend="parser" />
 5 |         <generator output="@phptools.phpdox.output@">
 6 |             <enrich path="@phptools.phpdox.enrichdir@">
 7 |                 <!-- enrichment source -->
 8 |                 <source type="checkstyle">
 9 |                     <file name="@phptools.phpcs.report.file@" />
10 |                 </source>
11 |                 <source type="pmd">
12 |                     <file name="@phptools.phpmd.reportfile.file@" />
13 |                 </source>
14 |                 <source type="clover">
15 |                     <file name="@phptools.phpunit.clover.file@" />
16 |                 </source>
17 |                 <source type="phpunit">
18 |                     <file name="@phptools.phpunit.junit.file@" />
19 |                 </source>
20 |             </enrich>
21 |             <build engine="html" enabled="true" output="html">
22 |                 <template dir="@phptools.phpdox.templates@" />
23 |                 <file extension="xhtml" />
24 |             </build>
25 |             <build engine="todo" enabled="true" output="todo">
26 |                 <file name="todolist.txt" encoding="utf-8" />
27 |             </build>
28 |             <build engine="graph" enabled="true" output="graph">
29 |                 <dot executable="@phptools.phpdox.dot@" options="" render="true" format="png" />
30 |             </build>
31 |         </generator>
32 |     </project>
33 | </phpdox>
34 | 


--------------------------------------------------------------------------------
/composer.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project name="composer" basedir=".">
 3 |     <dirname property="composer.basedir" file="${ant.file.composer}"/>
 4 |     <target name="init" unless="composer.properties">
 5 |         <property name="composer.file" value="composer.properties" />
 6 |         <property name="composer.properties" location="${composer.basedir}/${composer.file}" />
 7 |         <property file="${composer.properties}" />
 8 |         <echo message="using composer properties from ${composer.properties}" level="debug"/>
 9 |         <property name="composer.properties.filter" location="${composer.properties.tmp}" />
10 |         <echoproperties destfile="${composer.properties.filter}" prefix="composer."/>
11 |         <echo message="Expanded properties put into ${composer.properties.filter}" />
12 |     </target>
13 |     <target name="exists" description="Check that composer exists">
14 |         <available property="composer.run" file="${composer.phar}" />
15 |     </target>
16 |     <!-- Self-update composer -->
17 |     <target name="self-update" if="composer.self-update" unless="composer.installed" description="Self-update Composer">
18 |         <echo message="Self-updating composer" level="debug"/>
19 |         <exec executable="${composer.phar}">
20 |             <arg value="self-update" />
21 |             <arg value="--quiet" />
22 |             <arg value="--no-interaction" />
23 |         </exec>
24 |         <echo message="composer self-update complete" level="debug"/>
25 |     </target>
26 | 
27 |     <target name="self-install" unless="composer.run" depends='exists' description="Fetch Composer if it doesn't exist">
28 |         <echo message="Self-installing composer" level="debug"/>
29 |         <property name="composer.installed" value="1"/>
30 |         <property name="composer.run" value="1" />
31 |         <exec executable="/bin/bash">
32 |             <arg value="-c" />
33 |             <arg value="curl -s https://getcomposer.org/installer | php" />
34 |         </exec>
35 |         <echo message="composer self-install complete" level="debug"/>
36 |     </target>
37 | 
38 |     <target name="composer" depends="init, self-install, self-update" if="composer.run">
39 |         <condition property="composer.command" value="update" else="install">
40 |             <available file="${composer.lock}"/>
41 |         </condition>
42 |         <echo message="Beginning composer ${composer.command}" level="debug" />
43 |         <exec executable="${composer.phar}">
44 |             <arg value="${composer.command}" />
45 |             <arg value="--no-interaction" />
46 |             <arg value="--optimize-autoloader" />
47 |             <arg value="--dev" />
48 |         </exec>
49 |         <echo message="composer ${composer.command} complete" level="debug"/>
50 |     </target>
51 | </project>
52 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ant-phptools
  2 | ================
  3 | 
  4 | A Composer-friendly port of the PEAR-based Template for Jenkins Jobs for PHP Projects (http://jenkins-php.org)
  5 | 
  6 | ## Theory of operation
  7 | 
  8 | While the Jenkins Jobs relies on PEAR, this port relies on the new hotness that is Composer (http://getcomposer.org/).
  9 | While PEAR is a system-level library container, Composer is an application-level dependency manager, which allows more granularity of control over which libraries and version are required for use.
 10 | To get around the need for granular controls for testing, a Jenkins admin would have to install ALL the dependencies system-wide to meet any variety of testing criteria (TDD, BDD, SpecBDD, etc).
 11 | 
 12 | This library gets around this by keeping in sync with the application composer dependencies. It has hooks for:
 13 | 
 14 | * PHPUnit (https://github.com/sebastianbergmann/phpunit)
 15 | * Behat (http://behat.org/)
 16 | * PHPSpec2 (http://phpspec.net/)
 17 | * phpmd (PHP Mess Detector - http://phpmd.org/)
 18 | * phpcb (PHP Code Browser - https://github.com/Mayflower/PHP_CodeBrowser)
 19 | * phpcpd (PHP Copy Paste Detector - https://github.com/sebastianbergmann/phpcpd)
 20 | * phploc (PHP Lines of Code - https://github.com/sebastianbergmann/phploc)
 21 | * phpcs (PHP_CodeSniffer - https://github.com/squizlabs/PHP_CodeSniffer)
 22 | * pdepend (PHP_Depend - http://pdepend.org/)
 23 | 
 24 | 
 25 | ## Usage
 26 | 
 27 | Clone or download this repo into a location readable by ant:
 28 | 
 29 | ```shell
 30 | git clone https://github.com/shrikeh/ant-phptools.git
 31 | ```
 32 | 
 33 | Then, in your ant `build.xml` file, reference the `tests.xml` file by `<include>` (not `<import>`):
 34 | 
 35 | ```xml
 36 | <include file="${basedir}/ant-phptools/tests.xml"/>
 37 | ```
 38 | 
 39 | To use the tests, you can then simply add a reference to the tests within, such as:
 40 | ```xml
 41 | <target name="test" depends="prepare, phptools.phptests-parallel" />
 42 | ```
 43 | 
 44 | For every existing hook, the tools will check to see if the corresponding phar is available, and if so, it will assume the target is to be run. Thus, by adding or subtracting from your require-dev section of the `composer.json` file, your ant file will automatically run the new automated testing referenced.
 45 | 
 46 | These tools assume you have your tools installed to `vendor/bin`, which is the default. To achieve another location, add the following to your `composer.json` file:
 47 | 
 48 | ```json
 49 |     "config": {
 50 |         "bin-dir": "some-other-dir/bin"
 51 |     },
 52 | 
 53 | ```
 54 | There are a couple of variables you should change either in a properties file or in your build.xml if you wish to do this.
 55 | 
 56 | If you want to change the bin-dir globally, set a variable called `phptools.bindir` in your `build.xml` file:
 57 | 
 58 | ```xml
 59 | <property name="phptools.bindir" value="/path/to/tools/bin" />
 60 | ```
 61 | 
 62 | Or in your `.properties` file:
 63 | ```
 64 | phptools.bindir = /path/to/tools/bin
 65 | ```
 66 | 
 67 | If you don't use a bin dir for your tools, you can override either the path, the file, or both, for each tool:
 68 | 
 69 | ```xml
 70 | <property name="phptools.phpdox.phar" value="/path/to/phpdox/phar" />
 71 | <property name="phptools.phpunit.phar.path" value="/path/to/phpunit" />
 72 | ```
 73 | Each `phar` variable is constructed in the following format:
 74 | 
 75 | ```
 76 | phptools.[tool].phar = ${phptools.[tool].phar.path}/${phptools.[tool].phar.file}
 77 | 
 78 | ```
 79 | 
 80 | Which allows you to change either the path or the file, or simply override the resultant `.phar` variable if you prefer.
 81 | 
 82 | 
 83 | ## Further configuration
 84 | By default, the `tests.xml` uses sensible Symfony-style defaults for paths. However, ALL of the variables it uses are variables, allowing as much configuration as you wish.
 85 | 
 86 | There are several ways to configure the include:
 87 | 
 88 | * If you do not wish to use the default `php-build-tools.properties` file, copy the file, alter the values you wish, and simply set the `${phptools.properties}` to the path of the new file:
 89 | 
 90 | ```xml
 91 | <property name="${phptools.properties}" location="phptools.properties.local" />
 92 | ```
 93 | * Alternatively, you can set individual values. Because ant works on the theory that variables already configured are read only, you can set variables prior to running the `tests-parallel` target and all will be well.
 94 | 
 95 | ## @todo and coming soon
 96 | * Support for Composer self-update, install and update is included in composer.xml, but currently undocumented.
 97 | * The build will try and create phpunit.xml if it can't find one. This should be configurable.
 98 | * Full documentation for every variable
 99 | 
100 | 
101 | 


--------------------------------------------------------------------------------
/php-build-tools.properties:
--------------------------------------------------------------------------------
  1 | # Namespaced variables used by phptools
  2 | 
  3 | # The project directory including the phptools
  4 | phptools.project.dir                    = ${basedir}
  5 | 
  6 | # Temporary properties:
  7 | # Ant doesn't allow nested properties within filters, so to
  8 | # achieve this, we copy the expanded properties to a temporary file and then use this
  9 | # for filtering
 10 | phptools.properties.tmp.dir             = /tmp/
 11 | phptools.properties.tmp.file            = ${ant.project.name}.phptools.properties
 12 | phptools.properties.tmp                 = ${phptools.properties.tmp.dir}/${phptools.properties.tmp.file}
 13 | 
 14 | # The source directory for the site
 15 | phptools.srcdir                         = ${phptools.project.dir}/src
 16 | # The composer vendor directory for the site
 17 | phptools.vendordir                      = ${phptools.project.dir}/vendor
 18 | # The directory where all the php tools (phpunit, phpmd, etc) should be found.
 19 | phptools.bindir                         = ${phptools.vendordir}/bin
 20 | # The build directory
 21 | phptools.builddir                       = ${phptools.project.dir}/build
 22 | # The distribution directory. Used for copying/filtering templates for phpunit, behat, etc
 23 | phptools.distdir                        = ${phptools.basedir}/dist
 24 | # The log directory
 25 | phptools.logdir                         = ${phptools.builddir}/logs
 26 | #
 27 | phptools.parallel                       = true
 28 | phptools.threadcount                    = 2
 29 | 
 30 | phptools.phpdox.phar.path               = ${phptools.bindir}
 31 | phptools.phpdox.phar.file               = phpdox
 32 | phptools.phpdox.phar                    = ${phptools.phpdox.phar.path}/${phptools.phpdox.phar.file}
 33 | phptools.phpdox.dir                     = ${phptools.builddir}/api
 34 | phptools.phpdox.enrichdir               = ${phptools.logdir}
 35 | phptools.phpdox.dist.path               = ${phptools.distdir}
 36 | phptools.phpdox.dist.file               = phpdox.xml.dist
 37 | phptools.phpdox.dist                    = ${phptools.phpdox.dist.path}/${phptools.phpdox.dist.file}
 38 | phptools.phpdox.config.path             = ${phptools.builddir}
 39 | phptools.phpdox.config.file             = phpdox.xml
 40 | phptools.phpdox.config                  = ${phptools.phpdox.config.path}/${phptools.phpdox.config.file}
 41 | phptools.phpdox.output                  = ${phptools.phpdox.dir}/docs
 42 | phptools.phpdox.dot                     = /usr/bin/dot
 43 | phptools.phpdox.todofile                = todolist.txt
 44 | phptools.phpdox.srcdir                  = ${phptools.srcdir}
 45 | phptools.phpdox.workdir                 = ${phptools.phpdox.dir}/xml
 46 | phptools.phpdox.templates               = ${phptools.vendordir}/theseer/phpdox/templates/html
 47 | phptools.phpdox.failonerror             = false
 48 | phptools.phpdox.echolevel               = verbose
 49 | 
 50 | phptools.phpunit.phar.path              = ${phptools.bindir}
 51 | phptools.phpunit.phar.file              = phpunit
 52 | phptools.phpunit.phar                   = ${phptools.phpunit.phar.path}/${phptools.phpunit.phar.file}
 53 | phptools.phpunit.testdir                = ${phptools.project.dir}/tests
 54 | phptools.phpunit.srcdir                 = ${phptools.srcdir}
 55 | 
 56 | phptools.phpunit.bootstrap.path         = ${phptools.phpunit.testdir}
 57 | phptools.phpunit.bootstrap.file         = bootstrap.php
 58 | phptools.phpunit.bootstrap              = ${phptools.phpunit.bootstrap.path}/${phptools.phpunit.bootstrap.file}
 59 | phptools.phpunit.autoload               =  __DIR__ . '/../vendor/autoload.php'
 60 | phptools.phpunit.coverage.path          = ${phptools.builddir}
 61 | phptools.phpunit.coverage.name          = coverage
 62 | phptools.phpunit.coverage               = ${phptools.phpunit.coverage.path}/${phptools.phpunit.coverage.name}
 63 | 
 64 | phptools.phpunit.junit.path             = ${phptools.phpdox.enrichdir}
 65 | phptools.phpunit.junit.file             = junit.xml
 66 | phptools.phpunit.junit                  = ${phptools.phpunit.junit.path}/${phptools.phpunit.junit.file}
 67 | 
 68 | phptools.phpunit.clover.path            = ${phptools.phpdox.enrichdir}
 69 | phptools.phpunit.clover.file            = clover.xml
 70 | phptools.phpunit.clover                 = ${phptools.phpunit.clover.path}/${phptools.phpunit.clover.file}
 71 | 
 72 | phptools.phpunit.dist.bootstrap.path    = ${phptools.distdir}
 73 | phptools.phpunit.dist.bootstrap.file    = bootstrap.php.dist
 74 | phptools.phpunit.dist.bootstrap         = ${phptools.phpunit.dist.bootstrap.path}/${phptools.phpunit.dist.bootstrap.file}
 75 | 
 76 | phptools.phpunit.dist.config.path       = ${phptools.distdir}
 77 | phptools.phpunit.dist.config.file       = phpunit.xml.dist
 78 | phptools.phpunit.dist.config            = ${phptools.phpunit.dist.config.path}/${phptools.phpunit.dist.config.file}
 79 | phptools.phpunit.config.path            = ${phptools.phpunit.testdir}
 80 | phptools.phpunit.config.file            = phpunit.xml
 81 | phptools.phpunit.config                 = ${phptools.phpunit.config.path}/${phptools.phpunit.config.file}
 82 | phptools.phpunit.failonerror            = true
 83 | phptools.phpunit.echolevel              = verbose
 84 | 
 85 | phptools.behat.phar.path                = ${phptools.bindir}
 86 | phptools.behat.phar.file                = behat
 87 | phptools.behat.phar                     = ${phptools.behat.phar.path}/${phptools.behat.phar.file}
 88 | 
 89 | phptools.behat.dist.config.path         = ${phptools.distdir}
 90 | phptools.behat.dist.config.file         = behat.yml.dist
 91 | phptools.behat.dist.config              = ${phptools.behat.dist.config.path}/${phptools.behat.dist.config.file}
 92 | 
 93 | phptools.behat.config.path              = ${phptools.project.dir}
 94 | phptools.behat.config.file              = behat.yml
 95 | phptools.behat.config                   = ${phptools.behat.config.path}/${phptools.behat.config.file}
 96 | 
 97 | phptools.behat.features.path            = ${phptools.project.dir}
 98 | phptools.behat.features.name            = features
 99 | phptools.behat.features                 = ${phptools.behat.features.path}/${phptools.behat.features.name}
100 | 
101 | phptools.behat.bootstrap.path           = %behat.paths.features%
102 | phptools.behat.bootstrap.name           = bootstrap
103 | phptools.behat.bootstrap                = ${phptools.behat.bootstrap.path}/${phptools.behat.bootstrap.name}
104 | 
105 | phptools.behat.format                   = html
106 | phptools.behat.report.path              = ${phptools.builddir}/reports
107 | phptools.behat.report.file              = report.html
108 | phptools.behat.report                   = ${phptools.behat.report.path}/${phptools.behat.report.file}
109 | phptools.behat.srcdir                   = ${phptools.srcdir}
110 | phptools.behat.failonerror              = true
111 | phptools.behat.echolevel                = verbose
112 | 
113 | phptools.phpspec2.phar.path             = ${phptools.bindir}
114 | phptools.phpspec2.phar.file             = phpspec
115 | phptools.phpspec2.phar                  = ${phptools.phpspec2.phar.path}/${phptools.phpspec2.phar.file}
116 | phptools.phpspec2.spec.path             = ${phptools.project.dir}
117 | phptools.phpspec2.spec.name             = spec
118 | phptools.phpspec2.specs                 = ${phptools.phpspec2.spec.path}/${phptools.phpspec2.spec.name}
119 | phptools.phpspec2.failonerror           = true
120 | phptools.phpspec2.echolevel             = verbose
121 | phptools.phpspec2.log.path              = ${phptools.logdir}
122 | phptools.phpspec2.log.file              = phpspec.xml
123 | phptools.phpspec2.log                   = ${phptools.phpspec2.log.path}/${phptools.phpspec2.log.file}
124 | 
125 | phptools.phpcpd.phar.path               = ${phptools.bindir}
126 | phptools.phpcpd.phar.file               = phpcpd
127 | phptools.phpcpd.phar                    = ${phptools.phpcpd.phar.path}/${phptools.phpcpd.phar.file}
128 | phptools.phpcpd.log.path                = ${phptools.logdir}
129 | phptools.phpcpd.log.file                = pmdcpd.xml
130 | phptools.phpcpd.log                     = ${phptools.phpcpd.log.path}/${phptools.phpcpd.log.file}
131 | phptools.phpcpd.srcdir                  = ${phptools.srcdir}
132 | phptools.phpcpd.failonerror             = false
133 | phptools.phpcpd.echolevel               = verbose
134 | 
135 | phptools.phpmd.phar.path                = ${phptools.bindir}
136 | phptools.phpmd.phar.file                = phpmd
137 | phptools.phpmd.phar                     = ${phptools.phpmd.phar.path}/${phptools.phpmd.phar.file}
138 | phptools.phpmd.srcdir                   = ${phptools.srcdir}
139 | phptools.phpmd.format                   = xml
140 | phptools.phpmd.dist.path                = ${phptools.distdir}
141 | phptools.phpmd.dist.file                = phpmd.xml.dist
142 | phptools.phpmd.dist                     = ${phptools.phpmd.dist.path}/${phptools.phpmd.dist.file}
143 | phptools.phpmd.config.path              = ${phptools.builddir}
144 | phptools.phpmd.config.file              = phpmd.xml
145 | phptools.phpmd.config                   = ${phptools.phpmd.config.path}/${phptools.phpmd.config.file}
146 | 
147 | phptools.phpmd.reportfile.path          = ${phptools.phpdox.enrichdir}
148 | phptools.phpmd.reportfile.file          = pmd.xml
149 | phptools.phpmd.reportfile               = ${phptools.phpmd.reportfile.path}/${phptools.phpmd.reportfile.file}
150 | 
151 | phptools.phpmd.rulesets                 = ${phptools.vendordir}/phpmd/phpmd/src/main/resources/rulesets
152 | phptools.phpmd.failonerror              = false
153 | phptools.phpmd.echolevel               = verbose
154 | 
155 | phptools.pdepend.phar.path              = ${phptools.bindir}
156 | phptools.pdepend.phar.file              = pdepend
157 | phptools.pdepend.phar                   = ${phptools.pdepend.phar.path}/${phptools.pdepend.phar.file}
158 | phptools.pdepend.srcdir                 = ${phptools.srcdir}
159 | phptools.pdepend.path                   = ${phptools.builddir}/pdepend
160 | phptools.pdepend.xml.path               = ${phptools.logdir}
161 | phptools.pdepend.xml.file               = jdepend.xml
162 | phptools.pdepend.xml                    = ${phptools.pdepend.xml.path}/${phptools.pdepend.xml.file}
163 | phptools.pdepend.chart.path             = ${phptools.pdepend.path}
164 | phptools.pdepend.chart.file             = dependencies.svg
165 | phptools.pdepend.chart                  = ${phptools.pdepend.chart.path}/${phptools.pdepend.chart.file}
166 | phptools.pdepend.overview-pyramid.path  = ${phptools.pdepend.path}
167 | phptools.pdepend.overview-pyramid.file  = overview-pyramid.svg
168 | phptools.pdepend.overview-pyramid       = ${phptools.pdepend.overview-pyramid.path}/${phptools.pdepend.overview-pyramid.file}
169 | phptools.pdepend.failonerror            = false
170 | phptools.pdepend.echolevel              = verbose
171 | 
172 | phptools.phploc.phar.path               = ${phptools.bindir}
173 | phptools.phploc.phar.file               = phploc
174 | phptools.phploc.phar                    = ${phptools.phploc.phar.path}/${phptools.phploc.phar.file}
175 | phptools.phploc.csv.path                = ${phptools.builddir}
176 | phptools.phploc.csv.file                = phploc.csv
177 | phptools.phploc.csv                     = ${phptools.phploc.csv.path}/${phptools.phploc.csv.file}
178 | phptools.phploc.srcdir                  = ${phptools.srcdir}
179 | phptools.phploc.failonerror             = false
180 | phptools.phploc.echolevel               = verbose
181 | 
182 | phptools.phpcs.phar.path                = ${phptools.bindir}
183 | phptools.phpcs.phar.file                = phpcs
184 | phptools.phpcs.phar                     = ${phptools.phpcs.phar.path}/${phptools.phpcs.phar.file}
185 | phptools.phpcs.srcdir                   = ${phptools.srcdir}
186 | phptools.phpcs.standard                 = PSR2
187 | phptools.phpcs.report-format            = checkstyle
188 | phptools.phpcs.report.path              = ${phptools.phpdox.enrichdir}
189 | phptools.phpcs.report.file              = checkstyle.xml
190 | phptools.phpcs.report                   = ${phptools.phpcs.report.path}/${phptools.phpcs.report.file}
191 | phptools.phpcs.failonerror              = false
192 | phptools.phpcs.echolevel                = verbose
193 | 
194 | phptools.phpcb.phar.path                = ${phptools.bindir}
195 | phptools.phpcb.phar.file                = phpcb
196 | phptools.phpcb.phar                     = ${phptools.phpcb.phar.path}/${phptools.phpcb.phar.file}
197 | phptools.phpcb.logdir                   = ${phptools.logdir}
198 | phptools.phpcb.output.path              = ${phptools.builddir}
199 | phptools.phpcb.output.name              = code-browser
200 | phptools.phpcb.output                   = ${phptools.phpcb.output.path}/${phptools.phpcb.output.name}
201 | phptools.phpcb.srcdir                   = ${phptools.srcdir}
202 | phptools.phpcb.failonerror              = false
203 | phptools.phpcb.echolevel                = verbose
204 | 
205 | phptools.lint.srcdir                    = ${phptools.srcdir}
206 | phptools.lint.unitdir                   = ${phptools.phpunit.testdir}
207 | phptools.lint.failonerror               = true
208 | phptools.lint.echolevel                 = verbose
209 | 


--------------------------------------------------------------------------------
/tests.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project name="phptools" basedir=".">
  3 |     <dirname property="phptools.basedir" file="${ant.file.phptools}"/>
  4 | 
  5 |     <target name="tools-init-fallback" unless="phptools.properties">
  6 |         <property name="phptools.file" value="php-build-tools.properties"/>
  7 |         <property name="phptools.properties" location="${phptools.basedir}/${phptools.file}"/>
  8 |     </target>
  9 | 
 10 |     <target name="tools-init" depends="tools-init-fallback">
 11 |         <property file="${phptools.properties}"/>
 12 |         <echo message="using php tools properties from ${phptools.properties}" level="verbose"/>
 13 |         <!-- Use a timestamp to avoid collisions between builds of the same project -->
 14 |         <tstamp>
 15 |             <format property="phptools.properties.time" pattern="yyyyMMdd_HHmmss" />
 16 |         </tstamp>
 17 |         <property name="phptools.properties.filter" location="${phptools.properties.tmp}-${phptools.properties.time}" />
 18 |         <echoproperties destfile="${phptools.properties.filter}" prefix="phptools."/>
 19 |         <echo message="Expanded properties put into ${phptools.properties.filter}" level="verbose"/>
 20 |     </target>
 21 | 
 22 |     <target name="phptests" depends="phptests-parallel, phptests-serial"
 23 |         description="Entry point for php tests."/>
 24 | 
 25 |     <target name="phptests-serial" depends="tools-init, lint" unless="${phptools.parallel}"
 26 |         description="Run PHP tools in serial (after lint)">
 27 |         <echo message="Running PHP tools in serial mode" level="verbose"/>
 28 |         <antcall target="phptools.phpunit"/>
 29 |         <antcall target="phptools.behat"/>
 30 |         <antcall target="phptools.phpspec2" />
 31 |         <antcall target="phptools.phpmd-ci" />
 32 |         <antcall target="phptools.pdepend" />
 33 |         <antcall target="phptools.phpcpd" />
 34 |         <antcall target="phptools.phpcb" />
 35 |         <antcall target="phptools.phpcs-ci" />
 36 |         <antcall target="phptools.phploc" />
 37 |         <echo message="tools complete, generating documentation" level="verbose"/>
 38 |         <antcall target="phptools.phpdox" />
 39 |     </target>
 40 | 
 41 |     <target name="phptests-parallel" depends="tools-init, lint" if="${phptools.parallel}"
 42 |         description="Run PHP tools in parallel (after lint)">
 43 |         <echo message="Running PHP tools in parallel mode" level="verbose"/>
 44 |         <parallel threadCount="${phptools.threadcount}">
 45 |             <antcall target="phptools.phpunit"/>
 46 |             <antcall target="phptools.behat"/>
 47 |             <antcall target="phptools.phpspec2" />
 48 |             <antcall target="phptools.phpmd-ci" />
 49 |             <antcall target="phptools.pdepend" />
 50 |             <antcall target="phptools.phpcpd" />
 51 |             <antcall target="phptools.phpcb" />
 52 |             <antcall target="phptools.phpcs-ci" />
 53 |             <antcall target="phptools.phploc" />
 54 |         </parallel>
 55 |         <echo message="tools complete, generating documentation" level="verbose"/>
 56 |         <antcall target="phptools.phpdox" />
 57 |     </target>
 58 |     <target name="phpunit.exists" unless="phptools.phpunit.run" description="check if phpunit exists" depends="tools-init">
 59 |         <available property="phptools.phpunit.run" file="${phptools.phpunit.phar}" />
 60 |         <available property="phptools.phpunit.bootstrap.nocopy" file="${phptools.phpunit.bootstrap}" />
 61 |         <available property="phptools.phpunit.config.nocopy" file="${phptools.phpunit.config}" />
 62 |     </target>
 63 |     <target name="phpunit.bootstrap.copy" if="phptools.phpunit.run" unless="phptools.phpunit.bootstrap.nocopy"
 64 |         description="Copy a phpunit config file with sensible defaults if none exists">
 65 |         <echo message="Copying  ${phptools.phpunit.dist.bootstrap} to ${phptools.phpunit.bootstrap}" level="verbose" />
 66 |         <copy file="${phptools.phpunit.dist.bootstrap}" tofile="${phptools.phpunit.bootstrap}" overwrite="false" filtering="true">
 67 |             <filterset filtersfile="${phptools.properties.filter}"/>
 68 |         </copy>
 69 |     </target>
 70 |     <target name="phpunit.config.copy" if="phptools.phpunit.run" unless="phptools.phpunit.config.nocopy"
 71 |         description="Copy a phpunit config file with sensible defaults if none exists">
 72 |         <echo message="Copying ${phptools.phpunit.dist.config} to ${phptools.phpunit.config}" level="verbose" />
 73 |         <copy file="${phptools.phpunit.dist.config}" tofile="${phptools.phpunit.config}" overwrite="false" filtering="true">
 74 |             <filterset filtersfile="${phptools.properties.filter}"/>
 75 |         </copy>
 76 |     </target>
 77 |     <target name="phpunit" depends="tools-init, phpunit.exists, phpunit.bootstrap.copy, phpunit.config.copy" if="${phptools.phpunit.run}"
 78 |         description="Run unit tests with PHPUnit">
 79 |         <echo message="Running PHPUnit tests" level="${phptools.phpunit.echolevel}" />
 80 |         <exec dir="${phptools.builddir}" executable="${phptools.phpunit.phar}" failonerror="${phptools.phpunit.failonerror}">
 81 |             <arg value="--configuration" />
 82 |             <arg value="${phptools.phpunit.config}" />
 83 |             <arg path="${phptools.phpunit.testdir}" />
 84 |         </exec>
 85 |         <echo message="PHPUnit complete" level="${phptools.phpunit.echolevel}" />
 86 |     </target>
 87 | 
 88 |     <!-- Run Behat tests (http://behat.org/) -->
 89 |     <target name="behat.exists" unless="phptools.behat.run">
 90 |         <available property="phptools.behat.run" file="${phptools.behat.phar}" />
 91 |         <available property="phptools.behat.config.nocopy" file="${phptools.behat.config}" />
 92 |     </target>
 93 |     <target name="behat.config.copy" if="phptools.behat.run" unless="phptools.behat.config.nocopy"
 94 |         description="Copy a behat config file with sensible defaults if none exists">
 95 |         <echo message="Copying ${phptools.behat.dist.config} to ${phptools.behat.config}" level="${phptools.behat.echolevel}" />
 96 |         <copy file="${phptools.behat.dist.config}" tofile="${phptools.behat.config}" overwrite="false" filtering="true">
 97 |             <filterset filtersfile="${phptools.properties.filter}"/>
 98 |         </copy>
 99 |     </target>
100 |     <target name="behat" depends="tools-init, behat.exists, behat.config.copy" if="${phptools.behat.run}" description="Calculate software metrics using PHP_Depend">
101 |         <echo message="Behat found, running BDD tests" level="${phptools.behat.echolevel}" />
102 |         <exec dir="${phptools.builddir}" executable="${phptools.behat.phar}" failonerror="${phptools.behat.failonerror}">
103 |             <arg value="--config" />
104 |             <arg value="${phptools.behat.config}" />
105 |             <arg value="-f" />
106 |             <arg value="${phptools.behat.format}" />
107 |             <arg value="--out" />
108 |             <arg value="${phptools.behat.report}" />
109 |             <arg path="${phptools.behat.srcdir}" />
110 |         </exec>
111 |         <echo message="BDD tests complete" level="${phptools.behat.echolevel}" />
112 |     </target>
113 | 
114 |     <!-- Run phpspec (http://phpspec.net/) Specification BDD tests -->
115 |     <target name="phpspec2.exists" unless="phpspec2.run">
116 |         <available property="phptools.phpspec2.run" file="${phptools.phpspec2.phar}" />
117 |     </target>
118 |     <target name="phpspec2" depends="tools-init, phpspec2.exists" if="${phptools.phpspec2.run}" description="Calculate software metrics using PHP_Depend">
119 |         <echo message="PHPSpec2 found, running spec tests" level="${phptools.phpspec2.echolevel}"/>
120 |         <exec executable="${phptools.phpspec2.phar}" failonerror="${phptools.phpspec2.failonerror}">
121 |             <redirector output="${phptools.phpspec2.log}" alwayslog="true"/>
122 |             <arg value="run" />
123 |             <arg value="--no-interaction" />
124 |             <arg value="--no-code-generation" />
125 |             <arg value="--format=junit" />
126 |             <arg path="${phptools.phpspec2.specs}" />
127 |         </exec>
128 |         <echo message="Spec tests complete" level="${phptools.phpspec2.echolevel}" />
129 |     </target>
130 | 
131 |     <!-- Generate API documentation -->
132 |     <target name="phpdox.exists" unless="phptools.phpdox.run" description="Test that the phpdox phar is available"
133 |             depends="tools-init">
134 |         <available property="phptools.phpdox.run" file="${phptools.phpdox.phar}" />
135 |         <available property="phptools.phpdox.config.nocopy" file="${phptools.phpdox.config}" />
136 |     </target>
137 |     <target name="phpdox.copy" if="phptools.phpdox.run" unless="phptools.phpdox.config.nocopy"
138 |         description="Copy a phpDox config file with sensible defaults if none exists">
139 |         <echo message="No existing phpDox config found, copying ${phptools.phpdox.dist} to ${phptools.phpdox.config}"
140 |             level="${phptools.phpdox.echolevel}" />
141 |         <copy file="${phptools.phpdox.dist}" tofile="${phptools.phpdox.config}" overwrite="false" filtering="true">
142 |             <filterset filtersfile="${phptools.properties.filter}"/>
143 |         </copy>
144 |     </target>
145 |     <target name="phpdox" depends="tools-init, phpdox.exists, phpdox.copy" if="${phptools.phpdox.run}"
146 |         description="Generate API documentation using phpDox">
147 |         <echo message="Generating phpdox in ${phptools.phpdox.output}" level="${phptools.phpdox.echolevel}"/>
148 |         <exec dir="${phptools.builddir}" executable="${phptools.phpdox.phar}" failonerror="${phptools.phpdox.failonerror}">
149 |             <arg value="--file"/>
150 |             <arg value="${phptools.phpdox.config}"/>
151 |         </exec>
152 |         <echo message="documentation generation complete" level="${phptools.phpdox.echolevel}" />
153 |     </target>
154 | 
155 |     <target name="pdepend.exists" unless="phptools.pdepend.run" depends="tools-init">
156 |         <available property="phptools.pdepend.run" file="${phptools.pdepend.phar}" />
157 |     </target>
158 |     <target name="pdepend" depends="tools-init, pdepend.exists" if="${phptools.pdepend.run}"
159 |         description="Calculate software metrics using PHP_Depend">
160 |         <echo message="Calculating software metrics using PHP_Depend" level="${phptools.pdepend.echolevel}"/>
161 |         <exec dir="${phptools.builddir}" executable="${phptools.pdepend.phar}" failonerror="${phptools.pdepend.failonerror}">
162 |             <arg value="--jdepend-xml=${phptools.pdepend.xml}" />
163 |             <arg value="--jdepend-chart=${phptools.pdepend.chart}" />
164 |             <arg value="--overview-pyramid=${phptools.pdepend.overview-pyramid}" />
165 |             <arg path="${phptools.pdepend.srcdir}" />
166 |         </exec>
167 |         <echo message="PHP_Depend complete" level="${phptools.pdepend.echolevel}"/>
168 |     </target>
169 | 
170 |     <!-- PHP Copy paste detector tests -->
171 |     <target name="phpcpd.exists" unless="phptools.phpcpd.run" depends="tools-init">
172 |         <available property="phptools.phpcpd.run" file="${phptools.phpcpd.phar}" />
173 |     </target>
174 |     <target name="phpcpd" depends="tools-init, phpcpd.exists" if="${phptools.phpcpd.run}"
175 |         description="Find duplicate code using PHPCPD">
176 |         <echo message="Find duplicate code using PHPCPD: (${phptools.phpcpd.phar})" level="${phptools.phpcpd.echolevel}" />
177 |         <exec dir="${phptools.builddir}" executable="${phptools.phpcpd.phar}" failonerror="${phptools.phpcpd.failonerror}">
178 |             <arg value="--log-pmd" />
179 |             <arg value="${phptools.phpcpd.log}" />
180 |             <arg path="${phptools.phpcpd.srcdir}" />
181 |         </exec>
182 |         <echo message="PHP Copy-Paste Detection complete" level="${phptools.phpcpd.echolevel}" />
183 |     </target>
184 | 
185 |     <!-- Setup PHP_CodeBrowser (https://github.com/Mayflower/PHP_CodeBrowser) -->
186 |     <target name="phpcb.exists" depends="tools-init">
187 |         <available property="phptools.phpcb.run" file="${phptools.phpcb.phar}" />
188 |     </target>
189 |     <target name="phpcb" depends="tools-init, phpcb.exists" if="${phptools.phpcb.run}"
190 |         description="Aggregate tool output with PHP_CodeBrowser">
191 |         <echo message="Beginning PHP_CodeBrowser aggregation" level="${phptools.phpcb.echolevel}" />
192 |         <exec dir="${phptools.builddir}" executable="${phptools.phpcb.phar}" failonerror="${phptools.phpcb.failonerror}">
193 |             <arg value="--log" />
194 |             <arg path="${phptools.phpcb.logdir}" />
195 |             <arg value="--output" />
196 |             <arg path="${phptools.phpcb.output}" />
197 |             <arg value="--source" />
198 |             <arg path="${phptools.phpcb.srcdir}" />
199 |         </exec>
200 |         <echo message="PHP_CodeBrowser aggregation complete, logged to ${phptools.phpcb.logdir}"
201 |             level="${phptools.phpcb.echolevel}" />
202 |     </target>
203 | 
204 |     <target name="lint" description="Perform static code checking of PHP files" depends="tools-init">
205 |         <echo message="Beginning lint tests" level="${phptools.lint.echolevel}"/>
206 |         <apply executable="php" failonerror="${phptools.lint.failonerror}">
207 |             <arg value="-l" />
208 |             <fileset dir="${phptools.lint.srcdir}">
209 |                 <include name="**/*.php" />
210 |             </fileset>
211 |         </apply>
212 |         <echo message="Lint complete" level="${phptools.lint.echolevel}"/>
213 |     </target>
214 | 
215 |     <target name="phploc.exists" unless="phptools.phploc.run" depends="tools-init">
216 |         <available property="phptools.phploc.run" file="${phptools.phploc.phar}"/>
217 |     </target>
218 |     <target name="phploc" depends="tools-init, phploc.exists" if="${phptools.phploc.run}" description="Measure project size using PHPLOC">
219 |         <echo message="Running PHPLOC" level="${phptools.phploc.echolevel}"/>
220 |         <exec dir="${phptools.builddir}" executable="${phptools.phploc.phar}" failonerror="${phptools.phploc.failonerror}">
221 |             <arg value="--log-csv" />
222 |             <arg value="${phptools.phploc.csv}" />
223 |             <arg path="${phptools.phploc.srcdir}" />
224 |         </exec>
225 |         <echo message="PHPLOC complete" level="${phptools.phploc.echolevel}"/>
226 |     </target>
227 | 
228 |     <!-- PHP CodeSniffer tests -->
229 |     <target name="phpcs.exists" unless="phptools.phpcs.run" depends="tools-init">
230 |         <available property="phptools.phpcs.run" file="${phptools.phpcs.phar}" />
231 |     </target>
232 |     <target name="phpcs-ci" depends="tools-init, phpcs.exists" if="${phptools.phpcs.run}" description="Find coding standard violations using PHP_CodeSniffer creating a log file for the continuous integration server">
233 |         <echo message="Running PHP CodeSniffer: ${phptools.phpcs.phar}" level="${phptools.phpcs.echolevel}"/>
234 |         <exec dir="${phptools.builddir}" executable="${phptools.phpcs.phar}" failonerror="${phptools.phpcs.failonerror}">
235 |             <arg value="--standard=${phptools.phpcs.standard}" />
236 |             <arg value="--report=${phptools.phpcs.report-format}" />
237 |             <arg value="--report-file=${phptools.phpcs.report}" />
238 |             <arg value="--report-summary=${phptools.phpcs.report}.summary.log" />
239 |              <!-- Quick fix for XML overwritten by summary; FIXME make this properly configurable -->
240 |             <arg path="${phptools.phpcs.srcdir}" />
241 |         </exec>
242 |         <echo message="PHP CodeSniffer complete, logged to ${phptools.phpcs.report}" level="${phptools.phpcs.echolevel}"/>
243 |     </target>
244 |     <target name="phpcs" depends="tools-init, phpcs.exists" description="Find coding standard violations using PHP_CodeSniffer">
245 |         <exec dir="${phptools.builddir}" executable="${phptools.phpcs.phar}">
246 |             <arg value="--standard=${phptools.phpcs.standard}" />
247 |             <arg path="${phptools.phpcs.srcdir}" />
248 |         </exec>
249 |     </target>
250 | 
251 |     <!-- PHP Mess Detector -->
252 |     <target name="phpmd.exists" unless="phptools.phpmd.run" depends="tools-init">
253 |         <available property="phptools.phpmd.run" file="${phptools.phpmd.phar}"/>
254 |         <available property="phptools.phpdox.config.nocopy" file="${phptools.phpmd.config}"/>
255 |     </target>
256 |     <target name="phpmd.copy" if="phptools.phpdox.run" unless="phptools.phpdox.config.nocopy">
257 |         <echo message="No existing phpmd config found, copying ${phptools.phpmd.dist} to ${phptools.phpmd.config}" level="verbose" />
258 |         <copy file="${phptools.phpmd.dist}" tofile="${phptools.phpmd.config}" overwrite="false" filtering="true">
259 |             <filterset filtersfile="${phptools.properties.filter}"/>
260 |         </copy>
261 |     </target>
262 |     <target name="phpmd-ci" depends="tools-init, phpmd.exists, phpmd.copy" if="${phptools.phpmd.run}" description="Perform project mess detection using PHPMD">
263 |         <echo message="Running PHP Mess Detector" level="${phptools.phpmd.echolevel}"/>
264 |         <copy file="${phptools.phpmd.dist}" tofile="${phptools.phpmd.config}" overwrite="false" filtering="true">
265 |             <filterset filtersfile="${phptools.properties.filter}"/>
266 |         </copy>
267 |         <exec dir="${phptools.builddir}" executable="${phptools.phpmd.phar}" failonerror="${phptools.phpmd.failonerror}">
268 |             <arg path="${phptools.phpmd.srcdir}" />
269 |             <arg value="${phptools.phpmd.format}" />
270 |             <arg value="${phptools.phpmd.config}" />
271 |             <arg value="--reportfile" />
272 |             <arg value="${phptools.phpmd.reportfile}" />
273 |         </exec>
274 |         <echo message="Mess Detection complete, logged to ${phptools.phpmd.reportfile}" level="${phptools.phpmd.echolevel}"/>
275 |     </target>
276 |     <target name="phpmd" depends="tools-init, phpmd.exists, phpmd.copy" if="${phptools.phpmd.run}" description="Perform project mess detection using PHPMD">
277 |         <echo message="Running PHP Mess Detector" level="${phptools.phpmd.echolevel}"/>
278 |         <copy file="${phptools.phpmd.dist}" tofile="${phptools.phpmd.config}" overwrite="false" filtering="true">
279 |             <filterset filtersfile="${phptools.properties.filter}"/>
280 |         </copy>
281 |         <exec dir="${phptools.builddir}" executable="${phptools.phpmd.phar}" failonerror="${phptools.phpmd.failonerror}">
282 |             <arg path="${phptools.phpmd.srcdir}" />
283 |             <arg value="text" />
284 |             <arg value="${phptools.phpmd.config}" />
285 |         </exec>
286 |         <echo message="Mess Detection complete, logged to ${phptools.phpmd.reportfile}" level="${phptools.phpmd.echolevel}"/>
287 |     </target>
288 | </project>
289 | 


--------------------------------------------------------------------------------