treequel 1.0.1 → 1.0.4

data/spec/treequel/controls/sortedresults_spec.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/env ruby
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.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 'spec/lib/control_behavior'
+
+require 'treequel'
+require 'treequel/branchset'
+require 'treequel/controls/sortedresults'
+
+include Treequel::TestConstants
+include Treequel::Constants
+
+#####################################################################
+###	C O N T E X T S
+#####################################################################
+describe Treequel::SortedResultsControl do
+	include Treequel::SpecHelpers
+
+	before( :all ) do
+		setup_logging( :fatal )
+	end
+
+	before( :each ) do
+		# Used by the shared behavior
+		@control = Treequel::SortedResultsControl
+		@branch = mock( "Branch", :dn => 'cn=example,dc=acme,dc=com' )
+		@directory = mock( "Directory" )
+
+		@branch.stub!( :directory ).and_return( @directory )
+		@directory.stub!( :registered_controls ).and_return([ Treequel::SortedResultsControl ])
+		@branchset = Treequel::Branchset.new( @branch )
+
+	end
+
+	after( :all ) do
+		reset_logging()
+	end
+
+
+	it_should_behave_like "A Treequel::Control"
+
+
+	it "adds a sort_order_criteria attribute to extended branchsets" do
+		@branchset.should respond_to( :sort_order_criteria )
+	end
+
+
+	it "can add the listed attributes as ascending sort order criteria via an #order mutator " +
+	   "with Symbol attribute names" do
+		criteria = @branchset.order( :attr1, :attr2 ).sort_order_criteria
+		criteria.should have( 2 ).members
+
+		criteria[0].type.should == 'attr1'
+		criteria[0].ordering_rule.should == nil
+		criteria[0].reverse_order.should be_false()
+
+		criteria[1].type.should == 'attr2'
+		criteria[1].ordering_rule.should == nil
+		criteria[1].reverse_order.should be_false()
+	end
+
+	it "can add the listed attributes as descending sort order criteria via an #order mutator " +
+	   "with Sequel::SQL::Expressions" do
+		pending "requires the 'sequel' library" unless Sequel.const_defined?( :Model )
+		criteria = @branchset.order( :attr1.desc ).sort_order_criteria
+
+		criteria.should have( 1 ).member
+		criteria[0].type.should == 'attr1'
+		criteria[0].ordering_rule.should == nil
+		criteria[0].reverse_order.should be_true()
+	end
+
+	it "can remove existing sort order criteria via the #order mutator with no arguments" do
+		ordered_branchset = @branchset.order( :attr1 )
+		ordered_branchset.order().sort_order_criteria.should be_empty()
+	end
+
+	it "can remove any existing sort order criteria via an #unordered mutator" do
+		ordered_branchset = @branchset.order( :attr1 )
+		ordered_branchset.unordered.sort_order_criteria.should be_empty()
+	end
+
+	it "can remove any existing sort order criteria from the receiver via the #unordered! " +
+	   "imperative method" do
+		ordered_branchset = @branchset.order( :attr1 )
+		ordered_branchset.unordered!
+		ordered_branchset.sort_order_criteria.should be_empty()
+	end
+
+	it "injects the correct server-control structure into the search when iterating" do
+		oid = Treequel::SortedResultsControl::OID
+		expected_asn1_string = "0\x060\x04\x04\x02cn"
+		expected_control = LDAP::Control.new( oid, expected_asn1_string, true )
+
+		resultbranch = mock( "Sorted result branch" )
+		resultcontrol = mock( "Sorted result control" )
+
+		@branch.should_receive( :search ).with( :subtree,
+			instance_of(Treequel::Filter),
+			{
+				:limit           => 0,
+				:selectattrs     => [],
+				:timeout         => 0,
+				:server_controls => [ expected_control ],
+				:client_controls => []
+			}
+		  ).and_yield( resultbranch )
+
+		resultbranch.should_receive( :controls ).and_return([ resultcontrol ])
+		resultcontrol.should_receive( :oid ).
+			and_return( Treequel::SortedResultsControl::RESPONSE_OID )
+		resultcontrol.should_receive( :decode ).
+			and_return([ 0, :ignored ]) # 0 == Success
+
+		@branchset.order( :cn ).each do |*args|
+			args.should == [ resultbranch ]
+		end
+	end
+
+	it "raises an exception if the server returned an error in the response control" do
+		resultbranch = mock( "Sorted result branch" )
+		resultcontrol = mock( "Sorted result control" )
+
+		@branch.should_receive( :search ).and_yield( resultbranch )
+
+		resultbranch.should_receive( :controls ).and_return([ resultcontrol ])
+		resultcontrol.should_receive( :oid ).
+			and_return( Treequel::SortedResultsControl::RESPONSE_OID )
+		resultcontrol.should_receive( :decode ).
+			and_return([ 16, :ignored ]) # 16 == 'No such attribute'
+
+		expect {
+			@branchset.order( :cn ).each {}
+		}.to raise_exception( Treequel::ControlError, /no such attribute/i )
+	end
+
+	it "doesn't add a sort control if no sort order criteria have been set" do
+		resultbranch = mock( "Result branch" )
+
+		@branch.should_receive( :search ).with( :subtree,
+			instance_of(Treequel::Filter),
+			{
+				:limit           => 0,
+				:selectattrs     => [],
+				:timeout         => 0,
+				:server_controls => [],
+				:client_controls => []
+			}
+		  ).and_yield( resultbranch )
+
+		resultbranch.should_receive( :controls ).and_return( [] )
+
+		@branchset.unordered.each do |*args|
+			args.should == [ resultbranch ]
+		end
+	end
+
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/spec/treequel/directory_spec.rb

@@ -9,20 +9,13 @@ BEGIN {
 	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
 }
 
-begin
-	require 'spec'
-	require 'spec/lib/constants'
-	require 'spec/lib/helpers'
-
-	require 'treequel/directory'
-	require 'treequel/branch'
-rescue LoadError
-	unless Object.const_defined?( :Gem )
-		require 'rubygems'
-		retry
-	end
-	raise
-end
+require 'spec'
+require 'spec/lib/constants'
+require 'spec/lib/helpers'
+
+require 'treequel/directory'
+require 'treequel/branch'
+require 'treequel/control'
 
 
 include Treequel::TestConstants
@@ -82,8 +75,8 @@ describe Treequel::Directory do
 			and_return( conn )
 		conn.should_receive( :bind ).with( TEST_BIND_DN, TEST_BIND_PASS )
 
-		dir = Treequel::Directory.new( @options.merge( :bind_dn => TEST_BIND_DN, :pass => TEST_BIND_PASS ))
-		dir.instance_variable_get( :@bound_as ).should == TEST_BIND_DN
+		dir = Treequel::Directory.new( @options.merge(:bind_dn => TEST_BIND_DN, :pass => TEST_BIND_PASS) )
+		dir.bound_user.should == TEST_BIND_DN
 	end
 
 	it "uses the first namingContext from the Root DSE if no base is specified" do
@@ -282,6 +275,48 @@ describe Treequel::Directory do
 		end
 
 
+		it "returns branches with operational attributes enabled if the base is a branch with " +
+		   "operational attributes enabled" do
+			base = TEST_PEOPLE_DN
+			filter = '(|(uid=jonlong)(uid=margento))'
+
+			branch = mock( "branch", :dn => TEST_PEOPLE_DN )
+			branch.should_receive( :respond_to? ).with( :include_operational_attrs? ).
+				at_least( :once ).
+				and_return( true )
+			branch.should_receive( :respond_to? ).with( :dn ).
+				and_return( true )
+		   	branch.stub!( :include_operational_attrs? ).and_return( true )
+
+			found_branch1 = stub( "entry1 branch" )
+			found_branch2 = stub( "entry2 branch" )
+
+			# Do the search
+			entries = [
+				{ 'dn' => ["uid=jonlong,#{TEST_PEOPLE_DN}"] },
+				{ 'dn' => ["uid=margento,#{TEST_PEOPLE_DN}"] },
+			]
+			@conn.should_receive( :search_ext2 ).
+				with( base, LDAP::LDAP_SCOPE_BASE, filter, ['*'], false, nil, nil, 0, 0, 0, '', nil ).
+				and_return( entries )
+
+			# Turn found entries into Branch objects
+			Treequel::Branch.should_receive( :new_from_entry ).with( entries[0], @dir ).
+				and_return( found_branch1 )
+			found_branch1.should_receive( :include_operational_attrs= ).with( true )
+			Treequel::Branch.should_receive( :new_from_entry ).with( entries[1], @dir ).
+				and_return( found_branch2 )
+			found_branch2.should_receive( :include_operational_attrs= ).with( true )
+
+			results = []
+			@dir.search( branch, :base, filter ) do |branch|
+				results << branch
+			end
+
+			results.should == [ found_branch1, found_branch2 ]
+		end
+
+
 		it "catches plain RuntimeErrors raised by #search2 and re-casts them as " +
 		   "more-interesting errors" do
 			@conn.should_receive( :search_ext2 ).
@@ -406,6 +441,16 @@ describe Treequel::Directory do
 			@dir.modify( branch, 'cn' => ['nomblywob'] )
 		end
 
+		it "can modify the record corresponding to a Branch in the directory via LDAP::Mods" do
+			branch = mock( "branch" )
+			branch.should_receive( :dn ).at_least( :once ).and_return( :the_branches_dn )
+			delmod = LDAP::Mod.new( LDAP::LDAP_MOD_DELETE, 'displayName', ['georgina boots'] )
+
+			@conn.should_receive( :modify ).with( :the_branches_dn, [delmod] )
+
+			@dir.modify( branch, [delmod] )
+		end
+
 		it "can delete the record corresponding to a Branch from the directory" do
 			branch = mock( "branch" )
 			branch.should_receive( :dn ).at_least( :once ).and_return( :the_branches_dn )
@@ -446,6 +491,38 @@ describe Treequel::Directory do
 		end
 
 
+		it "doesn't include duplicates when smushing RDN attributes" do
+			newattrs = {
+				TEST_PERSON_DN_ATTR => [TEST_PERSON_DN_VALUE],
+				:cn => 'Chilly T',
+				:desc => 'Audi like Jetta',
+				:objectClass => :room,
+			}
+			rdn_attrs = {
+				TEST_PERSON_DN_ATTR => [TEST_PERSON_DN_VALUE]
+			}
+			addattrs = {
+				'cn' => ['Chilly T'],
+				'desc' => ['Audi like Jetta'],
+				'objectClass' => ['room'],
+				TEST_PERSON_DN_ATTR => [TEST_PERSON_DN_VALUE],
+			}
+
+			branch = mock( "new person branch" )
+			branch.should_receive( :dn ).and_return( TEST_PERSON_DN )
+			branch.should_receive( :rdn_attributes ).at_least( :once ).and_return( rdn_attrs )
+
+			room_objectclass = stub( 'room objectClass', :structural? => true )
+			@schema.should_receive( :object_classes ).at_least( :once ).and_return({ 
+				:room => room_objectclass,
+			})
+
+			@conn.should_receive( :add ).with( TEST_PERSON_DN, addattrs )
+
+			@dir.create( branch, newattrs )
+		end
+
+
 		it "can move a record to a new dn within the same branch" do
 			@dir.stub!( :bound? ).and_return( false )
 			branch = mock( "sibling branch obj" )
@@ -480,6 +557,99 @@ describe Treequel::Directory do
 			@dir.convert_syntax_value( OIDS::BOOLEAN_SYNTAX, 'true' ).should == 'true'
 		end
 
+
+		### Controls support
+		describe "to a server that supports controls introspection" do
+			before( :each ) do
+				@control = Module.new { include Treequel::Control }
+				@conn.should_receive( :root_dse ).and_return( TEST_DSE )
+			end
+
+
+			it "allows one to fetch the list of supported controls as OIDs" do
+				@dir.supported_control_oids.should == TEST_DSE.first['supportedControl']
+			end
+
+			it "allows one to fetch the list of supported controls as control names" do
+				@dir.supported_controls.should == TEST_DSE.first['supportedControl'].
+					collect {|oid| Treequel::Constants::CONTROL_NAMES[oid] }
+			end
+
+			it "allows the registration of one or more Treequel::Control modules" do
+				@control.const_set( :OID, TEST_DSE.first['supportedControl'].first )
+				@dir.register_controls( @control )
+				@dir.registered_controls.should == [ @control ]
+			end
+
+			it "raises an exception if the directory doesn't support registered controls" do
+				@control.const_set( :OID, '8.6.7.5.309' )
+				expect {
+					@dir.register_controls( @control )
+				}.to raise_error( Treequel::UnsupportedControl, /not supported/i )
+
+				@dir.registered_controls.should == []
+			end
+
+			it "raises an exception if a registered control doesn't define an OID" do
+				expect {
+					@dir.register_controls( @control )
+				}.to raise_error( NotImplementedError, /doesn't define/i )
+			end
+		end
+
+
+		describe "to a server that supports extensions introspection" do
+			before( :each ) do
+				@conn.should_receive( :root_dse ).and_return( TEST_DSE )
+			end
+
+
+			it "allows one to fetch the list of supported extensions as OIDs" do
+				@dir.supported_extension_oids.should == TEST_DSE.first['supportedExtension']
+			end
+
+			it "allows one to fetch the list of supported extensions as extension names" do
+				@dir.supported_extensions.should == TEST_DSE.first['supportedExtension'].
+					collect {|oid| Treequel::Constants::EXTENSION_NAMES[oid] }
+			end
+
+		end
+
+
+		describe "to a server that supports features introspection" do
+			before( :each ) do
+				@conn.should_receive( :root_dse ).and_return( TEST_DSE )
+			end
+
+
+			it "allows one to fetch the list of supported features as OIDs" do
+				@dir.supported_feature_oids.should == TEST_DSE.first['supportedFeatures']
+			end
+
+			it "allows one to fetch the list of supported features as feature names" do
+				@dir.supported_features.should == TEST_DSE.first['supportedFeatures'].
+					collect {|oid| Treequel::Constants::FEATURE_NAMES[oid] }
+			end
+
+		end
+
+		describe "to a server that doesn't support features introspection" do
+			before( :each ) do
+				@conn.should_receive( :root_dse ).and_return( TEST_DSE )
+			end
+
+
+			it "allows one to fetch the list of supported features as OIDs" do
+				@dir.supported_feature_oids.should == TEST_DSE.first['supportedFeatures']
+			end
+
+			it "allows one to fetch the list of supported features as feature names" do
+				@dir.supported_features.should == TEST_DSE.first['supportedFeatures'].
+					collect {|oid| Treequel::Constants::FEATURE_NAMES[oid] }
+			end
+
+		end
+
 	end
 end
 

data/spec/treequel/mixins_spec.rb

@@ -152,6 +152,7 @@ describe Treequel, "mixin" do
 	end
 
 	describe Treequel::ArrayUtilities do
+
 		it "includes a function for stringifying Array elements" do
 			testarray = [:a, :b, :c, [:d, :e, [:f, :g]]]
 
@@ -174,10 +175,9 @@ describe Treequel, "mixin" do
 		end
 	end
 
-
 	describe Treequel::AttributeDeclarations do
 		before( :all ) do
-			setup_logging( :debug )
+			setup_logging( :fatal )
 		end
 		after( :all ) do
 			reset_logging()
@@ -216,7 +216,7 @@ describe Treequel, "mixin" do
 	describe Treequel::Delegation do
 
 		before( :all ) do
-			setup_logging( :debug )
+			setup_logging( :fatal )
 		end
 		after( :all ) do
 			reset_logging()
@@ -325,6 +325,45 @@ describe Treequel, "mixin" do
 
 	end
 
+	describe Treequel::Normalization do
+
+		describe "key normalization" do
+			it "downcases" do
+				Treequel::Normalization.normalize_key( :logonTime ).should == :logontime
+			end
+
+			it "symbolifies" do
+				Treequel::Normalization.normalize_key( 'cn' ).should == :cn
+			end
+
+			it "strips invalid characters" do
+				Treequel::Normalization.normalize_key( 'given name' ).should == :givenname
+			end
+
+			it "converts hyphens to underscores" do
+				Treequel::Normalization.normalize_key( 'apple-nickname' ).should == :apple_nickname
+			end
+		end
+
+		describe "hash normalization" do
+			it "applies key-normalization to the keys of a hash" do
+				hash = {
+					:logonTime       => 'a logon time',
+					'cn'             => 'a common name',
+					'given name'     => 'a given name',
+					'apple-nickname' => 'a nickname',
+				}
+
+				Treequel::Normalization.normalize_hash( hash ).should == {
+					:logontime      => 'a logon time',
+					:cn             => 'a common name',
+					:givenname      => 'a given name',
+					:apple_nickname => 'a nickname',
+				}
+			end
+		end
+	end
+
 end
 
 # vim: set nosta noet ts=4 sw=4: