treequel 1.0.0

data/spec/treequel/schema/ldapsyntax_spec.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'yaml'
+require 'ldap'
+require 'ldap/schema'
+require 'treequel/schema/ldapsyntax'
+
+
+include Treequel::TestConstants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Treequel::Schema::LDAPSyntax do
+	include Treequel::SpecHelpers
+
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	before( :each ) do
+		@schema = mock( "treequel schema object" )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	describe "parsed from the 'Boolean' syntax" do
+
+		BOOLEAN_SYNTAX = %{( 1.3.6.1.4.1.1466.115.121.1.7 DESC 'Boolean' )}
+
+		before( :each ) do
+			@syntax = Treequel::Schema::LDAPSyntax.parse( @schema, BOOLEAN_SYNTAX )
+		end
+
+		it "knows what its OID is" do
+			@syntax.oid.should == '1.3.6.1.4.1.1466.115.121.1.7'
+		end
+
+		it "knows what its DESC attribute is" do
+			@syntax.desc.should == 'Boolean'
+		end
+
+	end
+
+
+	describe "parsed from a syntax with no DESC" do
+		NODESC_SYNTAX = %{( 1.3.6.1.4.1.1466.115.121.1.14 )}
+
+		before( :each ) do
+			@syntax = Treequel::Schema::LDAPSyntax.parse( @schema, NODESC_SYNTAX )
+		end
+
+		it "knows what its OID is" do
+			@syntax.oid.should == '1.3.6.1.4.1.1466.115.121.1.14'
+		end
+
+		it "knows that it doesn't have a DESC attribute" do
+			@syntax.desc.should be_nil()
+		end
+	end
+
+end
+
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/schema/matchingrule_spec.rb

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'yaml'
+require 'ldap'
+require 'ldap/schema'
+require 'treequel/schema/matchingrule'
+
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Treequel::Schema::MatchingRule do
+	include Treequel::SpecHelpers
+
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@datadir = Pathname( __FILE__ ).dirname.parent.parent + 'data'
+	end
+
+	before( :each ) do
+		@schema = mock( "treequel schema object" )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	describe "parsed from the 'octetStringMatch' matchingRule" do
+
+		OCTETSTRINGMATCH_RULE = %{( 2.5.13.17 NAME 'octetStringMatch' SYNTAX 1.3.6.1.4.1.1466.115.121.1.40 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, OCTETSTRINGMATCH_RULE )
+		end
+
+		it "knows what OID corresponds to the type" do
+			@rule.oid.should == '2.5.13.17'
+		end
+
+		it "knows what its NAME attribute is" do
+			@rule.name.should == :octetStringMatch
+		end
+
+		it "knows what its SYNTAX OID is" do
+			@rule.syntax_oid.should == '1.3.6.1.4.1.1466.115.121.1.40'
+		end
+
+		it "knows what its syntax is" do
+			@schema.should_receive( :ldap_syntaxes ).
+				and_return({ '1.3.6.1.4.1.1466.115.121.1.40' => :the_syntax })
+			@rule.syntax.should == :the_syntax
+		end
+
+		it "knows that it is not obsolete" do
+			@rule.should_not be_obsolete()
+		end
+
+	end
+
+	describe "parsed from an matchingRule that has a DESC attribute" do
+
+		DESCRIBED_RULE = %{( 9.9.9.9.9 DESC 'Hot dog propulsion device' SYNTAX 9.9.9.9.9.9 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, DESCRIBED_RULE )
+		end
+
+		it "knows what its DESC attribute" do
+			@rule.desc.should == 'Hot dog propulsion device'
+		end
+
+	end
+
+	describe "parsed from an matchingRule that doesn't have a NAME attribute" do
+
+		ANONYMOUS_RULE = %{( 9.9.9.9.9 SYNTAX 9.9.9.9.9.9 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, ANONYMOUS_RULE )
+		end
+
+		it "knows that its NAME is nil" do
+			@rule.name.should be_nil()
+		end
+
+	end
+
+	describe "parsed from an matchingRule that has a list as the value of its NAME attribute" do
+
+		MULTINAME_MATCHINGRULE = %{( 1.1.1.1 NAME ('firstname' 'secondname') SYNTAX 9.9.9.9.9.9 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, MULTINAME_MATCHINGRULE )
+		end
+
+		it "knows what both names are" do
+			@rule.names.should have(2).members
+			@rule.names.should include( :firstname, :secondname )
+		end
+
+		it "returns the first of its names for the #name method" do
+			@rule.name.should == :firstname
+		end
+
+	end
+
+	describe "parsed from an matchingRule that has escaped characters in its DESC attribute" do
+
+		ESCAPED_DESC_MATCHINGRULE = %{( 1.1.1.1 DESC } +
+			%{'This spec\\27s example, which includes a \\5c character.' SYNTAX 9.9.9.9.9.9 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, ESCAPED_DESC_MATCHINGRULE )
+		end
+
+		it "unscapes the escaped characters" do
+			@rule.desc.should == %{This spec's example, which includes a \\ character.}
+		end
+
+	end
+
+	describe "parsed from an matchingRule that has the OBSOLETE attribute" do
+
+		OBSOLETE_MATCHINGRULE = %{( 1.1.1.1 OBSOLETE SYNTAX 9.9.9.9.9.9 )}
+
+		before( :each ) do
+			@rule = Treequel::Schema::MatchingRule.parse( @schema, OBSOLETE_MATCHINGRULE )
+		end
+
+		it "knows that it's obsolete" do
+			@rule.should be_obsolete()
+		end
+
+	end
+
+end
+
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/schema/matchingruleuse_spec.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'yaml'
+require 'ldap'
+require 'ldap/schema'
+require 'treequel/schema/matchingruleuse'
+
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Treequel::Schema::MatchingRuleUse do
+	include Treequel::SpecHelpers
+
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@datadir = Pathname( __FILE__ ).dirname.parent.parent + 'data'
+	end
+
+	before( :each ) do
+		@schema = mock( "treequel schema object" )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	describe "parsed from the 'uniqueMemberMatch' matchingRuleUse" do
+
+		UNIQUE_MEMBER_MATCH_DESC = %{( 2.5.13.23 NAME 'uniqueMemberMatch' APPLIES uniqueMember )}
+
+		before( :each ) do
+			@ruleuse = Treequel::Schema::MatchingRuleUse.parse( @schema, UNIQUE_MEMBER_MATCH_DESC )
+		end
+
+		it "knows what its OID is" do
+			@ruleuse.oid.should == '2.5.13.23'
+		end
+
+		it "knows what its NAME attribute is" do
+			@ruleuse.name.should == :uniqueMemberMatch
+		end
+
+		it "knows that it is not obsolete" do
+			@ruleuse.should_not be_obsolete()
+		end
+
+		it "knows what the OIDs of the attribute types it applies to are" do
+			@ruleuse.attr_oids.should == [:uniqueMember]
+		end
+
+		it "knows what Treequel::Schema::AttributeType objects it applies to are" do
+			@schema.should_receive( :attribute_types ).
+				and_return({ :uniqueMember => :a_attrtype_object })
+			@ruleuse.attribute_types.should == [ :a_attrtype_object ]
+		end
+	end
+
+
+	describe "parsed from a matchingRuleUse with a DESC attribute" do
+		DESCRIPTIVE_MATCHRULEUSE_DESC = %{( 9.9.9.9.9 DESC 'Woop' APPLIES uniqueMember )}
+
+		before( :each ) do
+			@ruleuse = Treequel::Schema::MatchingRuleUse.parse( @schema, DESCRIPTIVE_MATCHRULEUSE_DESC )
+		end
+
+		it "knows what its description is" do
+			@ruleuse.desc.should == "Woop"
+		end
+
+	end
+
+
+	describe "parsed from a matchingRuleUse with more than one applicable attribute type" do
+		PHONENUMBER_MATCHRULEUSE_DESC = %{( 2.5.13.20 NAME 'telephoneNumberMatch' APPLIES } +
+			%{( telephoneNumber $ homePhone $ mobile $ pager ) )}
+
+		before( :each ) do
+			@ruleuse = Treequel::Schema::MatchingRuleUse.parse( @schema, PHONENUMBER_MATCHRULEUSE_DESC )
+		end
+
+		it "knows what the OIDs of the attribute types it applies to are" do
+			@ruleuse.attr_oids.should have(4).members
+			@ruleuse.attr_oids.should include( :telephoneNumber, :homePhone, :mobile, :pager )
+		end
+
+		it "knows what Treequel::Schema::AttributeType objects it applies to are" do
+			oidmap = {
+				:telephoneNumber => :phone_number_attr,
+				:homePhone => :home_phone_attr,
+				:mobile => :mobile_attr,
+				:pager => :pager_attr,
+			}
+			@schema.should_receive( :attribute_types ).at_least( 4 ).times.
+				and_return( oidmap )
+			@ruleuse.attribute_types.should have(4).members
+			@ruleuse.attribute_types.should include( *oidmap.values )
+		end
+	end
+
+
+	describe "parsed from a matchingRuleUse that is marked as OBSOLETE" do
+		OBSOLETE_MATCHRULEUSE_DESC = %{( 9.9.9.9.9 OBSOLETE APPLIES uniqueMember )}
+
+		before( :each ) do
+			@ruleuse = Treequel::Schema::MatchingRuleUse.parse( @schema, OBSOLETE_MATCHRULEUSE_DESC )
+		end
+
+		it "knows that it's obsolete" do
+			@ruleuse.should be_obsolete()
+		end
+
+	end
+
+end
+
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/schema/objectclass_spec.rb

@@ -0,0 +1,262 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+begin
+	require 'spec'
+	require 'spec/lib/constants'
+	require 'spec/lib/helpers'
+
+	require 'yaml'
+	require 'ldap'
+	require 'ldap/schema'
+	require 'treequel/schema/objectclass'
+	require 'treequel/schema/attributetype'
+rescue LoadError
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+
+describe Treequel::Schema::ObjectClass do
+	include Treequel::SpecHelpers
+
+
+	before( :all ) do
+		setup_logging( :fatal )
+		@datadir = Pathname( __FILE__ ).dirname.parent.parent + 'data'
+	end
+
+	before( :each ) do
+		@schema = mock( "Treequel schema" )
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	describe "parsed from the 'top' objectClass" do
+
+		TOP_OBJECTCLASS = %{( 2.5.6.0 NAME 'top' DESC 'top of the superclass chain' ABSTRACT } +
+			%{MUST objectClass )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, TOP_OBJECTCLASS )
+		end
+
+		it "is an AbstractObjectClass because its 'kind' is 'ABSTRACT'" do
+			@oc.should be_an_instance_of( Treequel::Schema::AbstractObjectClass )
+		end
+
+		it "knows what OID corresponds to the class" do
+			@oc.oid.should == '2.5.6.0'
+		end
+
+		it "knows what its NAME attribute is" do
+			@oc.name.should == :top
+		end
+
+		it "knows what its DESC attribute is" do
+			@oc.desc.should == 'top of the superclass chain'
+		end
+
+		it "knows that it has one MUST attribute" do
+			@oc.must_oids.should have( 1 ).member
+			@oc.must_oids.should == [ :objectClass ]
+		end
+
+		it "returns attribute objects for its MUST OIDs" do
+			@schema.should_receive( :attribute_types ).at_least( :once ).
+				and_return({ :objectClass => :attribute_type })
+
+			@oc.must.should have( 1 ).member
+			@oc.must.should == [ :attribute_type ]
+		end
+
+		it "returns attribute objects for its MAY OIDs" do
+			@schema.should_receive( :attribute_types ).at_least( :once ).
+				and_return({ :objectClass => :attribute_type })
+
+			@oc.must.should have( 1 ).member
+			@oc.must.should == [ :attribute_type ]
+		end
+
+		it "knows that it doesn't have any MAY attributes" do
+			@oc.may_oids.should be_empty()
+		end
+
+		it "knows that it is not obsolete" do
+			@oc.should_not be_obsolete()
+		end
+
+		it "knows that it doesn't have a superclass" do
+			@oc.sup.should be_nil()
+		end
+
+	end
+
+
+	describe "parsed from the 'organizationalUnit' objectClass" do
+
+		OU_OBJECTCLASS = %{( 2.5.6.5 NAME 'organizationalUnit' } +
+			%{DESC 'RFC2256: an organizational unit' SUP top STRUCTURAL } +
+			%{MUST ou MAY ( userPassword $ searchGuide $ seeAlso $ } +
+			%{businessCategory $ x121Address $ registeredAddress $ } +
+			%{destinationIndicator $ preferredDeliveryMethod $ telexNumber $ } +
+			%{teletexTerminalIdentifier $ telephoneNumber $ internationaliSDNNumber $ } +
+			%{facsimileTelephoneNumber $ street $ postOfficeBox $ postalCode $ postalAddress $ } +
+			%{physicalDeliveryOfficeName $ st $ l $ description ) )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, OU_OBJECTCLASS )
+		end
+
+		it "is a StructuralObjectClass because its kind is 'STRUCTURAL'" do
+			@oc.should be_an_instance_of( Treequel::Schema::StructuralObjectClass )
+		end
+
+		it "knows what OID corresponds to the class" do
+			@oc.oid.should == '2.5.6.5'
+		end
+
+		it "knows what its NAME attribute is" do
+			@oc.name.should == :organizationalUnit
+		end
+
+		it "knows what its DESC attribute is" do
+			@oc.desc.should == 'RFC2256: an organizational unit'
+		end
+
+		it "knows that it has one MUST attribute" do
+			@oc.must_oids.should have( 1 ).member
+			@oc.must_oids.should == [ :ou ]
+		end
+
+		it "knows what its MAY attributes are" do
+			@oc.may_oids.should have( 21 ).members
+        	@oc.may_oids.should include( :userPassword, :searchGuide, :seeAlso, :businessCategory,
+	        	:x121Address, :registeredAddress, :destinationIndicator, :preferredDeliveryMethod,
+	        	:telexNumber, :teletexTerminalIdentifier, :telephoneNumber, :internationaliSDNNumber,
+	        	:facsimileTelephoneNumber, :street, :postOfficeBox, :postalCode, :postalAddress,
+	        	:physicalDeliveryOfficeName, :st, :l, :description )
+		end
+
+	end
+
+
+	describe "parsed from an objectClass that doesn't specify an explicit KIND attribute" do
+
+		KINDLESS_OBJECTCLASS = %{( 1.1.1.1 )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, KINDLESS_OBJECTCLASS )
+		end
+
+		it "is the default kind (STRUCTURAL)" do
+			@oc.should be_an_instance_of( Treequel::Schema::StructuralObjectClass )
+		end
+
+	end
+
+	describe "parsed from an objectClass that has a list as the value of its NAME attribute" do
+
+		MULTINAME_OBJECTCLASS = %{( 1.1.1.1 NAME ('firstname' 'secondname') )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, MULTINAME_OBJECTCLASS )
+		end
+
+		it "knows what both names are" do
+			@oc.names.should have(2).members
+			@oc.names.should include( :firstname, :secondname )
+		end
+
+		it "returns the first of its names for the #name method" do
+			@oc.name.should == :firstname
+		end
+
+	end
+
+	describe "parsed from an objectClass that has escaped characters in its DESC attribute" do
+
+		ESCAPED_DESC_OBJECTCLASS = %{( 1.1.1.1 DESC } +
+			%{'This spec\\27s example, which includes a \\5c character.' )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, ESCAPED_DESC_OBJECTCLASS )
+		end
+
+		it "unscapes the escaped characters" do
+			@oc.desc.should == %{This spec's example, which includes a \\ character.}
+		end
+
+	end
+
+	describe "parsed from an objectClass that has the OBSOLETE attribute" do
+
+		OBSOLETE_OBJECTCLASS = %{( 1.1.1.1 OBSOLETE )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, OBSOLETE_OBJECTCLASS )
+		end
+
+		it "knows that it's obsolete" do
+			@oc.should be_obsolete()
+		end
+
+	end
+
+	describe "parsed from an objectClass that has organizationalPerson as its SUP" do
+
+		SUB_OBJECTCLASS = %{( 1.1.1.1 SUP organizationalPerson )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, SUB_OBJECTCLASS )
+		end
+
+		it "returns the corresponding objectClass from its schema" do
+			@schema.should_receive( :object_classes ).
+				and_return({ :organizationalPerson => :organizationalPerson_objectclass })
+			@oc.sup.should == :organizationalPerson_objectclass
+		end
+
+	end
+
+	describe "parsed from an objectClass that has no explicit SUP" do
+
+		ORPHAN_OBJECTCLASS = %{( 1.1.1.1 )}
+
+		before( :each ) do
+			@oc = Treequel::Schema::ObjectClass.parse( @schema, ORPHAN_OBJECTCLASS )
+		end
+
+		it "returns the objectClass for 'top' from its schema" do
+			@schema.should_receive( :object_classes ).
+				and_return({ :top => :top_objectclass })
+			@oc.sup.should == :top_objectclass
+		end
+
+	end
+
+end
+
+
+# vim: set nosta noet ts=4 sw=4: