From: Mathieu Baudier Date: Sat, 21 Jun 2008 18:18:19 +0000 (+0000) Subject: Rename Ant constants X-Git-Tag: argeo-slc-2.1.7~2763 X-Git-Url: http://git.argeo.org/?a=commitdiff_plain;h=fa38c56c899d3f7347d960c4684fa293b1502c6c;p=gpl%2Fargeo-slc.git Rename Ant constants git-svn-id: https://svn.argeo.org/slc/trunk@1279 4cfe0d0a-d680-48aa-b62c-e0a02a3f76cc --- diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntConstants.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntConstants.java new file mode 100644 index 000000000..1e6cf142e --- /dev/null +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntConstants.java @@ -0,0 +1,44 @@ +package org.argeo.slc.ant; + +public interface AntConstants { + // ANT + /** The Ant reference to the Spring application context used. */ + public static final String REF_ROOT_CONTEXT = "slcApplicationContext"; + /** The Ant reference to the SLC structure registry used. */ + public static final String REF_STRUCTURE_REGISTRY = "slcStructureRegistry"; + /** The Ant reference to the TreePath of the current project */ + public static final String REF_PROJECT_PATH = "slcProjectPath"; + /** + * Resource path to the property file listing the SLC specific Ant tasks: + * /org/argeo/slc/ant/taskdefs.properties + */ + public static final String SLC_TASKDEFS_RESOURCE_PATH = "/org/argeo/slc/ant/taskdefs.properties"; + /** + * Resource path to the property file listing the SLC specific Ant types: + * /org/argeo/slc/ant/typedefs.properties + */ + public static final String SLC_TYPEDEFS_RESOURCE_PATH = "/org/argeo/slc/ant/typedefs.properties"; + public static final String REF_SLC_EXECUTION = "slcExecution"; + + // SLC EXECUTION + public static final String EXECTYPE_ANT = "org.apache.tools.ant"; + public static final String EXECTYPE_SLC_ANT = "org.argeo.slc.ant"; + + public final static String EXECATTR_RUNTIME = "slc.runtime"; + public final static String EXECATTR_ANT_FILE = "ant.file"; + public final static String EXECATTR_ANT_TARGETS = "ant.targets"; + + // PROPERTIES + /** Property for the root dir (SLC root property file). */ + public final static String ROOT_DIR_PROPERTY = "slc.rootDir"; + /** Property for the conf dir (SLC root property file). */ + public final static String CONF_DIR_PROPERTY = "slc.confDir"; + /** Property for the work dir (SLC root property file). */ + public final static String WORK_DIR_PROPERTY = "slc.workDir"; + /** Name of the Spring bean used by default */ + public final static String DEFAULT_TEST_RUN_PROPERTY = "slc.defaultTestRun"; + + // LOG4J + public final static String MDC_ANT_PROJECT = "slc.ant.project"; + +} diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntExecutionContext.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntExecutionContext.java index d78b8f8ee..a010e7fad 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntExecutionContext.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntExecutionContext.java @@ -14,13 +14,13 @@ public class AntExecutionContext implements SlcExecutionContext { public T getBean(String name) { ApplicationContext context = (ApplicationContext) project - .getReference(SlcAntConstants.REF_ROOT_CONTEXT); + .getReference(AntConstants.REF_ROOT_CONTEXT); return (T) context.getBean(name); } public SlcExecution getSlcExecution() { return (SlcExecution) project - .getReference(SlcAntConstants.REF_SLC_EXECUTION); + .getReference(AntConstants.REF_SLC_EXECUTION); } public Project getProject() { diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntSlcApplication.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntSlcApplication.java index 8b8d2e4e5..ae1f8ef13 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntSlcApplication.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/AntSlcApplication.java @@ -77,8 +77,8 @@ public class AntSlcApplication { // 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, scriptRelativePath); @@ -102,20 +102,20 @@ 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 + System.setProperty(AntConstants.WORK_DIR_PROPERTY, workDir .getCanonicalPath()); // Additional properties in slc.properties file. Already set sytem @@ -155,7 +155,7 @@ public class AntSlcApplication { // Find runtime definition Resource runtimeRes = null; String runtimeStr = slcExecution.getAttributes().get( - SlcAntConstants.EXECATTR_RUNTIME); + AntConstants.EXECATTR_RUNTIME); if (runtimeStr == null) runtimeStr = "default"; @@ -208,7 +208,7 @@ public class AntSlcApplication { protected String findAntScript(SlcExecution slcExecution) { String scriptStr = slcExecution.getAttributes().get( - SlcAntConstants.EXECATTR_ANT_FILE); + AntConstants.EXECATTR_ANT_FILE); if (scriptStr == null) throw new SlcException("No Ant script provided"); @@ -217,7 +217,7 @@ public class AntSlcApplication { protected List findAntTargets(SlcExecution slcExecution) { String targetList = slcExecution.getAttributes().get( - SlcAntConstants.EXECATTR_ANT_TARGETS); + AntConstants.EXECATTR_ANT_TARGETS); List targets = new Vector(); if (targetList != null) { StringTokenizer stTargets = new StringTokenizer(targetList, ","); @@ -246,7 +246,7 @@ public class AntSlcApplication { project.addBuildListener(new CommonsLoggingListener()); ListableBeanFactory context = (ListableBeanFactory) project - .getReference(SlcAntConstants.REF_ROOT_CONTEXT); + .getReference(AntConstants.REF_ROOT_CONTEXT); // Register build listeners Map listeners = context.getBeansOfType( BuildListener.class, false, true); @@ -255,7 +255,7 @@ public class AntSlcApplication { } // Register log4j appenders from context - MDC.put(SlcAntConstants.MDC_ANT_PROJECT, project); + MDC.put(AntConstants.MDC_ANT_PROJECT, project); Map appenders = context.getBeansOfType( Appender.class, false, true); for (Appender appender : appenders.values()) { @@ -269,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 { @@ -280,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 { @@ -307,7 +307,7 @@ public class AntSlcApplication { protected void initStructure(Project project, String scriptRelativePath) { // Init structure registry StructureRegistry registry = new TreeSRegistry(); - project.addReference(SlcAntConstants.REF_STRUCTURE_REGISTRY, registry); + project.addReference(AntConstants.REF_STRUCTURE_REGISTRY, registry); // Lowest levels StringTokenizer st = new StringTokenizer(scriptRelativePath, "/"); @@ -334,7 +334,7 @@ public class AntSlcApplication { .getDescription() : projectPath.getName(); registry.register(projectPath, new SimpleSElement(projectDesc)); - project.addReference(SlcAntConstants.REF_PROJECT_PATH, projectPath); + project.addReference(AntConstants.REF_PROJECT_PATH, projectPath); if (log.isDebugEnabled()) log.debug("Project path: " + projectPath); diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcAntConstants.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcAntConstants.java deleted file mode 100644 index 7e234b121..000000000 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcAntConstants.java +++ /dev/null @@ -1,44 +0,0 @@ -package org.argeo.slc.ant; - -public interface SlcAntConstants { - // ANT - /** The Ant reference to the Spring application context used. */ - public static final String REF_ROOT_CONTEXT = "slcApplicationContext"; - /** The Ant reference to the SLC structure registry used. */ - public static final String REF_STRUCTURE_REGISTRY = "slcStructureRegistry"; - /** The Ant reference to the TreePath of the current project */ - public static final String REF_PROJECT_PATH = "slcProjectPath"; - /** - * Resource path to the property file listing the SLC specific Ant tasks: - * /org/argeo/slc/ant/taskdefs.properties - */ - public static final String SLC_TASKDEFS_RESOURCE_PATH = "/org/argeo/slc/ant/taskdefs.properties"; - /** - * Resource path to the property file listing the SLC specific Ant types: - * /org/argeo/slc/ant/typedefs.properties - */ - public static final String SLC_TYPEDEFS_RESOURCE_PATH = "/org/argeo/slc/ant/typedefs.properties"; - public static final String REF_SLC_EXECUTION = "slcExecution"; - - // SLC EXECUTION - public static final String EXECTYPE_ANT = "org.apache.tools.ant"; - public static final String EXECTYPE_SLC_ANT = "org.argeo.slc.ant"; - - public final static String EXECATTR_RUNTIME = "slc.runtime"; - public final static String EXECATTR_ANT_FILE = "ant.file"; - public final static String EXECATTR_ANT_TARGETS = "ant.targets"; - - // PROPERTIES - /** Property for the root dir (SLC root property file). */ - public final static String ROOT_DIR_PROPERTY = "slc.rootDir"; - /** Property for the conf dir (SLC root property file). */ - public final static String CONF_DIR_PROPERTY = "slc.confDir"; - /** Property for the work dir (SLC root property file). */ - public final static String WORK_DIR_PROPERTY = "slc.workDir"; - /** Name of the Spring bean used by default */ - public final static String DEFAULT_TEST_RUN_PROPERTY = "slc.defaultTestRun"; - - // LOG4J - public final static String MDC_ANT_PROJECT = "slc.ant.project"; - -} diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcExecutionBuildListener.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcExecutionBuildListener.java index 3e427b139..64dc33e98 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcExecutionBuildListener.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/SlcExecutionBuildListener.java @@ -130,7 +130,7 @@ public class SlcExecutionBuildListener extends AppenderSkeleton implements protected SlcExecution getSlcExecution(Project project) { SlcExecution slcExecution = (SlcExecution) project - .getReference(SlcAntConstants.REF_SLC_EXECUTION); + .getReference(AntConstants.REF_SLC_EXECUTION); if (slcExecution == null) throw new SlcException("No SLC Execution registered."); @@ -162,7 +162,7 @@ public class SlcExecutionBuildListener extends AppenderSkeleton implements @Override protected void append(LoggingEvent event) { - Project project = (Project) MDC.get(SlcAntConstants.MDC_ANT_PROJECT); + Project project = (Project) MDC.get(AntConstants.MDC_ANT_PROJECT); if (project == null) throw new SlcException("No Ant project registered in Log4j MDC."); diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/AbstractSpringTask.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/AbstractSpringTask.java index ebc14c215..f0eae3fd0 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/AbstractSpringTask.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/AbstractSpringTask.java @@ -4,7 +4,7 @@ import org.springframework.context.ApplicationContext; import org.apache.tools.ant.Task; -import org.argeo.slc.ant.SlcAntConstants; +import org.argeo.slc.ant.AntConstants; import org.argeo.slc.core.process.SlcExecution; /** Abstract Ant task providing access to a Spring context. */ @@ -13,12 +13,12 @@ public abstract class AbstractSpringTask extends Task { /** Gets the related Spring context. */ protected ApplicationContext getContext() { return (ApplicationContext) getProject().getReference( - SlcAntConstants.REF_ROOT_CONTEXT); + AntConstants.REF_ROOT_CONTEXT); } /** Gets the related slc execution or null if not is registered. */ protected SlcExecution getSlcExecution() { return (SlcExecution) getProject().getReference( - SlcAntConstants.REF_SLC_EXECUTION); + AntConstants.REF_SLC_EXECUTION); } } diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/SpringArg.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/SpringArg.java index 75b3447c5..c84c96567 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/SpringArg.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/spring/SpringArg.java @@ -5,7 +5,7 @@ import java.util.Vector; import org.apache.tools.ant.BuildException; import org.apache.tools.ant.types.DataType; -import org.argeo.slc.ant.SlcAntConstants; +import org.argeo.slc.ant.AntConstants; import org.argeo.slc.core.SlcException; import org.springframework.beans.BeanWrapper; import org.springframework.beans.BeanWrapperImpl; @@ -103,7 +103,7 @@ public class SpringArg extends DataType { /** The related Spring application context. */ protected ApplicationContext getContext() { return (ApplicationContext) getProject().getReference( - SlcAntConstants.REF_ROOT_CONTEXT); + AntConstants.REF_ROOT_CONTEXT); } protected void checkValueAlreadySet() { diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/structure/SAwareTask.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/structure/SAwareTask.java index 8c0cf9d76..343db9644 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/structure/SAwareTask.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/structure/SAwareTask.java @@ -5,7 +5,7 @@ import java.util.Vector; import org.apache.tools.ant.BuildException; import org.apache.tools.ant.Target; -import org.argeo.slc.ant.SlcAntConstants; +import org.argeo.slc.ant.AntConstants; import org.argeo.slc.ant.spring.AbstractSpringTask; import org.argeo.slc.ant.spring.SpringArg; import org.argeo.slc.core.SlcException; @@ -124,13 +124,13 @@ public abstract class SAwareTask extends AbstractSpringTask { /** Gets the underlying structure registry. */ protected StructureRegistry getRegistry() { return (StructureRegistry) getProject().getReference( - SlcAntConstants.REF_STRUCTURE_REGISTRY); + AntConstants.REF_STRUCTURE_REGISTRY); } /** Creates the treeSPath for a given Ant target. */ protected static TreeSPath createTargetPath(Target target) { TreeSPath projectPath = (TreeSPath) target.getProject().getReference( - SlcAntConstants.REF_PROJECT_PATH); + AntConstants.REF_PROJECT_PATH); return projectPath.createChild(target.getName()); } diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/test/SlcTestTask.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/test/SlcTestTask.java index d5185b9c7..37daed7d5 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/test/SlcTestTask.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/ant/test/SlcTestTask.java @@ -3,7 +3,7 @@ package org.argeo.slc.ant.test; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.apache.tools.ant.BuildException; -import org.argeo.slc.ant.SlcAntConstants; +import org.argeo.slc.ant.AntConstants; import org.argeo.slc.ant.spring.SpringArg; import org.argeo.slc.ant.structure.SAwareTask; import org.argeo.slc.core.deploy.DeployedSystem; @@ -39,7 +39,7 @@ public class SlcTestTask extends SAwareTask { testRunBeanT = testRunBean; } else { testRunBeanT = getProject().getProperty( - SlcAntConstants.DEFAULT_TEST_RUN_PROPERTY); + AntConstants.DEFAULT_TEST_RUN_PROPERTY); } WritableTestRun testRun = null; diff --git a/org.argeo.slc.agent/src/main/java/org/argeo/slc/cli/DefaultSlcRuntime.java b/org.argeo.slc.agent/src/main/java/org/argeo/slc/cli/DefaultSlcRuntime.java index 4b3aa0b15..3fc2a5671 100644 --- a/org.argeo.slc.agent/src/main/java/org/argeo/slc/cli/DefaultSlcRuntime.java +++ b/org.argeo.slc.agent/src/main/java/org/argeo/slc/cli/DefaultSlcRuntime.java @@ -14,7 +14,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.argeo.slc.ant.AntExecutionContext; import org.argeo.slc.ant.AntSlcApplication; -import org.argeo.slc.ant.SlcAntConstants; +import org.argeo.slc.ant.AntConstants; import org.argeo.slc.core.SlcException; import org.argeo.slc.core.process.SlcExecution; import org.argeo.slc.runtime.SlcExecutionOutput; @@ -99,21 +99,21 @@ public class DefaultSlcRuntime { slcExecution.setHost(SlcExecution.UNKOWN_HOST); } - slcExecution.setType(SlcAntConstants.EXECTYPE_SLC_ANT); + slcExecution.setType(AntConstants.EXECTYPE_SLC_ANT); slcExecution.setUser(System.getProperty("user.name")); if (runtimeStr != null) - slcExecution.getAttributes().put(SlcAntConstants.EXECATTR_RUNTIME, + slcExecution.getAttributes().put(AntConstants.EXECATTR_RUNTIME, runtimeStr); String scriptRelativePath = SpringUtils.extractRelativePath(SpringUtils .getParent(slcRootFile), script); - slcExecution.getAttributes().put(SlcAntConstants.EXECATTR_ANT_FILE, + slcExecution.getAttributes().put(AntConstants.EXECATTR_ANT_FILE, scriptRelativePath); if (targets != null) slcExecution.getAttributes().put( - SlcAntConstants.EXECATTR_ANT_TARGETS, targets); + AntConstants.EXECATTR_ANT_TARGETS, targets); slcExecution.setStatus(SlcExecution.STATUS_SCHEDULED); return slcExecution; @@ -137,7 +137,7 @@ public class DefaultSlcRuntime { // Conf dir String confDirStr = rootProps - .getProperty(SlcAntConstants.CONF_DIR_PROPERTY); + .getProperty(AntConstants.CONF_DIR_PROPERTY); if (confDirStr != null) confDir = new DefaultResourceLoader(application.getClass() .getClassLoader()).getResource(confDirStr); @@ -150,7 +150,7 @@ public class DefaultSlcRuntime { // Work dir String workDirStr = rootProps - .getProperty(SlcAntConstants.WORK_DIR_PROPERTY); + .getProperty(AntConstants.WORK_DIR_PROPERTY); if (workDirStr != null) { workDir = new File(workDirStr); } diff --git a/org.argeo.slc.agent/src/test/java/org/argeo/slc/ant/SlcAntTest.java b/org.argeo.slc.agent/src/test/java/org/argeo/slc/ant/SlcAntTest.java index b52f38a25..ad63b34b5 100644 --- a/org.argeo.slc.agent/src/test/java/org/argeo/slc/ant/SlcAntTest.java +++ b/org.argeo.slc.agent/src/test/java/org/argeo/slc/ant/SlcAntTest.java @@ -18,7 +18,7 @@ public class SlcAntTest extends AbstractSpringTestCase { slcApp.setParentContext(getContext()); SlcExecution slcExecution = new SlcExecution(); - slcExecution.getAttributes().put(SlcAntConstants.EXECATTR_ANT_FILE, + slcExecution.getAttributes().put(AntConstants.EXECATTR_ANT_FILE, "/org/argeo/slc/ant/build.xml"); slcApp.execute(slcExecution, null, null, null);