.\" -*- 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 "Zonemaster::Engine::Test::Address 3pm"
.TH Zonemaster::Engine::Test::Address 3pm 2024-04-22 "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
Zonemaster::Engine::Test::Address \- Module implementing tests focused on IP addresses of name servers
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my @results = Zonemaster::Engine::Test::Address\->all( $zone );
.Ve
.SH METHODS
.IX Header "METHODS"
.IP \fBall()\fR 4
.IX Item "all()"
.Vb 1
\&    my @logentry_array = all( $zone );
.Ve
.Sp
Runs the default set of tests for that module, i.e. between two and three tests depending on the tested zone.
If ADDRESS02 passes, ADDRESS03 is run.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBmetadata()\fR 4
.IX Item "metadata()"
.Vb 1
\&    my $hash_ref = metadata();
.Ve
.Sp
Returns a reference to a hash, the keys of which are the names of all Test Cases in the module, and the corresponding values are references to
an array containing all the message tags that the Test Case can use in log entries.
.IP \fBtag_descriptions()\fR 4
.IX Item "tag_descriptions()"
.Vb 1
\&    my $hash_ref = tag_descriptions();
.Ve
.Sp
Used by the built-in translation system.
.Sp
Returns a reference to a hash, the keys of which are the message tags and the corresponding values are strings (message IDs).
.IP \fBversion()\fR 4
.IX Item "version()"
.Vb 1
\&    my $version_string = version();
.Ve
.Sp
Returns a string containing the version of the current module.
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.IP \fB_emit_log()\fR 4
.IX Item "_emit_log()"
.Vb 1
\&    my $log_entry = _emit_log( $message_tag_string, $hash_ref );
.Ve
.Sp
Adds a message to the logger for this module.
See "add($tag, \f(CW$argref\fR, \f(CW$module\fR, \f(CW$testcase\fR)" in Zonemaster::Engine::Logger::Entry for more details.
.Sp
Takes a string (message tag) and a reference to a hash (arguments).
.Sp
Returns a Zonemaster::Engine::Logger::Entry object.
.IP \fB_find_special_address()\fR 4
.IX Item "_find_special_address()"
.Vb 1
\&    my $hash_ref = _find_special_address( $ip );
.Ve
.Sp
Verifies if an IP address is a special (private, reserved, ...) one.
.Sp
Takes a Net::IP::XS object.
.Sp
Returns a reference to a hash if true (see "\fB_extract_iana_ip_blocks()\fR" in Zonemaster::Engine::Constants), or \f(CW\*(C`undef\*(C'\fR if false.
.SH TESTS
.IX Header "TESTS"
.IP \fBaddress01()\fR 4
.IX Item "address01()"
.Vb 1
\&    my @logentry_array = address01( $zone );
.Ve
.Sp
Runs the Address01 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Address-TP/address01.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBaddress02()\fR 4
.IX Item "address02()"
.Vb 1
\&    my @logentry_array = address02( $zone );
.Ve
.Sp
Runs the Address02 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Address-TP/address02.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBaddress03()\fR 4
.IX Item "address03()"
.Vb 1
\&    my @logentry_array = address03( $zone );
.Ve
.Sp
Runs the Address03 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Address-TP/address03.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.