ant-ivy-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Kirby Files <>
Subject Re: How to create a filesystem repository
Date Mon, 02 May 2011 20:41:55 GMT wrote on 05/02/2011 03:00 PM:
> Hello to all,
> Can someone tell me how I can create a local filesystem repository with Ivy? I've been
through the documentation and it is not clear how I can get started.
> My jar files are in the format
> Libdirectory/module/jar1.jar
> Libdirectory/module/jar2.jar

Yes, Jose, this is one of the more frustrating deficiencies in the Ivy 
toolset: it's difficult to migrate from the most common situation (a 
directory full of jars with no metadata) to an ivy.xml file with 
dependencies and a repository containing those jars with metadata.

I have some suggestions:

1) Start with some decent metadata and existing sources of dependency 
management: use the IvyRoundup packager repository or the public Maven 
repos (with the ibiblio resolver) to bootstrap your filesystem 
repository with the <ivy:install> task (it can copy from a source repo 
to a dest repo, if necessary converting the maven poms to ivy.xml in 
the process).

2) Create an ivysettings.xml with all of the repos, public and 
private, that you'll need to access.

3) Create an ivy.xml and a ivy:publish target for each of your 
projects, and publish those to your repository.

3) Use scripts to install jars not available publicly, nor produced 
internally, from a directory to your repository.

I use this script:


if ($1 == "") then
     echo "Usage: installjar <org> <module> <revision> <path-to-file>"
     /usr/local/ant/bin/ant -Dorg="$1" -Dmodule="$2" -Drev="$3" 
-Dinstall.path="$4" $5 $6 $7 $8 $9

With the following build target:

   <target name="installjar"
           description="--> install jar to masrep">
     <ivy:install settingsRef="masergy.settings" organisation="${org}" 
module="${module}" revision="${rev}" type="jar" 
from="${localjar.resolver}" to="${to.resolver}" />

Where my defines these variables:


And my ivysettings.xml includes:
     <filesystem name="localjars">
       <artifact pattern="${install.path}/[artifact]-[revision].[ext]" />
       <artifact pattern="${install.path}/[artifact].[ext]" />

This script allows me to specify a jar on the local filesystem by its 
name and the directory in which it resides (install.path), add the 
org, and rev metadata, and publish it to one of my resolvers (I use 
SFTP with a keyfile to push files up to our webserver; you may use a 
filesystem resolver or webdav as a destination).

I also have a bigger hack of a perl script which attempts to read a 
directory of jars and guess the org, modul, and rev (validating 
against maven2), or prompt the user when it's unclear. See below.

Kirby Files
Software Architect
Masergy Communications

# Looks for jars in the incoming directory, attemps to parse the
# needed ivy info from the filename, and if successful, publishes
# the jar to the Masergy ivrep repository.

# If using linux with package mgmt, dependencies are:
# perl-libwww-perl
# perl-XML-Xpath
# perl-Archive-Zip
use LWP::UserAgent;
use XML::XPath;
use XML::XPath::XMLParser;
use Archive::Zip;
use Cwd;
use strict qw(vars);

use vars qw($indir $ant $rep $pre $post);

$indir = shift(@ARGV);
if ($indir !~ m#^/#) {
   my $cwd = getcwd();
   $indir =~ s/^/$cwd\//;
   print "CWD: $indir\n";
$ant = "/usr/local/ant/bin/ant";
$rep = "newjars";
$pre="<ivy:install settingsRef=\"masergy.settings\" organisation=\"";
$post=" from=\"\${from.resolver}\" to=\"\${to.resolver}\" />";

open (DIR, "ls -1 $indir|") || die "could not open $indir\n";
while (<DIR>) {
   my ($org, $module, $jar, $ver);
   next unless /jar/;
   my $file = $indir . "/" . $_;
   $ver="unknown" unless $ver =~ /\d/;
   ## Figure out the org
   ## Ask the user, if there's ambiguity
   $org = &maven_search_org( $module );
   if (-1 == $org) {
     $org = &guess_org($module);
     print "Org guessed from module name:\n  $org\n";
     $org = &classes_org($file);
     print "Org guessed from jar package naming:\n  $org\n"
       unless (-1 == $org);
     do {
       $org = &get_user_org();
     } while ($org =~ /^$/);
   if ($ver eq "unknown" || ($module !~ /^\w+$/) || $org !~ /\w+/) {
     print "Skipping jar $jar:\n";
     print "  $org / $module / $ver\n";
   } else {
     &publish_jar($jar, $org, $module, $ver);
   #&write_ivy_conf($jar, $org, $module, $ver);

## Use ivy::install to publish the jar via sftp to ivyrep
sub publish_jar
   my ($jar, $org, $module, $ver) = @_;
   print "Uploading $org / $module / $jar ... ";
   my $resp = `$ant -Dorg=$org -Dmodule=$module -Drev=$ver 
-Dinstall.path=$indir 2>&1`;
   if ($resp =~ /failed/i) {
     print STDERR "Error uploading $jar:\n", $resp;
     print "\n";
   } else {
     print "Done.\n";

## Find a directory in the jar to propose as the org
## searches for any dirs with two path elements
sub classes_org
   my ($file) = @_;
   my $somezip = Archive::Zip->new();
   unless ( $somezip->read( $file ) == AZ_OK ) {
        die "Error reading jarfile $file";
   my @members = $somezip->members();
   my @dirnames = ();
   foreach (@members) {
     if ($_->isDirectory()) {
       my $fname = $_->fileName();
       if ($fname =~ /^\w+\/\w+\/$/) {
         $fname =~ s/^(\w+)\/(\w+)\/$/$1.$2/;
         return $fname;
   return -1;

## Ask the user for the best org name
sub get_user_org
   print "Enter preffered org:> ";
   my $line = <STDIN>;
   return $line;

## Make a guess about the org name from the module name
sub guess_org
   my ($module) = @_;
   my $org = $module;
   return $org;

## Search the maven repo for a module matching this jar
## If found, return the module's organization
## if none, or more than one, are found, ask the user
sub maven_search_org
   my ($module) = @_;

   my $ua = LWP::UserAgent->new;
   $ua->agent('Maven Repo Search');

   my $service= 
   my $url=URI->new($service . $module);
   my $req=HTTP::Request->new;
   my $resp = $ua->request($req)->content;

   my $org = &parse_resp( $module, $resp );
   return $org;

## Parse the XML response from the Maven search service
sub parse_resp
   my ($module, $data) = @_;

   my $xp = XML::XPath->new(xml => $data);

   my $nodeset = $xp->find('//groupId'); # find all paragraphs

   # Get rid of duplicates
   my %uniq=();
   foreach my $node ($nodeset->get_nodelist) {
      $uniq{ $xp->getNodeText( $node ) } = 1;
   my @keys = (sort keys %uniq);

   if ($#keys == 0) {
     return ($keys[0]);
   } elsif ($#keys == -1) {
     print "Found no module matching $module in Maven repo\n";
     return -1;
   } else {
     print "Found multiple possible orgs for $module in Maven repo:\n";
     foreach (@keys) {
       print "  $_\n";
     return -1;

## (obsolete) Write ant task and ivy.xml conf lines to create repo
sub write_ivy_conf
   my ($jar, $org, $module, $ver) = @_;
   my $line = $pre . $org . "\" module=\"" . $module . "\" 
revision=\"" . $ver . "\"". $post . "\n";
   system("mkdir -p $rep/$org/$module/jars");
   link "$indir/$jar", "$rep/$org/$module/jars/$jar";
   print $line;
   print "<dependency org=\"" . $org . "\" name=\"" . $module . "\" 
rev=\"" . $ver . "\"/>\n";

View raw message