Presentation “CQ Maven Methods“ by Andrew Savory at CQCON2013 in Basel on 19 and 20 June 2013.

1. CQ MAVEN METHODS
CQCON 2013

2. HELLO WORLD
I'm Andrew.
asavory@adobe.com
@savs

3. Joined Adobe in November 2012

4. CQ Newbie
JCR/CMS/TLA old hat

5. Background in Open Source, Content Management, Mobile

6. Talking today about what I learned so far...

7. FORK ME!
If you found this talk useful, or spotted mistakes:
github.com/savs/CQCon_2013_CQ_Maven_Methods

8. IN YOUR BROWSER
http://goo.gl/qqS1F

9. SEE ALSO
http://www.planetcq.org/

12. LET'S BUILD A CQ SITE
... uh, where to begin?

13. METHOD 1
Enthusiastically rush in, use CRXDE Lite

14. METHOD 2
I'm a guru, I use Eclipse and CRXDE

15. METHOD 3
I'm a ninja, I use emacs and vlt

16. METHOD 4
I'm a guru ninja, I use vi and curl

17. METHOD 5
See also: http://xkcd.com/378/ – Real Programmers

18. BUT WHAT ABOUT ...
reverting mistakes?
reproducible builds?
collaborating with others?
deploying to production?

19. WHY ISN'T IT EASIER TO BUILD A CQ SITE?
Laborious project inception
No two projects alike
Don't know project layout
Don't know project dependencies
Hard for others to reproduce
Hard to test
Lengthy RTFM or worse (no FM)
Documentation over convention

20. CQ SUCKS

21. $PRODUCT SUCKS

22. YOUR METHODOLOGY SUCKS
(sorry)

23. SO HOW DO WE FIX THIS?
Maven
Git
(or Subversion, or CVS ... ymmv)
Best Practices

24. MAVEN
“Maven is a software project management
and comprehension tool. Based on the
concept of a project object model (POM),
Maven can manage a project's build,
reporting and documentation from a central
piece of information.”

25. GIT
“Git is a free and open source distributed
version control system designed to handle
everything from small to very large projects
with speed and efficiency. ”
Version control is a system that records changes to a file or set of files over
time so that you can recall specific versions later.

26. BEST PRACTICES
“A best practice is a method or technique that
has consistently shown results superior to
those achieved with other means.”
In addition, a "best" practice can evolve to become better as improvements
are discovered.

27. WHAT DO WE WANT?
Minimal customisation
Standardised way to create a project
Standardised way to build a project
Standardised way to deploy a project
Standardised way to test a project
Standardised way to share a project

28. OUR TARGET

29. Success criteria:
IT'S EASY TO BUILD A CQ SITE!

30. GETTING STARTED
Install Maven: http://maven.apache.org/guides/getting-
started/
Install Git: http://git-scm.com/book/en/Getting-Started-
Installing-Git

31. CONFIGURING MAVEN
Maven has a settings file that defines things like
repositories where plugins can be downloaded (typically
~/.m2/settings.xml).
We need to add a profile to point to the Adobe repository.
We then specify this repository when we use the
archetype plugin.
See also: Obtaining the Content Package Maven Plugin

32. CONFIGURING MAVEN
<profile>
<id>adobe-public</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<properties>
<releaseRepository-Id>adobe-public-releases</releaseRepository-Id>
<releaseRepository-Name>Adobe Public Releases</releaseRepository-Name>
<releaseRepository-URL>http://repo.adobe.com/nexus/content/groups/public</releaseRepository-URL>
</properties>
<repositories>
<repository>
<id>adobe-public-releases</id>
<name>Adobe Basel Public Repository</name>
<url>http://repo.adobe.com/nexus/content/groups/public</url>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>adobe-public-releases</id>
<name>Adobe Basel Public Repository</name>
<url>http://repo.adobe.com/nexus/content/groups/public</url>
<releases>
<enabled>true</enabled>
<updatePolicy>never</updatePolicy>
</releases>
<snapshots>
<enabled>false</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
</profile>

33. CONFIGURING MAVEN
Enable the repository:
Or use the -P option to activate profile(s):
<activeProfiles>
<activeProfile>adobe-public</activeProfile>
</activeProfiles>
mvn -P adobe-public [...]

34. USING MAVEN

35. STARTING A NEW PROJECT ...
... can sometimes feel like reinventing the wheel.

36. YOU ARE HERE

37. ARCHETYPES
archetype |ˈɑːkɪtʌɪp|
noun
a very typical example of a certain person or thing: he was
the archetype of the old-style football club chairman.
an original which has been imitated; a prototype: an
instrument which was the archetype of the early flute.

38. MAVEN ARCHETYPES
A prototype upon which others are
copied, patterned, or emulated.

39. WHAT CQ ARCHETYPES ARE THERE?
simple-content-package
Generates a simple
multimodule-content-package
Includes the folder structure for developing a CQ
application (content package and bundle).
cqblueprints multi-module
Third-party archetype encapsulating best practices for
working with e.g. OSGi bundles, taglibs, and CQ content
See also:
content package
How to work with packages

40. ON PACKAGES
Packages enable the importing and exporting of repository
content. They are used to install new functionality, transfer
content between instances, or back up the repository
A package is a zip file in file system (vault) serialization
format
Packages include meta information - filter definitions,
import configuration, package properties
Packages are often managed through the CQ
Package Manager

41. ON BUNDLES
Bundles are modular containers of functionality for OSGi –
essentially a java module that contains application logic
Bundles consist of java classes and other resources needed
to deliver functionality or to provide services to other
bundles.
Bundles can be managed through the CQ
See also:
Web Console
Creating OSGi bundles using CRXDE

42. HOW TO USE AN ARCHETYPE
archetypeGroupId: identifies the archetype project
uniquely across all projects
archetypeArtifactId: the name of the archetype jar
without a version number
archetypeRepository: where to get the archetype from
(based on pluginRepository in settings.xml)
See also: and
mvn archetype:generate
-DarchetypeGroupId=foo
-DarchetypeArtifactId=bar
-DarchetypeVersion=1.0.0
-DarchetypeRepository=baz
Maven: Introduction to Archetypes Maven: Naming conventions

43. SIMPLE CONTENT PACKAGE ARCHETYPE
From the fine manual:
“Creates a maven project that is suitable for
installing resources for a simple CQ
application. The folder structure is that used
below the /apps folder of the CQ repository.
The POM defines commands for packaging
the resources that you place in the folders and
installing the packages on the CQ server.”

44. SIMPLE CONTENT PACKAGE USAGE
archetypeGroupId: com.day.jcr.vault
identifies the archetype project uniquely across all projects
archetypeArtifactId: simple-content-package-archetype
the name of the archetype jar without a version number
archetypeRepository: adobe-public-releases
where to get the archetype from (based on
pluginRepository in settings.xml)
mvn archetype:generate
-DarchetypeGroupId=com.day.jcr.vault
-DarchetypeArtifactId=simple-content-package-archetype
-DarchetypeVersion=1.0.1
-DarchetypeRepository=adobe-public-releases

45. SIMPLE CONTENT PACKAGE IN ACTION

46. SIMPLE CONTENT PACKAGE PARAMETERS
groupId: Like a package name, e.g.
com.yourcompany.myproject
artifactId: name of the jar without the version, e.g.
myproject
version: accept the default
package: not used in simple-content-package
appsFolderName: name of /apps/myproject, e.g. myproject
artifactName: Description in Package Manager
packageGroup: Group in Package Manager
See also: Maven: Naming conventions

47. SIMPLE CONTENT PACKAGE OUTPUT
Template directories
pom.xml file
Instructions for compiling, creating bundles, deploying
to CQ in packages
FileVault configuration files

48. MULTIMODULE CONTENT PACKAGE USAGE
mvn archetype:generate
-DarchetypeGroupId=com.day.jcr.vault
-DarchetypeArtifactId=multimodule-content-package-archetype
-DarchetypeVersion=1.0.1
-DarchetypeRepository=adobe-public-releases

49. MULTIMODULE CONTENT PACKAGE OUTPUT
${artifactId}
|- pom.xml
|- bundle
|- pom.xml
|- src
|- main
|- java
|- ${groupId}
|- SimpleDSComponent.java
|- test
|- java
|- ${groupId}
|- SimpleUnitTest.java
|- content
|- pom.xml
|- src
|- main
|- content
|- jcr_root
|- apps
|- ${appsFolderName}
|- config
|- install
|- META-INF
|- vault
|- config.xml

50. |- filter.xml
|- nodetypes.cnd
|- properties.xml
|- definition
|- .content.xml

51. CQBLUEPRINTS MULTI-MODULE USAGE
First add the CQ Blueprints Maven Repository to Maven's
settings.xml, then:
archetypeGroupID: com.cqblueprints.archetypes
archetypeArtifactId: multi-module
archetypeVersion: 1.0.5
archetypeRepository: cqblueprints.plugins.releases
See also: and
mvn -P cqblueprints archetype:generate
-DarchetypeGroupId=com.cqblueprints.archetypes
-DarchetypeArtifactId=multi-module
-DarchetypeVersion=1.0.5
-DarchetypeRepository=cqblueprints.plugins.releases
Connecting to the CQ Blueprints Repository The CQ Project Maven Archetype

52. CQBLUEPRINTS MULTI-MODULE OUTPUT
${artifactId}
|- README
|- pom.xml
|- ${artifactId}-all
|- pom.xml
|- ${artifactId}-config
|- ${artifactId}-content
|- ${artifactId}-services
|- ${artifactId}-taglib
|- ${artifactId}-view

53. WHY USE CQBLUEPRINTS MULTI-MODULE?
The cqblueprint multi-module archetype is developed by
“The things we wanted to consider with our
archetype is to address concerns of larger
teams”
headwire.com

54. CQBLUEPRINTS MULTIMODULE DESIGN
foo-view subproject: where css/html/js developers (frontend)
do their work
foo-taglib foo-services: where java developers (backend) do
their work
foo-config: where the configuration (runmode configs stored)
foo-content: how we get initial content and site structure onto
the developer's box quickly
foo-all: how we hand off builds to the next environment

55. USING GIT

56. WHY GIT?
Local safety net
"The internet is my backup"
It's good to share
Enlightened self-interest

57. YOU ARE HERE

58. GIT PROJECT SETUP
cd projectname
git init

59. GIT IGNORE
Edit .gitignore, for example:
.classpath
.project
.vlt/
.settings/
target/

60. GET IT IN GIT
git add *
git commit -m 'Initial project version'

61. GET IT IN GITHUB (OPTIONAL)
hub-new-repo is a shortcut for creating a repository on
github and pushing your local repo into it
See also:
See also:
cd project
git hub-new-repo
CLI remote github repo creation
github

62. DEMO

63. ... TIME PASSES ...

64. COMMIT PROJECT
git add filenames
git commit -m "meaningful message"
git push origin master

65. (BEST) PRACTICE(S)

66. YOU ARE HERE

67. “the three great virtues of a programmer:
laziness, impatience, and hubris”

69. BUILDING

70. HOW CAN WE BUILD SMARTER?
Create local zips and jars that you can upload:
mvn package
produces:
Content package output: target/yourapp-content-
1.0-SNAPSHOT.zip
Bundle output: target/testapp-bundle-1.0-
SNAPSHOT.jar

71. DEPLOYING

72. HOW CAN WE BUILD AND DEPLOY SMARTER?
Content package: mvn -PautoInstallPackage
install
Bundle: mvn -PautoInstallBundle install
cqblueprints: mvn -Pauto-deploy install

73. DEMO

74. DEVELOPING

75. YOU ARE HERE

76. How do we develop in a world of maven builds and deploys
and git saves?

77. THE FILEVAULT TOOL
You can use the FileVault tool (vlt) to check in, check out,
update and sync local content with the repository.
Install: extract crx-
quickstart/opt/filevault/filevault.
[tgz|zip] and add to your path
Usage: vlt --credentials admin:admin co --
force http://localhost:4502/crx
See also: How to use the VLT Tool

78. SAMPLE DEVELOPMENT WORKFLOW
Use maven to build and deploy
Initialise vlt
Create components, templates with CRXDE Lite
Use vlt to copy back into local filesystem
Change locally
Use vlt to copy back into the repository
Add to git

79. DEMO

80. TESTING

81. CONTINUOUS INTEGRATION?
with ,
as a
with and
Jenkins Git plugin GitHub plugin
Selenium server
Cucumber for java Jenkins plugin tests in java

82. INTEGRATION TESTING FRAMEWORK
... see Lydia's talk

83. PRODUCTION

84. How do we move to production in a world of maven builds and
deploys and git saves?

85. YOU ARE HERE

86. MAVEN PROFILE FOR PRODUCTION
Add this to pom.xml:
Deploy using this profile:
Or one-time override: mvn -
Dcrx.host=another.host,crx.port=4504 -
PautoInstallPackage install
See also:
<profile>
<id>auto-deploy-prod</id>
<properties>
<crx.host>production.server.hostname</crx.host>
<crx.port>4502</crx.port>
</properties>
</profile>
mvn -PautoInstallPackage,auto-deploy-prod install
Introduction to build profiles

87. DEPLOYMENT TESTING
... see Bertrand's talk

88. PUTTING IT ALL TOGETHER

89. 0-60 IN 5 PSEUDO LINES
mvn archetype:generate
git init; git add *; git commit -m "Initial project"
mvn -PautoInstallPackage install
vlt checkout ; vlt update ; vlt commit
git add; git commit; git push

91. THANK YOU. QUESTIONS?

92. CREDITS
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
designed by from The Noun Project
Light Bulb Shane David Kenna
Question Anas Ramadan
Hard Disk Drive Eddie Alshehri
Time wayne25uk
Sync P.J. Onori
Sync Rohith M S
Cloud Upload Adam Whitcroft
Puzzle John O'Shea
Question Henry Ryder
Factory Adrijan Karavdic
Crash Test Dummy Luis Prado