]> git.argeo.org Git - gpl/argeo-slc.git/blobdiff - org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntSlcApplication.java
git-svn-id: https://svn.argeo.org/slc/trunk@1284 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc
[gpl/argeo-slc.git] / org.argeo.slc.agent / src / main / java / org / argeo / slc / ant / AntSlcApplication.java
index b312ad84a09b1de4973f57fc11aba63d7a5b5992..76c8331178a6f5a02dd7141d0482ec5cd939af71 100644 (file)
@@ -9,95 +9,92 @@ import java.util.Properties;
 import java.util.StringTokenizer;
 import java.util.Vector;
 
+import org.apache.commons.io.IOUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
+import org.apache.log4j.Appender;
+import org.apache.log4j.LogManager;
+import org.apache.log4j.MDC;
+import org.apache.tools.ant.BuildListener;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.ProjectHelper;
 import org.apache.tools.ant.helper.ProjectHelper2;
 import org.apache.tools.ant.listener.CommonsLoggingListener;
+import org.argeo.slc.core.SlcException;
 import org.argeo.slc.core.process.SlcExecution;
 import org.argeo.slc.core.structure.SimpleSElement;
 import org.argeo.slc.core.structure.StructureRegistry;
 import org.argeo.slc.core.structure.tree.TreeSPath;
 import org.argeo.slc.core.structure.tree.TreeSRegistry;
-import org.argeo.slc.runtime.SlcExecutionContext;
+import org.argeo.slc.logging.Log4jUtils;
+import org.argeo.slc.runtime.SlcExecutionOutput;
+import org.springframework.beans.factory.ListableBeanFactory;
+import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
 import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.support.GenericApplicationContext;
+import org.springframework.core.io.DefaultResourceLoader;
 import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.util.SystemPropertyUtils;
 
 public class AntSlcApplication {
+       private final static String DEFAULT_APP_LOG4J_PROPERTIES = "org/argeo/slc/ant/defaultAppLog4j.properties";
+
        private final static Log log = LogFactory.getLog(AntSlcApplication.class);
 
        private Resource contextLocation;
-       private ApplicationContext parentContext;
+       private ConfigurableApplicationContext parentContext;
 
        private Resource rootDir;
        private Resource confDir;
        private File workDir;
 
-       public SlcExecutionContext execute(SlcExecution slcExecution,
-                       Properties properties, Map<String, Object> references) {
-               log.info("### Start SLC execution " + slcExecution.getUuid() + " ###");
+       public void execute(SlcExecution slcExecution, Properties properties,
+                       Map<String, Object> references,
+                       SlcExecutionOutput<AntExecutionContext> executionOutput) {
+
+               // Properties and application logging initialization
+               initSystemProperties(properties);
+               Log4jUtils.initLog4j("classpath:" + DEFAULT_APP_LOG4J_PROPERTIES);
+
+               log.info("\n###\n### Start SLC execution " + slcExecution.getUuid()
+                               + "\n###\n");
                if (log.isDebugEnabled()) {
                        log.debug("rootDir=" + rootDir);
                        log.debug("confDir=" + confDir);
                        log.debug("workDir=" + workDir);
                }
 
+               // Spring initialization
+               ConfigurableApplicationContext ctx = createExecutionContext(slcExecution);
+
                // Ant coordinates
-               Resource script = findAntScript(slcExecution);
+               String scriptRelativePath = findAntScript(slcExecution);
                List<String> targets = findAntTargets(slcExecution);
 
-               ConfigurableApplicationContext ctx = createExecutionContext(properties);
-
+               // Ant project initialization
                Project project = new Project();
                AntExecutionContext executionContext = new AntExecutionContext(project);
-               project.addReference(SlcAntConstants.REF_ROOT_CONTEXT, ctx);
-               project.addReference(SlcAntConstants.REF_SLC_EXECUTION, slcExecution);
+               project.addReference(AntConstants.REF_ROOT_CONTEXT, ctx);
+               project.addReference(AntConstants.REF_SLC_EXECUTION, slcExecution);
                initProject(project, properties, references);
-               parseProject(project, script);
+               parseProject(project, scriptRelativePath);
 
-               initStructure(project, script);
+               // Execute project
+               initStructure(project, scriptRelativePath);
                runProject(project, targets);
 
-               ctx.close();
-
-               return executionContext;
-       }
+               if (executionOutput != null)
+                       executionOutput.postExecution(executionContext);
 
-       protected Resource findAntScript(SlcExecution slcExecution) {
-               String scriptStr = slcExecution.getAttributes().get(
-                               SlcAntConstants.EXECATTR_ANT_FILE);
-               if (scriptStr == null)
-                       throw new SlcAntException("No Ant script provided");
-
-               try {
-                       return rootDir.createRelative(scriptStr);
-               } catch (Exception e) {
-                       throw new SlcAntException("Cannot find Ant script " + scriptStr, e);
-               }
-       }
-
-       protected List<String> findAntTargets(SlcExecution slcExecution) {
-               String targetList = slcExecution.getAttributes().get(
-                               SlcAntConstants.EXECATTR_ANT_TARGETS);
-               List<String> targets = new Vector<String>();
-               if (targetList != null) {
-                       StringTokenizer stTargets = new StringTokenizer(targetList, ",");
-                       while (stTargets.hasMoreTokens()) {
-                               targets.add(stTargets.nextToken());
-                       }
-               }
-               return targets;
+               ctx.close();
        }
 
-       protected ConfigurableApplicationContext createExecutionContext(
-                       Properties userProperties) {
+       protected void initSystemProperties(Properties userProperties) {
                // Set user properties as system properties so that Spring can access
                // them
-
                if (userProperties != null) {
                        for (Object key : userProperties.keySet()) {
                                System.setProperty(key.toString(), userProperties
@@ -105,22 +102,77 @@ public class AntSlcApplication {
                        }
                }
 
-               if (System.getProperty(SlcAntConstants.DEFAULT_TEST_RUN_PROPERTY) == null) {
-                       System.setProperty(SlcAntConstants.DEFAULT_TEST_RUN_PROPERTY,
+               if (System.getProperty(AntConstants.DEFAULT_TEST_RUN_PROPERTY) == null) {
+                       System.setProperty(AntConstants.DEFAULT_TEST_RUN_PROPERTY,
                                        "defaultTestRun");
                }
 
                try {
                        if (rootDir != null)
-                               System.setProperty(SlcAntConstants.ROOT_DIR_PROPERTY, rootDir
+                               System.setProperty(AntConstants.ROOT_DIR_PROPERTY, rootDir
                                                .getURL().toString());
                        if (confDir != null)
-                               System.setProperty(SlcAntConstants.CONF_DIR_PROPERTY, confDir
+                               System.setProperty(AntConstants.CONF_DIR_PROPERTY, confDir
                                                .getURL().toString());
                        if (workDir != null)
-                               System.setProperty(SlcAntConstants.WORK_DIR_PROPERTY, workDir
-                                               .toString());
+                               System.setProperty(AntConstants.WORK_DIR_PROPERTY, workDir
+                                               .getCanonicalPath());
+
+                       // Additional properties in slc.properties file. Already set sytem
+                       // properties (such as the various directories) can be resolved in
+                       // placeholders.
+                       if (confDir != null) {
+                               Resource slcPropertiesRes = confDir
+                                               .createRelative("slc.properties");
+                               if (slcPropertiesRes.exists()) {
+                                       Properties slcProperties = new Properties();
+                                       InputStream in = slcPropertiesRes.getInputStream();
+                                       try {
+                                               slcProperties.load(in);
+                                       } finally {
+                                               IOUtils.closeQuietly(in);
+                                       }
+
+                                       for (String key : slcProperties.stringPropertyNames()) {
+                                               if (!System.getProperties().containsKey(key)) {
+                                                       String value = SystemPropertyUtils
+                                                                       .resolvePlaceholders(slcProperties
+                                                                                       .getProperty(key));
+                                                       System.setProperty(key, value);
+                                               }
+                                       }
+                               }
+                       }
+               } catch (Exception e) {
+                       throw new SlcException("Cannot init system properties.", e);
+               }
+       }
+
+       protected ConfigurableApplicationContext createExecutionContext(
+                       SlcExecution slcExecution) {
+               try {
+
+                       // Find runtime definition
+                       Resource runtimeRes = null;
+                       String runtimeStr = slcExecution.getAttributes().get(
+                                       AntConstants.EXECATTR_RUNTIME);
+                       if (runtimeStr == null)
+                               runtimeStr = "default";
+
+                       ResourceLoader rl = new DefaultResourceLoader(getClass()
+                                       .getClassLoader());
+                       try {// tries absolute reference
+                               runtimeRes = rl.getResource(runtimeStr);
+                       } catch (Exception e) {
+                               // silent
+                       }
+                       if (runtimeRes == null || !runtimeRes.exists()) {
+                               if (confDir != null)
+                                       runtimeRes = confDir.createRelative("runtime/" + runtimeStr
+                                                       + ".xml");
+                       }
 
+                       // Find runtime independent application context definition
                        if (confDir != null && contextLocation == null) {
                                contextLocation = confDir
                                                .createRelative("applicationContext.xml");
@@ -128,19 +180,54 @@ public class AntSlcApplication {
 
                        GenericApplicationContext ctx = new GenericApplicationContext(
                                        parentContext);
-                       if (contextLocation != null && contextLocation.exists()) {
-                               XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(
-                                               ctx);
+                       ctx.setDisplayName("SLC Execution #" + slcExecution.getUuid());
+
+                       XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(ctx);
+                       if (runtimeRes != null && runtimeRes.exists())
+                               xmlReader.loadBeanDefinitions(runtimeRes);
+                       else
+                               log.warn("No runtime context defined");
+
+                       if (contextLocation != null && contextLocation.exists())
                                xmlReader.loadBeanDefinitions(contextLocation);
-                       }
+                       else
+                               log.warn("No runtime independent application context defined");
+
+                       // Add property place holder
+                       PropertyPlaceholderConfigurer ppc = new PropertyPlaceholderConfigurer();
+                       ppc.setIgnoreUnresolvablePlaceholders(true);
+                       ctx.addBeanFactoryPostProcessor(ppc);
+
                        ctx.refresh();
                        return ctx;
                } catch (Exception e) {
-                       throw new SlcAntException(
+                       throw new SlcException(
                                        "Cannot create SLC execution application context.", e);
                }
        }
 
+       protected String findAntScript(SlcExecution slcExecution) {
+               String scriptStr = slcExecution.getAttributes().get(
+                               AntConstants.EXECATTR_ANT_FILE);
+               if (scriptStr == null)
+                       throw new SlcException("No Ant script provided");
+
+               return scriptStr;
+       }
+
+       protected List<String> findAntTargets(SlcExecution slcExecution) {
+               String targetList = slcExecution.getAttributes().get(
+                               AntConstants.EXECATTR_ANT_TARGETS);
+               List<String> targets = new Vector<String>();
+               if (targetList != null) {
+                       StringTokenizer stTargets = new StringTokenizer(targetList, ",");
+                       while (stTargets.hasMoreTokens()) {
+                               targets.add(stTargets.nextToken());
+                       }
+               }
+               return targets;
+       }
+
        protected void initProject(Project project, Properties properties,
                        Map<String, Object> references) {
                if (properties != null) {
@@ -157,6 +244,24 @@ public class AntSlcApplication {
                }
 
                project.addBuildListener(new CommonsLoggingListener());
+
+               ListableBeanFactory context = (ListableBeanFactory) project
+                               .getReference(AntConstants.REF_ROOT_CONTEXT);
+               // Register build listeners
+               Map<String, BuildListener> listeners = context.getBeansOfType(
+                               BuildListener.class, false, true);
+               for (BuildListener listener : listeners.values()) {
+                       project.addBuildListener(listener);
+               }
+
+               // Register log4j appenders from context
+               MDC.put(AntConstants.MDC_ANT_PROJECT, project);
+               Map<String, Appender> appenders = context.getBeansOfType(
+                               Appender.class, false, true);
+               for (Appender appender : appenders.values()) {
+                       LogManager.getRootLogger().addAppender(appender);
+               }
+
                project.init();
                addCustomTaskAndTypes(project);
        }
@@ -164,7 +269,7 @@ public class AntSlcApplication {
        /** Loads the SLC specific Ant tasks. */
        protected void addCustomTaskAndTypes(Project project) {
                Properties taskdefs = getDefs(project,
-                               SlcAntConstants.SLC_TASKDEFS_RESOURCE_PATH);
+                               AntConstants.SLC_TASKDEFS_RESOURCE_PATH);
                for (Object o : taskdefs.keySet()) {
                        String name = o.toString();
                        try {
@@ -175,7 +280,7 @@ public class AntSlcApplication {
                        }
                }
                Properties typedefs = getDefs(project,
-                               SlcAntConstants.SLC_TYPEDEFS_RESOURCE_PATH);
+                               AntConstants.SLC_TYPEDEFS_RESOURCE_PATH);
                for (Object o : typedefs.keySet()) {
                        String name = o.toString();
                        try {
@@ -194,57 +299,50 @@ public class AntSlcApplication {
                        defs.load(in);
                        in.close();
                } catch (IOException e) {
-                       throw new SlcAntException("Cannot load task definitions", e);
+                       throw new SlcException("Cannot load task definitions", e);
                }
                return defs;
        }
 
-       protected void initStructure(Project project, Resource script) {
+       protected void initStructure(Project project, String scriptRelativePath) {
                // Init structure registry
-               try {
-                       StructureRegistry<TreeSPath> registry = new TreeSRegistry();
-                       project.addReference(SlcAntConstants.REF_STRUCTURE_REGISTRY,
-                                       registry);
-
-                       String scriptPath = script.getURL().getPath();
-                       if (rootDir != null) {
-                               scriptPath = scriptPath.substring(rootDir.getURL().getPath()
-                                               .length());
-                               log.debug("rootDirPath=" + rootDir.getURL().getPath());
-                       }
-                       log.debug("scriptPath=" + scriptPath);
-
-                       StringTokenizer st = new StringTokenizer(scriptPath, "/");
-                       TreeSPath currPath = null;
-                       while (st.hasMoreTokens()) {
-                               String name = st.nextToken();
-                               if (currPath == null) {
-                                       currPath = TreeSPath.createRootPath(name);
-                               } else {
+               StructureRegistry<TreeSPath> registry = new TreeSRegistry();
+               project.addReference(AntConstants.REF_STRUCTURE_REGISTRY, registry);
+
+               // Lowest levels
+               StringTokenizer st = new StringTokenizer(scriptRelativePath, "/");
+               TreeSPath currPath = null;
+               while (st.hasMoreTokens()) {
+                       String name = st.nextToken();
+                       if (currPath == null) {
+                               currPath = TreeSPath.createRootPath(name);
+                       } else {
+                               if (st.hasMoreTokens())// don't register project file
                                        currPath = currPath.createChild(name);
-                               }
-                               registry.register(currPath, new SimpleSElement(name));
                        }
-                       TreeSPath projectPath = currPath
-                                       .createChild(project.getName() != null
-                                                       && !project.getName().equals("") ? project
-                                                       .getName() : "project");
-                       String projectDesc = project.getDescription() != null
-                                       && !project.getDescription().equals("") ? project
-                                       .getDescription() : projectPath.getName();
-                       registry.register(projectPath, new SimpleSElement(projectDesc));
-                       project.addReference(SlcAntConstants.REF_PROJECT_PATH, currPath);
-
-                       if (log.isDebugEnabled())
-                               log.debug("Project path: " + projectPath);
-               } catch (IOException e) {
-                       throw new SlcAntException("Cannot inititalize execution structure",
-                                       e);
+                       registry.register(currPath, new SimpleSElement(name));
                }
+
+               // Project level
+               String projectName = project.getName() != null
+                               && !project.getName().equals("") ? project.getName()
+                               : "project";
+               TreeSPath projectPath = currPath.createChild(projectName);
+
+               String projectDesc = project.getDescription() != null
+                               && !project.getDescription().equals("") ? project
+                               .getDescription() : projectPath.getName();
+
+               registry.register(projectPath, new SimpleSElement(projectDesc));
+               project.addReference(AntConstants.REF_PROJECT_PATH, projectPath);
+
+               if (log.isDebugEnabled())
+                       log.debug("Project path: " + projectPath);
        }
 
-       protected void parseProject(Project project, Resource script) {
+       protected void parseProject(Project project, String scriptRelativePath) {
                try {
+                       Resource script = rootDir.createRelative(scriptRelativePath);
                        File baseDir = null;
                        try {
                                File scriptFile = script.getFile();
@@ -262,8 +360,8 @@ public class AntSlcApplication {
                                        projectHelper);
                        projectHelper.parse(project, script.getURL());
                } catch (Exception e) {
-                       throw new SlcAntException("Could not parse project for script "
-                                       + script, e);
+                       throw new SlcException("Could not parse project for script "
+                                       + scriptRelativePath, e);
                }
 
        }
@@ -279,7 +377,7 @@ public class AntSlcApplication {
                        }
                } catch (Throwable e) {
                        exception = e;
-                       throw new SlcAntException("SLC Ant execution failed", exception);
+                       throw new SlcException("SLC Ant execution failed", exception);
                } finally {
                        p.fireBuildFinished(exception);
                }
@@ -301,8 +399,8 @@ public class AntSlcApplication {
                this.workDir = workDir;
        }
 
-       public void setParentContext(ApplicationContext parentContext) {
-               this.parentContext = parentContext;
+       public void setParentContext(ConfigurableApplicationContext runtimeContext) {
+               this.parentContext = runtimeContext;
        }
 
 }