Add descriptions, remove test from IdP-SP build (until test source fixed)
[java-idp.git] / build.xml
1 <!-- Main build configutaion for Shibboleth java components - Walter Hoehn 06/04/2002 -->
2
3 <project name="Shibboleth" default="dist-IdP" basedir=".">
4
5     <!-- Set global properties for this build -->
6     <property name="distname" value="shibboleth" />
7     <property name="root" value="." />
8     <property name="src" value="${root}/src/" />
9     <property name="tests" value="${root}/tests/" />
10     <property name="approot" value="${root}/webApplication/" />
11     <property name="appconfig" value="${src}/conf/" />
12     <property name="configroot" value="${root}/webAppConfig/" />
13     <property name="build" value="${approot}/WEB-INF/classes/" />
14     <property name="libdir" value="${approot}/WEB-INF/lib/" />
15     <property name="buildlibs" value="${root}/lib/" />
16     <property name="endorsed" value="${root}/endorsed/" />
17     <property name="distlibs" value="${root}/lib/" />
18     <property name="dist" value="${root}/dist/" />
19     <property name="docs" value="${root}/doc/" />
20     <property name="javadocs" value="${docs}/api/" />
21
22     <property name="year" value="2002-2005"/>
23     <property name="copyright" value="Copyright &#169; ${year} UCAID. All Rights Reserved."/>
24
25         <!-- Configure properties to find Tomcat and access the Manager application -->
26         <property name="tomcat.home" value="/usr/local/tomcat"/>
27         <property name="url" value="http://localhost:8080/manager"/>
28         <property name="username" value="manager"/>
29         <property name="password" value="password"/>
30
31         <!-- Uncomment this for Tomcat Tasks
32         <path id="tomcat.classpath">
33         <fileset dir="${tomcat.home}/server/lib" includes="catalina-ant.jar"/>
34         </path>
35
36         <taskdef name="tomcatStart" classname="org.apache.catalina.ant.StartTask" classpathref="tomcat.classpath"/>
37         <taskdef name="tomcatStop" classname="org.apache.catalina.ant.StopTask" classpathref="tomcat.classpath"/>
38         <taskdef name="tomcatDeploy" classname="org.apache.catalina.ant.DeployTask" classpathref="tomcat.classpath"/>
39         <taskdef name="tomcatUndeploy" classname="org.apache.catalina.ant.UndeployTask" classpathref="tomcat.classpath"/>
40         -->
41         
42     <!-- Construct the CLASSPATH -->
43     <path id="build.path">
44         <pathelement path="${classpath}" />
45         <pathelement location="${build}" />
46         <fileset dir="${libdir}">
47             <include name="**/*.jar" />
48         </fileset>
49         <fileset dir="${buildlibs}">
50             <include name="**/*.jar" />
51         </fileset>
52     </path>
53
54
55     <!-- Prepare directory structure for project build-->
56     <target name="init">
57     <mkdir dir="${build}" />
58     <mkdir dir="${dist}" />
59     </target>
60
61
62     <!-- This target should be run before checking code into the repository -->
63     <target name="pre-checkin" depends="compile, test-all, clean-all" />
64
65
66     <!-- Compile classes and move them to ${build} -->
67     <target name="compile" depends="init"
68         description="Compile source file, combine with schemas and conf directories">
69         <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on">
70             <classpath refid="build.path" />
71         </javac>
72         <copy todir="${build}/schemas">
73             <fileset dir="${src}/schemas"/>
74         </copy>
75         <copy todir="${build}/conf">
76             <fileset dir="${src}/conf"/>
77         </copy>
78     </target>
79     
80     <target name="compile-tests" depends="compile">
81         <javac srcdir="${tests}" destdir="${build}" includes="**/*.java" debug="on">
82             <classpath refid="build.path" />
83         </javac>
84     </target>
85
86
87         <!-- Generate API docs -->
88         <target name="javadocs">
89                 <mkdir dir="${docs}" />
90                 <mkdir dir="${javadocs}" />
91                 <javadoc packagenames='edu.internet2.middleware.*'
92                         sourcepath='${src}' destdir='${javadocs}'
93                         author='true' version='true'
94                         windowtitle='Shibboleth Java API' doctitle='Shibboleth Java API'
95                         bottom='${copyright}'>
96                 <classpath refid="build.path" />
97         </javadoc>
98         </target>
99
100     <!-- Create various product distributions and move them to ${dist} -->
101
102     <target name="dist-all" depends="compile, test-all, package-all, clean-build" />
103         
104     <target name="package-all">
105         <war warfile="${dist}/${distname}.war" webxml="${configroot}/all.xml" basedir="${approot}" update="no" />
106     </target>
107
108     <target name="dist-IdP" depends="compile, test-IdP, package-IdP, clean-build" />
109     <target name="package-IdP">
110         <war warfile="${dist}/${distname}.war" webxml="${configroot}/origin.xml" basedir="${approot}" update="no" />
111     </target>
112         
113     <target name="dist-IdP-SP" depends="compile, package-IdP-SP, clean-build" 
114         description="Build application from source, create shibboleth.war file for IdP and SP"/>
115     <target name="package-IdP-SP" depends="compile"
116         description="Create shibboleth.war file from build output and IdP-SP deployment descriptor">
117         <war warfile="${dist}/${distname}.war" webxml="${configroot}/IdP-SP.xml" basedir="${approot}" update="no" />
118     </target>
119
120     <target name="dist-wayf" depends="compile, package-wayf, clean-build" />
121     <target name="package-wayf">
122         <war warfile="${dist}/${distname}-wayf.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
123     </target>
124
125     <!-- Build utilities -->
126     <target name="build-util" depends="compile">
127         <jar jarfile="${distlibs}/shib-util.jar" basedir="${build}" />
128     </target>
129
130     
131     <!-- Cleanup after the build, test, and distribution processes -->
132     <target name="clean" depends="clean-all" />
133     <target name="clean-all" depends="clean-build, clean-dist, clean-test, clean-javadocs, clean-util" />
134     <target name="clean-build">
135         <delete dir="${build}" />
136     </target>
137     <target name="clean-test">
138         <delete>
139             <fileset dir="${root}">
140                 <include name="**/TEST*.txt" />
141             </fileset>
142         </delete>
143     </target>
144     <target name="clean-dist">
145         <delete dir="${dist}" />
146     </target>
147         <target name="clean-javadocs">
148                 <delete dir="${javadocs}" />
149         </target>
150     <target name="clean-util">
151         <delete>
152             <fileset dir="${buildlibs}">
153                 <include name="shib-util.jar" />
154             </fileset>
155         </delete>
156     </target>
157
158     <!-- Run automated tests on compiled code -->
159     <target name="test-all" depends="test-IdP" />
160     <target name="test-IdP" depends="compile-tests">
161         <junit printsummary="no" fork="yes" haltonfailure="yes" haltonerror="yes" dir="${root}">
162                         <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
163             <classpath refid="build.path" />
164             <formatter type="plain" />
165             <test name="edu.internet2.middleware.shibboleth.aa.arp.ArpTests" />
166                         <test name="edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverTests" />
167         </junit>
168     </target>
169     
170     <!-- Tomcat Management -->
171     <target name="start" description="Start a deployed webapp using Tomcat manager">
172         <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
173     </target>
174
175     <target name="stop" description="Stop a deployed webapp using Tomcat manager">
176         <tomcatStop url="${url}" username="${username}" password="${password}" path="/${distname}"/>
177     </target>
178
179     <target name="deploy" description="Upload and deploy using Tomcat manager">
180         <tomcatDeploy url="${url}" username="${username}" password="${password}" path="/${distname}"
181                 war="file:${basedir}/${dist}/${distname}.war"/>
182     </target>
183
184     <target name="undeploy" description="Undeploy using Tomcat manager">
185         <tomcatUndeploy url="${url}" username="${username}" password="${password}" path="/${distname}"/>
186     </target>
187         
188         <target name="distcopy" description="Copy shibboleth.war to {tomcat.home}/webapps (Tomcat must be stopped first)">
189                 <!-- Deploy war file by copy and delete. Tomcat must not be
190                      running when this occurs. --> 
191                 <copy file="${dist}/${distname}.war" 
192                         tofile="${tomcat.home}/webapps/${distname}.war" 
193                 />
194                 <delete dir="${tomcat.home}/webapps/${distname}" quiet="yes" />
195         </target>
196         
197     
198     <!-- Automated key generation -->
199         <target name="genSecret" depends="compile">
200         <taskdef name="genSecret" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
201                 <genSecret keyStorePath="${appconfig}/handle.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
202         </target>
203
204     <target name="genSalt" depends="compile">
205         <taskdef name="genSalt" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
206         <genSalt keyStorePath="${appconfig}/persistent.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
207     </target>
208 </project>