Integração contínua em PHP com Jenkins

Integração
contínua
em PHP

Automating PHP
Continuous
Integration with
Jenkins

Gilmar Pupo
@gpupo

Sobre @gpupo
• Desenvolvedor e consultor em TI
• Doctrine ORM, Symfony, Perl, Bash,
Linux, jQuery e o que mais funcionar
• Membro e co-fundador do #maisagil
• Empreendedor no @hotellinux

www.gilmar.eti.br www.gpupo.com

Integração contínua @gpupo

PHPUnit
PHP_CodeSniffer
phpcpd
Jenkins

Ferramentas
Ant
<
Git
Capistrano
Testes Unitários
Testes
Funcionais
Documentação

PHPUnit
PHP_CodeSniffer
phpcpd
Jenkins

Ferramentas
Ant
<
Git
Testes Unitários
Testes
Funcionais
Documentação
www.delicious.com/gpupo/ci

Para que serve
• Reduzir retrabalho

• Reduzir custo de entrega

• Código de manutenção barata

• Identificar erros mais cedo


O que faz
• Verifica padrões

• Gera relatórios e alertas

• Gera documentação


O que faz
• Verifica duplicidade de código

• Recomenda o encapsulamento

• Identifica a % de código coberto

• Gera pacotes


Compatibilidade
• Incompatível com
Cowboy coding OS

http://en.wikipedia.org/wiki/Cowboy_coding


http://martinfowler.com/articles/continuousIntegration.html

“...em minha cópia de trabalho e faço o
que preciso para completar minha
tarefa. Isso irá consistir em alterar o
código de produção e também
adicionar ou alterar os testes
automatizados.

Integração Contínua assume um alto
nível de testes que são automatizados
no software: uma facilidade que eu
chamo de self-testing code...”


“...Uma vez que eu terminei, eu faço uma build
automatizada na minha máquina de
desenvolvimento.

Assim, o código fonte em minha cópia de
trabalho é pego, compilado e transformado em
um executável – e então é executado os testes
automáticos.

Somente se todas as builds e testes não tiverem
erros que tudo será considerado bom...”


“....Com uma boa build, eu posso então pensar em
colocar minhas alterações no repositório...

...Sendo assim, primeiro eu atualizo minha cópia de
trabalho com as mudanças feitas pelos outros e crio
uma nova build. Se as mudanças deles chocarem com
as minhas mudanças, será exibido erros tanto na
compilação quanto nos testes. Neste caso é minha a
responsabilidade de corrigir estes erros e repetir o
processo até que minha cópia local esteja sincronizada
com a versão principal......”


“...Uma vez que tenho as alterações na minha própria
build eu posso finalmente fazer o commit na versão
principal, que atualiza o repositório.

Entretanto meu commit não termina meu trabalho.
Nós fazemos uma build novamente, mas agora em
uma maquina de integração baseada na versão
principal do código. Somente com o sucesso desta
build poderemos dizer que as minhas alterações
foram feitas. ”


“...Sempre existe uma chance de eu ter
esquecido alguma coisa na minha máquina e
o repositório não ser atualizado corretamente.

Somente quando minha build de alterações
for lançada com sucesso na máquina de
integração é que o meu trabalho terminou...”


“...Se um choque ocorrer entre as versões de dois
desenvolvedores, isso geralmente é pego quando o
segundo desenvolvedor atualizar sua cópia local com
as builds feitas pelos outros.

Caso não, a build de integração deve falhar.

De qualquer modo o erro é detectado rapidamente.

Nesse momento a tarefa mais importante é
consertar os problemas, e fazer sua build voltar a
funcionar corretamente....”


“...A história anterior é uma apresentação da
Integração Contínua e de como ela funciona
diariamente. Colocar isso tudo pra funcionar sem
problemas envolve obviamente mais coisas do
que foi dito....”

Adaptação do artigo escrito por Martin Fowler

http://martinfowler.com/articles/continuousIntegration.html


“...Em um ambiente de Integração
Contínua você nunca deve ter uma build
de integração com falhas por muito
tempo. Um bom time deve ter muitas
builds corretas por dia.

Más builds podem ocorrer de tempos em
tempos, mas devem ser consertadas
rapidamente...”


Sem C.I.
Development Phase Testing Phase
Number of Bugs

Integration Phase

undetected bugs
Project Timeline

Gráfico de Arno Schneider @Barcelona PHP Conference, Feb. 23rd 2008


primeiros passos

Checkout / Update Local testing Resolve / Testing
Develop Update WC Commit

!
Receive
Build Result



Workflow com C.I. Server



O que faz
• Mantém Logs

• Reforça as políticas

• Informa status aos desenvolvedores

• Mantém rastreabilidade


Coding Style

• Zend Programmer's
Reference Guide
– Coding Style
• http://goo.gl/z9BWj


Coding Style

• PEARManual
– Coding Style
• http://goo.gl/JYKLu


Por que padrões
diferentes para a
mesma coisa ?
E uma crítica à
comunidade PHP

PHP CodeSniffer
• PHP CodeSniffer é um analizador de
código PHP que escaneia o seu
código e mostra erros e alertas
baseado em um conjunto de padrões
de código.


PHP CodeSniffer
• PHP CodeSniffer é um analizador de
código PHP que escaneia o seu
código e mostra erros e alertas
baseado em um conjunto de padrões
de código.

www.delicious.com/gpupo/codesniffer


PHP CodeSniffer
• PHP Code Sniffer (PHPCS) is a
package for syntax checking,
available from PEAR. It can check
code against defined rules covering
anything from whitespace through
doc comments to variable naming
conventions and beyond


Usage: phpcs [-nwlsapvi] [-d key[=value]]
[--report=<report>] [--report-file=<reportfile>] [--report-<report>=<reportfile>] ...
[--report-width=<reportWidth>] [--generator=<generator>] [--tab-width=<tabWidth>]
[--severity=<severity>] [--error-severity=<severity>] [--warning-severity=<severity>]
[--config-set key value] [--config-delete key] [--config-show]
[--standard=<standard>] [--sniffs=<sniffs>] [--encoding=<encoding>]
[--extensions=<extensions>] [--ignore=<patterns>] <file> ...
-n Do not print warnings (shortcut for --warning-severity=0)
-w Print both warnings and errors (on by default)
-l Local directory only, no recursion
-s Show sniff codes in all reports
-a Run interactively
-p Show progress of the run
-v[v][v] Print verbose output
-i Show a list of installed coding standards
-d Set the [key] php.ini value to [value] or [true] if value is omitted
--help Print this help message
--version Print version information
<file> One or more files and/or directories to check
<extensions> A comma separated list of file extensions to check
(only valid if checking a directory)
<patterns> A comma separated list of patterns to ignore files and directories
<encoding> The encoding of the files being checked (default is iso-8859-1)
<sniffs> A comma separated list of sniff codes to limit the check to
(all sniffs must be part of the specified standard)
<severity> The minimum severity required to display an error or warning
<standard> The name or path of the coding standard to use
<tabWidth> The number of spaces each tab represents
<generator> The name of a doc generator to use
(forces doc generation instead of checking)
<report> Print either the "full", "xml", "checkstyle", "csv", "emacs"
"source", "summary", "svnblame" or "gitblame" report
(the "full" report is printed by default)
<reportfile> Write the report to the specified file path
<reportWidth> How many columns wide screen reports should be printed

Configure (phpcs LIKE A BOSS)

sudo phpcs --config-set default_standard Zend
sudo phpcs --config-set zend_ca_path
/usr/share/php/phing/tasks/ext/ZendCodeAnalyzerTask.php

phpcs --config-show

phpcs --standard=/path/to/custom_ruleset.xml test.php

Eclipse plugin

http://www.phpsrc.org/eclipse/pti/

Eclipse plugin


http://www.phpsrc.org/projects/pti/wiki/Installation

Eclipse plugin


http://www.phpsrc.org/projects/pti/wiki/Installation
http://www.phpsrc.org/projects/pti-php-codesniffer/wiki/Configuration

$ phpcs --report=source .
PHP CODE SNIFFER VIOLATION SOURCE SUMMARY
--------------------------------------------------------------------------------
STANDARD CATEGORY SNIFF COUNT
--------------------------------------------------------------------------------
Generic White space Disallow tab indent tabs used 3
Generic Files Line length too long 6
PEAR Commenting File comment missing 4
PEAR Commenting Class comment missing 4
PEAR White space Scope indent incorrect 4
PEAR Commenting Function comment missing 4
PEAR Functions Function call signature close bracket line 4
PEAR Functions Function call signature content after open 4
PEAR Commenting Function comment wrong style 2
PEAR Commenting File comment wrong style 2
PEAR White space Object operator indent incorrect 1
--------------------------------------------------------------------------------
A TOTAL OF 48 SNIFF VIOLATION(S) WERE FOUND IN 11 SOURCE(S)
--------------------------------------------------------------------------------

Time: 1 second, Memory: 9.25Mb

$ phpcs --report=source .
PHP CODE SNIFFER VIOLATION SOURCE SUMMARY
--------------------------------------------------------------------------------
STANDARD CATEGORY SNIFF COUNT
--------------------------------------------------------------------------------
Generic White space Disallow tab indent tabs used 3
Generic Files Line length too long 6
PEAR Commenting File comment missing 4
PEAR Commenting Class comment missing 4
PEAR White space Scope indent incorrect 4
PEAR Commenting Function comment missing 4
PEAR Functions Function call signature close bracket line 4
PEAR Functions Function call signature content after open 4
PEAR Commenting Function comment wrong style 2
PEAR Commenting File comment wrong style 2
PEAR White space Object operator indent incorrect 1
--------------------------------------------------------------------------------
A TOTAL OF 48 SNIFF VIOLATION(S) WERE FOUND IN 11 SOURCE(S)
--------------------------------------------------------------------------------

Time: 1 second, Memory: 9.25Mb
find /usr/share/php/PHP/CodeSniffer/Standards/ -name "*Sniff.php" -and -not -name "Abstract*"

Está correto?

phpcs --standard=Zend
recipe.class.php

Está correto?

phpcs --standard=Zend
recipe.class.php

phpcs recipe.class.php

Refactory (PEAR)

OpeningFunctionBraceBsdAllmanSniff
X
OpeningFunctionBraceKernighanRitchieSniff

Manual validation

Click on the
PHP_CodeSniffer
toolbar icon to check
selected file.


Eclipse espaces x tabs


Eclipse templates


Duplicate code
• Duplicate code is a computer
programming term for a sequence of
source code that occurs more than
once, either within a program or across
different programs owned or
maintained by the same entity.
• Duplicate code is generally considered
undesirable for a number of reasons.


Duplicate code
• A minimum requirement is usually
applied to the quantity of code that
must appear in a sequence for it to be
considered duplicate rather than
coincidentally similar.
• Sequences of duplicate code are
sometimes known as clones.


PMD's Copy/Paste
Detector (CPD)


PMD's Copy/Paste
Detector (CPD)

public class Something {
private static int FOO = 2; // Unused
private int i = 5; // Unused
private int j = 6;
public int addOne() {
return j++;
}
}


PMD's Copy/Paste
Detector (CPD)

public class Foo {
private String baz() {
String bar = "howdy";
return bar.toString();
}
}


PHP Copy/Paste Detector
• O objetivo do phpcpd é oferecer uma
visão geral do código duplicado em
um projeto.

$ sudo pear channel-discover pear.phpunit.de

$ sudo pear channel-discover components.ez.no

$ sudo pear install phpunit/phpcpd


Usage: phpcpd [switches] <directory|file> ...

--log-pmd <file> Write report in PMD-CPD XML format to file.

--min-lines <N> Minimum number of identical lines (default: 5).
--min-tokens <N> Minimum number of identical tokens (default: 70).

--exclude <directory> Exclude <directory> from code analysis.
--suffixes <suffix,...> A comma-separated list of file suffixes to check.

--help Prints this usage information.
--version Prints the version and exits.

--verbose Print progress bar.


By default phpcpd will search for a
minimum of 5 identical lines and 70
identical tokens.
So if there are less than 5 duplicate
lines in the code or less than 70
identical tokens they will be ignored.


Localizando duplicações (hands on)

$ phpcpd --min-lines 1
--min-tokens 4 src/
phpcpd 1.3.2 by Sebastian Bergmann.

Found 1 exact clones with 16 duplicated lines in 1 files:

- average.php:6-22
average.php:32-48

31.37% duplicated lines out of 51 total lines of code.

average.php (hands on)

//continuando....
<?php
$array1 = array(3,3,6,7,8);
$array1 = array(4,8,5,6); $array2 = array(9,9,8,78,4,6,5);
$array2 = array(7,78,8,9);
$sum1 = 0;
$sum1 = 0; $sum2 = 0;
$sum2 = 0; $average1 = 0;
$average1 = 0; $average2 = 0;
$average2 = 0;
for ($i = 0; $i < 4; $i++)
for ($i = 0; $i < 4; $i++) {
{ $sum1 += $array1[$i];
}
$sum1 += $array1[$i];
$average1 = $sum1/4;
}
$average1 = $sum1/4; for ($i = 0; $i < 4; $i++)
{
for ($i = 0; $i < 4; $i++) $sum2 += $array2[$i];
{ }
$sum2 += $array2[$i]; $average2 = $sum2/4;
}
$average2 = $sum2/4;
printf("nSoma 2:%dnMédia 2: %d",$average1,$average2);

printf("Soma 1:%dnMédia 1: %d",$average1,$average2);

phpDocumentor

The complete documentation solution
for PHP [sic]


phpDocumentor

Publicos diferentes;
- Interno
- Externo


PHP_Depend

Gerar um conjunto de métricas de
software a partir de uma base de
código dado, para medir a qualidade
de um projeto de software e ajudam a
identificar as partes de uma aplicação
onde uma refatoração pode ser
aplicada


PHP_Depend
overview
pyramid


P phploc
H
P
Lines
Of
Code

phploc
tool for quickly measuring the size of
a PHP project


phploc
tool for quickly measuring the size of
a PHP project

$ sudo pear install phpunit/phploc

https://github.com/sebastianbergmann/phploc


PHP Project Wizard
(PPW)
commandline tool that can be used
to generate the scripts and
configuration files necessary for the
build automation of a PHP project

https://github.com/sebastianbergmann/php-project-wizard


Criando um novo projeto (hands on)

$ppw --source src
--tests tests --name object-freezer
--bootstrap tests/bootstrap.php .

$ echo "build" > .gitignore;
$ echo "source=${basedir}/src" > build.properties;

A formiga atômica!

The Apache Ant build.xml build script

Zend Framework...
$ sudo apt-get install -y zend-framework-bin
$ sudo pear channel-discover zend.googlecode.com/svn
$ sudo pear install zend/zend

$cd src;

$ zf create project
. Object-freezer;

$ mv tests ../ ;

Bootstrap
de testes
Refatorado

https://github.com/gpupo/object-freezer/tree/zend

Rodando testes
$ ~/workspace/object-freezer$ phpunit
PHPUnit 3.5.14 by Sebastian Bergmann.

.

Time: 0 seconds, Memory: 6.50Mb

OK (1 test, 4 assertions)

PHPUnit
Para ter o código auto-testável você
necessitará de uma suite de testes
automatizados que possa checar
uma grande parte da base do
código para achar problemas. Os
testes necessitam estar aptos para
rodarem com um simples comando
e serem checados
automaticamente.


Jenkins

“In a nutshell Jenkins CI is the leading
open-source continuous integration
server. Built with Java, it provides over
300 plugins to support building and
testing virtually any project.”


Jenkins

“In a nutshell Jenkins CI is the leading
open-source continuous integration
server. Built with Java, it provides over
300 plugins to support building and
testing virtually any project.”

www.delicious.com/gpupo/jenkins


Jenkins on Ubuntu

$ wget -q -O -
http://pkg.jenkins-ci.org/debian/jenkins-ci.org.key
| sudo apt-key add - ;

$ sudo sh -c
'echo deb http://pkg.jenkins-ci.org/debian binary/ >
/etc/apt/sources.list.d/jenkins.list';

sudo apt-get update
sudo apt-get install jenkins ant


Jenkins on Ubuntu

…
Setting up daemon (0.6.4-1) ...
Setting up jenkins (1.420) ...
Adding system user `jenkins' (UID 125) ...
Adding new user `jenkins' (UID 125) with group `nogroup' ...
Not creating home directory `/var/lib/jenkins'.
* Starting Jenkins Continuous Integration Server jenkins
The selected http port (8080) seems to be in use by
another program
Please select another port to use for jenkins


Jenkins on Ubuntu

• Http://localhost:8080

• http://localhost:8080/manage

• http://localhost:8080/pluginManager/available


Jenkins on Ubuntu

• $ sudo /etc/init.d/jenkins
{
start|stop|status|restart|force-reload
}


Jenkins CLI

• java -jar jenkins-cli.jar -s
http://localhost:8080/ help


Jenkins CLI

build: Builds a job, and optionally waits until its completion.
copy-job: Copies a job
•
create-job: Creates a new job by reading stdin as a configuration
•XML file
• enable-job: Enables a job

help: Lists all the available commands
•
install-plugin: Installs a plugin either from a file, an URL, or from
•update center
• login: Saves the current credential to allow future commands to
run without explicit credential information
• mail: Reads stdin and sends that out as an e-mail.

•

Instalando plugins

wget http://localhost:8080/jnlpJars/jenkins-cli.jar
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin checkstyle
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin cloverphp
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin dry
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin htmlpublisher
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin jdepend
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin git
•

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin github
•


Jenkins on Ubuntu

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin
plot

pmd

violations

xunit


Instalando plugins
ou

$ plugins=( cloverphp dry htmlpublisher jdepend plot

pmd violations xunit git github);

$ for name in "${plugins[@]}";

do java -jar jenkins-cli.jar -s

http://localhost:8080 install-plugin $name;

done; Script disponivel em
https://gist.github.com/1078415


Reload

• $ sudo /etc/init.d/jenkins restart


Seguranca

• http://localhost:8080/configure
– Enable security
• Jenkins's own user database
• Save


Seguranca

• http://localhost:8080/configure
– Enable security
• Jenkins's own user database
• Save
• Sign UP
• Config >> Logged-in users can do anything


Jenkins Alerts

• Configurar envio de e-mail autenticado


TODO (right now)

Instalar:

Jenkins
Plugins Jenkins (+GIT)
PHP Tools

Jenkins + PHP

• $ sudo pear channel-discover pear.pdepend.org

• $ sudo pear channel-discover pear.phpmd.org

• $ sudo pear channel-discover pear.phpunit.de

• $ sudo pear channel-discover components.ez.no

• $ sudo pear channel-discover pear.symfony-project.com


Jenkins + PHP

• $ sudo pear install pdepend/PHP_Depend

• $ sudo pear install phpmd/PHP_PMD

• $ sudo pear install phpunit/phpcpd

• $ sudo pear install phpunit/phploc


Jenkins + PHP

• $ sudo pear install PHPDocumentor

• $ sudo pear install PHP_CodeSniffer

• $ sudo pear install pear/Text_Highlighter-beta

• $ sudo pear install pear/HTTP_Request2-beta

• $ sudo pear install phpunit/ppw


Jenkins + PHP

• $ sudo pear install –alldeps
phpunit/PHP_CodeBrowser

• $ sudo pear install –alldeps
phpunit/PHPUnitear install PHPDocumentor


Jenkins template

• $ cd /var/lib/jenkins/jobs/

• $ sudo git clone
git://github.com/sebastianbergmann/php-jenkins-template.git php-template

• $ sudo chown -R jenkins:nogroup
php-template/


Jenkins + PHP

• $ cd /var/lib/jenkins/jobs/

• $ git clone

RELOAD!
git://github.com/sebastianbergmann/php-jenkins-template.git php-template

• $sudo chown -R jenkins:nogroup
php-template/


Jenkins + GIT

• $ sudo su - jenkins

• $ ssh-keygen -t rsa -C "jenkins@hotellinux.com"

• $ git config --global user.email
"jenkins@hotellinux.com"

• $ git config --global user.name "Jenkins Robot"


Jenkins + GIT

• Adicionar Chave ao Repositório


Jenkins + GIT

• Adicionar Chave ao Repositório

• $ ssh git@github.com


Template for Jenkins
Jobs for PHP Projects
• Adivinha
de quem
éo
projeto?


Criando um job PHP no
Jenkins
• Nome do projeto exemplo: "Object-Freezer".

• Selecione "Copy existing job" e escreva "php-template" no campo "Copy
from".

• Substitua as duas ocorrencias de "job-name" pelo nome do projeto, no
campo "Description".

• Desabilite a opcao "Disable Build".

• Preencha as informacoes do repositorio GIT.

• Configure o "Build Trigger" como "Poll SCM".


Criando um job PHP no
Jenkins


Jenkins alerts


Jenkins jobs


Jenkins job


Job/documentação


Job/testes


Job/histórico


Job/estilo


Job/cobertura


Job/violações


Job/CodeBrowser


Job/workspace


Job/Build Time Trend


Customizando
Quero que meu projeto avalie apenas o Coding style
Zend. Como configurar?


Customizando
Quero que meu projeto avalie apenas o Coding style
Zend. Como configurar?
build.xml:


Customizando
Como configurar a codificação do meu projeto?


Customizando
Como configurar a codificação do meu projeto?

build.xml:
///...
<target name="phpcs" description="Generate checkstyle.xml using
PHP_CodeSniffer">
<exec executable="phpcs" output="/dev/null">
<arg line="--report=checkstyle
--report-file=${basedir}/build/logs/checkstyle.xml
--standard=PEAR
--encoding=iso-8859-1
${source}" />
</exec>
</target>
//...


Jenkins + capistrano

• soon


Referências
- https://wiki.jenkins-ci.org/display/JENKINS/Installing+Jenkins+on+Ubuntu
- https://github.com/sebastianbergmann/php-project-wizard
- https://github.com/sebastianbergmann/phpcpd
- https://gist.github.com/1078415

http://www.delicious.com/gpupo/ci

Integração contínua em PHP com Jenkins

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (20)

Similar to Integração contínua em PHP com Jenkins

Similar to Integração contínua em PHP com Jenkins (20)

More from Gilmar Pupo

More from Gilmar Pupo (6)

Integração contínua em PHP com Jenkins