Mercury Ant tasks - HowTo

mercury-ant-tasks is an Ant wrapper for Mercury functionality, that provides a lot of Mercury functionality inside ant scripts.

-----------
Please check this posting first. It contains the latest information on the subject.
-----------

What exactly is provided:

• Configuration
  • named authentication elements to be used by repository or proxy authentication
  • supports both name/password or certificate pointer (file or URL) plus optional password
  • named repository configurations
  • local repositories (not limited to one)
  • remote repositories
  • stream verification per repository - separate for reading and writing
  • currently supported SHA-1 and PGP (.asc)
• named dependency sets
  • lists dependencies and optionally - their Maven scopes
  • standardized on a one-string naming convention
  • supports OSGi-syntax version ranges
• ant path creation/alteration
  • a task that either creates a new ant path or adds to existing one
  • optionally allows to specify Maven-like scope for the path resolution
• repository writes
  • allows to write named files into repositories
  • optional classifiers, types
  • signature generation is configured per repository
  • SHA1, PGP

Where to get mercury-ant-tasks?

All the development releases will be deployed to this site; grab the latest snapshot and:

• put it into ${user.home}/.ant/lib
• if you plan to use PGP signatures - also put there bcpg-jdk15-140.jar and bcprov-jdk15-140.jar from this central repository location
• if interested - my test build.xml contains all the unit test scripts

mercury-ant-tasks howto-by-example

This snippet shows how to define mercury namespace in the ant project markup

<project name="mercury-ant-test" default="compile"
xmlns:merc="antlib:org.apache.maven.mercury.ant.tasks" > ... </project>

This snippet shows how to define two repositories - one remote, one local. You don't have to always define a local repository, but in this case binaries would reside in temp. location and will be reloaded from the remote on each invocation of the merc:resolve task

<merc:config id="conf">
  <merc:repo id="localRepo" dir="/maven.repo"/>
  <merc:repo id="central" url="http://repo1.maven.org/maven2"/>
</merc:config>

This snippet shows how to define authenticated repository and hide the password in the external file, so that each OS user can have their own credentials

<property file="~/.secret/secret.properties"/>

<merc:config id="conf">
  <merc:auth id="repo-auth" name="${repo.user}" pass="${repo.pass}"/>
  <merc:repo id="localRepo" dir="/maven.repo"/>
  <merc:repo id="central" url="http://repo1.maven.org/maven2"
             authid="repo-auth"/>
</merc:config>

This snippet shows how to configure a repository for PGP signature generation and checking; here secret keyring password is also kept in external file. Key ID always is a 16-digit hex number - use GnuPG GUI to look it up (and also generate/manipulate your keys). The verifier will accept any key from pubring.gpg for the signature

<property file="~/.secret/secret.properties"/>

<merc:config id="conf">

  <merc:auth id="repo-auth" name="${repo.user}" pass="${repo.pass}"/>

  <merc:repo id="localRepo" dir="/maven.repo"/>

  <merc:repo id="central" url="http://repo1.maven.org/maven2"
                    authid="repo-auth">

    <merc:verifywrite type="pgp">
<property name="keyring" value="/home/me/pgp/secring.gpg"/>
<property name="pass" value="${secret.keyring.pass}"/>
<property name="key" value="0EDB5D91141BC4F2"/>
    </merc:verifywrite>

    <merc:verifyread type="pgp">
<property name="keyring" value="/home/me/pgp/pubring.gpg"/>
    </merc:verifyread>

  </merc:repo>

</merc:config>

This snippet shows how to define authenticated repository and hide the password in the external file, so that each OS user can have their own credentials

<property file="~/.secret/secret.properties"/>
<merc:config id="conf">
  <merc:auth id="repo-auth" name="${repo.user}" pass="${repo.pass}"/>
  <merc:repo id="localRepo" dir="/maven.repo"/>
  <merc:repo id="central" url="http://repo1.maven.org/maven2"
                    authid="repo-auth"/>
</merc:config>

This snippet shows how to define a dependency set. Junit will only be added to paths that define scope="test"

<merc:dep id="my-libs">
  <merc:dependency name="asm:asm:[2.0,3.0)"/>
  <merc:dependency name="junit:junit:[4.0.1,):::test"/>
  </merc:dep>

This snippet shows how to resolve a dependency set and add the resulting binaries to "compile-path" path. This path will not include JUnit from previous snippet

<merc:resolve pathid="compile-path" depid="my-libs" configid="conf" />
<javac srcdir="${src}" destdir="${target}" classpathref="compile-path" />

This snippet shows how to resolve a dependency set in test scope and add the resulting binaries to "test-compile-path" path. This path will have JUnit

<merc:resolve pathid="test-compile-path"
                      depid="my-libs"
                      configid="conf"
                      scope="test"
/>

This snippet shows how to write a jar file and it's sources to a repository

<merc:write repoid="remoteRepo"
                   name="t:t:1.0"
                   file="${basedir}/target/t.jar"
/>
<merc:write repoid="remoteRepo"
                   name="t:t:1.0:sources"
                   file="${basedir}/target/t-src.jar"
/> 

mercury-ant-tasks reference

Now, let's have a closer look at ant mercury markup. To make it available to ant, provide a namespace definition on the project level, for example:
<project name="test" default="compile" xmlns:merc="antlib:org.apache.maven.mercury.ant.tasks">

Everywhere here I mention named - named configuration, named set. It means named in ant sense: something that has an id attribute value, and then we can reference that particular object (configuration, set, etc) by this value.