Contents

module GitHub
  class Ldap
    require 'ladle'

    # Preconfigured user fixtures. If you want to use them for your own tests.
    DEFAULT_FIXTURES_PATH = File.expand_path('fixtures.ldif', File.dirname(__FILE__))

    DEFAULT_SERVER_OPTIONS = {
      user_fixtures:  DEFAULT_FIXTURES_PATH,
      user_domain:     'dc=github,dc=com',
      admin_user:      'uid=admin,dc=github,dc=com',
      admin_password:  'secret',
      quiet:           true,
      port:            3897
    }

    class << self

      # server_options: is the options used to start the server,
      #                 useful to know in development.
      attr_reader :server_options

      # ldap_server: is the instance of the testing ldap server,
      #              you should never interact with it,
      #              but it's used to grecefully stop it after your tests finalize.
      attr_reader :ldap_server
    end

    # Start a testing server.
    # If there is already a server initialized it doesn't do anything.
    #
    # options: is a hash with the custom options for the server.
    def self.start_server(options = {})
      @server_options = DEFAULT_SERVER_OPTIONS.merge(options)

      @ldap_server ||= Ladle::Server.new(
        allow_anonymous: false,
        ldif:            server_options[:user_fixtures],
        domain:          server_options[:user_domain],
        port:            server_options[:port],
        quiet:           server_options[:quiet])

      @ldap_server.start
    end

    # Stop the testing server.
    # If there is no server started this method doesn't do anything.
    def self.stop_server
      ldap_server && ldap_server.stop
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
github-ldap-1.0.2	lib/github/ldap/server.rb
github-ldap-1.0.1	lib/github/ldap/server.rb
github-ldap-1.0.0	lib/github/ldap/server.rb