Build process improvements.

- Separate out libraries by their purpose, so Netbeans doesn't have
  so much junk on the main classpath.

- Bundle a version of Ivy instead of downloading it.

- Have Ivy remove old versions of libraries instead of just adding
  new ones.

- Write the classpaths themselves to private.properties instead of
  an indirect private.classpath property which shows up weirdly in
  Netbeans.

Change-Id: I33b5fe34cc08d48d1b0e35ee93f21fa62bf8cfdb
Reviewed-on: http://gerrit.dmdirc.com/2705
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

.gitignore

@@ -32,7 +32,7 @@ __history
 /reports/report-fb.html
 /reports/report-pmd.*
 /reports/checkstyle.*
-/lib/clover.license
+/etc/clover.license
 /.clover
 /test_profile
 /*.key

build-installer.xml

@@ -5,13 +5,13 @@
     <target name="-init-installer" depends="init">
         <taskdef name="nsis" classname="com.danielreese.nsisant.Task">
             <classpath>
-                <fileset dir="lib" includes="*nsis*.jar"/>
+                <fileset dir="lib/build" includes="*nsis*.jar"/>
             </classpath>
         </taskdef>
 
         <taskdef name="git-describe" classname="org.mdonoughe.JGitDescribeTask">
             <classpath>
-                <fileset dir="lib" includes="*jgit*.jar"/>
+                <fileset dir="lib/build" includes="*jgit*.jar"/>
            </classpath>
         </taskdef>
     </target>

build-ivy.xml

@@ -2,33 +2,21 @@
 <project name="DMDirc-ivy" basedir="." xmlns:ivy="antlib:org.apache.ivy.ant">
     <description>Ivy utilities for DMDirc</description>
 
-    <property name="ivy.install.version" value="2.2.0"/>
     <property name="ivy.cache.ttl.default" value="7d"/>
 
     <target name="-init-ivy" depends="-init-lib-directory">
         <path id="ivy.classpath">
-           <fileset dir="lib" includes="*.jar"/>
+           <fileset dir="etc/ivy" includes="ivy*.jar"/>
         </path>
 
         <available classname="org.apache.ivy.ant.IvyConfigure"
               property="ivy.available" classpathref="ivy.classpath" />
     </target>
 
-    <target name="-download-ivy" depends="-init-ivy" unless="ivy.available">
-        <echo message="Retrieving Ivy"/>
-        <get src="http://repo1.maven.org/maven2/org/apache/ivy/ivy/${ivy.install.version}/ivy-${ivy.install.version}.jar"
-             dest="lib/ivy-${ivy.install.version}.jar"/>
-    </target>
-
-    <target name="-init-dependencies" depends="-download-ivy" unless="ivy.done">
-        <!-- Regenerate the classpath as we may have just downloaded Ivy -->
-        <path id="ivy.classpath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-
+    <target name="-init-dependencies" depends="-init-ivy" unless="ivy.done">
         <taskdef resource="org/apache/ivy/ant/antlib.xml" uri="antlib:org.apache.ivy.ant" classpathref="ivy.classpath"/>
         <ivy:settings file="etc/ivy/ivysettings.xml"/>
-        <ivy:retrieve symlink="true" pattern="lib/[artifact]-[revision].[ext]" />
+        <ivy:retrieve symlink="true" pattern="lib/[conf]/[artifact].[ext]" sync="true" />
         <property name="ivy.done" value="true"/>
     </target>
 </project>

build-paths.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="DMDirc-paths" default="default" basedir=".">
+
+    <path id="build-classpath">
+        <fileset dir="lib/build" includes="*.jar"/>
+    </path>
+
+    <path id="test-classpath">
+        <fileset dir="lib/test" includes="*.jar"/>
+    </path>
+
+    <path id="analyse-classpath">
+        <fileset dir="lib/analyse" includes="*.jar"/>
+    </path>
+
+    <path id="main-classpath">
+        <fileset dir="lib/main" includes="*.jar"/>
+    </path>
+
+</project>

build-plugins.xml

@@ -1,20 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project name="DMDirc-plugins" default="default" basedir=".">
 
-    <!-- Netbeans property files -->
-    <property file="nbproject/project.properties"/>
-    <property file="nbproject/private/private.properties"/>
-    <property file="${user.properties.file}"/>
-
     <import file="modules/plugins/build-pluginutils.xml"/>
 
     <target name="-init-plugins">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-
-        <taskdef resource="net/sf/fikin/ant/ant.properties" classpathref="libclasspath"/>
-        <taskdef resource="net/sf/antcontrib/antlib.xml" classpathref="libclasspath"/>
+        <taskdef resource="net/sf/fikin/ant/ant.properties" classpathref="build-classpath"/>
+        <taskdef resource="net/sf/antcontrib/antlib.xml" classpathref="build-classpath"/>
     </target>
 
     <target name="-init-default-build-target" unless="plugins.build.target">

build-properties.xml

@@ -7,12 +7,8 @@
     </condition>
 
     <target name="-init-properties">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-
-        <taskdef resource="net/sf/fikin/ant/ant.properties" classpathref="libclasspath"/>
-        <taskdef resource="net/sf/antcontrib/antlib.xml" classpathref="libclasspath"/>
+        <taskdef resource="net/sf/fikin/ant/ant.properties" classpathref="build-classpath"/>
+        <taskdef resource="net/sf/antcontrib/antlib.xml" classpathref="build-classpath"/>
     </target>
 
     <target name="-create-private-properties" unless="private.properties.exists">
@@ -22,25 +18,41 @@
 
     <target name="-check-private-classpath">
         <loadfile property="private.properties.old" srcFile="nbproject/private/private.properties"/>
-        <condition property="private.properties.needsinsert">
+        <condition property="private.properties.needs.javac">
+            <not>
+                <matches string="${private.properties.old}" pattern="^javac.classpath=(.*)$" multiline="true" casesensitive="true"/>
+            </not>
+        </condition>
+        <condition property="private.properties.needs.javac.test">
             <not>
-                <matches string="${private.properties.old}" pattern="^private.classpath=(.*)$" multiline="true" casesensitive="true"/>
+                <matches string="${private.properties.old}" pattern="^javac.test.classpath=(.*)$" multiline="true" casesensitive="true"/>
             </not>
         </condition>
     </target>
 
-    <target name="-create-private-classpath" if="private.properties.needsinsert">
-        <echo append="true" file="nbproject/private/private.properties">${line.separator}private.classpath=${line.separator}</echo>
+    <target name="-create-private-classpath" if="private.properties.needs.javac">
+        <echo append="true" file="nbproject/private/private.properties">${line.separator}javac.classpath=${line.separator}</echo>
     </target>
 
-    <target name="-init-private-properties" depends="-init-properties,-create-private-properties,-check-private-classpath,-create-private-classpath">
-        <path id="all.libs">
+    <target name="-create-private-test-classpath" if="private.properties.needs.javac.test">
+        <echo append="true" file="nbproject/private/private.properties">${line.separator}javac.test.classpath=${line.separator}</echo>
+    </target>
+
+    <target name="-init-private-properties" depends="-init-properties,-create-private-properties,-check-private-classpath,-create-private-classpath,-create-private-test-classpath">
+        <path id="main-libs">
             <fileset dir="modules" includes="*/lib/*.jar"/>
-            <fileset dir="lib" includes="*.jar"/>
+            <fileset dir="lib/main" includes="*.jar"/>
         </path>
 
-        <propertyregex property="private.classpath.value" input="${toString:all.libs}" regexp="\\" replace="/" global="true" defaultValue="${toString:all.libs}"/>
-        <replaceregexp file="nbproject/private/private.properties" match="^private.classpath=(.*)$" flags="im" replace="private.classpath=${private.classpath.value}"/>
+        <path id="test-libs">
+            <fileset dir="lib/test" includes="*.jar"/>
+        </path>
+
+        <propertyregex property="javac.classpath.value" input="${toString:all.libs}" regexp="\\" replace="/" global="true" defaultValue="${toString:main-libs}"/>
+        <propertyregex property="javac.test.classpath.value" input="${toString:test.libs}" regexp="\\" replace="/" global="true" defaultValue="${toString:test-libs}"/>
+
+        <replaceregexp file="nbproject/private/private.properties" match="^javac.classpath=(.*)$" flags="im" replace="javac.classpath=${javac.classpath.value}"/>
+        <replaceregexp file="nbproject/private/private.properties" match="^javac.test.classpath=(.*)$" flags="im" replace="javac.test.classpath=${javac.test.classpath.value}:$${javac.classpath}:build/classes:modules/plugins/build/classes"/>
     </target>
 
 </project>

build-reports.xml

@@ -13,31 +13,19 @@
     <target name="-mostreports" depends="cpd, pmd, checkstyle" /> 
 
     <target name="-init-checkstyle" depends="-init-dependencies">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-        <taskdef resource="checkstyletask.properties" classpathref="libclasspath"/>
+        <taskdef resource="checkstyletask.properties" classpathref="analyse-classpath"/>
     </target>
 
     <target name="-init-pmd" depends="-init-dependencies">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-        <taskdef name="pmd" classpathref="libclasspath" classname="net.sourceforge.pmd.ant.PMDTask" />
+        <taskdef name="pmd" classpathref="analyse-classpath" classname="net.sourceforge.pmd.ant.PMDTask" />
     </target>
 
     <target name="-init-cpd" depends="-init-dependencies">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-        <taskdef name="cpd" classpathref="libclasspath" classname="net.sourceforge.pmd.cpd.CPDTask" />
+        <taskdef name="cpd" classpathref="analyse-classpath" classname="net.sourceforge.pmd.cpd.CPDTask" />
     </target>
 
     <target name="-init-findbugs" depends="-init-dependencies">
-        <path id="libclasspath">
-            <fileset dir="lib" includes="*.jar"/>
-        </path>
-        <taskdef name="findbugs" classpathref="libclasspath" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" />
+        <taskdef name="findbugs" classpathref="analyse-classpath" classname="edu.umd.cs.findbugs.anttask.FindBugsTask" />
     </target>
     
     <target name="checkstyle-all" depends="-init-checkstyle">

build-tests.xml

@@ -3,18 +3,15 @@
     <description>Test-related tasks for DMDirc.</description>
 
     <target name="-init-clover" depends="-init-dependencies">
-        <path id="clover.classpath">
-            <fileset dir="lib" includes="*clover*.jar"/>
-        </path>
-
-        <taskdef resource="cloverlib.xml" classpathref="clover.classpath"/>
-        <taskdef resource="cloverjunitlib.xml" classpathref="clover.classpath"/>
+        <taskdef resource="cloverlib.xml" classpathref="test-classpath"/>
+        <taskdef resource="cloverjunitlib.xml" classpathref="test-classpath"/>
+        <property name="clover.license.path" location="etc/clover.license"/>
         <property name="clover.init.string" location=".clover/clover.db"/>
 
         <condition property="clover.installed">
             <and>
                 <available classname="com.cenqua.clover.CloverInstr"/>
-                <available file="lib/clover.license"/>
+                <available file="etc/clover.license"/>
             </and>
         </condition>
 

build-versioning.xml

@@ -11,7 +11,7 @@
     <available file=".git" property="is.git"/>
 
     <target name="-init-version">
-        <taskdef name="git-describe" classname="org.mdonoughe.JGitDescribeTask" classpathref="libclasspath"/>
+        <taskdef name="git-describe" classname="org.mdonoughe.JGitDescribeTask" classpathref="build-classpath"/>
     </target>
 
     <target name="-write-version" depends="-init-version, -write-version-header, -add-version, -write-updater, -write-identities, -write-disable-updates"/>

build.xml

@@ -4,6 +4,7 @@
 
     <import file="nbproject/build-impl.xml"/>
     <import file="build-installer.xml"/>
+    <import file="build-paths.xml"/>
     <import file="build-plugins.xml"/>
     <import file="build-reports.xml"/>
     <import file="build-tests.xml"/>
@@ -19,7 +20,7 @@
         <echo>Downloading private files, if this fails please pass username and</echo>
         <echo>password to ant using -Dusername=... -Dpassword=...</echo>
 
-        <get src="http://www.dmdirc.com/private/clover.license" dest="lib/clover.license" username="${username}" password="${password}"/>
+        <get src="http://www.dmdirc.com/private/clover.license" dest="etc/clover.license" username="${username}" password="${password}"/>
 
         <get dest="installer/signing/" username="${username}" password="${password}">
             <url url="http://www.dmdirc.com/private/DMDirc.cer"/>
@@ -33,7 +34,7 @@
         <condition property="clover.installed">
             <and>
                 <available classname="com.cenqua.clover.CloverInstr"/>
-                <available file="lib/clover.license"/>
+                <available file="etc/clover.license"/>
             </and>
         </condition>
     </target>
@@ -49,14 +50,14 @@
 
     <target name="-bundle-slf4j">
         <jar destfile="${dist.jar}" update="true">
-            <zipfileset src="lib/slf4j-api-1.6.6.jar" includes="org/slf4j/**/*"/>
+            <zipfileset src="lib/main/slf4j-api.jar" includes="org/slf4j/**/*"/>
         </jar>
     </target>
 
     <target name="-bundle-dagger">
         <jar destfile="${dist.jar}" update="true">
-            <zipfileset src="lib/dagger-1.1.0.jar" includes="dagger/**"/>
-            <zipfileset src="lib/javax.inject-1.jar" includes="javax/inject/*"/>
+            <zipfileset src="lib/main/dagger.jar" includes="dagger/**"/>
+            <zipfileset src="lib/main/javax.inject.jar" includes="javax/inject/*"/>
         </jar>
     </target>
 

etc/ivy/ant-fikin/ivy.xml

@@ -1,6 +1,7 @@
 <ivy-module version="2.0">
     <info organisation="net.sourceforge.fikin-ant-tasks" module="ant-fikin"/>
     <dependencies>
-        <dependency org="commons-httpclient" name="commons-httpclient" rev="3.1" conf="default" />
+        <dependency org="commons-httpclient" name="commons-httpclient" rev="3.+" conf="default" />
+        <dependency org="xerces" name="xercesImpl" rev="2.+" conf="default"/>
     </dependencies>
 </ivy-module>

ivy.xml

@@ -3,9 +3,9 @@
 
     <configurations>
         <conf name="build" description="Everything needed to support the build process"/>
-        <conf name="compile" description="Everything needed to compile DMDirc separately"/>
+        <conf name="main" description="Everything needed to compile DMDirc separately"/>
         <conf name="test" description="Everything needed to test DMDirc"/>
-        <conf name="default" extends="build,compile,test"/>
+        <conf name="analyse" description="Everything needed to run analysis on DMDirc"/>
     </configurations>
 
     <dependencies>
@@ -14,20 +14,21 @@
         <dependency org="com.github.shanemcc" name="jgit-describe" rev="0.3" conf="build->default" />
         <dependency org="net.sourceforge.fikin-ant-tasks" name="ant-fikin" rev="1.7.3" conf="build->default" />
 
-        <dependency org="org.slf4j" name="slf4j-api" rev="1.6.6" conf="compile->default" />
+        <dependency org="org.slf4j" name="slf4j-api" rev="1.+" conf="main->default" />
         <dependency org="ch.qos.logback" name="logback-classic" rev="1.+" conf="test->default" />
 
-        <dependency org="com.github.peichhorn" name="lombok-pg" rev="latest.release" conf="compile->default" />
+        <dependency org="com.github.peichhorn" name="lombok-pg" rev="latest.release" conf="main->default" />
 
-        <dependency org="com.squareup.dagger" name="dagger" rev="1.1.+" conf="compile->default" />
-        <dependency org="com.squareup.dagger" name="dagger-compiler" rev="1.1.+" conf="compile->default" />
+        <dependency org="com.squareup.dagger" name="dagger" rev="1.1.+" conf="main->default" />
+        <dependency org="com.squareup.dagger" name="dagger-compiler" rev="1.1.+" conf="main->default" />
 
-        <dependency org="pmd" name="pmd" rev="4.+" conf="test->default" />
         <dependency org="junit" name="junit" rev="4.+" conf="test->default" />
         <dependency org="org.mockito" name="mockito-all" rev="1.+" conf="test->default" />
         <dependency org="com.cenqua.clover" name="clover" rev="3.+" conf="test->default" />
-        <dependency org="com.puppycrawl.tools" name="checkstyle" rev="5.+" conf="test->default" />
-        <dependency org="net.sourceforge.findbugs" name="findbugs-ant" rev="1.+" conf="test->default" />
+
+        <dependency org="pmd" name="pmd" rev="4.+" conf="analyse->default" />
+        <dependency org="com.puppycrawl.tools" name="checkstyle" rev="5.+" conf="analyse->default" />
+        <dependency org="net.sourceforge.findbugs" name="findbugs-ant" rev="1.+" conf="analyse->default" />
 
         <exclude org="ant" module="ant"/>
     </dependencies>

nbproject/project.properties

@@ -80,12 +80,6 @@ util.test.dir=modules/util/test
 # However netbeans fails miserably at understanding this in the IDE, so we
 # have the private.classpath variable that will be updated in dynamic.propeties
 # automatically by ant.
-javac.classpath=\
-    ${private.classpath}
-javac.test.classpath=\
-    ${javac.classpath}:\
-    ${build.classes.dir}:\
-    modules/plugins/build/classes
 run.classpath=\
     ${javac.classpath}:\
     ${build.classes.dir}