Make extension script a little more friendly. It will fail and print an error when...
[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                 <if>
78                         <not>
79                                 <isset property="ext.name" />
80                         </not>
81                         <then>
82                                 <fail message="The extension ${ext.root} does not contain the required (ext.name) property in its build.properties file."/>
83                         </then>
84                 </if>
85
86                 <!-- Create needed directories -->
87                 <mkdir dir="${ext.dist}" />
88                 <mkdir dir="${ext.classes}" />
89         </target>
90
91     <!-- Compiles the extension -->
92     <target name="ext-compile" description="Compiles an extension">
93         <!-- Compile any source that might be out there -->
94         <if>
95             <available file="${ext.src}" />
96             <then>
97                 <echo message="Compiling extension source" />
98                 <javac srcdir="${ext.src}" destdir="${ext.classes}" includes="**/*.java" debug="on" source="1.4">
99                     <!-- Shibboleth Libraries -->
100                     <classpath refid="build.path" />
101
102                     <!-- Shibboleth Classes -->
103                     <classpath>
104                         <pathelement location="${build}"/>
105                     </classpath>
106                     
107                     <!-- Extension libraries -->
108                     <classpath>
109                         <fileset dir="${ext.lib}">
110                             <include name="**/*.jar" />
111                         </fileset>
112                     </classpath>
113                 </javac>
114             </then>
115         </if>
116     </target>
117
118     <!-- Copies files from etc directory to dist directory to be bundled with extension jar -->
119     <target name="ext-copy-etc" depends="ext-build-init" description="Copys non-source files to place where they will be added to jar">
120         <!-- Copy any extra stuff that needs to be on the classpath -->
121         <if>
122             <available file="${ext.etc}" />
123             <then>
124                 <echo message="Detected files in the extensions 'etc' directory, ensuring they are bundled with the extension's jar." />
125                 <copy todir="${ext.classes}">
126                     <fileset dir="${ext.etc}">
127                         <include name="**" />
128                     </fileset>
129                 </copy>
130             </then>
131         </if>
132     </target>
133     
134     <!-- Move third party libraries to be picked up by the war -->
135     <target name="ext-copy-libs" depends="ext-compile" description="Moves third party libraries to be picked up by the war">
136         <if>
137             <available file="${ext.lib}" />
138             <then>
139                 <copy todir="${exts.dir}/lib">
140                     <fileset dir="${ext.lib}" includes="*.jar" />
141                     <fileset dir="${ext.dist}" includes="*.jar" />
142                 </copy>
143             </then>
144         </if>
145     </target>
146
147     <!-- Move web resources to be picked up by the war -->
148     <target name="ext-copy-webpages" depends="ext-compile" description="Moves web resources to be picked up by the war">
149         <if>
150             <available file="${ext.webpages}" />
151             <then>
152                 <copy todir="${exts.dir}/web">
153                     <fileset dir="${ext.webpages}"/>    
154                 </copy>
155             </then>
156         </if>
157     </target>
158
159     
160     <!-- Run any unit tests for the extension -->
161     <target name="ext-test" depends="ext-compile" description="Runs extension unit test">
162         <if>
163             <equals arg1="${test.ext}" arg2="true" />
164             <then>
165                 <if>
166                     <available file="${ext.test.src}" />
167                     <then>
168                         <echo message="Running tests cases for extension ${ext.name}" />
169                         <junit printsummary="no" fork="yes" haltonerror="true" haltonfailure="true" jvm="${ext.root}">
170                             <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
171                             <formatter type="plain" />
172                             <batchtest>
173                                 <fileset dir="${ext.test.src}" />
174                             </batchtest>
175                         </junit>
176                     </then>
177                 </if>
178             </then>
179         </if>
180
181     </target>
182
183     <!-- Generates the Javadocs for the extension -->
184     <target name="ext-gen-docs" description="Generates Javadocs for extension">
185         <if>
186             <equals arg1="${gen.ext.docs}" arg2="true" />
187             <then>
188                 <if>
189                     <available file="${ext.src}" />
190                     <then>
191                         <echo message="Generating javadocs for extension ${ext.name}" />
192                         <javadoc sourcepath="${ext.src}" 
193                                  destdir="${ext.docs}" 
194                                  packagenames="*"
195                                  author="true"
196                                  version="true"
197                                  windowtitle="${ext.name} Shibboleth Extension Java API"
198                                  doctitle="${ext.name} Shibboleth Extension Java API"
199                                  failonerror="false">
200                             <classpath refid="build.path" />
201                         </javadoc>
202                     </then>
203                 </if>
204             </then>
205         </if>
206     </target>
207
208     <!-- Jars up the extension -->
209     <target name="ext-package" depends="ext-compile" description="Packages up the extension">
210         <jar jarfile="${ext.dist}/${ext.name}.jar" basedir="${ext.classes}" excludes="${ext.name}.jar" />
211     </target>
212
213     <!-- Cleans up build generated resources -->
214     <target name="ext-clean" description="Cleans up any build created resources">
215         <!-- Clean up all the modules -->
216         <for keepgoing="true" param="module-path">
217             <dirset dir="${exts.dir}">
218                 <include name="*" />
219                 <exclude name="lib" />
220                 <exclude name="web" />
221             </dirset>
222             <sequential>
223                 <delete dir="${ext.dist}" />
224             </sequential>
225         </for>
226     </target>
227
228 </project>