fix class name
[java-idp.git] / build.xml
index ae05261..cf4f772 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-IdP" basedir=".">
-
-    <!-- Set global properties for this build -->
-    <property name="distname" value="shibboleth" />
-    <property name="root" value="." />
-    <property name="src" value="${root}/src/" />
-    <property name="tests" value="${root}/tests/" />
-    <property name="approot" value="${root}/webApplication/" />
-    <property name="appconfig" value="${src}/conf/" />
-    <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="endorsed" value="${root}/endorsed/" />
-    <property name="distlibs" value="${root}/lib/" />
-    <property name="dist" value="${root}/dist/" />
-    <property name="docs" value="${root}/doc/" />
-    <property name="javadocs" value="${docs}/api/" />
-
-    <property name="year" value="2002"/>
-    <property name="copyright" value="Copyright &#169; ${year} UCAID. All Rights Reserved."/>
-
-       <!-- Configure properties to find Tomcat and access the Manager application -->
-       <property name="tomcat.home" value="/usr/local/tomcat"/>
-       <property name="url" value="http://localhost:8080/manager"/>
-       <property name="username" value="manager"/>
-       <property name="password" value="password"/>
-
-       <!-- Uncomment this for Tomcat Tasks
-       <path id="tomcat.classpath">
-       <fileset dir="${tomcat.home}/server/lib" includes="catalina-ant.jar"/>
-       </path>
-
-       <taskdef name="tomcatStart" classname="org.apache.catalina.ant.StartTask" classpathref="tomcat.classpath"/>
-       <taskdef name="tomcatStop" classname="org.apache.catalina.ant.StopTask" classpathref="tomcat.classpath"/>
-       <taskdef name="tomcatDeploy" classname="org.apache.catalina.ant.DeployTask" classpathref="tomcat.classpath"/>
-       <taskdef name="tomcatUndeploy" classname="org.apache.catalina.ant.UndeployTask" classpathref="tomcat.classpath"/>
-       -->
-       
-    <!-- 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>
+<project name="Shibboleth Identity Provider" basedir="." default="install">
 
+    <!-- User based property file that overrides any property below -->
+    <property file="${user.name}-build.properties" />
 
-    <!-- Prepare directory structure for project build-->
-    <target name="init">
-    <mkdir dir="${build}" />
-    <mkdir dir="${dist}" />
-    </target>
+    <!-- Project based property file -->
+    <property file="build.properties" />
 
+    <!-- Installation specific property file -->
+    <property file="install.properties" />
 
-    <!-- This target should be run before checking code into the repository -->
-    <target name="pre-checkin" depends="compile, test-all, clean-all" />
+    <!-- Load ant-contrib tasks -->
+    <taskdef resource="net/sf/antcontrib/antlib.xml" />
 
+    <!-- Load Internet2 ant extensions -->
+    <taskdef resource="edu/internet2/middleware/ant/antlib.xml" />
 
-    <!-- Compile classes and move them to ${build} -->
-    <target name="compile" depends="init">
-        <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on">
-            <classpath refid="build.path" />
-        </javac>
-        <copy todir="${build}/schemas">
-            <fileset dir="${src}/schemas"/>
-        </copy>
-        <copy todir="${build}/conf">
-            <fileset dir="${src}/conf"/>
-        </copy>
-    </target>
-    
-    <target name="compile-tests" depends="compile">
-        <javac srcdir="${tests}" destdir="${build}" includes="**/*.java" debug="on">
-            <classpath refid="build.path" />
-        </javac>
+    <!-- Load Checkstyle tasks -->
+    <taskdef resource="checkstyletask.properties" />
+
+    <!-- Classpath for building core classes-->
+    <path id="build-path">
+        <fileset dir="${build-lib.dir}" includes="**/*.jar" />
+        <fileset dir="${lib.dir}" includes="**/*.jar" />
+    </path>
+
+    <!-- Classpath for testing classes-->
+    <path id="test-path">
+        <path refid="build-path" />
+        <pathelement location="${core-classes.dir}" />
+        <pathelement location="${core-src.dir}" />
+        <pathelement location="${test-classes.dir}" />
+        <pathelement location="${test-classes.dir}/data" />
+        <pathelement location="${test-classes.dir}/log4j.xml" />
+        <pathelement location="${test-src.dir}" />
+        <pathelement location="${classpathres.dir}" />
+    </path>
+
+    <!-- Prepare directory structure for build -->
+    <target name="build-init">
+        <mkdir dir="${build.dir}" />
     </target>
 
+    <!-- Compile core (non-test) classes -->
+    <target name="compile-core" depends="build-init, clean-compile">
+        <mkdir dir="${core-prep-source.dir}" />
+        <mkdir dir="${core-classes.dir}" />
 
-       <!-- 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>
-       </target>
+        <copy todir="${core-prep-source.dir}" preservelastmodified="true">
+            <fileset dir="${core-src.dir}" />
+            <filterset begintoken="$" endtoken="$">
+                <filter token="IDP_HOME" value="${idp.home}" />
+                <filter token="IDP_VERSION" value="${version}" />
+            </filterset>
+        </copy>
 
-    <!-- Create various product distributions and move them to ${dist} -->
+        <javac srcdir="${core-prep-source.dir}"
+               destdir="${core-classes.dir}"
+               includes="**/*.java"
+               debug="on"
+               source="1.5">
+            <classpath refid="build-path" />
+        </javac>
 
-    <target name="dist-all" depends="compile, test-all, package-all, clean-build" />
-       
-    <target name="package-all">
-        <war warfile="${dist}/${distname}.war" webxml="${configroot}/all.xml" basedir="${approot}" update="no" />
-    </target>
+        <delete dir="${core-prep-source.dir}" />
 
-    <target name="dist-IdP" depends="compile, test-IdP, package-IdP, clean-build" />
-    <target name="package-IdP">
-        <war warfile="${dist}/${distname}.war" webxml="${configroot}/origin.xml" basedir="${approot}" update="no" />
-    </target>
-       
-    <target name="dist-IdP-SP" depends="compile, test-IdP, package-IdP-SP, clean-build" />
-    <target name="package-IdP-SP">
-        <war warfile="${dist}/${distname}.war" webxml="${configroot}/IdP-SP.xml" basedir="${approot}" update="no" />
     </target>
 
-    <target name="dist-wayf" depends="compile, package-wayf, clean-build" />
-    <target name="package-wayf">
-        <war warfile="${dist}/${distname}-wayf.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
-    </target>
+    <!-- Compile unit test classes -->
+    <target name="compile-test" depends="compile-core">
+        <mkdir dir="${test-classes.dir}" />
 
-    <!-- Build utilities -->
-    <target name="build-util" depends="compile">
-        <jar jarfile="${distlibs}/shib-util.jar" basedir="${build}" />
-    </target>
+        <javac srcdir="${test-src.dir}" destdir="${test-classes.dir}" includes="**/*.java" debug="on" source="1.5">
+            <classpath refid="test-path" />
+        </javac>
 
-    
-    <!-- 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, clean-util" />
-    <target name="clean-build">
-        <delete dir="${build}" />
     </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>
-    <target name="clean-util">
-        <delete>
-            <fileset dir="${buildlibs}">
-                <include name="shib-util.jar" />
+
+    <!-- Compile and run unit tests -->
+    <target name="test" depends="compile-core, compile-test" description="Runs the unit tests for the project.">
+        <mkdir dir="${test-results.dir}" />
+
+        <echo message="Excuting unit tests using endorsed directory ${java.endorsed.dirs}" />
+        <junit printsummary="off"
+               fork="yes"
+               forkmode="once"
+               haltonerror="false"
+               haltonfailure="false"
+               dir="${basedir}"
+               errorproperty="testFailed">
+            <jvmarg value="-Djava.endorsed.dirs=${java.endorsed.dirs}" />
+            <classpath refid="test-path" />
+            <formatter type="xml" />
+            <batchtest todir="${test-results.dir}">
+                <fileset dir="${test-classes.dir}">
+                    <include name="**/*Test.class" />
+                </fileset>
+            </batchtest>
+        </junit>
+        <junitreport todir="${test-results.dir}">
+            <fileset dir="${test-results.dir}">
+                <include name="TEST-*.xml" />
             </fileset>
-        </delete>
+            <report format="frames" todir="${test-report.dir}" />
+        </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." />
     </target>
 
-    <!-- Run automated tests on compiled code -->
-    <target name="test-all" depends="test-IdP" />
-    <target name="test-IdP" depends="compile-tests">
-        <junit printsummary="no" fork="yes" haltonfailure="yes" haltonerror="yes" dir="${root}">
-                       <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
-            <classpath refid="build.path" />
-            <formatter type="plain" />
-            <test name="edu.internet2.middleware.shibboleth.aa.arp.ArpTests" />
-                       <test name="edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverTests" />
-        </junit>
+    <!-- Javadoc core (non-test) classes -->
+    <target name="javadoc" description="Creates the JavaDoc documentatin for the project.">
+        <mkdir dir="${javadoc.dir}" />
+        <javadoc packagenames="org.opensaml.*"
+                 sourcepath="${core-src.dir}"
+                 destdir="${javadoc.dir}"
+                 author="false"
+                 version="true"
+                 windowtitle="${ant.project.name} ${version} Java API"
+                 doctitle="${ant.project.name} ${version} Java API"
+                 bottom="${copyright}"
+                 overview="${core-src.dir}/overview.html">
+            <classpath refid="build-path" />
+        </javadoc>
     </target>
-    
-    <!-- Tomcat Management -->
-    <target name="start" description="Start a deployed webapp using Tomcat manager">
-        <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+
+    <!-- Removes previously compiled files -->
+    <target name="clean-compile">
+        <delete dir="${build.dir}" />
+        <delete dir="${dist.dir}" />
     </target>
 
-    <target name="stop" description="Stop a deployed webapp using Tomcat manager">
-        <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+    <!-- Removes all build generated content -->
+    <target name="clean" depends="clean-compile" description="Removes any artifact produced by the build process.">
+        <delete dir="${javadoc.dir}" />
+        <delete dir="${reports.dir}" />
+        <delete dir="${dist.dir}" />
     </target>
 
-    <target name="deploy" description="Upload and deploy using Tomcat manager">
-        <tomcatDeploy url="${url}" username="${username}" password="${password}" path="/${distname}"
-               war="file:${basedir}/${dist}/${distname}.war"/>
+    <!-- Create JAR file -->
+    <target name="package" depends="compile-core" description="Creates the project library jar file.">
+        <mkdir dir="${dist.dir}" />
+
+        <jar destfile="${dist.dir}/${jar.name}" whenempty="fail">
+            <fileset dir="${classpathres.dir}" />
+            <zipfileset dir="${metainf.dir}" prefix="META-INF/" />
+            <zipfileset dir="${core-classes.dir}" />
+        </jar>
+
     </target>
 
-    <target name="undeploy" description="Undeploy using Tomcat manager">
-        <tomcatUndeploy url="${url}" username="${username}" password="${password}" path="/${distname}"/>
+    <target name="install" description="Installs the identity provider software.">
+        <input message="Is this a new installation? Answering yes will overwrite your current configuration. [yes|no]"
+               addproperty="new.install"
+               defaultvalue="no" />
+
+        <if>
+            <equals arg1="${new.install}" arg2="yes" />
+            <then>
+                <input message="Where should the Shibboleth Identity Provider software be installed? [default: ${idp.home}]"
+                       addproperty="idp.home.input"
+                       defaultvalue="${idp.home}" />
+                <var name="idp.home" value="${idp.home.input}" />
+
+                <input message="What is the hostname of the Shibboleth Identity Provider server? [default: ${idp.hostname}]"
+                       addproperty="idp.hostname.input"
+                       defaultvalue="${idp.hostname}" />
+                <var name="idp.hostname" value="${idp.hostname.input}" />
+                
+                <input message="A keystore is about to be generated for you. Please enter a password that will be used to protect it."
+                       addproperty="idp.keystore.pass" />
+
+                <propertyfile file="install.properties">
+                    <entry key="idp.home" value="${idp.home.input}" />
+                    <entry key="idp.hostname" value="${idp.hostname.input}" />
+                </propertyfile>
+
+                <mkdir dir="${idp.home}" />
+                <mkdir dir="${idp.home}/bin" />
+                <mkdir dir="${idp.home}/conf" />
+                <mkdir dir="${idp.home}/credentials" />
+                <mkdir dir="${idp.home}/lib" />
+                <mkdir dir="${idp.home}/lib/endorsed" />
+                <mkdir dir="${idp.home}/logs" />
+                <mkdir dir="${idp.home}/metadata" />
+                <mkdir dir="${idp.home}/war" />
+
+                <var name="idp.entity.id" value="https://${idp.hostname}/idp/shibboleth" />
+
+                <regexSplit input="${idp.hostname}" regex="^.*\.(.*\..*$)" addproperty="idp.scope" />
+
+                <echo message="Generating signing and encryption key, certificate, and keystore. " />
+                <selfSignedCert hostname="${idp.hostname}"
+                                privateKeyFile="${idp.home}/credentials/idp.key"
+                                certificateFile="${idp.home}/credentials/idp.crt"
+                                keystoreFile="${idp.home}/credentials/idp.jks"
+                                keystorePassword="${idp.keystore.pass}"
+                                uriSubjectAltNames="${idp.entity.id}"/>
+
+                <copy todir="${idp.home}/bin" preservelastmodified="true">
+                    <fileset dir="${tools.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_HOME" value="${idp.home}" />
+                        <filter token="IDP_VERSION" value="${version}" />
+                    </filterset>
+                </copy>
+                <chmod file="${idp.home}/bin/*.sh" perm="+x" />
+
+                <copy todir="${idp.home}/conf" preservelastmodified="true" overwrite="true">
+                    <fileset dir="${conf.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_HOME" value="${idp.home}" />
+                        <filter token="IDP_VERSION" value="${version}" />
+                        <filter token="IDP_ENTITY_ID" value="${idp.entity.id}" />
+                        <filter token="IDP_SCOPE" value="${idp.scope}" />
+                        <filter token="IDP_CERTIFICATE" value="${idp.cert}" />
+                        <filter token="IDP_HOSTNAME" value="${idp.hostname}" />
+                    </filterset>
+                </copy>
+
+                <stringFromFile input="${idp.home}/credentials/idp.crt" addProperty="idp.cert" />
+                <regexSplit input="${idp.cert}"
+                            regex="\A.*-----\s((?:.*\s)*)-----END.*\Z"
+                            addproperty="idp.metadata.cert" />
+                <copy todir="${idp.home}/metadata" preservelastmodified="true" overwrite="true">
+                    <fileset dir="${metadata.dir}" />
+                    <filterset begintoken="$" endtoken="$">
+                        <filter token="IDP_ENTITY_ID" value="${idp.entity.id}" />
+                        <filter token="IDP_SCOPE" value="${idp.scope}" />
+                        <filter token="IDP_CERTIFICATE" value="${idp.metadata.cert}" />
+                        <filter token="IDP_HOSTNAME" value="${idp.hostname}" />
+                    </filterset>
+                </copy>
+            </then>
+        </if>
+
+        <copy todir="${idp.home}/lib" preservelastmodified="true">
+            <fileset dir="${lib.dir}" />
+            <fileset file="${dist.dir}/${jar.name}" />
+            <fileset file="${build-lib.dir}/servlet-2.4.jar" />
+        </copy>
+            
+        <copy todir="${idp.home}/lib/endorsed" preservelastmodified="true" failonerror="false">
+            <fileset dir="endorsed" />
+        </copy>
+
+        <copy todir="${webinf-temp.dir}">
+            <fileset dir="${webinf.dir}" />
+            <filterset begintoken="$" endtoken="$">
+                <filter token="IDP_HOME" value="${idp.home}" />
+                <filter token="IDP_VERSION" value="${version}" />
+            </filterset>
+        </copy>
+
+        <jar destfile="${idp.home}/war/${war.name}" whenempty="fail">
+            <zipfileset dir="${webinf-temp.dir}" prefix="WEB-INF/" />
+            <zipfileset dir="${webpages.dir}" prefix="" />
+            <zipfileset dir="${lib.dir}" prefix="WEB-INF/lib/" />
+            <zipfileset file="${dist.dir}/${jar.name}" prefix="WEB-INF/lib/" />
+        </jar>
     </target>
-    
-    <!-- Automated key generation -->
-       <target name="genSecret" depends="compile">
-       <taskdef name="genSecret" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
-               <genSecret keyStorePath="${appconfig}/handle.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
-       </target>
-
-    <target name="genSalt" depends="compile">
-        <taskdef name="genSalt" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
-        <genSalt keyStorePath="${appconfig}/persistent.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
+
+    <!-- **************************************************************** -->
+    <!-- ***                                                          *** -->
+    <!-- ***                     Developer Tasks                      *** -->
+    <!-- ***                                                          *** -->
+    <!-- **************************************************************** -->
+
+    <!-- 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>
+
 </project>