Skip to content

Updates methodsv2 unit tests #1351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matsduf merged 12 commits into from
Jul 23, 2024
Merged

Updates methodsv2 unit tests #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3e2e398
Updates TestUtil.pm
matsduf Jul 12, 2024
56bd4da
Updates methodsv2.t
matsduf Jul 12, 2024
8e6f726
Updates data
matsduf Jul 12, 2024
fa8911d
Apply suggestions from code review
tgreenx Jul 16, 2024
a49117d
Update t/TestUtil.pm for MethodsV2, and unit tests
tgreenx Jul 16, 2024
4184d4c
Update t/TestUtil.pm for MethodsV2, and unit tests
tgreenx Jul 17, 2024
7ad849b
Enable all remaining unit tests in t/methodsv2.t, and update unit tes…
tgreenx Jul 17, 2024
0bd581a
Apply suggestions from code review
matsduf Jul 18, 2024
9703d4b
Removes unsed POD code
matsduf Jul 18, 2024
8012cd3
Picks the data file from develop
matsduf Jul 23, 2024
f5cd61c
Merge branch 'develop' into updates-methodsv2-unit-tests
matsduf Jul 23, 2024
d96c59b
Updates data after merge
matsduf Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 91 additions & 31 deletions t/TestUtil.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ use Test::More;
use Zonemaster::Engine;
use Exporter 'import';
use List::MoreUtils qw[ uniq ];
use Zonemaster::Engine::Validation qw( validate_ipv4 validate_ipv6 );

use Carp qw( croak );

Expand Down Expand Up @@ -40,13 +41,20 @@ unknown to the include path @INC, it can be including using the following code:

=item perform_methodsv2_testing()

perform_methodsv2_testing( %subtests );
perform_methodsv2_testing( $href_subtests, $single_scenario, $disabled_scenarios );

This method loads unit test data (test scenarios) and, after some data checks and if the test scenario is testable,
it runs all external L<MethodsV2|Zonemaster::Engine::Test::TestMethodsV2> methods and checks for the presence (or absence) of
specific nameservers data for each specified test scenario.

Takes a hash - the keys of which are scenario names (in all uppercase), and their corresponding values are an array of:
If C<$single_scenario> has been set in the call to the name of a scenario then only that
scenario will be run, and it will always be run even if it has been set as not testable.

If C<$disabled_scenario> has been set in the call to the name of a scenario or to a
comma separated list of scenarios then that or those scenarios will be
temporarily disabled.

Takes a reference to a hash - the keys of which are scenario names (in all uppercase), and their corresponding values are an array of:

=over

Expand Down Expand Up @@ -127,6 +135,14 @@ has the format "keytag,algorithm,type,digest". Those two expressions have the sa

=over

=item _check_ip_addresses()

_check_ip_addresses( $scenario_name, @ip_addresses );

Helper method that checks if the given ip address(es) are valid.

Takes a string (scenario name) and a reference to an array of strings (IP addresses).

=item _check_ns_expressions()

_check_ns_expressions( $scenario_name, @ns_expressions );
Expand All @@ -147,6 +163,17 @@ Takes a string (scenario name) and a reference to an array of strings (delegatio

=cut

sub _check_ip_addresses {
my ( $scenario, $ip_addresses ) = @_;

return if ! defined $ip_addresses;

foreach my $ip ( @{ $ip_addresses } ) {
croak "Scenario $scenario: IP address '$ip' is not valid"
unless validate_ipv4( $ip ) or validate_ipv6( $ip );
}
}

sub _check_ns_expressions {
my ( $scenario, $ns_expressions ) = @_;

Expand All @@ -157,13 +184,8 @@ sub _check_ns_expressions {
croak "Scenario $scenario: Name server name '$ns' in '$nsexp' is not valid" if $ns !~ /^[0-9A-Za-z-.]+$/;

if ( $ip ) {
croak "Scenario $scenario: IP address '$ip' in '$nsexp' is not valid" if
$ip !~ /^([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}$/ and
$ip !~ /^((?:[0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(?:[0-9A-Fa-f]{1,4}:){1,7}:|:(?::[0-9A-Fa-f]{1,4}){1,7}|
[0-9A-Fa-f]{1,4}:(?:(?::[0-9A-Fa-f]{1,4}){1,6})|:(?:(?::[0-9A-Fa-f]{1,4}){1,7}|:)|
(?:(?:[0-9A-Fa-f]{1,4}:){1,6}:[0-9A-Fa-f]{1,4})|(?:(?:[0-9A-Fa-f]{1,4}:){1,5}:(?:[0-9A-Fa-f]{1,4}:){1,2})|
(?:(?:[0-9A-Fa-f]{1,4}:){1,4}:(?:[0-9A-Fa-f]{1,4}:){1,3})|(?:(?:[0-9A-Fa-f]{1,4}:){1,3}:(?:[0-9A-Fa-f]{1,4}:){1,4})|
(?:(?:[0-9A-Fa-f]{1,4}:){1,2}:(?:[0-9A-Fa-f]{1,4}:){1,5}))$/x; # IPv4 and IPv6, respectively
croak "Scenario $scenario: IP address '$ip' in '$nsexp' is not valid"
unless validate_ipv4( $ip ) or validate_ipv6( $ip );
}
}
}
Expand All @@ -181,11 +203,25 @@ sub _check_ds_expressions {
}

sub perform_methodsv2_testing {
my ( %subtests ) = @_;
my ( $href_subtests, $single_scenario, $disabled_scenarios ) = @_;
my %subtests = %$href_subtests;

$single_scenario = uc( $single_scenario ) if $single_scenario;
my @disabled_scenarios = map {uc} split(/, */, $disabled_scenarios) if $disabled_scenarios;

my @untested_scenarios = ();

if ( $single_scenario and not grep /^$single_scenario$/, keys %subtests ) {
croak "Scenario $single_scenario does not exist";
}

for my $scenario ( sort ( keys %subtests ) ) {
next if $single_scenario and $scenario ne $single_scenario;
if ( @disabled_scenarios and grep /^$scenario$/, @disabled_scenarios ) {
push @untested_scenarios, $scenario;
next;
}

if ( ref( $scenario ) ne '' or $scenario ne uc($scenario) ) {
croak "Scenario $scenario: Key must (i) not be a reference and (ii) be in all uppercase";
}
Expand Down Expand Up @@ -218,6 +254,8 @@ sub perform_methodsv2_testing {
croak "Scenario $scenario: Value of testable must be 0 or 1";
}

$testable = 1 if $single_scenario and $scenario eq $single_scenario;

if ( ref( $zone_name ) ne '' ) {
croak "Scenario $scenario: Type of zone name must not be a reference";
}
Expand All @@ -231,17 +269,18 @@ sub perform_methodsv2_testing {
}

if ( defined( $expected_del_ns ) and ref( $expected_del_ns ) ne 'ARRAY' ) {
croak "Scenario $scenario: Incorrect reference type of expected delegation nameservers. Expected: ARRAY";
croak "Scenario $scenario: Incorrect reference type of expected delegation name servers. Expected: ARRAY";
}

if ( defined( $expected_zone_ns ) and ref( $expected_zone_ns ) ne 'ARRAY' ) {
croak "Scenario $scenario: Incorrect reference type of expected zone nameservers. Expected: ARRAY";
croak "Scenario $scenario: Incorrect reference type of expected zone name servers. Expected: ARRAY";
}

if ( ref( $undelegated_ns ) ne 'ARRAY' ) {
croak "Scenario $scenario: Incorrect reference type of undelegated name servers expressions. Expected: ARRAY";
}

_check_ip_addresses( $scenario, $expected_parent_ip );
_check_ns_expressions( $scenario, $expected_del_ns );
_check_ns_expressions( $scenario, $expected_zone_ns );
_check_ns_expressions( $scenario, $undelegated_ns );
Expand Down Expand Up @@ -270,10 +309,11 @@ sub perform_methodsv2_testing {
if ( defined $expected_parent_ip ) {
ok( defined $res, "Result is defined" ) or diag "Unexpected undefined result";
foreach my $expected_ip ( @{ $expected_parent_ip } ) {
ok( grep( /^$expected_ip$/, uniq map { $_->address->short } @{ $res } ), "Nameserver IP '$expected_ip' is present" )
or diag "Nameserver IP '$expected_ip' should have been present, but wasn't";
ok( grep( /^$expected_ip$/, uniq map { $_->address->short } @{ $res } ), "Name server IP '$expected_ip' is present" )
or diag "Expected but missing: $expected_ip";
}
ok( scalar @{ $res } == scalar @{ $expected_parent_ip } ) or diag "Number of nameserver IP addresses in both arrays does not match";
ok( scalar @{ $res } == scalar @{ $expected_parent_ip }, "Number of name server IPs in both arrays match" )
or diag "Number of name server IPs in both arrays does not match (found ". scalar @{ $res } . ", expected " . @{ $expected_parent_ip } . ")";
}
else {
ok( ! defined $res, "Result is undefined" ) or diag "Unexpected defined result";
Expand All @@ -291,10 +331,15 @@ sub perform_methodsv2_testing {
if ( defined $expected_res ) {
ok( defined $res, "Result is defined" ) or diag "Unexpected undefined result";
foreach my $expected_ns ( @{ $expected_res } ) {
ok( grep( /^$expected_ns$/, @{ $res } ), "Nameserver '$expected_ns' is present" )
or diag "Nameserver '$expected_ns' should have been present, but wasn't";
ok( grep( /^$expected_ns$/, @{ $res } ), "Name server '$expected_ns' is present" )
or diag "Expected but missing: $expected_ns";
}
ok( scalar @{ $res } == scalar @{ $expected_res } ) or diag "Number of nameservers in both arrays does not match";
foreach my $ns ( @{ $res } ) {
ok( grep( /^$ns$/, @{ $expected_res } ), "Name server '$ns' is expected" )
or diag "Present but not expected: $ns";
}
ok( scalar @{ $res } == scalar @{ $expected_res }, "Number of name server in both arrays match" )
or diag "Number of name servers in both arrays does not match (found " . scalar @{ $res } . ", expected " . scalar @{ $expected_res }.")";
}
else {
ok( ! defined $res, "Result is undefined" ) or diag "Unexpected defined result";
Expand All @@ -304,9 +349,11 @@ sub perform_methodsv2_testing {

# Methods: get_del_ns_names() and get_zone_ns_names()
@method_names = qw( get_del_ns_names get_zone_ns_names );
my @expected_del_ns_names = uniq map { (split( m(/), $_ ))[0] } @{ $expected_del_ns };
my @expected_zone_ns_names = uniq map { (split( m(/), $_ ))[0] } @{ $expected_zone_ns };
my @expected_ns_names = ( \@expected_del_ns_names, \@expected_zone_ns_names );
my $expected_del_ns_names = defined $expected_del_ns ?
[ uniq map { (split( m(/), $_ ))[0] } @{ $expected_del_ns } ] : undef;
my $expected_zone_ns_names = defined $expected_zone_ns ?
[ uniq map { (split( m(/), $_ ))[0] } @{ $expected_zone_ns } ] : undef;
my @expected_ns_names = ( $expected_del_ns_names, $expected_zone_ns_names );
foreach my $i ( 0..$#method_names ) {
my $method = $method_names[$i];
subtest $method => sub {
Expand All @@ -315,10 +362,15 @@ sub perform_methodsv2_testing {
if ( defined $expected_res ) {
ok( defined $res, "Result is defined" ) or diag "Unexpected undefined result";
foreach my $expected_name ( @{ $expected_res } ) {
ok( grep( /^$expected_name$/, @{ $res } ), "Nameserver name '$expected_name' is present" )
or diag "Nameserver name '$expected_name' should have been present, but wasn't";
ok( grep( /^$expected_name$/, @{ $res } ), "Name server name '$expected_name' is present" )
or diag "Expected but missing: $expected_name";
}
foreach my $name ( @{ $res } ) {
ok( grep( /^$name$/, @{ $expected_res } ), "Name server name '$name' is expected" )
or diag "Present but not expected: $name";
}
ok( scalar @{ $res } == scalar @{ $expected_res } ) or diag "Number of nameserver names in both arrays does not match";
ok( scalar @{ $res } == scalar @{ $expected_res }, "Number of name server names in both arrays match" )
or diag "Number of name server names in both arrays does not match (found " . scalar @{ $res } . ", expected " . scalar @{ $expected_res }.")";
}
else {
ok( ! defined $res, "Result is undefined" ) or diag "Unexpected defined result";
Expand All @@ -328,9 +380,12 @@ sub perform_methodsv2_testing {

# Methods: get_del_ns_ips() and get_zone_ns_ips()
@method_names = qw( get_del_ns_ips get_zone_ns_ips );
my @expected_del_ns_ips = uniq map { (split( m(/), $_ ))[1] } @{ $expected_del_ns };
my @expected_zone_ns_ips = uniq map { (split( m(/), $_ ))[1] } @{ $expected_zone_ns };
my @expected_ns_ips = ( \@expected_del_ns_ips, \@expected_zone_ns_ips );
my $expected_del_ns_ips = defined $expected_del_ns ?
[ uniq grep { $_ ne '' } map { (split( m(/), $_ ))[1] ? (split( m(/), $_ ))[1] : '' } @{ $expected_del_ns } ] : undef;
my $expected_zone_ns_ips = defined $expected_zone_ns ?
[ uniq grep { $_ ne '' } map { (split( m(/), $_ ))[1] ? (split( m(/), $_ ))[1] : '' } @{ $expected_zone_ns } ] : undef;

my @expected_ns_ips = ( $expected_del_ns_ips, $expected_zone_ns_ips );
foreach my $i ( 0..$#method_names ) {
my $method = $method_names[$i];
subtest $method => sub {
Expand All @@ -339,10 +394,15 @@ sub perform_methodsv2_testing {
if ( defined $expected_res ) {
ok( defined $res, "Result is defined" ) or diag "Unexpected undefined result";
foreach my $expected_ip ( @{ $expected_res } ) {
ok( grep( /^$expected_ip$/, @{ $res } ), "Nameserver IP '$expected_ip' is present" )
or diag "Nameserver IP '$expected_ip' should have been present, but wasn't";
ok( grep( /^$expected_ip$/, @{ $res } ), "Name server IP '$expected_ip' is present" )
or diag "Expected but missing: $expected_ip";
}
ok( scalar @{ $res } == scalar @{ $expected_res } ) or diag "Number of nameserver IPs in both arrays does not match";
foreach my $ip ( @{ $res } ) {
ok( grep( /^$ip$/, @{ $expected_res } ), "Name server IP '$ip' is expected" )
or diag "Present but not expected: $ip";
}
ok( scalar @{ $res } == scalar @{ $expected_res }, "Number of name server IPs in both arrays match" )
or diag "Number of name server IPs in both arrays does not match (found " . scalar @{ $res } . ", expected " . scalar @{ $expected_res }.")";
}
else {
ok( ! defined $res, "Result is undefined" ) or diag "Unexpected defined result";
Expand All @@ -354,7 +414,7 @@ sub perform_methodsv2_testing {

if ( @untested_scenarios ) {
warn "Untested scenarios:\n";
warn "\tScenario $_ cannot be tested.\n" for @untested_scenarios;
warn "\tScenario $_ has been disabled from testing.\n" for @untested_scenarios;
}
}

Expand Down
Loading