Download - Deploying PHP applications with Phing

Deploying PHP applications with Phing – 1 / 37

Deploying PHP applications with Phing

Michiel Rook

PHPNW11 - October 8th, 2011

About me


� Freelance PHP/Java consultant

� Phing project lead

� http://www.linkedin.com/in/michieltcs

� @michieltcs

http://www.linkedin.com/in/michieltcs

http://twitter.com/michieltcs

About Phing


� PHing Is Not GNU make; it’s a PHP project build system or build tool based on

Apache Ant.

� Originally developed by Binarycloud

� Ported to PHP5 by Hans Lellelid

� I joined in 2005

Features


� Scripting using XML build files

� Mostly cross-platform

� Interface to various popular (PHP) tools

Features


Installation


� PEAR installation

$ pear channel-discover pear.phing.info$ pear install [--alldeps] phing/phing

� Optionally, install the documentation package

$ pear install phing/phingdocs

Why Use A Build Tool?


Why Use A Build Tool


� Repetitive tasks

� Version control

� (Unit) Testing

� Configuring

� Packaging

� Uploading

� DB changes

� ...

Why Use A Build Tool


� For developers and administrators

� Automate!

� Easier handover to new team members

� Improves quality

� Reduces errors

� Saves time

Why Use Phing


� Rich set of tasks

� Integration with PHP specific tools

� Allows you to stay in the PHP infrastructure

� Easy to extend

� Embed PHP code directly in the build file

Why Use Phing


� Rich set of tasks

� Integration with PHP specific tools

� Allows you to stay in the PHP infrastructure

� Easy to extend

� Embed PHP code directly in the build file

� ... in the end, the choice is yours

The Basics


Build Files


� Phing uses XML build files

� Contain standard elements

� Task: code that performs a specific function (svn checkout, mkdir, etc.)

� Target: groups of tasks, can optionally depend on other targets

� Project: root node, contains multiple targets

Example Build File


<project name="Example" default="world"><target name="hello">

<echo>Hello</echo></target>

<target name="world" depends="hello"><echo>World!</echo>

</target></project>

Properties


� Simple key-value files (.ini)

## build.propertiesversion=1.0

� Can be expanded by using ${key} in the build file

$ phing -propertyfile build.properties ...

<project name="Example" default="default"><property file="build.properties" />

<target name="default"><echo>${version}</echo>

</target></project>

File Sets


� Constructs a group of files to process

� Supported by most tasks

<fileset dir="./application" includes="**"/>

<fileset dir="./application"><include name="**/*.php" /><exclude name="**/*Test.php" />

</fileset>

� Supports references

<fileset dir="./application" includes="**" id="files"/>

<fileset refid="files"/>

File Sets


� Selectors allow fine-grained matching on certain attributes

� contains, date, file name & size, ...

<fileset dir="${dist}"><and>

<filename name="**"/><date datetime="01/01/2011" when="before"/>

</and></fileset>

Mappers and Filters


� Transform files during copy/move/...

� Mappers

� Change filename

� Filters

� Strip comments, white space

� Replace values

� Perform XSLT transformation

� Translation (i18n)

Mappers and Filters


<copy todir="${build}"><fileset refid="files"/><mapper type="glob" from="*.txt" to="*.new.txt"/><filterchain>

<replaceregexp><regexp pattern="\r\n" replace="\n"/><expandproperties/>

</replaceregexp></filterchain>

</copy>

Practical Examples


Testing


� Built-in support for PHPUnit / SimpleTest

� Code coverage through XDebug

� Various output formats

PHPUnit


<target name="test"><coverage-setup database="reports/coverage.db">

<fileset dir="src"><include name="**/*.php"/><exclude name="**/*Test.php"/>

</fileset></coverage-setup><phpunit codecoverage="true">

<formatter type="xml" todir="reports"/><batchtest>

<fileset dir="src"><include name="**/*Test.php"/>

</fileset></batchtest>

</phpunit><phpunitreport infile="reports/testsuites.xml"

format="frames" todir="reports/tests"/><coverage-report outfile="reports/coverage.xml">

<report todir="reports/coverage" title="Demo"/></coverage-report>

</target>

DocBlox


<target name="docs"><docblox title="Phing API Documentation"

output="docs" quiet="true"><fileset dir="../../classes">

<include name="**/*.php"/></fileset>

</docblox></target>

Database Migration


� DbDeploy

� Set of delta files (SQL)

� Tracks current version in changelog table

� Generates do & undo scripts

Database Migration


� Numbered delta file (1-create-post.sql)

� Apply & undo statements

--//

CREATE TABLE ‘post‘ (‘title‘ VARCHAR(255),‘time_created‘ DATETIME,‘content‘ MEDIUMTEXT

);

--//@UNDO

DROP TABLE ‘post‘;

--//

Database Migration


<target name="migrate"><dbdeploy

url="sqlite:test.db"dir="deltas"outputfile="deploy.sql"undooutputfile="undo.sql"/>

<pdosqlexecsrc="deploy.sql"url="sqlite:test.db"/>

</target>

Packaging


� Create complete PEAR packages

<pearpkg name="demo" dir="."><fileset refid="files"/>

<option name="outputdirectory" value="./build"/><option name="description">Test package</option><option name="version" value="0.1.0"/><option name="state" value="beta"/>

<mapping name="maintainers"><element>

<element key="handle" value="test"/><element key="name" value="Test"/><element key="email" value="[email protected]"/><element key="role" value="lead"/>

</element></mapping>

</pearpkg>

Packaging


� Then build a TAR

<tar compression="gzip" destFile="package.tgz"basedir="build"/>

� ... or ZIP

<zip destfile="htmlfiles.zip"><fileset dir=".">

<include name="**/*.html"/></fileset>

</zip>

Deployment


� SSH

<scp username="john" password="smith"host="webserver" todir="/www/htdocs/project/"><fileset dir="test">

<include name="*.html"/></fileset>

</scp>

� FTP

<ftpdeployhost="server01"username="john"password="smit"dir="/var/www"><fileset dir=".">

<include name="*.html"/></fileset>

</ftpdeploy>

Extending Phing


Extending Phing


� Numerous extension points

� Tasks

� Types

� Selectors

� Filters

� Mappers

� Loggers

� ...

Sample Task


<?

class SampleTask extends Task{

private $var;

public function setVar($v){

$this->var = $v;}

public function main(){

$this->log("value: " . $this->var);}

}

Sample Task


<project name="Example" default="default"><taskdef name="sample"

classpath="/dev/src"classname="tasks.my.SampleTask" />

<target name="default"><sample var="Hello World" />

</target></project>

Ad Hoc Extension


� Define a task within your build file

<target name="main"><adhoc-task name="foo"><![CDATA[class FooTest extends Task {

private $bar;

function setBar($bar) {$this->bar = $bar;

}

function main() {$this->log("In FooTest: " . $this->bar);

}}]]></adhoc-task><foo bar="TEST"/>

</target>

Demo


More Uses For Phing


� Installations and upgrades

� Bootstrapping development environments

� Code analysis

� Version control (SVN / GIT)

� Code encryption / encoding

More Uses For Phing


� Installations and upgrades

� Bootstrapping development environments

� Code analysis

� Version control (SVN / GIT)

� Code encryption / encoding

� Check the documentation!

The Future


� Improvements

� Better performance

� Increased test coverage

� Cross-platform compatibility

� Pain-free installation of dependencies (PHAR?)

� More documentation

� IDE support

� Moving to GitHub

� We would love (more) contributions!

Questions?


http://www.phing.info

http://joind.in/3590

#phing (freenode)

@phingofficial

Thank you!

http://www.phing.info

http://joind.in/3590

http://twitter.com/phingofficial