More Apache Maven Best Practices

More Apache MavenBest Practices

Brett Porter - brett@apache.org

More Apache MavenBest Practices

Welcome Back

This time last year...Apache Maven Best PracticesSlides are available online• http://blogs.exist.com/bporter/

But wait, there’s more!

EnvironmentSet up your environment in advanceA repository manager is a must

Keep the POM simpleWrite your build like you write your code

Keep it Simple

Keep it PortableKeep the build portableAvoid hard codingMake artifacts portable and minimize resource filtering

Keep it ReproducibleBefore releasing, make sure the build is reproducibleFirst, it must be portableLock downversionsLock downenvironmentalvariations

The Enforcer

<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-enforcer-plugin</artifactId> <version>1.0-alpha-4</version> <executions> <execution> <goals> <goal>enforce</goal> </goals> <configuration> <rules> <requirePluginVersions> <banLatest>true</banLatest> <banRelease>true</banRelease> </requirePluginVersions> </rules> </configuration> ...

The Enforcer

The EnforcerHelp ensure build will be reproducibleBased on rules

force specific plugin versionsban snapshotsglobal exclusionsforce Maven/Java/OS versioncan write your own

Release Early and OftenMake sure releases are quick, easy, and automatedUse the Maven/Continuum tools to help

And Now...Dependency managementIntegration testingMaven sites and reportingPlugin development

Dependency Management

Dependencies EverywhereTransitive dependencies are very convenient...

... until you get bitten by bad metadataYou wind up witha tree of artifactsyou may or maynot be using

Troubleshoot Dependenciesmvn dependency:tree

or equivalent Eclipse integration

[INFO] org.example.maven:example-webapp:war:1.2-SNAPSHOT[INFO] +- junit:junit:jar:3.8.1:test[INFO] +- org.apache.struts:struts2-core:jar:2.0.5:compile[INFO] | +- opensymphony:xwork:jar:2.0.0:compile[INFO] | +- org.apache.struts:struts2-api:jar:2.0.5:compile[INFO] | +- freemarker:freemarker:jar:2.3.8:compile[INFO] | +- ognl:ognl:jar:2.6.9:compile[INFO] | \- commons-logging:commons-logging:jar:1.0.4:compile[INFO] +- org.apache.struts:struts2-sitemesh-plugin:jar:2.0.5:compile[INFO] | \- opensymphony:sitemesh:jar:2.2.1:compile[INFO] +- org.apache.struts:struts2-spring-plugin:jar:2.0.5:compile[INFO] | +- org.springframework:spring-beans:jar:2.0.1:compile[INFO] | +- org.springframework:spring-core:jar:2.0.1:compile[INFO] | +- org.springframework:spring-context:jar:2.0.1:compile[INFO] | | \- aopalliance:aopalliance:jar:1.0:compile[INFO] | \- org.springframework:spring-web:jar:2.0.1:compile[INFO] +- javax.servlet:servlet-api:jar:2.4:provided[INFO] +- javax.servlet:jsp-api:jar:2.0:provided[INFO] +- commons-fileupload:commons-fileupload:jar:1.1.1:compile[INFO] | \- commons-io:commons-io:jar:1.1:compile[INFO] +- uk.ltd.getahead:dwr:jar:1.1-beta-3:compile[INFO] +- org.example.maven:example-model:jar:1.2-SNAPSHOT:compile[INFO] \- org.example.maven:example-manager:jar:1.2-SNAPSHOT:compile

<exclusions> <exclusion> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> </exclusion></exclusions>

<rules> <bannedDependencies> <excludes> <exclude>commons-logging:commons-logging</exclude> </excludes> </bannedDependencies></rules>

<exclusions> <exclusion> <groupId>commons-logging</groupId> <artifactId>commons-logging</artifactId> </exclusion></exclusions>

Don’t Add to the ProblemBe careful with your own dependencies

Specify only what you needSpecify scopeUse optional if you must

Use dependencyManagement to:coerce Maven to use a particular versionenforce consistency within a project

Only What You Needmvn dependency:analyze

find out what you’re using but not declaringfind out what you’re declaring but not using

[WARNING] Used undeclared dependencies found:[WARNING] opensymphony:xwork:jar:2.0.0:compile[WARNING] Unused declared dependencies found:[WARNING] org.apache.struts:struts2-spring-plugin:jar:2.0.5:compile[WARNING] javax.servlet:jsp-api:jar:2.0:provided[WARNING] commons-fileupload:commons-fileupload:jar:1.1.1:compile[WARNING] javax.servlet:servlet-api:jar:2.4:provided[WARNING] org.apache.struts:struts2-core:jar:2.0.5:compile[WARNING] org.apache.struts:struts2-sitemesh-plugin:jar:2.0.5:compile[WARNING] uk.ltd.getahead:dwr:jar:1.1-beta-3:compile

Integration Testing

“Integration” TestingCovers any type of testing beyond unit

integration testingfunctional testing, etc.

Unfortunately, an afterthought in Maven 2.0.x

at least in the lifecycle

PatternsTests in a separate moduleTests in same projectUse of profiles applies to botheg. Maven

Plugin ITs are in the pluginCore ITs are separate

Separate ProjectMost common patternIf you are testing multiple modules, use a separate project

Separate Projectcreate a parallel moduleuse the regular src/test/java directoryadd a dependency on the module(s) being testedenable the module in a profile

if a profile is necessary

Separate Projectcreate a parallel moduleuse the regular src/test/java directoryadd a dependency on the module(s) being testedenable the module in a profile

if a profile is necessary

<profile> <id>run-its</id> <modules> <module>integration-tests</module> </modules></profile>

Testing in the Same ProjectGood for framework examples and small projectsTwo alternatives

separate directory, redeclare both compilation and test plugins• eg src/it

same test directory, test exclusions• eg **/selenium/**

Include the tests in a profile

Example: Selenium

<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <configuration> <excludes> <exclude>**/selenium/**</exclude> </excludes> </configuration></plugin>

Example: Selenium

<profile> <id>selenium</id> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <executions> <execution> <phase>integration-test</phase> <goals> <goal>test</goal> </goals> <configuration> <includes> <include>**/selenium/**/*Test.java</include> </includes> </configuration> </execution> </executions> </plugin> </plugins> </build></profile>

Example: Selenium

<profile> <id>selenium</id> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-surefire-plugin</artifactId> <executions> <execution> <phase>integration-test</phase> <goals> <goal>test</goal> </goals> <configuration> <includes> <include>**/selenium/**/*Test.java</include> </includes> </configuration> </execution> </executions> </plugin> </plugins> </build></profile>

Example: Selenium

<plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>selenium-maven-plugin</artifactId> <version>1.0-beta-1</version> <executions> <execution> <phase>pre-integration-test</phase> <goals> <goal>start-server</goal> </goals> </execution> </executions> <configuration> <background>true</background> </configuration></plugin>

Maven Sites and Reporting

Two technologiesreportingrendering

They aren’t the same!They work together

... but can be used independently

... and should be for different tasks

Maven Sites

Site TipsAvoid reports on documentation sites

some minimal project reports, like mailing lists, source repository may be relevant

Use site inheritanceUse versioning in the URL

for version specific usage documentationespecially for developer reference site

Include release notes in the versioned usage documentation

Set up what you’ll use!don't create reports with thousands of issues

It won’t be used if...too much informationirrelevant information

Don’t settle for thedefault settings

Report Tips

Report TipsUse active checks, not passive reports

fail the build!Use profiles if they are time consuming

run them in continuous integrationdevelopers can use IDE integration

Have a centralized location to deploy reports

visualize problems, and errors under the build failure threshold

Plugin Development

Don’t Fear ScriptingSometimes it is easier to use a script for short, one-off, customizations

antrun pluginjruby, groovy plugin, etc.

If you might use it twice, consider writing a plugin

Plugin DevelopmentIt isn’t the big deal you think it isCan be written in Java, Ruby, Groovy, ...Plugins are as easy to write as any other module

though they still lack the quick “run and test” scenario of most scripting solutions

Plugin TipsWrite functionality in components, with the Mojo as a “wrapper”

easier to test and reusethe theory of mojos as pojos isn’t as realistic due to the current wiring

Minimize Maven API dependencies and component exposure

eg, use maven-artifact, not maven-coreMinimize dependencies in general

all builds have to download them!33

Final WordDo as we say...

... but not as we doMaven fails to implement many of these practices in various projects

We learned the hard way!It can be really hard to find time to go back and fix it later

Questions?

More Apache Maven Best Practices

Technology

Transcript of More Apache Maven Best Practices

Apache Maven and Android at - simpligility · Apache Maven and Android at ... apk android:dex ... Robotium Like Selenium for Android Add dependency to pom.xml and start coding tests.

Apache Maven: Best Practicespeople.apache.org/~wsmoak/maven/ApacheMavenBestPractices-ACE… · Apache Maven: Best Practices Wendy Smoak - wsmoak@apache.org wsmoak/maven. Maven without

Apache Maven: Best Practices - WordPress.com · 3 Apache Maven developer since 2003 Started the Archiva project Co-founder of DevZuz Co-author of Better Builds with Maven Who am I?

NimbusSanL-Regu - · PDF fileThe Hudson Book viii 7 Working with Apache Maven Builds 84 7.1 Installing and Conﬁguring Apache Maven . . . . . . . . . . . . . . . . . . . . . . . .

Building Applications with Apache Maven

Ignite talk: Maven Best Practices

Introduction to Apache Maven

WA2404 Dependency Management with Nexus, Apache Maven … › setupguides › WA2404... · WA2404 Dependency Management with Nexus, Apache Maven and Apache Ivy - Classroom Setup Guide

Building Applications with Apache Maven - Colorado Software Summit

Apache Maven and Android at - simpligility

Efficient Enterprise Builds With Apache Maven

Apache Maven basics

WA2321 Continuous Integration with Apache Maven Jenkins-CI ... · WA2321 Continuous Integration with Apache Maven Jenkins-CI and Nexus Classroom Setup Guide Web Age Solutions Inc.

Maven Best Practices

Introduction to Apache Maven 2webserver2.tecgraf.puc-rio.br/.../2-Maven/articles/ibm_mavenv2.pdf · Introduction to Apache Maven 2 Skill Level: Intermediate Sing Li (westmakaha@yahoo.com)

Maven and JBoss AS quickstart - WildFly JBoss …mastertheboss.com/eBooks/maven-jboss.pdfUsing the JBoss AS plugin for Maven What is Apache Maven ? Apache Maven originated as an attempt

Fundamental of apache maven

Apache Maven Cookbook - Sample Chapter

Introduction to Apache Maven 2 - IBM Software · PDF filegenerate-test-resources Allows for the generation of test-related (non-source-code) resources. Introduction to Apache Maven

The Stairway to Maven - The Apache Software Foundationpeople.apache.org/~sgoeschl/presentations/maven-20020626.pdf · 2007-09-14 · Stairway To Maven 3 Maven For Rookies § Maven