1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
package Test::MaxMind::DB::Writer;
use strict;
use warnings;
use Test::More;
use Data::Printer;
use File::Temp qw( tempdir );
use List::Util qw( all );
use MaxMind::DB::Writer::Tree;
use Net::Works::Address;
use Net::Works::Network;
use Scalar::Util qw( blessed );
use Test::HexDifferences qw( eq_or_dump_diff );
use Exporter qw( import );
our @EXPORT_OK = qw(
insert_for_type
make_tree_from_pairs
ranges_to_data
test_iterator_sanity
test_freeze_thaw
test_freeze_thaw_optional_params
test_tree
);
sub test_tree {
my $insert_pairs = shift;
my $expect_pairs = shift;
my $desc = shift;
my $args = shift;
my $skip_dne_tests = shift;
for my $type (qw( network range )) {
subtest "$desc - insert_$type " => sub {
my $tree = make_tree_from_pairs( $type, $insert_pairs, $args );
_test_expected_data( $tree, $expect_pairs, $desc );
return if $skip_dne_tests;
for my $raw (qw( 1.1.1.33 8.9.10.11 ffff::1 )) {
my $address = Net::Works::Address->new_from_string(
string => $raw,
version => ( $raw =~ /::/ ? 6 : 4 ),
);
is(
$tree->lookup_ip_address($address),
undef,
"The address $address is not in the tree - $desc"
);
}
};
}
}
sub make_tree_from_pairs {
my $type = shift;
my $pairs = shift;
my $args = shift;
my $tree = MaxMind::DB::Writer::Tree->new(
ip_version => ( $pairs->[0][0] =~ /::/ ? 6 : 4 ),
record_size => 24,
database_type => 'Test',
languages => ['en'],
description => { en => 'Test tree' },
map_key_type_callback => sub { },
%{ $args || {} },
);
for my $pair ( @{$pairs} ) {
my ( $network, @insert_args ) = @{$pair};
insert_for_type( $tree, $type, $network, @insert_args );
}
return $tree;
}
sub insert_for_type {
my $tree = shift;
my $type = shift;
my $network = shift;
my @insert_args = @_;
if ( $type eq 'network' ) {
$tree->insert_network( $network, @insert_args );
return;
}
$network = Net::Works::Network->new_from_string( string => $network )
unless blessed $network;
$tree->insert_range( $network->first, $network->last, @insert_args );
}
sub _test_expected_data {
my $tree = shift;
my $expect = shift;
my $desc = shift;
foreach my $pair ( @{$expect} ) {
my ( $network, $data ) = @{$pair};
my $iter = $network->iterator();
while ( my $address = $iter->() ) {
my $result = $tree->lookup_ip_address($address);
is_deeply(
$tree->lookup_ip_address($address),
$data,
"Got expected data for $address - $desc"
) or diag p $result;
}
}
}
{
# We want to have a unique id as part of the data for various tests
my $id = 0;
sub ranges_to_data {
my $insert_ranges = shift;
my $expect_ranges = shift;
my %ip_to_data;
my @insert;
for my $network (
map { Net::Works::Network->range_as_subnets( @{$_} ), }
@{$insert_ranges} ) {
my $data = {
x => 'foo',
id => $id,
};
push @insert, [ $network, $data ];
my $iter = $network->iterator();
while ( my $ip = $iter->() ) {
$ip_to_data{ $ip->as_string() } = $data;
}
$id++;
}
my @expect = (
map { [ $_, $ip_to_data{ $_->first()->as_string() } ] } (
map { Net::Works::Network->range_as_subnets( @{$_} ), }
@{$expect_ranges}
)
);
return \@insert, \@expect;
}
}
sub test_iterator_sanity {
my $iterator = shift;
my $tree = shift;
my $network_count = shift;
my $desc = shift;
ok(
( all { $_ == 1 } values %{ $iterator->{nodes} } ),
"each node was visited exactly once - $desc"
);
ok(
( all { $_ == 1 } values %{ $iterator->{records} } ),
"each record was visited exactly once - $desc"
);
ok(
( all { $_ == 2 } values %{ $iterator->{networks} } ),
"each network was visited exactly twice (two records per node) - $desc"
);
is(
scalar values %{ $iterator->{records} },
$tree->node_count() * 2,
"saw every record for every node in the tree - $desc"
);
my @data_networks = map { $_->[0] } @{ $iterator->{data_records} };
is(
scalar @data_networks,
$network_count,
"saw $network_count networks - $desc"
);
is_deeply(
[ map { $_->as_string() } @data_networks ],
[ map { $_->as_string() } sort @data_networks ],
"data nodes are seen in network order when iterating - $desc"
);
my %first_ips;
for my $network (@data_networks) {
$first_ips{ $network->first()->as_string }++;
}
ok(
( all { $_ == 1 } values %first_ips ),
"did not see two data records with the same network first IP address - $desc"
);
}
sub test_freeze_thaw {
my $tree1 = shift;
my $dir = tempdir( CLEANUP => 1 );
my $file = "$dir/frozen-tree";
$tree1->freeze_tree($file);
my $tree2 = MaxMind::DB::Writer::Tree->new_from_frozen_tree(
filename => $file,
map_key_type_callback => $tree1->map_key_type_callback(),
);
my $now = time();
$_->_set_build_epoch($now) for $tree1, $tree2;
my $tree1_output;
open my $fh, '>:raw', \$tree1_output or die $!;
$tree1->write_tree($fh);
close $fh or die $!;
my $tree2_output;
open $fh, '>:raw', \$tree2_output or die $!;
$tree2->write_tree($fh);
close $fh or die $!;
eq_or_dump_diff(
$tree1_output, $tree2_output,
'output for tree is the same after freeze/thaw'
);
my @attrs = qw(
_root_data_type
alias_ipv6_to_ipv4
database_type
description
ip_version
languages
merge_strategy
record_size
);
for my $attr (@attrs) {
is_deeply(
$tree1->$attr(),
$tree2->$attr(),
"$attr remains the same across freeze/thaw"
);
}
return ( $tree1, $tree2 );
}
sub test_freeze_thaw_optional_params {
my $tree1 = shift;
my $dir = tempdir( CLEANUP => 1 );
my $file = "$dir/frozen-tree-params";
$tree1->freeze_tree($file);
my $description = { en => 'A tree in the forest' };
my $type = 'TreeDB';
my $merge_strategy = 'recurse';
my $record_size = 32;
my $tree2 = MaxMind::DB::Writer::Tree->new_from_frozen_tree(
filename => $file,
map_key_type_callback => $tree1->map_key_type_callback(),
description => $description,
database_type => $type,
merge_strategy => $merge_strategy,
record_size => $record_size,
);
is(
$tree2->database_type, $type,
'type passed to constructor overrides frozen type'
);
is_deeply(
$tree2->description, $description,
'description passed to constructor overrides frozen description'
);
is_deeply(
$tree2->merge_strategy, $merge_strategy,
'merge_strategy passed to constructor overrides frozen merge_strategy'
);
is_deeply(
$tree2->record_size, $record_size,
'record_size passed to constructor overrides frozen record_size'
);
}
1;
|