Subject: [picocontainer-scm] [2318] java/nanocontainer-sandbox/trunk: http://jira.codehaus.org/browse/NANOSANDBOX-7 by Michael Rimov applied - msg#00209

http://jira.codehaus.org/browse/NANOSANDBOX-7 by Michael Rimov applied

• java/nanocontainer-sandbox/trunk/deployer/project.xml
• java/nanocontainer-sandbox/trunk/deployer/src/deploytest/META-INF/nanocontainer.groovy
• java/nanocontainer-sandbox/trunk/deployer/src/deploytest/foo/bar/Zap.class
• java/nanocontainer-sandbox/trunk/deployer/src/java/org/nanocontainer/tools/deployer/NanoContainerDeployer.java
• java/nanocontainer-sandbox/trunk/deployer/src/test/org/nanocontainer/tools/deployer/NanoContainerDeployerTestCase.java
• java/nanocontainer-sandbox/trunk/project.properties

• java/nanocontainer-sandbox/trunk/deployer/src/badbuildscriptdeploy.jar
• java/nanocontainer-sandbox/trunk/deployer/src/malformed-deployment.jar

--- java/nanocontainer-sandbox/trunk/deployer/project.xml	2005-08-26 02:02:06 UTC (rev 2317)
+++ java/nanocontainer-sandbox/trunk/deployer/project.xml	2005-08-26 04:54:23 UTC (rev 2318)
@@ -29,19 +29,24 @@
         </dependency>
 
         <dependency>
+            <id>antlr</id>
+            <version>2.7.5</version>
+        </dependency>
+
+        <dependency>
             <id>groovy</id>
-            <version>1.0-beta-7</version>
+            <version>1.0-jsr-03-SNAPSHOT</version>
         </dependency>
 
         <dependency>
             <id>asm</id>
-            <version>1.4.3</version>
+            <version>2.0</version>
         </dependency>
 
         <dependency>
             <groupId>asm</groupId>
             <artifactId>asm-util</artifactId>
-            <version>1.4.3</version>
+            <version>2.0</version>
         </dependency>
 
     </dependencies>

(Binary files differ)

--- java/nanocontainer-sandbox/trunk/deployer/src/deploytest/META-INF/nanocontainer.groovy	2005-08-26 02:02:06 UTC (rev 2317)
+++ java/nanocontainer-sandbox/trunk/deployer/src/deploytest/META-INF/nanocontainer.groovy	2005-08-26 04:54:23 UTC (rev 2318)
@@ -1,5 +1,5 @@
 builder = new org.nanocontainer.script.groovy.NanoContainerBuilder()
 pico = builder.container(parent:parent) {
  component(instance:'Groovy')
- component(key:'zap', class:foo.bar.Zap)
+ component(key:'zap', class:'foo.bar.Zap')
 }

(Binary files differ)

--- java/nanocontainer-sandbox/trunk/deployer/src/java/org/nanocontainer/tools/deployer/NanoContainerDeployer.java	2005-08-26 02:02:06 UTC (rev 2317)
+++ java/nanocontainer-sandbox/trunk/deployer/src/java/org/nanocontainer/tools/deployer/NanoContainerDeployer.java	2005-08-26 04:54:23 UTC (rev 2318)
@@ -14,21 +14,20 @@
  */
 package org.nanocontainer.tools.deployer;
 
+import java.io.InputStreamReader;
+import java.io.Reader;
+
 import org.apache.commons.vfs.FileObject;
 import org.apache.commons.vfs.FileSelectInfo;
 import org.apache.commons.vfs.FileSelector;
 import org.apache.commons.vfs.FileSystemException;
 import org.apache.commons.vfs.FileSystemManager;
 import org.apache.commons.vfs.impl.VFSClassLoader;
+import org.nanocontainer.integrationkit.ContainerBuilder;
 import org.nanocontainer.script.ScriptedContainerBuilderFactory;
-import org.nanocontainer.script.ScriptedContainerBuilderFactory;
-import org.nanocontainer.integrationkit.ContainerBuilder;
 import org.picocontainer.defaults.ObjectReference;
 import org.picocontainer.defaults.SimpleReference;
 
-import java.io.InputStreamReader;
-import java.io.Reader;
-
 /**
  * This class is capable of deploying an application from any kind of file system
  * supported by <a href="" VFS</a>.
@@ -83,12 +82,37 @@
  * @author Aslak Helles&oslash;y
  */
 public class NanoContainerDeployer implements Deployer {
+
+    /**
+     * VFS file system manager.
+     */
     private final FileSystemManager fileSystemManager;
 
-    public NanoContainerDeployer(FileSystemManager fileSystemManager) {
+    /**
+     * File system basename.  Defaults to 'nanocontainer'.  May be set differently
+     * for other applications.
+     */
+    private final String fileBasename;
+
+    /**
+     * Constructs a nanocontainer deployer with the specified file system manager.
+     * @param fileSystemManager A VFS FileSystemManager.
+     */
+    public NanoContainerDeployer(final FileSystemManager fileSystemManager) {
+        this(fileSystemManager,"nanocontainer");
+    }
+
+    /**
+     * Constructs a nanocontainer deployer with the specified file system manager
+     * and specifies a 'base name' for the configuration file that will be loaded.
+     * @param fileSystemManager A VFS FileSystemManager.
+     */
+    public NanoContainerDeployer(final FileSystemManager fileSystemManager, String baseFileName) {
         this.fileSystemManager = fileSystemManager;
+        fileBasename = baseFileName;
     }
 
+
     /**
      * Deploys an application.
      *
@@ -110,6 +134,11 @@
         Reader scriptReader = new InputStreamReader(deploymentScript.getContent().getInputStream());
         String builderClassName = ScriptedContainerBuilderFactory.getBuilderClassName(extension);
 
+        if (builderClassName == null) {
+          throw new FileSystemException("Could not find a suitable builder for: " + deploymentScript.getName()
+              + ".  Known extensions are: [groovy|bsh|js|py|xml]");
+        }
+
         ScriptedContainerBuilderFactory scriptedContainerBuilderFactory = new ScriptedContainerBuilderFactory(scriptReader, builderClassName, applicationClassLoader);
         ContainerBuilder builder = scriptedContainerBuilderFactory.getContainerBuilder();
         builder.buildContainer(result, parentContainerRef, null, true);
@@ -117,22 +146,56 @@
         return result;
     }
 
+    /**
+     * Given the base application folder, return a file object that represents the
+     * nanocontainer configuration script.
+     * @param applicationFolder FileObject
+     * @return FileObject
+     * @throws FileSystemException
+     */
     private FileObject getDeploymentScript(FileObject applicationFolder) throws FileSystemException {
         final FileObject metaInf = applicationFolder.getChild("META-INF");
         if(metaInf == null) {
             throw new FileSystemException("Missing META-INF folder in " + applicationFolder.getName().getPath());
         }
         final FileObject[] nanocontainerScripts = metaInf.findFiles(new FileSelector(){
+
             public boolean includeFile(FileSelectInfo fileSelectInfo) throws Exception {
-                return fileSelectInfo.getFile().getName().getBaseName().startsWith("nanocontainer");
+                return fileSelectInfo.getFile().getName().getBaseName().startsWith(getFileBasename());
             }
+
             public boolean traverseDescendents(FileSelectInfo fileSelectInfo) throws Exception {
+              //
+              //nanocontainer.* can easily be deep inside a directory tree and
+              //we end up not picking up our desired script.
+              //
+              if (fileSelectInfo.getDepth() > 1) {
+                return false;
+              } else {
                 return true;
+              }
             }
         });
+
         if(nanocontainerScripts == null || nanocontainerScripts.length < 1) {
-            throw new FileSystemException("No deployment script (nanocontainer.[groovy|bsh|js|py|xml]) in " + applicationFolder.getName().getPath() + "/META-INF");
+            throw new FileSystemException("No deployment script ("+ getFileBasename() +".[groovy|bsh|js|py|xml]) in " + applicationFolder.getName().getPath() + "/META-INF");
         }
-        return nanocontainerScripts[0];
+
+        if (nanocontainerScripts.length == 1) {
+          return nanocontainerScripts[0];
+        } else {
+          throw new FileSystemException("Found more than one candidate config script in : " + applicationFolder.getName().getPath() + "/META-INF."
+              + "Please only have one " + getFileBasename() + ".[groovy|bsh|js|py|xml] this directory.");
+        }
+
     }
-}
\ No newline at end of file
+
+
+    /**
+     * Retrieve the file base name.
+     * @return String
+     */
+    public String getFileBasename() {
+        return fileBasename;
+    }
+}

(Binary files differ)

--- java/nanocontainer-sandbox/trunk/deployer/src/test/org/nanocontainer/tools/deployer/NanoContainerDeployerTestCase.java	2005-08-26 02:02:06 UTC (rev 2317)
+++ java/nanocontainer-sandbox/trunk/deployer/src/test/org/nanocontainer/tools/deployer/NanoContainerDeployerTestCase.java	2005-08-26 04:54:23 UTC (rev 2318)
@@ -1,6 +1,5 @@
 package org.nanocontainer.tools.deployer;
 
-import junit.framework.TestCase;
 import org.apache.commons.vfs.FileObject;
 import org.apache.commons.vfs.FileSystemException;
 import org.apache.commons.vfs.impl.DefaultFileSystemManager;
@@ -11,10 +10,11 @@
 import org.nanocontainer.tools.deployer.NanoContainerDeployer;
 import org.picocontainer.PicoContainer;
 import org.picocontainer.defaults.ObjectReference;
+import junit.framework.TestCase;
 
+import java.net.MalformedURLException;
+import java.lang.reflect.InvocationTargetException;
 import java.io.File;
-import java.lang.reflect.InvocationTargetException;
-import java.net.MalformedURLException;
 
 /**
  * @author Aslak Hellesøy
@@ -26,16 +26,25 @@
         DefaultFileSystemManager manager = new DefaultFileSystemManager();
         FileObject applicationFolder = getApplicationFolder(manager);
 
-        Deployer deployer = new NanoContainerDeployer(manager);
-        ObjectReference containerRef = deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
-        PicoContainer pico = (PicoContainer) containerRef.get();
-        Object zap = pico.getComponentInstance("zap");
-        assertEquals("Groovy Started", zap.toString());
+        try {
+            Deployer deployer = null;
+            deployer = new NanoContainerDeployer(manager);
+            ObjectReference containerRef = deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
+            PicoContainer pico = (PicoContainer) containerRef.get();
+            Object zap = pico.getComponentInstance("zap");
+            assertEquals("Groovy Started", zap.toString());
+
+        } catch (Exception e) {
+            e.printStackTrace();  //To change body of catch statement use File | Settings | File Templates.
+        }
     }
 
+
+
+
     public void testZipWithDeploymentScriptAndClassesCanBeDeployed() throws FileSystemException, MalformedURLException, ClassNotFoundException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, InstantiationException {
         DefaultFileSystemManager manager = new DefaultFileSystemManager();
-        FileObject applicationFolder = getApplicationArchive(manager);
+        FileObject applicationFolder = getApplicationArchive(manager, "/deploytest.jar");
 
         Deployer deployer = new NanoContainerDeployer(manager);
         ObjectReference containerRef = deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
@@ -44,6 +53,36 @@
         assertEquals("Groovy Started", zap.toString());
     }
 
+    public void testZipWithBadScriptNameThrowsFileSystemException() throws ClassNotFoundException, FileSystemException {
+
+      DefaultFileSystemManager manager = new DefaultFileSystemManager();
+      FileObject applicationFolder = getApplicationArchive(manager, "/badbuildscriptdeploy.jar");
+
+      try {
+        Deployer deployer = new NanoContainerDeployer(manager);
+        ObjectReference containerRef= deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
+        fail("Deployment should have thrown FileSystemException for bad script file name.  Instead got:" + containerRef.toString() + " built.");
+      }
+      catch (FileSystemException ex) {
+        //a-ok
+      }
+    }
+
+    public void testMalformedDeployerArchiveThrowsFileSystemException() throws ClassNotFoundException, FileSystemException {
+      DefaultFileSystemManager manager = new DefaultFileSystemManager();
+      FileObject applicationFolder = getApplicationArchive(manager, "/malformed-deployment.jar");
+
+      try {
+        Deployer deployer = new NanoContainerDeployer(manager);
+        ObjectReference containerRef= deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
+        fail("Deployment should have thrown FileSystemException for badly formed archive. Instead got:" + containerRef.toString() + " built.");
+      }
+      catch (FileSystemException ex) {
+        //a-ok
+      }
+    }
+
+
     public void testZapClassCanBeLoadedByVFSClassLoader() throws FileSystemException, MalformedURLException, ClassNotFoundException {
         DefaultFileSystemManager manager = new DefaultFileSystemManager();
         FileObject applicationFolder = getApplicationFolder(manager);
@@ -51,7 +90,26 @@
         applicationClassLoader.loadClass("foo.bar.Zap");
     }
 
-    private FileObject getApplicationFolder(DefaultFileSystemManager manager) throws FileSystemException, MalformedURLException {
+    public void testSettingDifferentBaseNameWillResultInChangeForWhatBuilderLooksFor() throws FileSystemException, MalformedURLException, ClassNotFoundException {
+        DefaultFileSystemManager manager = new DefaultFileSystemManager();
+        FileObject applicationFolder = getApplicationFolder(manager);
+        NanoContainerDeployer deployer = new NanoContainerDeployer(manager);
+        assertEquals("nanocontainer", deployer.getFileBasename());
+
+        deployer = new NanoContainerDeployer(manager,"foo");
+        assertEquals("foo", deployer.getFileBasename());
+
+        try {
+            ObjectReference containerRef = deployer.deploy(applicationFolder, getClass().getClassLoader(), null);
+            fail("Deployer should have now thrown an exception after changing the base name. Instead got: " + containerRef.toString());
+        }
+        catch (FileSystemException ex) {
+            //a-ok
+        }
+
+    }
+
+    private FileObject getApplicationFolder(final DefaultFileSystemManager manager) throws FileSystemException, MalformedURLException {
         manager.setDefaultProvider(new DefaultLocalFileProvider());
         manager.init();
         File testapp = new File("src/deploytest");
@@ -63,12 +121,13 @@
         return applicationFolder;
     }
 
-    private FileObject getApplicationArchive(DefaultFileSystemManager manager) throws FileSystemException {
+    private FileObject getApplicationArchive(final DefaultFileSystemManager manager, final String jarName) throws FileSystemException {
         manager.addProvider("file", new DefaultLocalFileProvider());
         manager.addProvider("zip", new ZipFileProvider());
         manager.init();
         File src = "" File("src");
-        FileObject applicationFolder = manager.resolveFile("zip:/" + src.getAbsolutePath() + "/deploytest.jar");
+        FileObject applicationFolder = manager.resolveFile("zip:/" + src.getAbsolutePath() + jarName);
         return applicationFolder;
     }
-}
\ No newline at end of file
+
+}

--- java/nanocontainer-sandbox/trunk/project.properties	2005-08-26 02:02:06 UTC (rev 2317)
+++ java/nanocontainer-sandbox/trunk/project.properties	2005-08-26 04:54:23 UTC (rev 2318)
@@ -35,7 +35,7 @@
 maven.multiproject.aggregateDir=components/
 maven.multiproject.includes=*/project.xml
 #the following fail and therefore are excluded
-maven.multiproject.excludes=idea/project.xml,deployer/project.xml
+maven.multiproject.excludes=idea/project.xml
 maven.simian.linecount = 4
 maven.license.licenseFile=${maven.multiproject.basedir}/LICENSE.txt