ruby-ldap 0.9.9

data/test/search3.rb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+# This file is a part of test scripts of LDAP extension module.
+
+$test = File.dirname($0)
+require "#{$test}/conf"
+require "./ldap"
+
+$KCODE = "UTF8"
+
+conn = LDAP::Conn.new($HOST, $PORT)
+conn.perror("bind")
+conn.bind{
+  # search2 returns an array of hash
+  print("search2 without a block:\n")
+  conn.search2("dc=localhost, dc=localdomain", LDAP::LDAP_SCOPE_SUBTREE,
+	       "(objectclass=*)", nil, false, 0, 0).each{|ent|
+    ent.each{|attr,vals|
+      print("#{attr}: #{vals.join(', ')}\n")
+    }
+    print("\n")
+  }
+  GC.start()
+}

data/test/setup.rb

@@ -0,0 +1,38 @@
+# $Id: setup.rb,v 1.3 2005/03/13 10:10:56 ianmacd Exp $
+#
+# Basic set-up for performing LDAP unit tests.
+
+require 'ldap'
+require 'ldap/schema'
+require 'test/unit'
+
+class TC_LDAPTest < Test::Unit::TestCase
+
+  @@conn = nil
+
+  # Get the LDAP host and base DN from /etc/ldap.conf.
+  def setup
+    unless @@conn && @@conn.bound?
+      File.open( '/etc/ldap.conf' ) do |f|
+        while line = f.gets
+          if line =~ /^host\s+(\S+)$/
+            @@host = $1
+            break
+	  elsif line =~ /^base\s+(\S+)$/
+	    @@base = $1
+	    break
+          end
+        end
+      end
+
+      @@conn = LDAP::Conn.new( @@host )
+      @@conn.set_option( LDAP::LDAP_OPT_PROTOCOL_VERSION, 3 )
+      @@conn.bind
+      @@root_dse = @@conn.root_dse[0]
+      @@naming_context = @@root_dse['namingContexts'][0]
+    end
+  end
+
+  undef_method :default_test
+    
+end

data/test/subschema.rb

@@ -0,0 +1,21 @@
+
+$test = File.dirname($0)
+require "#{$test}/conf"
+require "./ldap"
+require "#{$test}/../lib/ldap/schema"
+
+conn = LDAP::Conn.new($HOST, $PORT)
+conn.bind{
+  schema = conn.schema()
+  p schema.must("person")
+  p schema.attr("person", "MUST")
+  p schema.may("person")
+  p schema.attr("person", "MAY")
+  p schema.sup("person")
+  p schema.attr("person", "SUP")
+  schema.each{|key,vals|
+    vals.each{|val|
+      print("#{key}: #{val}\n")
+    }
+  }
+}

data/test/tc_conn.rb

@@ -0,0 +1,124 @@
+# $Id: tc_conn.rb,v 1.3 2005/03/15 01:43:59 ianmacd Exp $
+#
+# A suite of unit tests for testing Ruby/LDAP connection functionality.
+
+require 'ldap'
+require 'test/unit'
+require './setup'
+
+class TC_ConnectionTest < TC_LDAPTest
+
+  # Ensure that rebinding works.
+  #
+  def test_rebind
+    id = @@conn.object_id
+
+    assert_nothing_raised do
+      @@conn.unbind
+      @@conn.bind
+    end
+
+    id2 = @@conn.object_id
+    assert_equal( id, id2 )
+
+    assert_nothing_raised do
+      @@conn.unbind
+      @@conn.simple_bind
+    end
+
+    id2 = @@conn.object_id
+    assert_equal( id, id2 )
+  end
+
+  def test_double_bind
+    assert_raises( LDAP::Error ) { @@conn.bind }
+    assert_raises( LDAP::Error ) { @@conn.simple_bind }
+  end
+
+  def test_double_unbind
+    assert_nothing_raised { @@conn.unbind }
+    assert_raises( LDAP::InvalidDataError ) { @@conn.unbind }
+  end
+
+  def test_bound?
+    assert( @@conn.bound? )
+    @@conn.unbind
+    assert( ! @@conn.bound? )
+  end
+
+  def test_sasl_bind
+    @@conn = LDAP::Conn.new( @@host )
+    @@conn.sasl_quiet = true
+    
+    assert_nothing_raised { @@conn.sasl_bind( '', '' ) }
+    
+    @@conn = nil
+  end
+
+  def test_double_sasl_bind
+    @@conn = LDAP::Conn.new( @@host )
+    @@conn.sasl_quiet = true
+
+    assert_nothing_raised { @@conn.sasl_bind( '', '' ) }
+    assert_raises( LDAP::Error ) { @@conn.sasl_bind( '', '' ) }
+
+    @@conn = nil
+  end
+
+  def test_sasl_rebind
+    @@conn = LDAP::Conn.new( @@host )
+    @@conn.sasl_quiet = true
+
+    id = @@conn.object_id
+
+    assert_nothing_raised do
+      @@conn.unbind
+      @@conn.sasl_bind( '', '' )
+    end
+
+    id2 = @@conn.object_id
+    assert_equal( id, id2 )
+
+    @@conn = nil
+  end
+
+  def test_ssl_rebind
+    @@conn = LDAP::SSLConn.new( @@host, LDAP::LDAPS_PORT )
+
+    id = @@conn.object_id
+
+    assert_nothing_raised do
+      @@conn.bind
+      @@conn.unbind
+      @@conn.bind
+    end
+
+    id2 = @@conn.object_id
+    assert_equal( id, id2 )
+
+    @@conn = nil
+  end
+
+  def test_ssl_open
+    assert_raises( NotImplementedError ) { LDAP::SSLConn.open( @@host ) }
+  end
+
+  def test_ssl_starttls_rebind
+    @@conn = LDAP::SSLConn.new( @@host, LDAP::LDAP_PORT, true )
+
+    id = @@conn.object_id
+
+    assert_nothing_raised do
+      @@conn.bind
+      @@conn.unbind
+      @@conn.bind
+    end
+
+    id2 = @@conn.object_id
+    assert_equal( id, id2 )
+
+    @@conn = nil
+  end
+
+
+end

data/test/tc_ldif.rb

@@ -0,0 +1,174 @@
+# $Id: tc_ldif.rb,v 1.5 2005/02/26 01:42:27 ianmacd Exp $
+#
+# A suite of unit tests for testing Ruby/LDAP LDIF functionality. 
+
+require 'ldap'
+require 'ldap/ldif'
+require 'ldap/control'
+require 'test/unit'
+
+class TC_LDIFTest < Test::Unit::TestCase
+
+  include LDAP::LDIF
+
+  def test_version_entry
+    ldif = File.open( 'data/ldif1.txt' ) { |f| f.readlines }
+    entry = nil
+    assert_nothing_raised { entry = LDAP::LDIF.parse_entry( ldif ) }
+    assert_instance_of( LDAP::Record, entry )
+    assert_instance_of( String, entry.dn )
+    assert_instance_of( Array, entry.attrs['objectclass'] )
+    assert( entry.attrs['objectclass'].length > 1 )
+  end
+
+  def test_bad_version_entry
+    ldif = File.open( 'data/ldif2.txt' ) { |f| f.readlines }
+    assert_raise( LDIFError ) { LDAP::LDIF.parse_entry( ldif ) }
+  end
+
+  def test_no_version_entry
+    ldif = File.open( 'data/ldif3.txt' ) { |f| f.readlines }
+    assert_nothing_raised { LDAP::LDIF.parse_entry( ldif ) }
+  end
+
+  def test_file
+    entries = LDAP::LDIF.parse_file( 'data/ldif4.txt' )
+    assert_instance_of( Array, entries )
+    assert_instance_of( Hash, entries[0].attrs )
+    assert_not_equal( {}, entries[0].attrs )
+  end
+
+  def test_folded_attribute_entry
+    ldif = File.open( 'data/ldif5.txt' ) { |f| f.readlines }
+    entry = nil
+    assert_nothing_raised { entry = LDAP::LDIF.parse_entry( ldif ) }
+    assert_no_match( /\n/, entry.attrs['description'][0] )
+    assert( entry.attrs['description'][0].length > LDAP::LDIF::LINE_LENGTH )
+  end
+
+  def test_base64_value_entry
+    ldif = File.open( 'data/ldif6.txt' ) { |f| f.readlines }
+    entry = LDAP::LDIF.parse_entry( ldif )
+    assert_match( /\r/, entry.attrs['description'][0] )
+  end
+
+  def test_utf8_file
+    entries = LDAP::LDIF.parse_file( 'data/ldif7.txt' )
+    assert_instance_of( Array, entries )
+    assert_instance_of( Hash, entries[0].attrs )
+    assert_not_equal( {}, entries[0].attrs )
+  end
+
+  def test_external_file_entry
+    ldif = File.open( 'data/ldif8.txt' ) { |f| f.readlines }
+    entry = LDAP::LDIF.parse_entry( ldif )
+    assert( entry.attrs['jpegphoto'][0].size > 1024 )
+  end
+
+  def test_change_records_file
+    entries = LDAP::LDIF.parse_file( 'data/ldif9.txt' )
+    assert_instance_of( Array, entries )
+    assert_instance_of( Hash, entries[0].attrs )
+    assert_not_equal( {}, entries[0].attrs )
+  end
+
+  def test_bad_line_entry
+    ldif = File.open( 'data/ldif10.txt' ) { |f| f.readlines }
+    assert_raise( LDIFError ) { LDAP::LDIF.parse_entry( ldif ) }
+  end
+
+  def test_bad_attr_entry
+    ldif = File.open( 'data/ldif11.txt' ) { |f| f.readlines }
+    assert_raise( LDIFError ) { LDAP::LDIF.parse_entry( ldif ) }
+  end
+
+  def test_change_record_binary_replace_entry
+    ldif = File.open( 'data/ldif12.txt' ) { |f| f.readlines }
+    entry = LDAP::LDIF.parse_entry( ldif )
+    assert( entry.mods.keys.include?( LDAP::LDAP_MOD_REPLACE |
+				      LDAP::LDAP_MOD_BVALUES ) )
+  end
+
+  def test_change_record_control
+    ldif = File.open( 'data/ldif13.txt' ) { |f| f.readlines }
+    entry = LDAP::LDIF.parse_entry( ldif )
+    assert_instance_of( LDAP::Control, entry.controls[0] )
+    assert_equal( entry.controls[0].oid, '1.2.840.113556.1.4.805' )
+    assert( entry.controls[0].iscritical )
+    assert_nil( entry.controls[0].value )
+  end
+
+  def test_change_record_control2
+    ldif = File.open( 'data/ldif14.txt' ) { |f| f.readlines }
+    entry = LDAP::LDIF.parse_entry( ldif )
+    assert_instance_of( LDAP::Control, entry.controls[0] )
+    assert_equal( entry.controls[0].oid, '1.2.3.4' )
+    assert_equal( entry.controls[0].iscritical, false )
+    assert_not_nil( entry.controls[0].value )
+  end
+
+  def test_mod_to_ldif
+    mod = LDAP.mod( LDAP::LDAP_MOD_ADD | LDAP::LDAP_MOD_BVALUES,
+		    'mailRoutingAddress', ['a', 'b'] )
+    assert_instance_of( LDAP::LDIF::Mod,
+		        mod.to_ldif( 'uid=foo,dc=example,dc=com' ) )
+    assert_equal( <<LDIF, mod.to_ldif( 'uid=foo,dc=example,dc=com' ) )
+dn: uid=foo,dc=example,dc=com
+changetype: add
+mailRoutingAddress: a
+mailRoutingAddress: b
+LDIF
+
+    mod = LDAP.mod( LDAP::LDAP_MOD_REPLACE | LDAP::LDAP_MOD_BVALUES,
+		    'mailRoutingAddress', ['a', 'b'] )
+    assert_equal( <<LDIF, mod.to_ldif( 'uid=foo,dc=example,dc=com' ) )
+dn: uid=foo,dc=example,dc=com
+changetype: modify
+replace: mailRoutingAddress
+mailRoutingAddress: a
+mailRoutingAddress: b
+LDIF
+
+    mod = LDAP.mod( LDAP::LDAP_MOD_DELETE, 'mailRoutingAddress', ['a', 'b'] )
+    assert_equal( <<LDIF, mod.to_ldif( 'uid=foo,dc=example,dc=com' ) )
+dn: uid=foo,dc=example,dc=com
+changetype: delete
+mailRoutingAddress: a
+mailRoutingAddress: b
+LDIF
+  end
+
+  def test_mods_to_ldif
+
+    # Try passing an array of mods to LDAP::LDIF.mods_to_ldif.
+
+    # This must be a single line for the heredoc to work.
+    assert_equal( <<LDIF, LDAP::LDIF.mods_to_ldif( 'uid=ianmacd,dc=foo', [ LDAP.mod( LDAP::LDAP_MOD_ADD | LDAP::LDAP_MOD_BVALUES, 'mailRoutingAddress', ['a', 'b'] ), LDAP.mod( LDAP::LDAP_MOD_DELETE, 'location', [ 'amsterdam'] ), LDAP.mod( LDAP::LDAP_MOD_REPLACE, 'telephonenumber', [ '+1 408 555 1234', '+1 408 555 5678' ] ), LDAP.mod( LDAP::LDAP_MOD_DELETE, 'office', [] ) ] ) )
+dn: uid=ianmacd,dc=foo
+changetype: modify
+add: mailRoutingAddress
+mailRoutingAddress: a
+mailRoutingAddress: b
+-
+delete: location
+location: amsterdam
+-
+replace: telephonenumber
+telephonenumber: +1 408 555 1234
+telephonenumber: +1 408 555 5678
+-
+delete: office
+LDIF
+
+  # Try passing a single mod to LDAP::LDIF.mods_to_ldif.
+  assert_equal( <<LDIF, LDAP::LDIF.mods_to_ldif( 'uid=ianmacd,dc=google,dc=com', LDAP.mod( LDAP::LDAP_MOD_REPLACE, 'telephonenumber', [ '+1 408 555 1234', '+1 408 555 5678' ] ) ) )
+dn: uid=ianmacd,dc=google,dc=com
+changetype: modify
+replace: telephonenumber
+telephonenumber: +1 408 555 1234
+telephonenumber: +1 408 555 5678
+LDIF
+
+  end
+
+end

data/test/tc_schema.rb

@@ -0,0 +1,32 @@
+# $Id: tc_schema.rb,v 1.4 2005/03/13 10:11:41 ianmacd Exp $
+#
+# A suite of unit tests for testing Ruby/LDAP schema functionality.
+
+require 'ldap'
+require 'ldap/schema'
+require 'test/unit'
+require './setup'
+
+class TC_SchemaTest < TC_LDAPTest
+
+  def test_schema
+    schema = @@conn.schema
+    assert_instance_of( LDAP::Schema, schema )
+    assert( schema.key?( 'attributeTypes' ) )
+    assert( schema.key?( 'ldapSyntaxes' ) )
+    assert( schema.key?( 'matchingRules' ) )
+    assert( schema.key?( 'matchingRuleUse' ) )
+    assert( schema.key?( 'objectClasses' ) )
+  end
+
+  def test_root_dse
+    root_dse = @@conn.root_dse[0]
+    assert( root_dse.key?( 'subschemaSubentry' ) )
+    assert( root_dse.key?( 'namingContexts' ) )
+    assert( root_dse.key?( 'supportedSASLMechanisms' ) )
+    assert( root_dse.key?( 'supportedControl' ) )
+    assert( root_dse.key?( 'supportedExtension' ) )
+    assert( root_dse.key?( 'supportedLDAPVersion' ) )
+  end
+    
+end

data/test/tc_search.rb

@@ -0,0 +1,137 @@
+# $Id: tc_search.rb,v 1.4 2006/02/12 19:55:59 ianmacd Exp $
+#
+# A suite of unit tests for testing Ruby/LDAP search functionality.
+
+require 'ldap'
+require 'ldap/control'
+require 'test/unit'
+require './setup'
+
+class TC_SearchTest < TC_LDAPTest
+
+  # Ensure that giving an incorrect attribute argument raises an exception
+  # and that passing a string instead of an array is treated as a single
+  # element array.
+  #
+  def test_attrs
+    assert_raise( TypeError ) do
+      @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		     '(objectClass=*)', false )
+    end
+
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(objectClass=*)', [], true ) do |x|
+      assert_nil( x['objectClass'] )
+      break
+    end
+
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(objectClass=*)', 'objectClass' ) do |x|
+      x = x.to_hash
+      x.delete( 'dn' )
+      assert( x.to_hash.keys == [ 'objectClass' ] )
+      break
+    end
+  end
+
+  # Ensure that we can sort on a given attribute.
+  #
+  def test_sort_attr
+    ou = []
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(ou=*)' ) do |x|
+      ou << x['ou']
+    end
+    ou.flatten!
+
+    sorted_ou = []
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(ou=*)', nil, nil, 0, 0, 'ou' ) do |x|
+      sorted_ou << x['ou']
+    end
+    sorted_ou.flatten!
+
+    assert_not_equal( ou, sorted_ou )
+    assert_equal( ou.sort, sorted_ou )
+  end
+
+  # Ensure that we can pass a proc object to use for sorting.
+  #
+  def test_sort_proc
+    ct = []
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(objectClass=*)', [ 'createTimestamp' ] ) do |x|
+      ct << x['createTimestamp']
+    end
+    ct.flatten!
+
+    sorted_ct = []
+    s_proc = proc { |a,b| b <=> a }
+    @@conn.search( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+		   '(objectClass=*)', [ 'createTimestamp' ], nil, 0, 0,
+		   'createTimestamp', s_proc ) do |x|
+      sorted_ct << x['createTimestamp']
+    end
+    sorted_ct.flatten!
+
+    assert_not_equal( ct, sorted_ct )
+    assert_equal( ct.sort( &s_proc ), sorted_ct )
+  end
+
+  # Ensure that the paged results control works properly.
+  #
+  def test_paged_results
+    total = 0
+    page_size = 1
+    cookie = ''
+
+    loop do
+      ber_string = LDAP::Control.encode( page_size, cookie )
+      ctrl = LDAP::Control.new( LDAP::LDAP_CONTROL_PAGEDRESULTS,
+			        ber_string,
+				true )
+      @@conn.set_option( LDAP::LDAP_OPT_SERVER_CONTROLS, [ ctrl ] )
+
+      this_page = nil
+      assert_nothing_raised do
+	begin
+          this_page = @@conn.search2( @@naming_context,
+				      LDAP::LDAP_SCOPE_ONELEVEL,
+				      '(objectclass=*)' )
+	rescue LDAP::ResultError
+	  @@conn = nil
+	  raise
+	end
+      end
+      total += this_page.size
+      assert_equal( page_size, this_page.size )
+
+      @@conn.controls.each do |c|
+        if c.oid == LDAP::LDAP_CONTROL_PAGEDRESULTS
+          ctrl = c
+          break
+        end
+      end
+
+      assert_equal( ctrl.oid, LDAP::LDAP_CONTROL_PAGEDRESULTS )
+
+      fetched_size, cookie = ctrl.decode
+      page_size = fetched_size if fetched_size.to_i > 0
+
+      break if cookie.empty?
+    end
+
+    # Reset connection.
+    @@conn = nil
+    setup
+
+    unpaged = @@conn.search2( @@naming_context, LDAP::LDAP_SCOPE_ONELEVEL,
+			      '(objectclass=*)' )
+
+    # Does the total number of results match the equivalent unpaged search?
+    # This has a race condition, but we assume the number of top-level OUs is
+    # more or less static. :-)
+    assert_equal( total, unpaged.size )
+  end
+
+end