org.argeo.slc/src/main/java/org/argeo/slc/ant/SlcAntConfig.java

   1 package org.argeo.slc.ant;
   2
   3 import java.io.File;
   4 import java.io.FileInputStream;
   5 import java.io.IOException;
   6 import java.util.Map;
   7 import java.util.Properties;
   8 import java.util.StringTokenizer;
   9
  10 import org.springframework.util.Log4jConfigurer;
  11
  12 import org.apache.tools.ant.Project;
  13
  14 import org.argeo.slc.core.test.WritableTestRun;
  15
  16 /**
  17  * <p>
  18  * Manager and initializer of the properties required by SLC Ant.
  19  * </p>
  20  *
  21  * <p>
  22  * All properties described here will get a value one way or another (see below
  23  * for details)/ Each property will be accessible via Ant or Spring properties.
  24  * </p>
  25  *
  26  * <p>
  27  * The property <i>slc.rootFile</i> is set based on the location of the SLC
  28  * root property file found in the directory structure of a called Ant file. The
  29  * default name of this file is <b>slcRoot.properties</b> (can be set by
  30  * {@link #setSlcRootFileName(String)}). <br>
  31  * This property provides the absolute path to the unique SLC root property file
  32  * which marks the root of an Ant SLC tree structure.
  33  * </p>
  34  *
  35  * <p>
  36  * The property <i>slc.rootDir</i> is inferred from <i>slc.rootFile</i> and
  37  * provides a convenient shortcut to the root directory of the Ant files
  38  * directory structure.
  39  * </p>
  40  *
  41  * <p>
  42  * A few directory and file related properties can be set in the SLC root
  43  * property file (if they are not explicitly set their default values will be
  44  * used):
  45  *
  46  * <table border="1" cellspacing="0">
  47  * <tr>
  48  * <th>Property</th>
  49  * <th>Description</th>
  50  * <th>Default</th>
  51  * </tr>
  52  * <tr>
  53  * <td><i>slc.confDir</i></td>
  54  * <td>Directory where to find the various configuration files of a given SLC
  55  * Ant deployment</td>
  56  * <td>${slc.rootDir}/../conf</td>
  57  * </tr>
  58  * <tr>
  59  * <td><i>slc.workDir</i></td>
  60  * <td>Directory where data can be retrieved or generated: build outputs, test
  61  * inputs/outputs, test results, etc. The underlying directory structure is
  62  * specified by the specific SLC application.</td>
  63  * <td>${slc.rootDir}/../work</td>
  64  * </tr>
  65  * <tr>
  66  * <td><i>slc.propertyFileNames</i></td>
  67  * <td>Comma-separated list of the files names of the property files to load
  68  * from the conf directory. Having various files allows to separate between SLC
  69  * framework properties and properties specific to a given application built on
  70  * top of SLC. All will be available across Ant and Spring.</td>
  71  * <td>slc.properties</td>
  72  * </tr>
  73  * </table> <b>Note:</b> Only the properties above can be set in the SLC root
  74  * properties file. All other properties should be defined in the registered
  75  * conf files.
  76  * </p>
  77  *
  78  * <p>
  79  * Any property can be defined in the conf files defined in the SLC root
  80  * properties file (see above). SLC expects some which will have defaults but
  81  * can be overriden there. By convention they should be defined in the
  82  * <b>slc.properties</b> file, while application specific properties should be
  83  * defined in other conf files. This allows for a clean spearation between SLC
  84  * and the applications built on top of it:
  85  *
  86  * <table border="1" cellspacing="0">
  87  * <tr>
  88  * <th>Property</th>
  89  * <th>Description</th>
  90  * <th>Default</th>
  91  * </tr>
  92  * <tr>
  93  * <td><i>slc.applicationContext</i></td>
  94  * <td>Path to the root Spring application context file used by SLC Ant.</td>
  95  * <td>${slc.confDir}/applicationContext.xml</td>
  96  * </tr>
  97  * <tr>
  98  * <td><i>slc.defaultTestRun</i></td>
  99  * <td>Name of the {@link WritableTestRun} Spring bean that the
 100  * <code>slc.test</code> task will use by default. This can be overridden when
 101  * calling the task from Ant.</td>
 102  * <td>defaultTestRun</td>
 103  * </tr>
 104  * </table>
 105  * </p>
 106  */
 107 public class SlcAntConfig {
 108         // SLC ROOT PROPERTIES
 109         public final static String ROOT_FILE_PROPERTY = "slc.rootFile";
 110         public final static String ROOT_DIR_PROPERTY = "slc.rootDir";
 111         public final static String CONF_DIR_PROPERTY = "slc.confDir";
 112         public final static String WORK_DIR_PROPERTY = "slc.workDir";
 113         /**
 114          * Comma-separated list of property file names to load from the conf dir and
 115          * add to project user properties
 116          */
 117         public final static String PROPERTY_FILE_NAMES_PROPERTY = "slc.propertyFileNames";
 118
 119         // SLC CONF PROPERTIES
 120         /** Path to the root Spring application context */
 121         public static String APPLICATION_CONTEXT_PROPERTY = "slc.applicationContext";
 122         /** Name of the Spring bean used by default */
 123         public static String DEFAULT_TEST_RUN_PROPERTY = "slc.defaultTestRun";
 124
 125         // SLC LOCAL PROPERTIES
 126         public static String DIR_DESCRIPTION_PROPERTY = "slc.dirDescription";
 127
 128         private String slcRootFileName = "slcRoot.properties";
 129         private String slcLocalFileName = "slcLocal.properties";
 130
 131         /**
 132          * Retrieves or infers all properties and set them as project user
 133          * properties. All these properties will be set as project properties <b>if
 134          * they had not been set as project properties before</b> (like by
 135          * overriding through the standard Ant mechanisms).
 136          *
 137          * @param project
 138          *            the Ant <code>Project</code> being run.
 139          */
 140         public void initProject(Project project) {
 141                 File projectBaseDir = project.getBaseDir();
 142                 File slcRootFile = findSlcRootFile(projectBaseDir);
 143                 if (slcRootFile == null) {
 144                         throw new SlcAntException("Cannot find SLC root file");
 145                 }
 146                 // pass the project properties through the System properties
 147                 System.getProperties().putAll((Map<?, ?>) project.getUserProperties());
 148                 Properties all = prepareAllProperties(slcRootFile);
 149                 for (Object o : all.keySet()) {
 150                         String key = o.toString();
 151                         if (project.getUserProperty(key) == null) {// not already set
 152                                 project.setUserProperty(key, all.getProperty(key));
 153                         }
 154                 }
 155         }
 156
 157         /**
 158          * Retrieves or infers all required properties.
 159          *
 160          * @param slcRootFile
 161          *            the location of the SLC root file
 162          *
 163          * @return the prepared properties. Note that it also contains the System
 164          *         and Ant properties which had previously been set.
 165          */
 166         protected Properties prepareAllProperties(File slcRootFile) {
 167                 try {
 168                         Properties all = new Properties();
 169                         all.putAll(System.getProperties());
 170                         all.put(ROOT_FILE_PROPERTY, slcRootFile.getCanonicalPath());
 171
 172                         Properties rootProps = loadFile(slcRootFile.getCanonicalPath());
 173
 174                         final File confDir;
 175                         final File workDir;
 176                         // Root dir
 177                         final File rootDir = slcRootFile.getParentFile();
 178                         all.setProperty(ROOT_DIR_PROPERTY, rootDir.getCanonicalPath());
 179
 180                         // Conf dir
 181                         if (all.getProperty(CONF_DIR_PROPERTY) == null) {
 182                                 confDir = new File(rootProps.getProperty(CONF_DIR_PROPERTY,
 183                                                 rootDir.getAbsolutePath() + "/../conf"))
 184                                                 .getCanonicalFile();
 185                                 all.setProperty(CONF_DIR_PROPERTY, confDir.getAbsolutePath());
 186                         } else {
 187                                 confDir = new File(all.getProperty(CONF_DIR_PROPERTY))
 188                                                 .getCanonicalFile();
 189                         }
 190
 191                         // Work dir
 192                         if (all.getProperty(WORK_DIR_PROPERTY) == null) {
 193                                 workDir = new File(rootProps.getProperty(WORK_DIR_PROPERTY,
 194                                                 rootDir.getAbsolutePath() + "/../work"))
 195                                                 .getCanonicalFile();
 196                                 all.setProperty(WORK_DIR_PROPERTY, workDir.getAbsolutePath());
 197                         } else {
 198                                 workDir = new File(all.getProperty(WORK_DIR_PROPERTY))
 199                                                 .getCanonicalFile();
 200                         }
 201
 202                         // Properties from the conf dir files
 203                         Properties properties = new Properties();
 204                         StringTokenizer st = new StringTokenizer(rootProps.getProperty(
 205                                         PROPERTY_FILE_NAMES_PROPERTY, "slc.properties"), ",");
 206                         while (st.hasMoreTokens()) {
 207                                 String fileName = st.nextToken();
 208                                 properties.putAll(loadFile(confDir.getAbsolutePath()
 209                                                 + File.separator + fileName));
 210                         }
 211
 212                         for (Object o : properties.keySet()) {
 213                                 String key = o.toString();
 214                                 if (all.getProperty(key) == null) {// not already set
 215                                         all.setProperty(key, properties.getProperty(key));
 216                                 }
 217                         }
 218
 219                         // Default application context
 220                         if (all.getProperty(APPLICATION_CONTEXT_PROPERTY) == null) {
 221                                 all.setProperty(APPLICATION_CONTEXT_PROPERTY, confDir
 222                                                 .getAbsolutePath()
 223                                                 + "/applicationContext.xml");
 224                         }
 225                         // Default test run
 226                         if (all.getProperty(DEFAULT_TEST_RUN_PROPERTY) == null) {
 227                                 all.setProperty(DEFAULT_TEST_RUN_PROPERTY, "defaultTestRun");
 228                         }
 229
 230                         // Default log4j
 231                         if (all.getProperty("log4j.configuration") == null) {
 232                                 System.setProperty("log4j.configuration", confDir
 233                                                 .getCanonicalPath()
 234                                                 + File.separator + "log4j.properties");
 235                                 // TODO: fix dependency to log4j
 236                                 Log4jConfigurer.initLogging(confDir.getCanonicalPath()
 237                                                 + File.separator + "log4j.properties");
 238                         }
 239
 240                         return all;
 241                 } catch (Exception e) {
 242                         throw new SlcAntException("Unexpected exception while configuring",
 243                                         e);
 244                 }
 245         }
 246
 247         /** Loads the content of a file as <code>Properties</code>. */
 248         private Properties loadFile(String path) {
 249                 Properties p = new Properties();
 250                 try {
 251                         FileInputStream in = new FileInputStream(path);
 252                         p.load(in);
 253                         in.close();
 254                 } catch (IOException e) {
 255                         throw new SlcAntException("Cannot read SLC root file", e);
 256                 }
 257                 return p;
 258         }
 259
 260         /**
 261          * Looks for a file named {@link #getSlcLocalFileName()} in the directory,
 262          * loads it as properties file and return the value of the property
 263          * {@link #DIR_DESCRIPTION_PROPERTY}.
 264          */
 265         public String getDescriptionForDir(File dir) {
 266                 String description = dir.getName();
 267                 File slcLocal = new File(dir.getPath() + File.separator
 268                                 + getSlcLocalFileName());
 269                 if (slcLocal.exists()) {
 270                         Properties properties = loadFile(slcLocal.getAbsolutePath());
 271                         description = properties.getProperty(
 272                                         SlcAntConfig.DIR_DESCRIPTION_PROPERTY, description);
 273                 }
 274                 return description;
 275         }
 276
 277         /**
 278          * Recursively scans directories downwards until it find a file names as
 279          * defined by {@link #getSlcRootFileName()}.
 280          */
 281         public File findSlcRootFile(File dir) {
 282                 for (File file : dir.listFiles()) {
 283                         if (!file.isDirectory()
 284                                         && file.getName().equals(getSlcRootFileName())) {
 285                                 return file;
 286                         }
 287                 }
 288
 289                 File parentDir = dir.getParentFile();
 290                 if (parentDir == null) {
 291                         return null;// stop condition: not found
 292                 } else {
 293                         return findSlcRootFile(parentDir);
 294                 }
 295         }
 296
 297         /**
 298          * Gets the file name of the file marking the root directory, default being
 299          * <i>slcRoot.properties</i>.
 300          */
 301         public String getSlcRootFileName() {
 302                 return slcRootFileName;
 303         }
 304
 305         /** Sets the file name of the file marking the root directory. */
 306         public void setSlcRootFileName(String slcRootFileName) {
 307                 this.slcRootFileName = slcRootFileName;
 308         }
 309
 310         /**
 311          * Gets the file name of the file containing directory specific properties,
 312          * default being <i>slcLocal.properties</i>.
 313          */
 314         public String getSlcLocalFileName() {
 315                 return slcLocalFileName;
 316         }
 317
 318         /** Sets the file name of the file containing directory specific properties. */
 319         public void setSlcLocalFileName(String slcLocalFileName) {
 320                 this.slcLocalFileName = slcLocalFileName;
 321         }
 322
 323 }