Better display.
[java-idp.git] / build.xml
1 <!-- Main build configutaion for Shibboleth java components - Walter Hoehn 06/04/2002 -->
2
3 <project name="Shibboleth" default="install" 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     <!-- antcontrib tasks -->
26     <taskdef resource="net/sf/antcontrib/antcontrib.properties" classpath="${buildlibs}/ant-contrib.jar"/>
27         
28     <!-- Construct the CLASSPATH -->
29     <path id="build.path">
30         <pathelement path="${classpath}" />
31         <pathelement location="${build}" />
32         <fileset dir="${endorsed}">
33             <include name="**/*.jar" />
34         </fileset>
35         <fileset dir="${libdir}">
36             <include name="**/*.jar" />
37         </fileset>
38         <fileset dir="${buildlibs}">
39             <include name="**/*.jar" />
40         </fileset>
41     </path>
42
43
44     <!-- Prepare directory structure for project build-->
45     <target name="init">
46         <mkdir dir="${build}" />
47         <mkdir dir="${dist}" />
48         <var file="build.properties" />
49     </target>
50
51     <target name="install.init">
52         <taskdef name="xinput" classname="edu.internet2.middleware.shibboleth.utils.ant.XInput" classpath="${build}"/>
53         <typedef name="xoption" classname="edu.internet2.middleware.shibboleth.utils.ant.XInputOption" classpath="${build}"/>
54     </target>
55
56
57     <!-- This target should be run before checking code into the repository -->
58     <target name="pre-checkin" depends="compile, test-all, clean-all" />
59
60
61     <!-- Compile classes and move them to ${build} -->
62     <target name="compile" depends="init"
63         description="Compile source file, combine with schemas and conf directories">
64         <javac srcdir="${src}" destdir="${build}" includes="**/*.java" debug="on" 
65                 target="1.4" source="1.4">
66             <classpath refid="build.path" />
67         </javac>
68         <copy todir="${build}/schemas">
69             <fileset dir="${src}/schemas"/>
70         </copy>
71         <!-- configuration is now stored outside of shibboleth.war
72         <copy todir="${build}/conf">
73             <fileset dir="${src}/conf"/>
74         </copy>
75         -->
76     </target>
77     
78     <target name="compile-tests" depends="compile">
79         <javac srcdir="${tests}" destdir="${build}" includes="**/*.java" debug="on" target="1.4" source="1.4">
80             <classpath refid="build.path" />
81         </javac>
82     </target>
83
84
85         <!-- Generate API docs -->
86         <target name="javadocs">
87                 <mkdir dir="${docs}" />
88                 <mkdir dir="${javadocs}" />
89                 <javadoc packagenames='edu.internet2.middleware.*'
90                         sourcepath='${src}' destdir='${javadocs}'
91                         author='true' version='true'
92                         windowtitle='Shibboleth Java API' doctitle='Shibboleth Java API'
93                         bottom='${copyright}'>
94                 <classpath refid="build.path" />
95         </javadoc>
96         </target>
97
98     <!-- Create various product distributions and move them to ${dist} -->
99
100     <target name="dist-all" depends="compile, test-all, package-all, clean-build" />
101         
102     <target name="package-all">
103         <war warfile="${dist}/${distname}.war" webxml="${configroot}/all.xml" basedir="${approot}" update="no" />
104     </target>
105
106     <target name="dist-IdP-SP" depends="compile, package-IdP-SP, clean-build" 
107         description="Build application from source, create shibboleth.war file for IdP and SP"/>
108     <target name="package-IdP-SP" depends="compile"
109         description="Create shibboleth.war file from build output and IdP-SP deployment descriptor">
110         <war warfile="${dist}/${distname}.war" webxml="${configroot}/IdP-SP.xml" basedir="${approot}" update="no" />
111     </target>
112
113     <target name="dist-wayf" depends="compile, package-wayf, clean-build" />
114     <target name="package-wayf">
115         <war warfile="${dist}/${distname}-wayf.war" webxml="${configroot}/wayf.xml" basedir="${approot}" update="no" />
116     </target>
117
118     <!-- Build utilities -->
119     <target name="build-util" depends="compile">
120         <jar jarfile="${distlibs}/shib-util.jar" basedir="${build}" />
121     </target>
122
123     
124     <!-- Cleanup after the build, test, and distribution processes -->
125     <target name="clean" depends="clean-all" />
126     <target name="clean-all" depends="clean-build, clean-dist, clean-test, clean-javadocs, clean-util" />
127     <target name="clean-build">
128         <delete dir="${build}" />
129     </target>
130     <target name="clean-test">
131         <delete>
132             <fileset dir="${root}">
133                 <include name="**/TEST*.txt" />
134             </fileset>
135         </delete>
136     </target>
137     <target name="clean-dist">
138         <delete dir="${dist}" />
139     </target>
140         <target name="clean-javadocs">
141                 <delete dir="${javadocs}" />
142         </target>
143     <target name="clean-util">
144         <delete>
145             <fileset dir="${buildlibs}">
146                 <include name="shib-util.jar" />
147             </fileset>
148         </delete>
149     </target>
150
151     <!-- Run automated tests on compiled code -->
152     <target name="test-all" depends="test-IdP" />
153     <target name="test-IdP" depends="compile-tests">
154         <junit printsummary="no" fork="yes" haltonfailure="yes" haltonerror="yes" dir="${root}">
155                         <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
156             <classpath refid="build.path" />
157             <formatter type="plain" />
158             <test name="edu.internet2.middleware.shibboleth.aa.arp.ArpTests" />
159                         <test name="edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverTests" />
160         </junit>
161     </target>
162     
163     <!-- Tomcat Management -->
164     <target name="setupTomcatTasks">
165         <path id="tomcat.classpath">
166                     <fileset dir="${tomcat.home}/server/lib" includes="catalina-ant.jar"/>
167             </path>
168
169         <taskdef name="tomcatStart" classname="org.apache.catalina.ant.StartTask" classpathref="tomcat.classpath"/>
170         <taskdef name="tomcatStop" classname="org.apache.catalina.ant.StopTask" classpathref="tomcat.classpath"/>
171             <taskdef name="tomcatDeploy" classname="org.apache.catalina.ant.DeployTask" classpathref="tomcat.classpath"/>
172         <taskdef name="tomcatUndeploy" classname="org.apache.catalina.ant.UndeployTask" classpathref="tomcat.classpath"/>
173         </target>
174     
175     <target name="tomcat.start" depends="setupTomcatTasks" description="Start a deployed webapp using Tomcat manager">
176         <tomcatStart url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${distname}"/>
177     </target>
178
179     <target name="tomcat.stop" depends="setupTomcatTasks" description="Stop a deployed webapp using Tomcat manager">
180         <tomcatStop url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${distname}"/>
181     </target>
182
183     <target name="tomcat.deploy" depends="setupTomcatTasks" description="Upload and deploy using Tomcat manager">
184         <tomcatDeploy url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${distname}"
185                 war="file:${basedir}/${dist}/${distname}.war"/>
186     </target>
187
188     <target name="tomcat.undeploy" depends="setupTomcatTasks" description="Undeploy using Tomcat manager">
189         <tomcatUndeploy url="${tomcat.url}" username="${tomcat.username}" password="${tomcat.password}" path="/${distname}"/>
190     </target>
191         
192     
193     <!-- Automated key generation -->
194         <target name="genSecret" depends="compile">
195         <taskdef name="genSecret" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
196                 <genSecret keyStorePath="${appconfig}/handle.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
197         </target>
198
199     <target name="genSalt" depends="compile">
200         <taskdef name="genSalt" classname="edu.internet2.middleware.shibboleth.utils.HandleRepositorySecretGenerator" classpathref="build.path"/>
201         <genSalt keyStorePath="${appconfig}/persistent.jks" keyStorePassword="shibhs" keyStoreKeyAlias="handleKey" keyStoreKeyPassword="shibhs" />
202     </target>
203         
204         <target name="exampleCertificate">
205                 <genkey alias="tomcat" storepass="exampleorg"
206                         keystore="${tomcat.home}/conf/example.jks"
207                         keyalg="RSA" validity="365"
208                         dname="cn=shibboleth.example.org, o=example.org, c=US"
209                 />
210         </target>
211         
212         
213     <!-- Install Shibboleth -->
214     <target name="install" depends="init, install.init" description="Install Shibboleth">
215
216         <if>
217             <xinput type="confirm" defaultvalue="y">Do you want to install the Shibboleth Identity Provider?</xinput>
218             <then>
219                 <antcall target="install.idp" />
220             </then>
221         </if>
222     </target>
223
224         <target name="install.idp" depends="init, install.init">
225         <xinput message="Deploying java web application.  Do you want to install it directly onto the filesystem or use the tomcat manager application?" 
226             addproperty="idp.install-type" type="menu" casesensitive="no">
227             <xoption>filesystem</xoption>
228             <xoption>manager</xoption>
229         </xinput>
230         
231         <antcall target="install.idp.${idp.install-type}" />
232     </target>
233
234     <target name="install.idp.filesystem" depends="init, install.init">
235         
236         <input message="Enter Shibboleth install directory [default: ${shib.home}]"
237             addproperty="shib.home.input" defaultvalue="${shib.home}" />
238         <var name="shib.home" value="${shib.home.input}" />
239
240         <input message="Enter tomcat home directory [default: ${tomcat.home}]"
241             addproperty="tomcat.home.input" defaultvalue="${tomcat.home}" />
242         <var name="tomcat.home" value="${tomcat.home.input}" />
243         
244         <copy file="${configroot}/idp.xml.dist" tofile="${configroot}/idp.xml" overwrite="true" />
245         <replace file="${configroot}/idp.xml" token="$SHIB_HOME$" value="${shib.home}" />
246         <war warfile="${dist}/${distname}.war" webxml="${configroot}/idp.xml" basedir="${approot}" update="no" />
247         <copy file="${dist}/${distname}.war" tofile="${tomcat.home}/webapps/${distname}.war" />
248
249         <if>
250             <available file="${shib.home}" />
251             <then>
252                 <if>
253                     <xinput type="confirm">The directory `${shib.home}` already exists.  Do you want to overwrite the existing configuration?</xinput>
254                     <then>
255                         <delete dir="${shib.home}/etc" />
256                         <antcall target="install.idp.filesystem.config" />
257                     </then>
258                 </if>
259             </then>
260             <else>
261                 <antcall target="install.idp.filesystem.config" />
262             </else>
263         </if>
264
265         <antcall target="savePropertyFile" />
266     </target>
267
268         <target name="install.idp.filesystem.config" depends="init, install.init">
269         <mkdir dir="${shib.home}/etc" />
270         <copy todir="${shib.home}/etc" overwrite="true">
271             <fileset dir="${src}/conf" />
272         </copy>
273         <replace file="${shib.home}/etc/idp.xml" token="$SHIB_HOME$" value="${shib.home}" />
274     </target>
275
276         <target name="install.idp.manager" depends="init, install.init">
277         <antcall target="setupTomcatTasks" />
278         
279         <input message="Enter local tomcat directory [default: ${tomcat.home}]" addproperty="tomcat.home.input" defaultValue="${tomcat.home}" />
280         <var name="tomcat.home" value="${tomcat.home.input}" />
281         
282         <input message="Enter tomcat url [default: ${tomcat.url}]" addproperty="tomcat.url.input" defaultValue="${tomcat.url}" />
283         <var name="tomcat.url" value="${tomcat.url.input}" />
284         
285         <input message="Enter tomcat username [default: ${tomcat.username}]" addproperty="tomcat.username.input" defaultValue="${tomcat.username}" />
286         <var name="tomcat.username" value="${tomcat.username.input}" />
287         
288         <input message="Enter tomcat password [default: ${tomcat.password}]" addproperty="tomcat.password.input" defaultValue="${tomcat.password}" />
289         <var name="tomcat.password" value="${tomcat.password.input}" />
290         
291         <antcall target="tomcat.deploy" />
292         <antcall target="savePropertyFile" />
293     </target>
294
295     <target name="savePropertyFile">
296         <propertyfile file="build.properties">
297             <entry key="shib.home" value="${shib.home}" />
298             <entry key="tomcat.home" value="${tomcat.home}" />
299             <entry key="tomcat.url" value="${tomcat.url}" />
300             <entry key="tomcat.username" value="${tomcat.username}" />
301             <entry key="tomcat.password" value="${tomcat.password}" />
302         </propertyfile>
303     </target>
304     
305 </project>