Initial code for building custom extensions
[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="standard-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="standard-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="compile-ext" />
32
33         <!-- Generate the java docs if we're supposed to -->
34         <antcall target="gen-ext-docs" />
35
36         <!-- Run unit tests if we're supposed to -->
37         <antcall target="test-ext" />
38
39         <!-- Package everything up -->
40         <echo message="Packaging extension" />
41         <antcall target="package-ext" />
42
43         <!-- Put the libraries where the IdP and SP packaging can pick them up -->
44         <copy todir="${exts.dir}/lib">
45             <fileset dir="${ext.lib}" includes="*.jar" />
46             <fileset dir="${ext.dist}" includes="*.jar" />
47         </copy>
48
49         <!-- Put the webpages where the IdP and SP packaging can pick them up -->
50         <copy todir="${exts.dir}/web">
51             <fileset dir="${ext.web}" includes="*" />
52         </copy>
53         <echo message="--- Extension ${ext.name} built" />
54     </target>
55
56     <!-- Initialize everything we need. -->
57     <!-- The properties loaded here are scoped to this particular extension build -->
58     <target name="ext-build-init" description="Sets up everything to prepare for the build">
59         <echo message="Loading build property files" />
60         <!-- 
61           Load extension specific properties if available. We can not set the extension's build.properties 
62           file name in the extension-build.properties file because if we read that file first the extension 
63           build properties won't be able to override properties in it as properties are immutable once set.
64         -->
65         <property file="${ext.root}/build.properties" />
66
67         <!-- Load default properties -->
68         <echo message="Loading build property defaults ${exts-dir}/default-build.properties" />
69         <property file="${exts.dir}/extension-build.properties" />
70
71         <!-- Create needed directories -->
72         <mkdir dir="${ext.dist}" />
73         <mkdir dir="${ext.classes}" />
74     </target>
75
76     <!-- Compiles the extension -->
77     <target name="compile-ext" depends="ext-build-init" description="Compiles an extension">
78         <echo message="Compiling extension source" />
79         <javac srcdir="${ext.src}" destdir="${ext.classes}" includes="**/*.java" debug="on" source="1.4">
80             <!-- Shibboleth Classpath -->
81             <classpath refid="build.path" />
82
83             <!-- Extension libraries -->
84             <classpath>
85                 <fileset dir="${ext.lib}">
86                     <include name="**/*.jar" />
87                 </fileset>
88             </classpath>
89         </javac>
90
91         <!-- Copy any extra stuff that needs to be on the classpath -->
92         <if>
93             <available file="${ext.etc}" />
94             <then>
95                 <echo message="Detected files in the extensions 'etc' directory, ensuring they are bundled with the extension's jar." />
96                 <copy todir="${ext.classes}">
97                     <fileset dir="${ext.etc}">
98                         <include name="**" />
99                     </fileset>
100                 </copy>
101             </then>
102         </if>
103     </target>
104
105     <!-- Run any unit tests for the extension -->
106     <target name="test-ext" depends="compile-ext" description="Runs extension unit test">
107         <if>
108             <equals arg1="${test.ext}" arg2="true" />
109             <then>
110                 <if>
111                     <available file="${ext.test.src}" />
112                     <then>
113                         <echo message="Running tests cases for extension ${ext.name}" />
114                         <junit printsummary="no" fork="yes" haltonerror="true" haltonfailure="true" jvm="${ext.root}">
115                             <jvmarg value="-Djava.endorsed.dirs=${endorsed}" />
116                             <formatter type="plain" />
117                             <batchtest>
118                                 <fileset dir="${ext.test.src}" />
119                             </batchtest>
120                         </junit>
121                     </then>
122                 </if>
123             </then>
124         </if>
125
126     </target>
127
128     <!-- Generates the Javadocs for the extension -->
129     <target name="gen-ext-docs" description="Generates Javadocs for extension">
130         <if>
131             <equals arg1="${gen.ext.docs}" arg2="true" />
132             <then>
133                 <echo message="Generating javadocs for extension ${ext.name}" />
134                 <javadoc sourcepath="${ext.src}" destdir="${ext.docs}" />
135             </then>
136         </if>
137     </target>
138
139     <!-- Jars up the extension -->
140     <target name="package-ext" depends="compile-ext" description="Packages up the extension">
141         <jar jarfile="${ext.dist}/${ext.name}.jar" basedir="${ext.dist}" excludes="${ext.name}.jar" />
142     </target>
143
144     <!-- Cleans up build generated resources -->
145     <target name="clean-ext" description="Cleans up any build created resources">
146         <!-- Clean up all the modules -->
147         <for keepgoing="true" param="module-path">
148             <dirset dir="${exts.dir}">
149                 <include name="*" />
150                 <exclude name="lib" />
151                 <exclude name="web" />
152             </dirset>
153             <sequential>
154                 <delete dir="${ext.dist}" />
155             </sequential>
156         </for>
157
158         <!-- Clean out all the staged libraries from the modules -->
159         <delete dir="${exts.dir}/lib" includeemptydirs="true">
160             <fileset dir="${exts.dir}/lib" includes="**/*" />
161         </delete>
162
163         <!-- Clean out all the staged web pages from the modules -->
164         <delete dir="${exts.dir}/web" includeemptydirs="true">
165             <fileset dir="${exts.dir}/web" includes="**/*" />
166         </delete>
167     </target>
168
169 </project>