move configuration files into a conf directory (which will be copied onto the filesys...
[java-idp.git] / build.xml
index 25bbcf2..71f691b 100755 (executable)
--- a/build.xml
+++ b/build.xml
-<!-- Main build configutaion for Shibboleth java components - Walter Hoehn 06/04/2002 -->
-
-<project name="Shibboleth" default="dist-all" basedir=".">
-
-    <!-- Set global properties for this build -->
-    <property name="distname" value="shibboleth" />
-    <property name="root" value="." />
-    <property name="src" value="${root}/src" />
-    <property name="approot" value="${root}/webApplication" />
-    <property name="configroot" value="${root}/webAppConfig" />
-    <property name="build" value="${approot}/WEB-INF/classes" />
-    <property name="libdir" value="${approot}/WEB-INF/lib" />
-    <property name="buildlibs" value="${root}/lib" />
-    <property name="dist" value="${root}/dist" />
-    <property name="docs" value="${root}/docs" />
-    <property name="javadocs" value="${docs}/api" />
-
-    <property name="year" value="2002"/>
-    <property name="copyright" value="Copyright &#169; ${year} UCAID. All Rights Reserved."/>
-
-
-    <!-- Construct the CLASSPATH -->
-    <path id="build.path">
-        <pathelement path="${classpath}" />
-        <pathelement location="${build}" />
-        <fileset dir="${libdir}">
-            <include name="**/*.jar" />
-        </fileset>
-        <fileset dir="${buildlibs}">
-            <include name="**/*.jar" />
-        </fileset>
-    </path>
-
-
-    <!-- Prepare directory structure for project build-->
-    <target name="init">
-    <mkdir dir="${build}" />
-    <mkdir dir="${dist}" />
-    </target>
-
-
-    <!-- This target should be run before checking code into the repository -->
-    <target name="pre-checkin" depends="compile-all, test-all, clean-all" />
-
-
-    <!-- Compile classes and move them to ${build} -->
-    <target name="compile-all" depends="init">
-        <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on">
-            <exclude name="edu/internet2/middleware/shibboleth/hs-cmu/**" />
-            <classpath refid="build.path" />
-        </javac>
-        <copy todir="${build}/schemas">
-            <fileset dir="${src}/schemas"/>
-        </copy>
-    </target>
-
-
-       <!-- Generate API docs -->
-       <target name="javadocs">
-               <mkdir dir="${docs}" />
-               <mkdir dir="${javadocs}" />
-               <javadoc packagenames='edu.internet2.middleware.*'
-                       sourcepath='${src}' destdir='${javadocs}'
-                       author='true' version='true'
-                       windowtitle='Shibboleth Java API' doctitle='Shibboleth Java API'
-                       bottom='${copyright}'>
-                <classpath refid="build.path" />
-        </javadoc>
+<project name="Shibboleth Identity Provider" basedir="." default="package">
+       
+       <tstamp>
+               <format property="build-date" pattern="ddMMyyyy'T'kkmmss" timezone="GMT"/>
+       </tstamp>\r
+
+       <!-- User based property file that overrides any property below -->
+       <property file="${user.name}-build.properties"/>
+               
+       <!-- Project based property file -->\r
+    <property file="build.properties" />\r
+\r
+    <!-- Load ant-contrib tasks -->\r
+    <taskdef resource="net/sf/antcontrib/antlib.xml" />
+       
+       <!-- Load Checkstyle tasks -->
+       <taskdef resource="checkstyletask.properties" />\r
+\r
+    <!-- Classpath for building core classes-->\r
+    <path id="build-path">\r
+        <fileset dir="${build-lib.dir}" includes="**/*.jar" />\r
+        <fileset dir="${lib.dir}" includes="**/*.jar" />\r
+    </path>\r
+\r
+    <!-- Classpath for testing classes-->\r
+    <path id="test-path">\r
+        <path refid="build-path" />\r
+        <pathelement location="${core-classes.dir}" />\r
+        <pathelement location="${core-src.dir}" />\r
+        <pathelement location="${test-classes.dir}" />
+       <pathelement location="${test-classes.dir}/data" />
+       <pathelement location="${test-classes.dir}/log4j.xml" />\r
+        <pathelement location="${test-src.dir}" />\r
+        <pathelement location="${classpathres.dir}" />\r
+    </path>\r
+\r
+    <!-- Prepare directory structure for build -->\r
+    <target name="build-init">\r
+        <mkdir dir="${build.dir}" />\r
+    </target>\r
+\r
+    <!-- Compile core (non-test) classes -->\r
+    <target name="compile-core" depends="build-init, clean-compile">\r
+        <mkdir dir="${core-classes.dir}" />\r
+\r
+        <javac srcdir="${core-src.dir}" destdir="${core-classes.dir}" includes="**/*.java" debug="on" source="1.5">\r
+            <classpath refid="build-path" />\r
+        </javac>\r
+\r
+    </target>\r
+\r
+    <!-- Compile unit test classes -->\r
+    <target name="compile-test" depends="compile-core">\r
+        <mkdir dir="${test-classes.dir}" />\r
+\r
+        <javac srcdir="${test-src.dir}" destdir="${test-classes.dir}" includes="**/*.java" debug="on" source="1.5">\r
+            <classpath refid="test-path" />\r
+        </javac>\r
+\r
+    </target>\r
+\r
+    <!-- Compile and run unit tests -->\r
+    <target name="test" depends="compile-core, compile-test" description="Runs the unit tests for the project.">\r
+        <mkdir dir="${test-results.dir}" />\r
+\r
+       <echo message="Excuting unit tests using endorsed directory ${java.endorsed.dirs}" />\r
+        <junit printsummary="off" fork="yes" forkmode="once" haltonerror="false" haltonfailure="false" dir="${basedir}" errorproperty="testFailed">\r
+               <jvmarg value="-Djava.endorsed.dirs=${java.endorsed.dirs}" />\r
+            <classpath refid="test-path" />\r
+            <formatter type="xml" />\r
+            <batchtest todir="${test-results.dir}">\r
+                <fileset dir="${test-classes.dir}">\r
+                    <include name="**/*Test.class" />\r
+                </fileset>\r
+            </batchtest>\r
+        </junit>\r
+       <junitreport todir="${test-results.dir}">\r
+         <fileset dir="${test-results.dir}">\r
+           <include name="TEST-*.xml"/>\r
+         </fileset>\r
+         <report format="frames" todir="${test-report.dir}"/>\r
+       </junitreport>
+       
+       <echo message="Test report available at ${test-report.dir}/index.html" />
+       <fail if="testFailed" message="Test failure; see ${test-report.dir}/index.html for more information."/>\r
+    </target>\r
+\r
+    <!-- Javadoc core (non-test) classes -->\r
+    <target name="javadoc" description="Creates the JavaDoc documentatin for the project.">\r
+        <mkdir dir="${javadoc.dir}" />\r
+        <javadoc packagenames="org.opensaml.*" \r
+                    sourcepath="${core-src.dir}" \r
+                    destdir="${javadoc.dir}" \r
+                    author="false" version="true" \r
+                    windowtitle="${ant.project.name} ${version} Java API" \r
+                    doctitle="${ant.project.name} ${version} Java API" \r
+                    bottom="${copyright}"\r
+                    overview="${core-src.dir}/overview.html">\r
+            <classpath refid="build-path" />\r
+        </javadoc>\r
+    </target>\r
+\r
+    <!-- Removes previously compiled files -->\r
+    <target name="clean-compile">\r
+        <delete dir="${build.dir}" />\r
+    </target>\r
+\r
+    <!-- Removes all build generated content -->\r
+    <target name="clean" depends="clean-compile" description="Removes any artifact produced by the build process.">\r
+        <delete dir="${javadoc.dir}" />
+       <delete dir="${reports.dir}" />\r
+        <delete dir="${dist.dir}" />\r
+    </target>\r
+\r
+    <!-- Create JAR file -->\r
+    <target name="package" depends="compile-core, test" description="Creates the project library jar file.">\r
+        <mkdir dir="${dist.dir}" />\r
+\r
+        <if>\r
+            <equals arg1="${jdk.target}" arg2="1.4" />\r
+            <then>\r
+                <java classname="com.rc.retroweaver.Weaver">\r
+                    <arg value="-source" />\r
+                    <arg value="${core-classes.dir}" />\r
+                    <classpath>\r
+                        <fileset dir="${thirdpaty-lib.dir}">\r
+                            <include name="**/*.jar" />\r
+                        </fileset>\r
+                    </classpath>\r
+                </java>\r
+\r
+                <echo message="**************************************************************" />\r
+                <echo message="    Remember, you must include the retroweaver-rt jar" />\r
+                <echo message="    file, located in the thirdparty-lib directory, along with the" />\r
+                <echo message="    ${jar.name} on your" />\r
+                <echo message="    classpath in order to use this with JDK 1.4" />\r
+                <echo message="**************************************************************" />\r
+\r
+            </then>\r
+        </if>\r
+\r
+        <jar destfile="${dist.dir}/${jar.name}" whenempty="fail">\r
+               <fileset dir="${classpathres.dir}" />
+               <fileset dir="${metainf.dir}" />
+               <fileset dir="${webinf.dir}" />
+               <fileset dir="${webpages.dir}" />
+               <zipfileset dir="${core-classes.dir}" prefix="/WEB-INF/classes/" />
+               <zipfileset dir="${lib.dir}" prefix="/WEB-INF/lib/" />\r
+       </jar>\r
+\r
+    </target>\r
+\r
+    <!-- **************************************************************** -->\r
+    <!-- ***                                                          *** -->\r
+    <!-- ***                     Developer Tasks                      *** -->\r
+    <!-- ***                                                          *** -->\r
+    <!-- **************************************************************** -->\r
+       
+       <!-- Checks code against style guidelines -->
+       <target name="checkstyle" description="Developer task: Produces coding standard compliance report.">
+               <mkdir dir="${reports.dir}" />
+               
+               <checkstyle config="${basedir}/checkstyle.xml"
+                                       failOnViolation="false"
+                       classpathref="build-path">
+                       <fileset dir="src" includes="**/*.java" />
+                       <formatter type="plain" toFile="${reports.dir}/checkstyle-report.txt" />
+               </checkstyle>
        </target>
-
-    <!-- Create various product distributions and move them to ${dist} -->
-    <target name="dist" depends="dist-all" />
-    <target name="dist-all" depends="compile-all, test-all, package-all, clean-build" />
-    <target name="package-all">
-        <war warfile="${dist}/${distname}.war" webxml="${approot}/WEB-INF/web.xml" basedir="${approot}" update="no" />
-    </target>
-
-    <target name="dist-origin" depends="compile-all, test-origin, package-origin, clean-build" />
-    <target name="package-origin">
-        <war warfile="${dist}/${distname}-origin.war" webxml="${configroot}/origin.xml" basedir="${approot}" update="no" />
-    </target>
-
-    <target name="dist-target" depends="compile-all, test-target, package-target, clean-build" />
-    <target name="package-target">
-        <war warfile="${dist}/${distname}-target.war" webxml="${configroot}/target.xml" basedir="${approot}" update="no" />
-    </target>
-
-    <target name="dist-target-includewayf" depends="compile-all, test-target, test-wayf, package-target-includewayf, clean-build" />
-    <target name="package-target-includewayf">
-        <war warfile="${dist}/${distname}-target.war" webxml="${configroot}/target-includewayf.xml" basedir="${approot}" update="no" />
+       \r
+    <!-- Create TGZ source distribution -->
+    <target name="tgz-src-dist" depends="package, javadoc" description="Developer task: Creates the tar, gzipped source distribution.">
+        <tar tarfile="${dist.dir}/${src-dist.name}.tgz" compression="gzip">
+               <tarfileset dir="${build-lib.dir}" prefix="/build-lib/" />
+               <tarfileset dir="${lib.dir}" prefix="/lib/" />
+               <tarfileset dir="${resources.dir}" prefix="/resources/" />
+               <tarfileset dir="${core-src.dir}" prefix="/src/" />
+               <tarfileset dir="${test-src.dir}" prefix="/test/" />
+               <tarfileset dir="${doc.dir}" prefix="/doc/" />
+               <tarfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
+               <tarfileset file="${basedir}/*.*" prefix="/" />
+        </tar>
+       <checksum file="${dist.dir}/${src-dist.name}.tgz" />
     </target>
 
-    <target name="dist-wayf" depends="compile-all, test-wayf, package-wayf, clean-build" />
-    <target name="package-wayf">
-        <war warfile="${dist}/${distname}-wayf.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
+    <!-- Create TGZ binary distribution -->
+    <target name="tgz-bin-dist" depends="package, javadoc" description="Developer task: Creates the tar, gzipped binary distribution.">
+        <tar tarfile="${dist.dir}/${bin-dist.name}.tgz" compression="gzip">
+               <tarfileset dir="${lib.dir}" prefix="/lib/" />\r
+               <tarfileset dir="${resources.dir}" prefix="/resources/" />
+               <tarfileset dir="${doc.dir}" prefix="/doc/" />
+               <tarfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
+        </tar>
+       <checksum file="${dist.dir}/${bin-dist.name}.tgz" />
     </target>
 
-
-    <!-- Cleanup after the build, test, and distribution processes -->
-    <target name="clean" depends="clean-all" />
-    <target name="clean-all" depends="clean-build, clean-dist, clean-test, clean-javadocs" />
-    <target name="clean-build">
-        <delete dir="${build}" />
+    <!-- Create ZIP source distribution -->
+    <target name="zip-src-dist" depends="package, javadoc" description="Developer task: Creates the zipped source distribution.">
+        <zip zipfile="${dist.dir}/${src-dist.name}.zip" whenempty="fail">
+               <zipfileset dir="${build-lib.dir}" prefix="build-lib/" />
+               <zipfileset dir="${lib.dir}" prefix="lib/" />\r
+               <zipfileset dir="${resources.dir}" prefix="/resources/" />
+               <zipfileset dir="${core-src.dir}" prefix="src/" />
+               <zipfileset dir="${test-src.dir}" prefix="test/" />
+               <zipfileset dir="${doc.dir}" prefix="doc/" />
+               <zipfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
+               <zipfileset file="${basedir}/*.*" prefix="" />
+        </zip>
+       <checksum file="${dist.dir}/${src-dist.name}.zip" />
     </target>
-    <target name="clean-test">
-        <delete>
-            <fileset dir="${root}">
-                <include name="**/TEST*.txt" />
-            </fileset>
-        </delete>
-    </target>
-    <target name="clean-dist">
-        <delete dir="${dist}" />
-    </target>
-       <target name="clean-javadocs">
-               <delete dir="${javadocs}" />
-       </target>
-
-    
-    <!-- Run automated tests on compiled code -->
-    <target name="test-all" depends="test-origin, test-target, test-wayf" />
-    <target name="test-origin" depends="test-common" />
-    <target name="test-target" depends="test-common" />
-    <target name="test-wayf" depends="test-common" />
-    <target name="test-common" depends="compile-all">
-        <junit printsummary="no" fork="no" haltonfailure="yes" haltonerror="no">
-            <classpath refid="build.path" />
-            <formatter type="plain" />
-        <!-- <test name="edu.internet2.middleware.shibboleth.common.AQHTest" /> -->
-        </junit>
-    </target>
-
-</project>
-
 
+    <!-- Create ZIP binary distribution -->
+    <target name="zip-bin-dist" depends="package, javadoc"  description="Developer task: Creates the zipped binary distribution.">
+        <zip zipfile="${dist.dir}/${bin-dist.name}.zip" whenempty="fail">
+               <zipfileset dir="${lib.dir}" prefix="lib/" />\r
+               <zipfileset dir="${resources.dir}" prefix="/resources/" />
+               <zipfileset dir="${doc.dir}" prefix="doc/" />
+               <zipfileset file="${dist.dir}/${jar.name}" prefix="/dist/" />
+        </zip>
+       <checksum file="${dist.dir}/${bin-dist.name}.zip" />
+    </target>\r
+\r
+</project>
\ No newline at end of file