Phing for power users - frOSCon8

Phing for power users
Stephan Hochdörfer, bitExpert AG

About me
 Stephan Hochdörfer
 Head of IT at bitExpert AG, Germany
 enjoying PHP since 1999
 S.Hochdoerfer@bitExpert.de
 @shochdoerfer

I used to be an Ant fanboy...

What is Phing?

What is Phing?
It is a PHP project build system or
build tool based on Apache Ant.

What is Phing?
Domain Specific Language
for an project build system.

A build system for PHP code? Srsly?

Glue for all 3rd party tools

How to install Phing?

$> pear channeldiscover pear.phing.info
$> pear install phing/phing
How to install Phing? The PEAR way...
Installing Phing

$> phing v
Phing 2.5.0
$> pear channeldiscover pear.phing.info
$> pear install phing/phing
How to install Phing? The PEAR way...
Installing Phing
Running Phing:

Installing Phing globally? WTF?!?

Phing is „just another“
dependency for your project.

How to install Phing? The Composer way...

{
"require": {
"phing/phing": "2.5.0"
}
}
composer.json:

{
"require": {
"phing/phing": "2.5.0"
}
}
$> php composer.phar install
Loading composer repositories with package information
Installing dependencies
Installing phing/phing (2.5.0)
Downloading: 100%
Writing lock file
Generating autoload files
composer.json:
Running Composer:

Phing Basics

Phing Basics
Project, Target, Task, Properties

Phing Basics: Project
Root node of a build file
containing one or more targets.

Phing Basics: Target
A group of tasks that
run as an entity.

Phing Basics: Task
Custom piece of code to
perform a specific function.

Phing Basics: Properties
Properties (variables) help to
customize execution.

Phing Basics: Built-In Properties
e.g. host.os, line.separator,
phing.version, php.version, …

<?xml version="1.0"?>
<project name="myproject" default="init">
<target name="init">
<! insert logic here >
</target>
</project>
Phing Basics: Sample Build File

<project name="myproject" default="hello">
<target name="hello"
description="Says Hello, world!">
<echo msg="Hello, world!" />
</target>
</project>
Build File – Hello World example

Why Phing?
Runs everywhere where PHP runs.

Why Phing?
No additional depencendies needed
(e.g. Java, …).

Why Phing?
More than 120 predefined
tasks to choose from.

Why Phing?
Easy to extend by writing
custom tasks in PHP.

Enforce Internal Targets

<target name="init"
description="Property initialization">
<property name="Hello" value="Hello, world!" />
</target>
depends="init">
<echo msg="${Hello}" />
</target>
</project>

$> ./vendor/bin/phing -f build.xml hello
/tmp/myproject/build.xml
myproject > init:
myproject > hello:
[echo] Hello, world!
BUILD FINISHED
Total time: 0.0474 seconds

$> ./vendor/bin/phing -f build.xml init
/tmp/myproject/build.xml
myproject > init:
BUILD FINISHED

$> ./vendor/bin/phing -l
Buildfile: /tmp/myproject/build.xml
Default target:
---------------------------------------------------------
hello
Main targets:
---------------------------------------------------------
init Property initialization
Subtargets:
---------------------------------------------------------
hello

Internal targets are just helpers
like private methods.

<target name="-init"
</target>
depends="-init">
</target>
</project>
Enforce Internal Targets – The solution

$> ./vendor/bin/phing -f build.xml -init
Unknown argument: -init
phing [options] [target [target2 [target3] ...]]
Options:
-h -help print this message
-l -list list available targets
-v -version print the version information
-q -quiet be extra quiet
-verbose be extra verbose
-debug print debugging information
Report bugs to <dev@phing.tigris.org>

Are the targets really hidden?

Default target:
---------------------------------------------------------
hello
Main targets:
---------------------------------------------------------
-init Property initialization
Subtargets:
---------------------------------------------------------
hello

Enforce Internal Targets (Improved Version)
<target name="-init"
hidden="true"
</target>
depends="-init">
</target>
</project>

Default target:
---------------------------------------------------------
hello
Subtargets:
---------------------------------------------------------
hello
Enforce Internal Targets (Improved Version)

Custom Tasks

Custom Tasks
Phing can do way more
than simple exec calls!

Custom Task (Adhoc definition)
<adhoc-task name="mytask"><![CDATA[
class MyTask extends Task {
/**
* (non-PHPdoc)
* @see Task::main()
*/
public function main() {
// Custom code here...
}
}
]]></adhoc-task>
</target>
depends="init">
<mytask />
</target>
</project>

<?php
require_once 'phing/Task.php';
/**
* (non-PHPdoc)
* @see Task::main()
*/
}
}
Custom Task (External file)

<taskdef
name="mytask"
classpath="${project.basedir}"
classname="MyApp.Common.Phing.MyTask" />
</target>
depends="init">
<mytask />
</target>
</project>
Custom Task (External file)

<?php
protected $file;
/**
* @param string $file
*/
public function setFile($file) {
$this->file = $file;
}
/**
* @see Task::main()
*/
}
}
Custom Task with Parameters

<taskdef
name="mytask"
classpath="${project.basedir}"
classname="MyApp.Common.Phing.MyTask" />
</target>
depends="init">
<mytask file="myfile.txt" />
</target>
</project>
Custom Task with Parameters

Properties File

Properties File
Use properties to
cutomize build behaviour.

description="Says whatever you want to say">
<property
file="./build.properties" />
</target>
</project>
Properties File

description="Says whatever you want to say">
<property
file="./build.properties" />
</target>
</project>
Properties File
Hello=Hello, world!
build.properties:

Properties File
$> phing
myproject > hello:
[property] Loading /tmp/myproject/build.properties
BUILD FINISHED

Properties File - Improved version

Requirement: Externalize properties
but offer customization capabilities!

$> phing
myproject > prop:
[echo] Loading default build.properties
myproject > local-prop-check:
myproject > local-prop:
myproject > init:
myproject > hello:
BUILD FINISHED

$> phing
myproject > prop:
[echo] Loading default build.properties
myproject > local-prop-check:
myproject > local-prop:
[echo] Loading custom properties!
[property] Loading /tmp/myproject/local.properties
myproject > init:
myproject > hello:
[echo] Hello my world!
BUILD FINISHED

build.properties example
phpunit.path=vendor/bin/phpunit
phpunit.junit.log=build/logs/junit.xml
phpunit.coverage.clover=build/logs/clover.xml
phpunit.coverage.html=build/coverage
phpcs.path=vendor/bin/phpcs
phpcs.log=build/logs/checkstyle.xml
sencha.senchaCmd=/user/local/lib/sencha/sencha
sencha.jsb3File=app.jsb3

build.properties example
Use distinct naming conventions
for your properties.

Accessing application configuration

Duplicating configuration code
is a bad habit.

<?php
class ConfigMapperTask extends Task {
/**
* @see Task::main()
*/
// will import $APP_CONF in local context
require_once('src/bootstrap.php');
$project = $this->project;
$project->setProperty(
'db.host', $APP_CONF['db_host']);
'db.database', $APP_CONF['db_database']);
'db.user', $APP_CONF['db_user']);
'db.password', $APP_CONF['db_passwd']);
}
}

Imports for Targets can help structuring

<project name="myproject" default="app:run">

<import file="build/build.db.xml" />
<import file="build/build.app.xml" />
<import file="build/build.ci.xml" />
</project>
Imports for Targets can help structuring

<project name="myproject" default="app:run">

<import file="vendor/vendor1/lib1/build/build.xml" />
<import file="vendor/vendor2/lib2/build/build.xml" />
<import file="build/build.app.xml" />
</project>
Import Targets: Composer packages

Import Targets: Path handling
Be aware that imports behave
like include in PHP!

<project name="myproject" default="lib1:run">

<import file="vendor/lib1/build/build.xml" />
</project>
build.xml

<project name="lib1" default="lib1:run">
<target name="lib1:run">
<echo msg="Local dir: ${phing.dir.lib1}" />
<echo msg="Global dir: ${phing.dir}" />
</target>
</project>
<project name="myproject" default="lib1:run">

<import file="vendor/lib1/build/build.xml" />
</project>
build.xml
vendor/lib1/build/build.xml

$> ./vendor/bin/phing
myproject > lib1:run:
[echo] Local dir: /tmp/myproject/vendor/lib1/build
[echo] Global dir: /tmp/myproject
BUILD FINISHED

Be aware to always(!) use the
projects name in lowercase format!

It`s ${phing.dir.myproject}
not ${phing.dir.MyProject}!

Distinct Target Naming

<project name="myproject" default="ci:run-tests">
<target name="app:clean-cache">
</target>
<target name="app:create-cache">
</target>
<target name="db:migrate">
</target>
<target name="js:minifiy">
</target>
<target name="ci:lint">
</target>
<target name="ci:run-tests">
</target>
</project>
Distinct Target Naming

<project name="myproject" default="app:create-cache">
<target name="app:clean-cache"
description="Removes all cache files.">
</target>
<target name="app:create-cache"
description="Builds the cache files from the
xml configuration.">
</target>
</project>
Adding meaningful descriptions

$> phing -l
Default target:
-----------------------------------------------------
app:create-cache Builds the cache files from the xml
configuration.
Main targets:
------------------------------------------------------
app:clean-cache Removes all cache files.
app:create-cache Builds the cache files from the xml
configuration.
Adding meaningful descriptions

Prompt user for input
<project name="myproject" default="run">
<target name="run">

<input
propertyname="tag"
defaultValue="mytag">Tag to create?</input>
<liquibase-tag
tag="${tag}"
jar="/opt/liquibase/liquibase.jar"
classpathref="/opt/liquibase/lib/mysql.jar"
changelogFile="${project.basedir}/diff.xml"
username="liquibase"
password="liquibase"
url="jdbc:mysql://localhost/myproject"/>
</target>
</project>

Calling PHP functions from Phing

Calling PHP functions from Phing
<target name="run">

<php function="realpath"
returnProperty="app.dir">
<param value="${app.dir}"/>
</php>
</target>
</project>

Restrict user access

<target name="run">

<if>
<not>
<equals arg1="${env.USER}"
arg2="root" />
</not>
<then>
<fail message="Wrong user!" />
</then>
</if>
</target>
</project>
Restrict user access

Path handling

Path handling
<project name="myproject" default="ci:phpunit">

<target name="ci:phpunit"
depends="-init, -ci:prepare">
<resolvepath propertyName="phpunit.path.abs"
dir="${phing.dir}"
file="${phpunit.path}"/>
<exec executable="${phpunit.path.abs}" />
</target>
</project>

Phing + Jenkins

Phing + Jenkins
Install the Jenkins Phing plugin

Phing + Composer + Jenkins

Phing + Composer + Jenkins
Install the Jenkins EnvInject plugin

Follow conventions

Follow conventions
Phing expects your build file to be called
build.xml and the build’s properties file
build.properties

Follow conventions
Pick meaningful, human-readable
names for targets and properties.

Follow conventions
Make build files self-contained.

Image Credits
http://www.sxc.hu/photo/629370
http://www.sxc.hu/photo/615731

Phing for power users - frOSCon8

Related slideshows

More Related Content

Phing for power users - frOSCon8