File: basic.t

package info (click to toggle)
libmaxmind-db-writer-perl 0.300003-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,336 kB
  • sloc: ansic: 3,059; perl: 2,895; makefile: 5; sh: 4
file content (282 lines) | stat: -rw-r--r-- 7,059 bytes parent folder | download | duplicates (3)
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
use strict;
use warnings;

use Test::More;

use MaxMind::DB::Common qw( DATA_SECTION_SEPARATOR );
use MaxMind::DB::Metadata;
use MaxMind::DB::Writer::Tree;

use Net::Works::Network;

for my $record_size ( 24, 28, 32 ) {
    _test_search_tree($record_size);
    _test_ipv4_networks($record_size);
    _test_ipv6_networks($record_size);
}

done_testing();

sub _test_search_tree {
    my $record_size = shift;

    my $tree = MaxMind::DB::Writer::Tree->new(
        ip_version    => 4,
        record_size   => $record_size,
        database_type => 'Test',
        languages     => [ 'en', 'zh' ],
        description   => {
            en => 'Test Database',
            zh => 'Test Database Chinese',
        },
        map_key_type_callback    => sub { 'utf8_string' },
        remove_reserved_networks => 0,
    );

    my @subnets = map { Net::Works::Network->new_from_string( string => $_ ) }
        qw( 0.0.0.0/2 128.0.0.0/2 );

    for my $subnet (@subnets) {
        $tree->insert_network(
            $subnet,
            { ip => $subnet->first()->as_string() }
        );
    }

    my $node_count = 3;

    is(
        $tree->node_count(),
        $node_count,
        "tree has $node_count nodes - $record_size-bit record"
    );

    my $buffer;
    open my $fh, '>:raw', \$buffer or die $!;
    $tree->write_tree($fh);
    close $fh or die $!;

    my $separator = DATA_SECTION_SEPARATOR;

    my $search_tree_size = $node_count * ( $record_size / 4 );
    like(
        $buffer,
        qr/^.{$search_tree_size}\Q$separator/,
        "tree output starts with a search tree of $search_tree_size bytes - $record_size-bit record"
    );

    my $number_encoder
        = __PACKAGE__->can( q{_} . $record_size . '_bit_number' );

    my $one = $number_encoder->(1);
    my $two = $number_encoder->(2);

    like(
        $buffer,
        qr/\A\Q$one$two/,
        "first node in search tree points to nodes 1 (L) and 2 (R) - $record_size-bit record"
    );

    my $data_section_size = length($buffer) - $search_tree_size;

    my %left_record;
    if ( $record_size == 24 ) {
        ( $left_record{1}, $left_record{2} )
            = map { unpack( N => pack( xa3 => unpack( a3 => $_ ) ) ) }
            $buffer =~ /^.{6}(.{3}).{3}(.{3})/;
    }
    elsif ( $record_size == 28 ) {
        my @nodes = $buffer =~ /^.{7}(.{7})(.{7})/;

        for my $num ( 1, 2 ) {
            my $node = $nodes[ $num - 1 ];

            my ( $left_bytes, $middle_bytes, undef )
                = unpack( a3Ca3 => $node );

            $left_record{$num}
                = unpack( N =>
                    pack( 'Ca*', ( $middle_bytes & 0xf0 ) >> 4, $left_bytes )
                );
        }
    }
    else {
        ( $left_record{1}, $left_record{2} )
            = map { unpack( N => $_ ) } $buffer =~ /^.{8}(.{4}).{4}(.{4})/;
    }

    cmp_ok(
        $left_record{1}, '>', 2,
        "node 1 left record points to a value outside the search tree - $record_size-bit record"
    );

    cmp_ok(
        $left_record{1} - $node_count, '<', $data_section_size,
        "node 1 left record points to a value in the data section - $record_size-bit record"
    );

    cmp_ok(
        $left_record{2}, '>', 2,
        "node 2 left record points to a value outside the search tree - $record_size-bit record"
    );

    cmp_ok(
        $left_record{2} - $node_count, '<', $data_section_size,
        "node 2 left record points to a value in the data section - $record_size-bit record"
    );
}

## no critic (Subroutines::ProhibitUnusedPrivateSubroutines)
sub _24_bit_number {
    return substr( pack( 'N', $_[0] ), 1, 3 );
}

sub _28_bit_number {
    return
        pack( N => ( ( $_[0] & 0b11111111_11111111_11111111 ) << 8 )
            | ( ( $_[0] >> 20 ) & 0b11110000 ) );
}

sub _32_bit_number {
    return pack( 'N', $_[0] );
}
## use critic

sub _test_ipv4_networks {
    my $record_size = shift;

    my $desc = "IPv4 - $record_size-bit record";

    my $buffer = _write_tree(
        $record_size,
        [ Net::Works::Network->range_as_subnets( '1.1.1.1', '1.1.1.32' ) ],
        { ip_version => 4 },
    );

    like(
        $buffer,
        qr/\0{16}/,
        'written-out database includes 16 bytes of 0s'
    );

    my $expect = join q{}, map { chr($_) } (

        # map with 1 key
        0b11100001,
        (
            # ip
            0b01000010,
            0b01101001, 0b01110000,
        ),
        (    # 1.1.1.1
            0b01000111,
            0b00110001, 0b00101110, 0b00110001,
            0b00101110, 0b00110001, 0b00101110, 0b00110001
        ),
    );

    like(
        $buffer,
        qr/\Q$expect/,
        "written-out database includes expected data for one subnet - $desc"
    );

    _test_metadata( $buffer, $desc );
}

sub _test_ipv6_networks {
    my $record_size = shift;

    my $desc = "IPv6 - $record_size-bit record";

    my $buffer = _write_tree(
        $record_size,
        [
            Net::Works::Network->range_as_subnets(
                '::1:ffff:ffff', '::2:0000:0059'
            )
        ],
        { ip_version => 6 },
    );

    my $expect = join q{}, map { chr($_) } (

        # map with 1 key
        0b11100001,
        (
            # ip
            0b01000010,
            0b01101001, 0b01110000,
        ),
        (
            # ::1:ffff:ffff
            0b01001101,
            0b00111010, 0b00111010, 0b00110001, 0b00111010,
            0b01100110, 0b01100110, 0b01100110, 0b01100110,
            0b00111010, 0b01100110, 0b01100110, 0b01100110, 0b01100110
        ),
    );

    like(
        $buffer,
        qr/\Q$expect/,
        "written-out database includes expected data for one subnet - $desc"
    );

    _test_metadata( $buffer, $desc );
}

sub _write_tree {
    my $record_size = shift;
    my $subnets     = shift;
    my $metadata    = shift;

    my $tree = MaxMind::DB::Writer::Tree->new(
        ip_version    => $metadata->{ip_version},
        record_size   => $record_size,
        database_type => 'Test',
        languages     => [ 'en', 'zh' ],
        description   => {
            en => 'Test Database',
            zh => 'Test Database Chinese',
        },
        map_key_type_callback    => sub { 'utf8_string' },
        remove_reserved_networks => 0,
    );

    for my $subnet ( @{$subnets} ) {
        $tree->insert_network(
            $subnet,
            { ip => $subnet->first()->as_string() }
        );
    }

    my $buffer;
    open my $fh, '>', \$buffer or die $!;
    $tree->write_tree($fh);
    close $fh or die $!;

    return $buffer;
}

sub _test_metadata {
    my $buffer = shift;
    my $desc   = shift;

    like(
        $buffer,
        qr/\xab\xcd\xefMaxMind\.com/,
        "written-out database includes metadata start marker - $desc"
    );

    for my $key ( sort map { $_->name() }
        MaxMind::DB::Metadata->meta()->get_all_attributes() ) {

        like(
            $buffer,
            qr/\xab\xcd\xefMaxMind\.com.*\Q$key/s,
            "written-out database includes metadata key $key - $desc"
        );
    }

}