1 package org
.argeo
.slc
.ant
;
4 import java
.io
.IOException
;
5 import java
.io
.InputStream
;
8 import java
.util
.Properties
;
9 import java
.util
.StringTokenizer
;
10 import java
.util
.Vector
;
12 import org
.apache
.commons
.io
.IOUtils
;
13 import org
.apache
.commons
.logging
.Log
;
14 import org
.apache
.commons
.logging
.LogFactory
;
15 import org
.apache
.log4j
.Appender
;
16 import org
.apache
.log4j
.LogManager
;
17 import org
.apache
.log4j
.MDC
;
18 import org
.apache
.tools
.ant
.BuildListener
;
19 import org
.apache
.tools
.ant
.Project
;
20 import org
.apache
.tools
.ant
.ProjectHelper
;
21 import org
.apache
.tools
.ant
.helper
.ProjectHelper2
;
22 import org
.apache
.tools
.ant
.listener
.CommonsLoggingListener
;
23 import org
.argeo
.slc
.core
.SlcException
;
24 import org
.argeo
.slc
.core
.process
.SlcExecution
;
25 import org
.argeo
.slc
.core
.structure
.SimpleSElement
;
26 import org
.argeo
.slc
.core
.structure
.StructureRegistry
;
27 import org
.argeo
.slc
.core
.structure
.tree
.TreeSPath
;
28 import org
.argeo
.slc
.core
.structure
.tree
.TreeSRegistry
;
29 import org
.argeo
.slc
.logging
.Log4jUtils
;
30 import org
.argeo
.slc
.runtime
.SlcExecutionOutput
;
31 import org
.springframework
.beans
.factory
.BeanFactoryUtils
;
32 import org
.springframework
.beans
.factory
.ListableBeanFactory
;
33 import org
.springframework
.beans
.factory
.config
.PropertyPlaceholderConfigurer
;
34 import org
.springframework
.beans
.factory
.xml
.XmlBeanDefinitionReader
;
35 import org
.springframework
.context
.ConfigurableApplicationContext
;
36 import org
.springframework
.context
.support
.GenericApplicationContext
;
37 import org
.springframework
.core
.io
.DefaultResourceLoader
;
38 import org
.springframework
.core
.io
.Resource
;
39 import org
.springframework
.core
.io
.ResourceLoader
;
40 import org
.springframework
.util
.SystemPropertyUtils
;
42 public class AntSlcApplication
{
43 private final static String DEFAULT_APP_LOG4J_PROPERTIES
= "org/argeo/slc/ant/defaultAppLog4j.properties";
45 private final static Log log
= LogFactory
.getLog(AntSlcApplication
.class);
47 private Resource contextLocation
;
48 private ConfigurableApplicationContext parentContext
;
50 private Resource rootDir
;
51 private Resource confDir
;
54 public void execute(SlcExecution slcExecution
, Properties properties
,
55 Map
<String
, Object
> references
,
56 SlcExecutionOutput
<AntExecutionContext
> executionOutput
) {
58 // Properties and application logging initialization
59 initSystemProperties(properties
);
60 Log4jUtils
.initLog4j("classpath:" + DEFAULT_APP_LOG4J_PROPERTIES
);
62 log
.info("\n###\n### Start SLC execution " + slcExecution
.getUuid()
64 if (log
.isDebugEnabled()) {
65 log
.debug("rootDir=" + rootDir
);
66 log
.debug("confDir=" + confDir
);
67 log
.debug("workDir=" + workDir
);
71 String scriptRelativePath
= findAntScript(slcExecution
);
72 List
<String
> targets
= findAntTargets(slcExecution
);
74 // Spring initialization
75 ConfigurableApplicationContext ctx
= createExecutionContext(slcExecution
);
77 // Ant project initialization
78 Project project
= new Project();
79 AntExecutionContext executionContext
= new AntExecutionContext(project
);
80 project
.addReference(AntConstants
.REF_ROOT_CONTEXT
, ctx
);
81 project
.addReference(AntConstants
.REF_SLC_EXECUTION
, slcExecution
);
84 initProject(project
, properties
, references
);
85 parseProject(project
, scriptRelativePath
);
88 initStructure(project
, scriptRelativePath
);
89 runProject(project
, targets
);
91 if (executionOutput
!= null)
92 executionOutput
.postExecution(executionContext
);
98 protected void initSystemProperties(Properties userProperties
) {
99 // Set user properties as system properties so that Spring can access
101 if (userProperties
!= null) {
102 for (Object key
: userProperties
.keySet()) {
103 System
.setProperty(key
.toString(), userProperties
104 .getProperty(key
.toString()));
108 if (System
.getProperty(AntConstants
.DEFAULT_TEST_RUN_PROPERTY
) == null) {
109 System
.setProperty(AntConstants
.DEFAULT_TEST_RUN_PROPERTY
,
115 setSystemPropertyForRes(AntConstants
.ROOT_DIR_PROPERTY
, rootDir
);
117 setSystemPropertyForRes(AntConstants
.CONF_DIR_PROPERTY
, confDir
);
119 System
.setProperty(AntConstants
.WORK_DIR_PROPERTY
, workDir
120 .getCanonicalPath());
122 // Additional properties in slc.properties file. Already set sytem
123 // properties (such as the various directories) can be resolved in
125 if (confDir
!= null) {
126 Resource slcPropertiesRes
= confDir
127 .createRelative("slc.properties");
128 if (slcPropertiesRes
.exists()) {
129 Properties slcProperties
= new Properties();
130 InputStream in
= slcPropertiesRes
.getInputStream();
132 slcProperties
.load(in
);
134 IOUtils
.closeQuietly(in
);
137 for (Object obj
: slcProperties
.keySet()) {
138 String key
= obj
.toString();
139 if (!System
.getProperties().containsKey(key
)) {
140 String value
= SystemPropertyUtils
141 .resolvePlaceholders(slcProperties
143 System
.setProperty(key
, value
);
148 } catch (Exception e
) {
149 throw new SlcException("Cannot init system properties.", e
);
154 * Set property as an absolute file path if the resource can be located on
155 * the file system, or as an url.
157 private void setSystemPropertyForRes(String key
, Resource res
)
161 value
= res
.getFile().getCanonicalPath();
162 } catch (IOException e
) {
163 value
= res
.getURL().toString();
165 System
.setProperty(key
, value
);
168 protected ConfigurableApplicationContext
createExecutionContext(
169 SlcExecution slcExecution
) {
172 // Find runtime definition
173 Resource runtimeRes
= null;
174 String runtimeStr
= slcExecution
.getAttributes().get(
175 AntConstants
.EXECATTR_RUNTIME
);
176 if (runtimeStr
== null)
177 runtimeStr
= System
.getProperty(AntConstants
.RUNTIME_PROPERTY
,
180 ResourceLoader rl
= new DefaultResourceLoader(getClass()
182 try {// tries absolute reference
183 runtimeRes
= rl
.getResource(runtimeStr
);
184 } catch (Exception e
) {
187 if (runtimeRes
== null || !runtimeRes
.exists()) {
189 runtimeRes
= confDir
.createRelative("runtime/" + runtimeStr
193 // Find runtime independent application context definition
194 if (confDir
!= null && contextLocation
== null) {
195 contextLocation
= confDir
196 .createRelative("applicationContext.xml");
199 GenericApplicationContext ctx
= new GenericApplicationContext(
201 ctx
.setDisplayName("SLC Execution #" + slcExecution
.getUuid());
203 XmlBeanDefinitionReader xmlReader
= new XmlBeanDefinitionReader(ctx
);
204 if (runtimeRes
!= null && runtimeRes
.exists())
205 xmlReader
.loadBeanDefinitions(runtimeRes
);
207 log
.warn("No runtime context defined");
209 if (contextLocation
!= null && contextLocation
.exists())
210 xmlReader
.loadBeanDefinitions(contextLocation
);
212 log
.warn("No runtime independent application context defined");
214 // Add property place holder
215 PropertyPlaceholderConfigurer ppc
= new PropertyPlaceholderConfigurer();
216 ppc
.setIgnoreUnresolvablePlaceholders(true);
217 ctx
.addBeanFactoryPostProcessor(ppc
);
221 } catch (Exception e
) {
222 throw new SlcException(
223 "Cannot create SLC execution application context.", e
);
227 protected String
findAntScript(SlcExecution slcExecution
) {
228 String scriptStr
= slcExecution
.getAttributes().get(
229 AntConstants
.EXECATTR_ANT_FILE
);
230 if (scriptStr
== null)
231 throw new SlcException("No Ant script provided");
236 protected List
<String
> findAntTargets(SlcExecution slcExecution
) {
237 String targetList
= slcExecution
.getAttributes().get(
238 AntConstants
.EXECATTR_ANT_TARGETS
);
239 List
<String
> targets
= new Vector
<String
>();
240 if (targetList
!= null) {
241 StringTokenizer stTargets
= new StringTokenizer(targetList
, ",");
242 while (stTargets
.hasMoreTokens()) {
243 targets
.add(stTargets
.nextToken());
249 protected void initProject(Project project
, Properties properties
,
250 Map
<String
, Object
> references
) {
251 if (properties
!= null) {
252 for (Map
.Entry
<Object
, Object
> entry
: properties
.entrySet()) {
253 project
.setUserProperty(entry
.getKey().toString(), entry
254 .getValue().toString());
258 if (references
!= null) {
259 for (Map
.Entry
<String
, Object
> entry
: references
.entrySet()) {
260 project
.addReference(entry
.getKey(), entry
.getValue());
264 project
.addBuildListener(new CommonsLoggingListener());
266 ListableBeanFactory context
= (ListableBeanFactory
) project
267 .getReference(AntConstants
.REF_ROOT_CONTEXT
);
268 // Register build listeners
269 Map
<String
, BuildListener
> listeners
= BeanFactoryUtils
270 .beansOfTypeIncludingAncestors(context
, BuildListener
.class,
272 for (BuildListener listener
: listeners
.values()) {
273 project
.addBuildListener(listener
);
276 // Register log4j appenders from context
277 MDC
.put(AntConstants
.MDC_ANT_PROJECT
, project
);
278 Map
<String
, Appender
> appenders
= context
.getBeansOfType(
279 Appender
.class, false, true);
280 for (Appender appender
: appenders
.values()) {
281 LogManager
.getRootLogger().addAppender(appender
);
285 addCustomTaskAndTypes(project
);
288 /** Loads the SLC specific Ant tasks. */
289 protected void addCustomTaskAndTypes(Project project
) {
290 Properties taskdefs
= getDefs(project
,
291 AntConstants
.SLC_TASKDEFS_RESOURCE_PATH
);
292 for (Object o
: taskdefs
.keySet()) {
293 String name
= o
.toString();
295 project
.addTaskDefinition(name
, Class
.forName(taskdefs
296 .getProperty(name
)));
297 } catch (ClassNotFoundException e
) {
298 log
.error("Unknown class for task " + name
, e
);
301 Properties typedefs
= getDefs(project
,
302 AntConstants
.SLC_TYPEDEFS_RESOURCE_PATH
);
303 for (Object o
: typedefs
.keySet()) {
304 String name
= o
.toString();
306 project
.addDataTypeDefinition(name
, Class
.forName(typedefs
307 .getProperty(name
)));
308 } catch (ClassNotFoundException e
) {
309 log
.error("Unknown class for type " + name
, e
);
314 private Properties
getDefs(Project project
, String path
) {
315 Properties defs
= new Properties();
317 InputStream in
= project
.getClass().getResourceAsStream(path
);
320 } catch (IOException e
) {
321 throw new SlcException("Cannot load task definitions", e
);
326 protected void initStructure(Project project
, String scriptRelativePath
) {
327 // Init structure registry
328 StructureRegistry
<TreeSPath
> registry
= new TreeSRegistry();
329 project
.addReference(AntConstants
.REF_STRUCTURE_REGISTRY
, registry
);
332 StringTokenizer st
= new StringTokenizer(scriptRelativePath
, "/");
333 TreeSPath currPath
= null;
334 while (st
.hasMoreTokens()) {
335 String name
= st
.nextToken();
336 if (currPath
== null) {
337 currPath
= TreeSPath
.createRootPath(name
);
339 if (st
.hasMoreTokens())// don't register project file
340 currPath
= currPath
.createChild(name
);
342 registry
.register(currPath
, new SimpleSElement(name
));
346 String projectName
= project
.getName() != null
347 && !project
.getName().equals("") ? project
.getName()
349 TreeSPath projectPath
= currPath
.createChild(projectName
);
351 String projectDesc
= project
.getDescription() != null
352 && !project
.getDescription().equals("") ? project
353 .getDescription() : projectPath
.getName();
355 registry
.register(projectPath
, new SimpleSElement(projectDesc
));
356 project
.addReference(AntConstants
.REF_PROJECT_PATH
, projectPath
);
358 if (log
.isDebugEnabled())
359 log
.debug("Project path: " + projectPath
);
362 protected void parseProject(Project project
, String scriptRelativePath
) {
364 Resource script
= rootDir
.createRelative(scriptRelativePath
);
367 File scriptFile
= script
.getFile();
368 baseDir
= scriptFile
.getParentFile();
369 } catch (IOException e
) {// resource is not a file
370 baseDir
= new File(System
.getProperty("user.dir"));
372 project
.setBaseDir(baseDir
);
373 // Reset basedir property, in order to avoid base dir override when
375 project
.setProperty("basedir", baseDir
.getAbsolutePath());
377 ProjectHelper2 projectHelper
= new ProjectHelper2();
378 project
.addReference(ProjectHelper
.PROJECTHELPER_REFERENCE
,
380 projectHelper
.parse(project
, script
.getURL());
381 } catch (Exception e
) {
382 throw new SlcException("Could not parse project for script "
383 + scriptRelativePath
, e
);
388 protected void runProject(Project p
, List
<String
> targets
) {
389 p
.fireBuildStarted();
390 Throwable exception
= null;
392 if (targets
.size() == 0) {// no target defined
393 p
.executeTarget(p
.getDefaultTarget());
395 p
.executeTargets(new Vector
<String
>(targets
));
397 } catch (Throwable e
) {
399 throw new SlcException("SLC Ant execution failed", exception
);
401 p
.fireBuildFinished(exception
);
405 public void setContextLocation(Resource contextLocation
) {
406 this.contextLocation
= contextLocation
;
409 public void setRootDir(Resource rootDir
) {
410 this.rootDir
= rootDir
;
413 public void setConfDir(Resource confDir
) {
414 this.confDir
= confDir
;
417 public void setWorkDir(File workDir
) {
418 this.workDir
= workDir
;
421 public void setParentContext(ConfigurableApplicationContext runtimeContext
) {
422 this.parentContext
= runtimeContext
;