Zonemaster::Engine::Test::Connectivity(3p)

NAME
Zonemaster::Engine::Test::Connectivity - Module implementing tests focused on name servers reachability

SYNOPSIS
    my @results = Zonemaster::Engine::Test::Connectivity->all( $zone );

METHODS

all()
        my @array = all( $zone );

    Runs the default set of tests for that module, i.e. four tests.

    Takes a Zonemaster::Engine::Zone object.

    Returns a list of Zonemaster::Engine::Logger::Entry objects.

metadata()
        my $hash_ref = metadata();

    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.

tag_descriptions()
        my $hash_ref = tag_descriptions();

    Used by the built-in translation system.

    Returns a reference to a hash, the keys of which are the message tags and the corresponding values are strings (message ids).

version()
        my $string = version();

    Returns a string containing the version of the current module.

INTERNAL METHODS

_emit_log()
        my $log_entry = _emit_log( $message_tag_string, $hash_ref );

    Adds a message to the logger for this module. See "add($tag, $argref, $module, $testcase)" in Zonemaster::Engine::Logger::Entry for more details.

    Takes a string (message tag) and a reference to a hash (arguments).

    Returns a Zonemaster::Engine::Logger::Entry object.

_ip_disabled_message()
        my $bool = _ip_disabled_message( $logentry_array_ref, $ns, @query_type_array );

    Checks if the IP version of a given name server is allowed to be queried. If not, it adds a logging message and returns true. Else, it returns false.

    Takes a reference to an array of Zonemaster::Engine::Logger::Entry objects, a Zonemaster::Engine::Nameserver object and an array of strings (query type).

    Returns a boolean.

_connectivity_loop()
        _connectivity_loop( $testcase_string, $zone_name, $ns_array_ref, $logentry_array_ref );

    Verifies name servers reachability. Used as an helper function for Test Cases "connectivity01()" in Connectivity01 and "connectivity02()" in Connectivity02.

    Takes a string (test case identifier), a Zonemaster::Engine::DNSName object, a reference to an array of Zonemaster::Engine::Nameserver objects and a reference to an array of Zonemaster::Engine::Logger::Entry objects.

TESTS

connectivity01()
        my @logentry_array = connectivity01( $zone );

    Runs the Connectivity01 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Connectivity-TP/connectivity01.md>.

    Takes a Zonemaster::Engine::Zone object.

    Returns a list of Zonemaster::Engine::Logger::Entry objects.

connectivity02()
        my @logentry_array = connectivity02( $zone );

    Runs the Connectivity02 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Connectivity-TP/connectivity02.md>.

    Takes a Zonemaster::Engine::Zone object.

    Returns a list of Zonemaster::Engine::Logger::Entry objects.

connectivity03()
        my @logentry_array = connectivity03( $zone );

    Runs the Connectivity03 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Connectivity-TP/connectivity03.md>.

    Takes a Zonemaster::Engine::Zone object.

    Returns a list of Zonemaster::Engine::Logger::Entry objects.

connectivity04()
        my @logentry_array = connectivity04( $zone );

    Runs the Connectivity04 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/Connectivity-TP/connectivity04.md>.

    Takes a Zonemaster::Engine::Zone object.

    Returns a list of Zonemaster::Engine::Logger::Entry objects.