22391ab7c79a1a934ebbad607be9f62a52d24251
[java-idp.git] / custom / extension-build.xml
1 <!-- 
2   This file is imported in to the main Shibboleth build.xml file and 
3   contains all targets used for building IdP and SP extensions.
4   
5   Chad La Joie
6   July 6, 2005
7 -->
8 <project name="Shibboleth-Extensions" default="build-exts" basedir=".">
9
10     <!-- Builds the extensions; loops through all the extension directories and builds them -->
11     <target name="build-exts" description="Compiles IdP and/or SP extensions">
12         <for keepgoing="true" param="module-path">
13             <dirset dir="${exts.dir}">
14                 <include name="*" />
15                 <exclude name="lib" />
16                 <exclude name="web" />
17             </dirset>
18             <sequential>
19                 <antcall target="ext-build">
20                     <param name="ext.root" value="@{module-path}" />
21                 </antcall>
22             </sequential>
23         </for>
24     </target>
25
26     <!-- Builds a single extension, called multiple times by build-exts -->
27     <target name="ext-build" depends="ext-build-init" description="Builds the extension">
28         <echo message="--- Starting to build module ${ext.name} in ${ext.root}" />
29
30         <!-- Compile the source -->
31         <antcall target="ext-compile" />
32
33         <!-- Copy over non-source files -->
34         <antcall target="ext-copy-etc" />
35
36         <!-- Generate the java docs if we're supposed to -->
37         <antcall target="ext-gen-docs" />
38
39         <!-- Run unit tests if we're supposed to -->
40         <antcall target="ext-test" />
41
42         <!-- Package everything up -->
43         <antcall target="ext-package" />
44
45         <!-- Put the libraries where the IdP and SP packaging can pick them up -->
46         <antcall target="ext-copy-libs"/>
47
48         <!-- Put the webpages where the IdP and SP packaging can pick them up -->
49         <antcall target="ext-copy-webpages"/>
50         
51         <echo message="--- Extension ${ext.name} built" />
52     </target>
53
54     <!-- Initialize everything we need. -->
55     <!-- The properties loaded here are scoped to this particular extension build -->
56         <target name="ext-build-init" description="Sets up everything to prepare for the build">
57                 <echo message="Loading build property files" />
58                 <!-- 
59                 Load extension specific properties if available. We can not set the extension's build.properties 
60                 file name in the extension-build.properties file because if we read that file first the extension 
61                 build properties won't be able to override properties in it as properties are immutable once set.
62                 -->
63                 <if>
64                         <not>
65                                 <available file="${ext.root}/build.properties"/>
66                         </not>
67                         <then>
68                                 <fail message="No build.properties file found for extension in ${ext.root}; this file is required."/>
69                         </then>
70                 </if>
71                 <property file="${ext.root}/build.properties" />
72
73                 <!-- Load default properties -->
74                 <echo message="Loading build property defaults ${exts.dir}/default-build.properties" />
75                 <property file="${exts.dir}/extension-build.properties" />
76
77             <fail unless="ext.name" message="The extension ${ext.root} does not contain the required (ext.name) property in its build.properties file."/>
78
79                 <!-- Create needed directories -->
80                 <mkdir dir="${ext.dist}" />
81                 <mkdir dir="${ext.classes}" />
82         </target>
83
84     <!-- Compiles the extension -->
85     <target name="ext-compile" description="Compiles an extension">
86         <!-- Compile any source that might be out there -->
87         <if>
88             <available file="${ext.src}" />
89             <then>
90                 <echo message="Compiling extension source" />
91                 <javac srcdir="${ext.src}" destdir="${ext.classes}" includes="**/*.java" debug="on" source="1.4">
92                     <!-- Shibboleth Libraries -->
93                     <classpath refid="build.path" />
94
95                     <!-- Shibboleth Classes -->
96                     <classpath>
97                         <pathelement location="${build}"/>
98                     </classpath>
99                     
100                     <!-- Extension libraries -->
101                     <classpath>
102                         <fileset dir="${ext.lib}">
103                             <include name="**/*.jar" />
104                         </fileset>
105                     </classpath>
106                 </javac>
107             </then>
108         </if>
109     </target>
110
111     <!-- Copies files from etc directory to dist directory to be bundled with extension jar -->
112     <target name="ext-copy-etc" depends="ext-build-init" description="Copys non-source files to place where they will be added to jar">
113         <!-- Copy any extra stuff that needs to be on the classpath -->
114         <if>
115             <available file="${ext.etc}" />
116             <then>
117                 <echo message="Detected files in the extensions 'etc' directory, ensuring they are bundled with the extension's jar." />
118                 <copy todir="${ext.classes}">
119                     <fileset dir="${ext.etc}">
120                         <include name="**" />
121                     </fileset>
122                 </copy>
123             </then>
124         </if>
125     </target>
126     
127     <!-- Move third party libraries to be picked up by the war -->
128     <target name="ext-copy-libs" depends="ext-compile" description="Moves third party libraries to be picked up by the war">
129         <if>
130             <available file="${ext.lib}" />
131             <then>
132                 <copy todir="${exts.dir}/lib">
133                     <fileset dir="${ext.lib}" includes="*.jar" />
134                     <fileset dir="${ext.dist}" includes="*.jar" />
135                 </copy>
136             </then>
137         </if>
138     </target>
139
140     <!-- Move web resources to be picked up by the war -->
141     <target name="ext-copy-webpages" depends="ext-compile" description="Moves web resources to be picked up by the war">
142         <if>
143             <available file="${ext.webpages}" />
144             <then>
145                 <copy todir="${exts.dir}/web">
146                     <fileset dir="${ext.webpages}"/>    
147                 </copy>
148             </then>
149         </if>
150     </target>
151
152     
153     <!-- Run any unit tests for the extension -->
154     <target name="ext-test" depends="ext-compile" description="Runs extension unit test">
155         <if>
156             <equals arg1="${test.ext}" arg2="true" />
157             <then>
158                 <if>
159                     <available file="${ext.test.src}" />
160                     <then>
161                         <echo message="Running tests cases for extension ${ext.name}" />
162                         <junit printsummary="no" fork="yes" haltonerror="true" haltonfailure="true" jvm="${ext.root}">
163                             <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
164                             <formatter type="plain" />
165                             <batchtest>
166                                 <fileset dir="${ext.test.src}" />
167                             </batchtest>
168                         </junit>
169                     </then>
170                 </if>
171             </then>
172         </if>
173
174     </target>
175
176     <!-- Generates the Javadocs for the extension -->
177     <target name="ext-gen-docs" description="Generates Javadocs for extension">
178         <if>
179             <equals arg1="${gen.ext.docs}" arg2="true" />
180             <then>
181                 <if>
182                     <available file="${ext.src}" />
183                     <then>
184                         <echo message="Generating javadocs for extension ${ext.name}" />
185                         <javadoc sourcepath="${ext.src}" 
186                                  destdir="${ext.docs}" 
187                                  packagenames="*"
188                                  author="true"
189                                  version="true"
190                                  windowtitle="${ext.name} Shibboleth Extension Java API"
191                                  doctitle="${ext.name} Shibboleth Extension Java API"
192                                  failonerror="false">
193                             <classpath refid="build.path" />
194                         </javadoc>
195                     </then>
196                 </if>
197             </then>
198         </if>
199     </target>
200
201     <!-- Jars up the extension -->
202     <target name="ext-package" depends="ext-compile" description="Packages up the extension">
203         <jar jarfile="${ext.dist}/${ext.name}.jar" basedir="${ext.classes}" excludes="${ext.name}.jar" />
204     </target>
205
206     <!-- Cleans up build generated resources -->
207     <target name="ext-clean" description="Cleans up any build created resources">
208         <!-- Clean up all the modules -->
209         <for keepgoing="true" param="module-path">
210             <dirset dir="${exts.dir}">
211                 <include name="*" />
212                 <exclude name="lib" />
213                 <exclude name="web" />
214             </dirset>
215             <sequential>
216                 <delete dir="@{module-path}/dist" failonerror="false"/>
217             </sequential>
218         </for>
219     </target>
220
221 </project>