CruiseControl com SVN – Parte 01
February 20th, 2010 | Published in metodologia, programação | 1 Comment
Esse ano estamos tentando fazer algumas mundanças na Informant. Percebemos que usar quadros magnéticos, pregar post-it’s por toda empresa e fazer reuniões diárias não estavam nos fazendo mais “ágeis”, e na prática… pouca coisa era aplicada. Agora estamos buscando realmente implementar algo ágil nos nossos projetos. Estamos dandos os primeiros passos, mas muita coisa boa está sendo planejada para este ano.
Uma das coisas que precisamos melhorar é a forma como trabalhamos com nosso repositório de fontes. Estamos modificando nossos procedimentos e nosso trabalho diário para manter nosso respositório mais confiável: A Integração Contínua é uma prática essencial do XP, que não se resume apenas a utilização de uma ferramenta, mas a automatização de build’s e deploy’s pode economizar muito tempo de desenvolvimento. Deixando o programador disponível para realizar o seu trabalho mais importante: programar.
Estamos começando a utilizar o CruiseControl, ferramenta que ainda não conhecia de perto. Apesar de já ter trabalhado com algumas ferramentas do gênero (ex.: Bamboo), o CC me impressionou bastante com relação a flexibilidade de configuração e implementação de planos de build. Para quem está perdendo muito tempo com liberação de versões, builds, deploys de aplicativos, e está pensando em utilizar o CC, vou repassar aqui os meus passos iniciais de configuração da ferramenta em ambiente Windows:
- Faça o download da última release do CC, que atualmente é a 2.8.3 e descompacte vvocê achar melhor, por exemplo em C:\java\cruisecontrol-bin-2.8.3
- O ideal é criar um diretório de trabalho configuração de seus projetos. (ex.: C:\java\work\cruise). Achei mais fácil iniciar o CC desta mesma workspace, por isso também copiei os arquivos cruisecontrol.bat, config.xml e dashboard-config.xml para o diretório /cruise. Bastando apenas fazer alguns acertos no cruisecontrol.bat, apontando o launcher do CC para o caminho correto (C:/java/cruisecontrol-bin-2.8.3/lib/cruisecontrol-launcher.jar). Nesse momento, você já poderá iniciar o CC. Apontando o seu navegador para http://localhost:8080/dashboard/tab/dashboard já será possível acessar a ferramenta. Se tudo der certo, você deverá ver o Dashboard Server, que por enquanto, não terá nenhum projeto disponível.Você deverá ter a variável JAVA_HOME também já configurada no seu Path.
- Agora precisamos configurar um projeto. No CC, todos os projetos são configurados a partir do arquivo config.xml. Quando trabalhamos com múltiplos projetos, é interessante manter a configuração de cada um deles em arquivos separados, para isso podemos alterar o config.xml para que fique da seguinte forma:
<!-- config.xml --> <!DOCTYPE cruisecontrol [ <!ENTITY build-informantUtils SYSTEM "projects/informantUtils-config.xml"> <!ENTITY build-informantEJB SYSTEM "projects/informantEJB-config.xml"> ]> <cruisecontrol> <property file="config.properties"/> <plugin name="svn" classname="net.sourceforge.cruisecontrol.sourcecontrols.SVN"/> <plugin name="svnbootstrapper" classname="net.sourceforge.cruisecontrol.bootstrappers.SVNBootstrapper"/> <system> <configuration> <threads count="2"/> </configuration> </system> &build-informantLibs; &build-informantEJB; </cruisecontrol> - O meu objetivo inicial com a utilização do CC, era fazer o build automático das aplicações no nosso ambiente de testes sempre que alterações fosse efetivadas (commit), garantindo que nosso repositório esteja sempre compilando, e que a qualquer momento, tivéssemos uma versão disponível para liberação. Para isso, utilizamos o elemento <modificationset>, que determina como o CC procura por alterações no repositório e quando vai executar o build do projeto.
<!-- informantEJB-config.xml --> <plugin name="svn" classname="net.sourceforge.cruisecontrol.sourcecontrols.SVN"/>; <plugin name="svnbootstrapper" classname="net.sourceforge.cruisecontrol.bootstrappers.SVNBootstrapper"/> <modificationset quietperiod="10"> <svn localWorkingCopy="checkout/agil/${project.name}" repositoryLocation="${svn.repository}/${svn.trunk}/InformantEJB" username="${svn.user}" password="${svn.passwd}"> </svn> </modificationset>Assim monitoramos alterações do projeto no SVN e quando o CC deverá fazer o build do projeto. Veja que é preciso indicar o respositório local do projeto (localWorkingCopy), para onde os fontes do projetos serão copiados e compilados no momento do build. Por isso é necessário criar um diretório de checkout local para os projetos no seu diretório de trabalho (ex.: /work/cruise/checkout)
Para tudo dar certo, ainda iremos precisar incluir os plugins do svn, conforme acima. Também será necessária instalar e garantir que o SVN esteja no seu Path. - Então utlizamos o elemento <schedule> com interval=”300″, para fazer com que o CC verifique o respositório do SVN a cada 5 minutos por novas modificações. Além disso utilizamos o atributo time=”2300″, forçando com que um build seja executado diariamente as 23:00 horas. Nestes casos, o CC irá executar o script de build do projeto: build-file=”checkout\agil\build-${project.name.xml}”
<!-- informantEJB-config.xml --> <schedule interval="500" showProgress="true"> <ant antscript="${ant.home}\bin\ant.bat" buildfile="checkout\agil\build-${project.name}.xml" target="build-informantEJB" uselogger="true" usedebug="true" time="2300"/> </schedule>Será necessário ter o ant instalado. O próprio CC já vem com a versão 1.7.0 do ant, disponível no diretório de instalação do CC (C:/java/cruisecontrol-bin-2.8.3/apache-ant-1.7.0).
- Precisamos agora definir o diretório de logs do projeto. Crie um diretório de logs no seu diretório de trabalho (ex.: C:/java/work/cruise/logs). Isso é importante, porque o CC controla todo o histórico de builds e status (buildstatus) dos projetos em execução, através deste diretório de logs. Dentro do diretório de logs serão criados outros vários subdiretórios, um para cada projeto.
E acrescente a configuração de log ao projeto:<!-- informantEJB-config.xml --> <log dir="logs/${project.name}"/> - Após cada build do projeto, geralmente um artefato é gerado. Um arquivo war, ear ou zip por exemplo. Neste caso, um arquivo .jar. Por isso é preciso definir uma diretório onde todos esses artefatos serão armazenados após um build realizado com sucesso. Crie um diretório para os artefatos gerados no seu diretório de trabalho (ex.: C:/java/work/cruise/artifacts). Dentro do diretório de artefatos serão criados outros vários subdiretórios, um para cada projeto.
Para dizer ao CC, onde e quais artefatos serão publicados, utilizamos o elemento <artifactpublisher>:<!-- informantEJB-config.xml --> <publishers> <artifactspublisher dir="checkout/agil/${project.name}/output" dest="artifacts/${project.name}"/> </publishers> - Com o arquivo de configuração do projeto concluído (projects/informantEJB-config.xml), precisamos apenas do script de build do projeto, que será chamado pelo CC. No meu caso, ficou mais ou menos assim:
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <project basedir="." default="build-informantEJB" name="informantEJB"> <echo message="Project:informantEJB: Executando..."/> <property file="build.properties"/> <property name="svnant.latest.url" value="${agil.svn.repository}/${agil.svn.trunk}/informantEJB"/> <property name="local.repository" value="informantEJB"/> <path id="informant.libs"> <fileset dir="libs/jars"> <include name="**/*.jar"/> </fileset> </path> <path id="jboss-runtime.libs"> <fileset dir="../../dependencies/jboss-runtime/client"> <include name="**/*.jar"/> </fileset> <fileset dir="../../dependencies/jboss-runtime/lib"> <include name="**/*.jar"/> </fileset> </path> <path id="ejb.libs"> <path refid="informant.libs"/> <path refid="jboss-runtime.libs"/> </path> <taskdef resource="svntask.properties"/> <target name="checkout"> <echo message="${ant.project.name}: Fazendo checkout do respositorio ${svnant.latest.url}..."/> <svn username="${agil.svn.user}" password="${agil.svn.passwd}"> <checkout url="${svnant.latest.url}" revision="HEAD" destPath="${local.repository}" /> </svn> </target> <target name="mkdir"> <mkdir dir="informantEJB/build/classes"/> <mkdir dir="informantEJB/output"/> <copy includeemptydirs="false" todir="informantEJB/build/classes"> <fileset dir="informantEJB/ejbModule"> <exclude name="**/*.launch"/> <exclude name="**/*.java"/> </fileset> </copy> </target> <target depends="checkout,mkdir" name="compile"> <echo message="${ant.project.name}: ${ant.file}"/> <javac debug="true" debuglevel="${debug.level}" destdir="informantEJB/build/classes" source="${compile.source}" target="${compile.target}" classpathref="ejb.libs"> <src path="informantEJB/ejbModule"/> </javac> </target> <target depends="compile" name="build-informantEJB"> <echo message="${ant.project.name}: Gerando informantEJB.jar..."/> <jar destfile="informantEJB/output/informantEJB.jar" basedir="informantEJB/build/classes" includes="**/*.class,**/*.xml"> <manifest> <attribute name="Created-By" value="Agil ERP"/> <attribute name="Manifest-Version" value="1.0"/> <attribute name="Implementation-Vendor" value="Informant"/> <attribute name="Implementation-Title" value="Informant"/> <attribute name="Implementation-Version" value="1.0"/> </manifest> </jar> </target> </project>O plano de build do projeto agora está OK: configuramos o informantEJB-config.xml para que execute o script de build (build-informantEJB.xml) quando alguma alteração for realizada no repositório. Além disso o CC irá executar também um build diário, as 23:00 horas.
- Tudo certo agora?! NÃO.
Mesmo que você faça um build manual do projeto através do CC ( http://localhost:8080/dashboard/tab/dashboard), o status do projeto continuará inativo. Isso acontece porque criamos um diretório de trabalho em C:/java/work/cruise, onde serão armazenados os logs e artefatos do projeto. Mas o CC ainda não sabe disso.Crie um arquivo override.properties em C:/java/cruisecontrol-bin-2.8.3/reporting/jsp dessa forma:# This should be the full path to your CruiseControl log directory. # If you are in multi-project mode, there will be multiple sub-directories # inside this log directory, one for each project. user.log.dir=C:/java/work/cruise/logs # This should be the path to your current build status file, # expressed relative to the project's log directory. user.build.status.file=C:/java/work/cruise/logs/buildstatus.txt # This should be the absolute path to the directory where # additional build artifacts are stored. cruise.build.artifacts.dir=C:/java/work/cruise/artifacts
Essa é uma configuração bem básica. Mas já dá pra ter uma idéia do que pode ser feito. O CC foi implementado para ser extensível e flexível o suficiente para que você possa customizar quase tudo. Além disso, existem vários plugins e outros add-ons que podem ser utilizados pafa aumentar ainda mais as possibilidades de uso do framework.
<!ENTITY build-informant SYSTEM "projects/informant-config.xml">
<!ENTITY build-informantLibs SYSTEM "projects/informantLibs-config.xml">
<!ENTITY build-informantUtils SYSTEM "projects/informantUtils-config.xml">
<!ENTITY build-displayTags SYSTEM "projects/struts2-displatTag-config.xml">
<!ENTITY build-informantWeb SYSTEM "projects/informantWeb-config.xml">
<!ENTITY build-informantEJB SYSTEM "projects/informantEJB-config.xml">
<!ENTITY build-informantEAR SYSTEM "projects/informantEAR-config.xml">
<!ENTITY deploy-informantEAR SYSTEM "projects/informantEAR-deploy-config.xml">
]>
<cruisecontrol><property file=”config.properties”/>
<plugin name=”svn” classname=”net.sourceforge.cruisecontrol.sourcecontrols.SVN”/>
<plugin name=”svnbootstrapper” classname=”net.sourceforge.cruisecontrol.bootstrappers.SVNBootstrapper”/>
<system>
<configuration>
<threads count=”2″/>
</configuration>
</system>
&build-informantLibs;
&build-informantUtils;
&build-displayTags;
&build-informantWeb;
&build-informantEJB;
&build-informantEAR;
&build-informant;
&deploy-informantEAR;
</cruisecontrol>
