.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Test::Net::LDAP 3pm"
.TH Test::Net::LDAP 3pm "2022-06-28" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Test::Net::LDAP \- A Net::LDAP subclass for testing
.SH "VERSION"
.IX Header "VERSION"
Version 0.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Basic testing utility
.PP
.Vb 2
\&    use Test::More tests => 1;
\&    use Test::Net::LDAP;
\&    
\&    # Create an object, just like Net::LDAP\->new()
\&    my $ldap = Test::Net::LDAP\->new(...);
\&    
\&    # Same as $ldap\->search(), testing the result to see if it is success
\&    my $search = $ldap\->search_ok(...search args...);
.Ve
.PP
Mocking (See Test::Net::LDAP::Mock)
.PP
.Vb 2
\&    use Test::More tests => 1;
\&    use Test::Net::LDAP::Util qw(ldap_mockify);
\&    
\&    ldap_mockify {
\&        # Net::LDAP\->new() will invoke Test::Net::LDAP::Mock\->new()
\&        my $ldap = Net::LDAP\->new(\*(Aqldap.example.com\*(Aq);
\&        
\&        # Add entries to in\-memory data tree
\&        $ldap\->add(\*(Aquid=user1, ou=users, dc=example, dc=com\*(Aq);
\&        $ldap\->add(\*(Aquid=user2, ou=users, dc=example, dc=com\*(Aq);
\&        
\&        # Test your application
\&        ok my_application_routine();
\&    };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides some testing methods for \s-1LDAP\s0 operations, such as
\&\f(CW\*(C`search\*(C'\fR, \f(CW\*(C`add\*(C'\fR, and \f(CW\*(C`modify\*(C'\fR, where each method is suffixed with either
\&\f(CW\*(C`_ok\*(C'\fR or \f(CW\*(C`_is\*(C'\fR.
.PP
\&\f(CW\*(C`Test::Net::LDAP\*(C'\fR is a subclass of \f(CW\*(C`Net::LDAP\*(C'\fR, so all the methods defined
for \f(CW\*(C`Net::LDAP\*(C'\fR are available in addition to \f(CW\*(C`search_ok\*(C'\fR, \f(CW\*(C`add_is\*(C'\fR, etc.
.PP
See Test::Net::LDAP::Mock for in-memory testing with fake data, without
connecting to the real \s-1LDAP\s0 servers.
.PP
See Test::Net::LDAP::Util for some helper subroutines.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Creates a new object. The parameters are the same as \f(CW\*(C`Net::LDAP::new\*(C'\fR.
.PP
.Vb 1
\&    my $ldap = Test::Net::LDAP\->new(\*(Aqldap.example.com\*(Aq);
.Ve
.SS "search_ok"
.IX Subsection "search_ok"
Available methods:
\&\f(CW\*(C`search_ok\*(C'\fR, \f(CW\*(C`compare_ok\*(C'\fR,
\&\f(CW\*(C`add_ok\*(C'\fR, \f(CW\*(C`modify_ok\*(C'\fR, \f(CW\*(C`delete_ok\*(C'\fR, \f(CW\*(C`moddn_ok\*(C'\fR,
\&\f(CW\*(C`bind_ok\*(C'\fR, \f(CW\*(C`unbind_ok\*(C'\fR, \f(CW\*(C`abandon_ok\*(C'\fR
.PP
Synopsis:
.PP
.Vb 2
\&    $ldap\->search_ok(@params);
\&    $ldap\->search_ok(\e@params, $name);
.Ve
.PP
Invokes the corresponding method with \f(CW@params\fR passed as arguments,
and tests the result to see if the code is \f(CW\*(C`LDAP_SUCCESS\*(C'\fR.
.PP
Alternatively, \f(CW@params\fR can be given as an array ref, so that the second
argument \f(CW$name\fR is specified as the test name.
.PP
\&\f(CW$name\fR is an optional test name, and if it is omitted, the test name is
automatically configured based on \f(CW$method\fR and \f(CW@params\fR.
.PP
.Vb 3
\&    my $search = $ldap\->search_ok(
\&        base => \*(Aqdc=example, dc=com\*(Aq, scope => \*(Aqsub\*(Aq, filter => \*(Aq(cn=*)\*(Aq,
\&    );
\&
\&    my $search = $ldap\->search_ok(
\&        [base => \*(Aqdc=example, dc=com\*(Aq, scope => \*(Aqsub\*(Aq, filter => \*(Aq(cn=*)\*(Aq],
\&        \*(AqTesting search (cn=*)\*(Aq
\&    );
.Ve
.SS "search_is"
.IX Subsection "search_is"
Available methods:
\&\f(CW\*(C`search_is\*(C'\fR, \f(CW\*(C`compare_is\*(C'\fR,
\&\f(CW\*(C`add_is\*(C'\fR, \f(CW\*(C`modify_is\*(C'\fR, \f(CW\*(C`delete_is\*(C'\fR, \f(CW\*(C`moddn_is\*(C'\fR,
\&\f(CW\*(C`bind_is\*(C'\fR, \f(CW\*(C`unbind_is\*(C'\fR, \f(CW\*(C`abandon_is\*(C'\fR
.PP
Synopsis:
.PP
.Vb 1
\&    $ldap\->search_is(\e@params, $expect, $name);
.Ve
.PP
Invokes the corresponding method with \f(CW@params\fR passed as arguments,
and tests the result to see if the code is equal to \f(CW$expect\fR.
.PP
\&\f(CW$expect\fR can be a result code such as \f(CW\*(C`LDAP_NO_SUCH_OBJECT\*(C'\fR or an object of
\&\f(CW\*(C`Net::LDAP::Message\*(C'\fR returned by \s-1LDAP\s0 operations.
.PP
\&\f(CW$name\fR is an optional test name, and if it is omitted, the test name is
automatically configured based on \f(CW$method\fR and \f(CW@params\fR.
.PP
.Vb 1
\&    use Net::LDAP::Constant qw(LDAP_ALREADY_EXISTS);
\&
\&    my $mesg = $ldap\->add_is(
\&        [\*(Aquid=duplicate, dc=example, dc=com\*(Aq],
\&        LDAP_ALREADY_EXISTS
\&    );
.Ve
.SS "method_ok"
.IX Subsection "method_ok"
.Vb 2
\&    $ldap\->method_ok($method, @params);
\&    $ldap\->method_ok($method, \e@params, $name);
.Ve
.PP
Invokes the method as \f(CW\*(C`$ldap\->$method(@params)\*(C'\fR and tests the result to see
if the code is \f(CW\*(C`LDAP_SUCCESS\*(C'\fR.
.PP
\&\f(CW$name\fR is an optional test name, and if it is omitted, the test name is
automatically configured based on \f(CW$method\fR and \f(CW@params\fR.
.SS "method_is"
.IX Subsection "method_is"
.Vb 1
\&    $ldap\->method_is($method, \e@params, $expect, $name);
.Ve
.PP
Invokes the method as \f(CW\*(C`$ldap\->$method(@params)\*(C'\fR and tests the result to see
if the code is equal to \f(CW$expect\fR.
.PP
\&\f(CW$expect\fR can be a result code such as \f(CW\*(C`LDAP_NO_SUCH_OBJECT\*(C'\fR or an object of
\&\f(CW\*(C`Net::LDAP::Message\*(C'\fR returned by \s-1LDAP\s0 operations.
.PP
\&\f(CW$name\fR is an optional test name, and if it is omitted, the test name is
automatically configured based on \f(CW$method\fR and \f(CW@params\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Test::More
.IP "\(bu" 4
Net::LDAP
.IP "\(bu" 4
Test::Net::LDAP::Mock
.IP "\(bu" 4
Test::Net::LDAP::Util
.SH "AUTHOR"
.IX Header "AUTHOR"
Mahiro Ando, \f(CW\*(C`<mahiro at cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-test\-net\-ldap at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Net\-LDAP>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Net::LDAP
.Ve
.PP
You can also look for information at:
.IP "\(bu" 4
GitHub repository (report bugs here)
.Sp
<https://github.com/mahiro/perl\-Test\-Net\-LDAP>
.IP "\(bu" 4
\&\s-1RT: CPAN\s0's request tracker (report bugs here, alternatively)
.Sp
<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test\-Net\-LDAP>
.IP "\(bu" 4
AnnoCPAN: Annotated \s-1CPAN\s0 documentation
.Sp
<http://annocpan.org/dist/Test\-Net\-LDAP>
.IP "\(bu" 4
\&\s-1CPAN\s0 Ratings
.Sp
<http://cpanratings.perl.org/d/Test\-Net\-LDAP>
.IP "\(bu" 4
Search \s-1CPAN\s0
.Sp
<http://search.cpan.org/dist/Test\-Net\-LDAP/>
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2013\-2015 Mahiro Ando.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.