.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "AnyEvent::XMPP::TestClient 3"
.TH AnyEvent::XMPP::TestClient 3 2024-07-13 "perl v5.38.2" "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
AnyEvent::XMPP::TestClient \- XMPP Test Client for tests
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is a helper module to ease the task of testing.
If you want to run the developer test suite you have to set the environment
variable \f(CW\*(C`NET_XMPP2_TEST\*(C'\fR to something like this:
.PP
.Vb 1
\&   NET_XMPP2_TEST="test_me@your_xmpp_server.tld:secret_password"
.Ve
.PP
Most tests will try to connect two accounts, so please take a server
that allows two connections from the same IP.
.PP
If you also want to run the MUC tests (see AnyEvent::XMPP::Ext::MUC)
you also need to setup the environment variable \f(CW\*(C`NET_XMPP2_TEST_MUC\*(C'\fR
to contain the domain of a MUC service:
.PP
.Vb 1
\&   NET_XMPP2_TEST_MUC="conference.your_xmpp_server.tld"
.Ve
.PP
If you see some tests fail and want to know more about the protocol flow
you can enable the protocol debugging output by setting \f(CW\*(C`NET_XMPP2_TEST_DEBUG\*(C'\fR
to '1':
.PP
.Vb 1
\&   NET_XMPP2_TEST_DEBUG=1
.Ve
.PP
(NOTE: You will only see the output of this by running a single test)
.PP
If one of the tests takes longer than the preconfigured 20 seconds default
timeout in your setup you can set \f(CW\*(C`NET_XMPP2_TEST_TIMEOUT\*(C'\fR:
.PP
.Vb 1
\&   NET_XMPP2_TEST_TIMEOUT=60  # for a 1 minute timeout
.Ve
.SH "CLEANING UP"
.IX Header "CLEANING UP"
If the tests went wrong somewhere or you interrupted the tests you might
want to delete the accounts from the server manually, then run:
.PP
.Vb 1
\&   perl t/z_*_unregister.t
.Ve
.SH "MANUAL TESTING"
.IX Header "MANUAL TESTING"
If you just want to run a single test yourself, just execute the register
test before doing so:
.PP
.Vb 1
\&   perl t/z_00_register.t
.Ve
.PP
And then you could eg. run:
.PP
.Vb 1
\&   perl t/z_03_iq_auth.t
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "new (%args)"
.IX Subsection "new (%args)"
Following arguments can be passed in \f(CW%args\fR:
.SH AUTHOR
.IX Header "AUTHOR"
Robin Redeker, \f(CW\*(C`<elmex at ta\-sa.org>\*(C'\fR, JID: \f(CW\*(C`<elmex at jabber.org>\*(C'\fR
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2007, 2008 Robin Redeker, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.