ladle 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.2.0
+=====
+
+- Support custom schemas.
+
 0.1.1
 =====
 

data/CUSTOM-SCHEMA.md

@@ -0,0 +1,61 @@
+Custom Schemas in Ladle
+=======================
+
+If you need to use LDAP classes other the standard ones, you'll need
+to define and include a custom schema.  There are three steps in this
+process:
+
+Create or obtain the schema in openldap format
+----------------------------------------------
+
+All the details are there in the step name.
+
+Generate the java representation of the schema
+----------------------------------------------
+
+The embedded LDAP server in ladle is ApacheDS 1.0.2.  That project
+provides [documentation][ds-custom] of how to build custom schemas;
+look at the section titled "Creating a Maven module for your custom
+schema."  As you might guess from the title, you'll need [maven
+2][mvn] to do this.
+
+The process has one snag -- after you generate the schema using
+`apacheds-schema-archetype.sh`, you'll need to modify the generated
+`pom.xml`.  Under the this code:
+
+    <plugins>
+      <plugin>
+        <groupId>org.apache.directory.server</groupId>
+        <artifactId>apacheds-core-plugin</artifactId>
+
+Add the line:
+
+        <version>1.0.2</version>
+
+Then continue with the directions.
+
+[ds-custom]: http://directory.apache.org/apacheds/1.0/custom-schema.html.
+[mvn]: http://maven.apache.org/
+
+Configure ladle to use the custom schema
+----------------------------------------
+
+At the end of the java schema generation step, you'll have a jar file
+under `target` containing several classes representing the the schema.
+Put that jar somewhere in your project, then configure the
+{Ladle::Server} instance to point to it:
+
+    Ladle::Server.new(
+      :additional_classpath => %w(path/to/sample-schema-1.0-SNAPSHOT.jar),
+      :custom_schemas => %w(com.example.schema.TestSchema),
+      :ldif => "path/to/schema-using.ldif",
+      :domain => "dc=example,dc=com"
+    )
+
+The custom schema classname is derived from the first argument you
+passed to `apacheds-schema-archtype.sh` and the name of your schema
+file.  In the example above, it's as if you ran
+
+    apacheds-schema-archetype.sh com.example.schema sample-schema
+
+And then named the schema file `test.schema`.

data/README.md

@@ -111,6 +111,13 @@ restriction of the data to a single domain.)
 
 [rfc2849]: http://tools.ietf.org/rfc/rfc2849.txt
 
+Additional classes
+------------------
+
+If you need to use LDAP classes that are not among the standard set
+provided by ApacheDS, you'll need to specify a custom schema.  See
+{file:CUSTOM-SCHEMA.md} for details.
+
 Project links
 -------------
 

data/lib/ladle/java/net/detailedbalance/ladle/Main.java

@@ -16,6 +16,9 @@ import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.PrintWriter;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
 
 /**
  * The executable front-end to {@link Server}.  Uses stdin/stdout as a control channel, with
@@ -42,6 +45,14 @@ public class Main {
                 new File(commandLine.getOptionValue("l")),
                 new File(commandLine.getOptionValue('t')),
                 !commandLine.hasOption('A'));
+            if (commandLine.hasOption('S')) {
+                List<String> schemaClassNames = Arrays.asList(commandLine.getOptionValue('S').split(","));
+                List<Class<?>> schemaClasses = new ArrayList<Class<?>>(schemaClassNames.size());
+                for (String schemaClassName : schemaClassNames) {
+                    schemaClasses.add(Class.forName(schemaClassName));
+                }
+                s.setCustomSchemas(schemaClasses);
+            }
 
             Runtime.getRuntime().addShutdownHook(new Thread(new Runnable() {
                 public void run() {
@@ -115,6 +126,10 @@ public class Main {
                 withLongOpt("no-anonymous").
                 withDescription("Disable anonymous access").
                 create('A'))
+            .addOption(OptionBuilder.
+                withLongOpt("custom-schemas").hasArg().
+                withDescription("Specify one or more custom schemas (comma-separated)").
+                create('S'))
             ;
         CommandLineParser parser = new GnuParser();
 

data/lib/ladle/java/net/detailedbalance/ladle/Server.java

@@ -5,6 +5,7 @@ import org.apache.directory.server.configuration.MutableServerStartupConfigurati
 import org.apache.directory.server.core.configuration.Configuration;
 import org.apache.directory.server.core.configuration.MutablePartitionConfiguration;
 import org.apache.directory.server.core.configuration.ShutdownConfiguration;
+import org.apache.directory.server.core.schema.bootstrap.BootstrapSchema;
 import org.apache.log4j.Logger;
 
 import javax.naming.Context;
@@ -16,6 +17,7 @@ import javax.naming.directory.BasicAttributes;
 import javax.naming.directory.InitialDirContext;
 import java.io.File;
 import java.io.IOException;
+import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Hashtable;
@@ -39,6 +41,7 @@ public class Server {
     private final File tempDir;
     private final File ldifDir;
     private boolean running = false;
+    private Collection<Class<?>> customSchemas = Collections.emptyList();
 
     public Server(
         int port, String domainComponent, File ldifFile, File tempDirBase, boolean allowAnonymous
@@ -93,6 +96,7 @@ public class Server {
 
     ////// RUNNING
 
+    @SuppressWarnings({"unchecked"})
     public void start() {
         if (running) return;
 
@@ -107,10 +111,21 @@ public class Server {
             cfg.setShutdownHookEnabled(false);
             cfg.setContextPartitionConfigurations(
                 Collections.singleton(createPartitionConfiguration()));
+            if (!customSchemas.isEmpty()) {
+                Set<BootstrapSchema> schemas = cfg.getBootstrapSchemas();
+                for (Class<?> customSchemaClass : customSchemas) {
+                    schemas.add((BootstrapSchema) customSchemaClass.newInstance());
+                }
+                cfg.setBootstrapSchemas(schemas);
+            }
 
             new InitialDirContext(createJndiEnvironment(cfg));
         } catch (NamingException e) {
             throw new LadleFatalException("Startup failed", e);
+        } catch (InstantiationException e) {
+            throw new LadleFatalException("Custom schema not initializable", e);
+        } catch (IllegalAccessException e) {
+            throw new LadleFatalException("Custom schema not initializable", e);
         }
 
         running = true;
@@ -171,4 +186,8 @@ public class Server {
             }
         }
     }
+
+    public void setCustomSchemas(Collection<Class<?>> customSchemas) {
+        this.customSchemas = customSchemas;
+    }
 }

data/lib/ladle/server.rb

@@ -38,6 +38,17 @@ module Ladle
     # @return [String]
     attr_reader :java_bin
 
+    ##
+    # Any custom schemas to use with the server.
+    # @return [Array<String>]
+    attr_reader :custom_schemas
+
+    ##
+    # Any additional entries to add to the classpath for the server,
+    # e.g., jars containing custom schemas.
+    # @return [Array<String>]
+    attr_reader :additional_classpath
+
     ##
     # @param [Hash] opts the options for the server
     # @option opts [Fixnum] :port (3897) The port to serve from.
@@ -75,6 +86,9 @@ module Ladle
       @tmpdir = opts[:tmpdir] || ENV['TMPDIR'] || ENV['TEMPDIR']
       @java_bin = opts[:java_bin] ||
         (ENV['JAVA_HOME'] ? File.join(ENV['JAVA_HOME'], "bin", "java") : "java")
+      @custom_schemas = opts[:custom_schemas] ? [*opts[:custom_schemas]] : []
+      @additional_classpath =
+        opts[:additional_classpath] ? [*opts[:additional_classpath]] : []
 
       # Additional arguments that can be passed to the java server
       # process.  Used for testing only, so not documented.
@@ -229,8 +243,12 @@ module Ladle
         "--domain", domain,
         "--ldif", ldif,
         "--tmpdir", tmpdir,
-        ("--no-anonymous" unless allow_anonymous?)
-      ].compact + @additional_args
+        ("--no-anonymous" unless allow_anonymous?),
+        ([
+            "--custom-schemas",
+            custom_schemas.join(',')
+          ] unless custom_schemas.empty?)
+      ].flatten.compact + @additional_args
     end
 
     def classpath
@@ -238,7 +256,9 @@ module Ladle
         # ApacheDS
         Dir[File.expand_path("../apacheds/*.jar", __FILE__)] +
         # Wrapper code
-        [File.expand_path("../java", __FILE__)]
+        [File.expand_path("../java", __FILE__)] +
+        # User-specified classpath
+        additional_classpath
       ).join(':')
     end
 

data/lib/ladle/version.rb

@@ -1,5 +1,5 @@
 module Ladle
   ##
   # The current version number for Ladle.
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/ladle/animals-custom.ldif

@@ -0,0 +1,22 @@
+version: 1
+
+dn: ou=animals,dc=example,dc=net
+objectClass: top
+objectClass: organizationalUnit
+ou: animals
+
+dn: cn=Ada Aardvark,ou=animals,dc=example,dc=net
+objectClass: top
+objectClass: person
+objectClass: animal
+cn: Ada Aardvark
+sn: Aardvark
+species: Orycteropus afer
+
+dn: cn=Bob Badger,ou=animals,dc=example,dc=net
+objectClass: top
+objectClass: person
+objectClass: animal
+cn: Bob Badger
+sn: Badger
+species: Meles meles

data/spec/ladle/server_spec.rb

@@ -193,6 +193,38 @@ describe Ladle, "::Server" do
         Ladle::Server.new(:allow_anonymous => false).allow_anonymous?.should be_false
       end
     end
+
+    describe ":custom_schemas" do
+      it "defaults to an empty list" do
+        Ladle::Server.new.custom_schemas.should == []
+      end
+
+      it "can be set from one class name" do
+        Ladle::Server.new(:custom_schemas => "net.example.HappySchema").
+          custom_schemas.should == %w(net.example.HappySchema)
+      end
+
+      it "can be set from a list" do
+        Ladle::Server.new(:custom_schemas => ["net.example.HappySchema", "net.example.SadSchema"]).
+          custom_schemas.should == %w(net.example.HappySchema net.example.SadSchema)
+      end
+    end
+
+    describe ":additional_classpath" do
+      it "defaults to an empty list" do
+        Ladle::Server.new.additional_classpath.should == []
+      end
+
+      it "can be set from one entry" do
+        Ladle::Server.new(:additional_classpath => "foo").
+          additional_classpath.should == %w(foo)
+      end
+
+      it "can be set from a list" do
+        Ladle::Server.new(:additional_classpath => ["bar", "baz"]).
+          additional_classpath.should == %w(bar baz)
+      end
+    end
   end
 
   describe "running" do
@@ -323,6 +355,22 @@ describe Ladle, "::Server" do
             collect { |result| result[:givenname].first }.sort.should == %w(Ada Bob)
         end
       end
+
+      describe "with a custom schema" do
+        before do
+          @server = create_server(
+            :ldif => File.expand_path("../animals-custom.ldif", __FILE__),
+            :domain => "dc=example,dc=net",
+            :custom_schemas => %w(net.detailedbalance.ladle.test.AnimalSchema),
+            :additional_classpath => File.expand_path("../animal-schema.jar", __FILE__)
+          )
+        end
+
+        it "has the data defined in the schema" do
+          ldap_search(Net::LDAP::Filter.pres('species'), 'dc=example,dc=net').
+            collect { |r| r[:species].first }.sort.should == ["Meles meles", "Orycteropus afer"]
+        end
+      end
     end
 
     describe "binding" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ladle
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rhett Sutphin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 -05:00
+date: 2010-10-29 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -166,11 +166,14 @@ files:
 - lib/ladle/server.rb
 - lib/ladle/version.rb
 - lib/ladle.rb
+- spec/ladle/animal-schema.jar
+- spec/ladle/animals-custom.ldif
 - spec/ladle/animals.ldif
 - spec/ladle/server_spec.rb
 - spec/ladle/version_spec.rb
 - spec/spec_helper.rb
 - CHANGELOG.md
+- CUSTOM-SCHEMA.md
 - README.md
 - ASL20-LICENSE
 - LICENSE
@@ -210,6 +213,8 @@ signing_key:
 specification_version: 3
 summary: Dishes out steaming helpings of LDAP for fluid testing
 test_files: 
+- spec/ladle/animal-schema.jar
+- spec/ladle/animals-custom.ldif
 - spec/ladle/animals.ldif
 - spec/ladle/server_spec.rb
 - spec/ladle/version_spec.rb