[PATCH] Tests: tests for GeoIP databases in the MMDB format

Maxim Dounin mdounin at mdounin.ru
Wed Dec 3 16:32:44 UTC 2025


# HG changeset patch
# User Maxim Dounin <mdounin at mdounin.ru>
# Date 1764694278 -10800
#      Tue Dec 02 19:51:18 2025 +0300
# Node ID f94d1e13363739c0f2129f404e5672a4ee98146c
# Parent  55ff381e5d3a0f0fb2e64b3ec63ec01bf1b6f132
Tests: tests for GeoIP databases in the MMDB format.

diff --git a/geoip.t b/geoip.t
--- a/geoip.t
+++ b/geoip.t
@@ -144,7 +144,7 @@ for my $i (0 .. 31) {
 
 $t->write_file('org.dat', $data);
 $t->write_file('index.html', '');
-$t->try_run('no inet6 support')->plan(20);
+$t->try_run('no geoip legacy')->plan(20);
 
 ###############################################################################
 
diff --git a/geoip.t b/geoip_mmdb.t
copy from geoip.t
copy to geoip_mmdb.t
--- a/geoip.t
+++ b/geoip_mmdb.t
@@ -1,9 +1,10 @@
 #!/usr/bin/perl
 
+# (C) Maxim Dounin
 # (C) Andrey Zelenkov
 # (C) Nginx, Inc.
 
-# Tests for geoip module.
+# Tests for geoip module with MMDB databases.
 
 ###############################################################################
 
@@ -37,9 +38,11 @@ http {
 
     geoip_proxy    127.0.0.1/32;
 
-    geoip_country  %%TESTDIR%%/country.dat;
-    geoip_city     %%TESTDIR%%/city.dat;
-    geoip_org      %%TESTDIR%%/org.dat;
+    geoip_country  test.mmdb;
+    geoip_city     test.mmdb;
+    geoip_org      test.mmdb;
+
+    geoip_set      $asn  test.mmdb  autonomous_system_number;
 
     server {
         listen       127.0.0.1:8080;
@@ -47,13 +50,13 @@ http {
 
         location / {
             add_header X-Country-Code      $geoip_country_code;
-            add_header X-Country-Code3     $geoip_country_code3;
+            add_header X-Country-Code3     $geoip_country_code3:none;
             add_header X-Country-Name      $geoip_country_name;
 
-            add_header X-Area-Code         $geoip_area_code;
+            add_header X-Area-Code         $geoip_area_code:none;
             add_header X-C-Continent-Code  $geoip_city_continent_code;
             add_header X-C-Country-Code    $geoip_city_country_code;
-            add_header X-C-Country-Code3   $geoip_city_country_code3;
+            add_header X-C-Country-Code3   $geoip_city_country_code3:none;
             add_header X-C-Country-Name    $geoip_city_country_name;
             add_header X-Dma-Code          $geoip_dma_code;
             add_header X-Latitude          $geoip_latitude;
@@ -64,6 +67,8 @@ http {
             add_header X-Postal-Code       $geoip_postal_code;
 
             add_header X-Org               $geoip_org;
+
+            add_header X-ASN               $asn;
         }
     }
 }
@@ -72,127 +77,126 @@ EOF
 
 my $d = $t->testdir();
 
-# country database:
-#
-# "10.0.0.1","10.0.0.1","RU","Russian Federation"
-# "2001:db8::","2001:db8::","US","United States"
+# MMDB format specification:
+# https://github.com/maxmind/MaxMind-DB/blob/main/MaxMind-DB-spec.md
 
 my $data = '';
 
-for my $i (0 .. 156) {
-	# skip to offset 32 if 1st bit set in ipv6 address wins
-	$data .= pack_node($i + 1) . pack_node(32), next if $i == 2;
-	# otherwise default to RU
-	$data .= pack_node(0xffffb9) . pack_node(0xffff00), next if $i == 31;
-	# continue checking bits set in ipv6 address
-	$data .= pack_node(0xffff00) . pack_node($i + 1), next
-		if grep $_ == $i, (44, 49, 50, 52, 53, 55, 56, 57);
-	# last bit set in ipv6 address
-	$data .= pack_node(0xffffe1) . pack_node(0xffff00), next if $i == 156;
-	$data .= pack_node($i + 1) . pack_node(0xffff00);
-}
+# binary search tree
+# just one node (two records), 32-bit records
+
+$data .= pack('NN', 17, 17);
+
+# data section
+
+$data .= pack('x16');
+
+$data .= pack("B8", "11101000");
+
+$data .= pack("B8A*", "01011000", "autonomous_system_number");
+$data .= pack("B8N", "11000100", 64511);
+
+$data .= pack("B8CA*", "01011101", 30 - 29, "autonomous_system_organization");
+$data .= pack("B8A*", "01001101", "freenginx.org");
 
-$data .= chr(0x00) x 3;
-$data .= chr(0xFF) x 3;
-$data .= chr(12);
-
-$t->write_file('country.dat', $data);
+$data .= pack("B8A*", "01000111", "country");
+$data .= pack("B8", "11100010");
+$data .= pack("B8A*", "01001000", "iso_code");
+$data .= pack("B8A*", "01000010", "RU");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01010010", "Russian Federation");
 
-# city database:
-#
-# "167772161","167772161","RU","48","Moscow","119034","55.7543",37.6202",,
-
-$data = '';
+$data .= pack("B8A*", "01001001", "continent");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000100", "code");
+$data .= pack("B8A*", "01000010", "EU");
 
-for my $i (0 .. 31) {
-	$data .= pack_node(32) . pack_node($i + 1), next if $i == 4 or $i == 6;
-	$data .= pack_node(32) . pack_node($i + 2), next if $i == 31;
-	$data .= pack_node($i + 1) . pack_node(32);
-}
+$data .= pack("B8A*", "01001100", "subdivisions");
+$data .= pack("B8C", "00000001", 11 - 7);
+$data .= pack("B8", "11100010");
+$data .= pack("B8A*", "01001000", "iso_code");
+$data .= pack("B8A*", "01000011", "MOW");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01000110", "Moscow");
 
-$data .= chr(42);
-$data .= chr(185);
-$data .= pack('Z*', 48);
-$data .= pack('Z*', 'Moscow');
-$data .= pack('Z*', 119034);
-$data .= pack_node(int((55.7543 + 180) * 10000));
-$data .= pack_node(int((37.6202 + 180) * 10000));
-$data .= chr(0) x 3;
-$data .= chr(0xFF) x 3;
-$data .= chr(2);
-$data .= pack_node(32);
+$data .= pack("B8A*", "01000100", "city");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01000110", "Moscow");
+
+$data .= pack("B8A*", "01000110", "postal");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000100", "code");
+$data .= pack("B8A*", "01000110", "119034");
 
-$t->write_file('city.dat', $data);
+$data .= pack("B8A*", "01001000", "location");
+$data .= pack("B8", "11100011");
+$data .= pack("B8A*", "01001000", "latitude");
+$data .= pack("B8d>", "01101000", 55.7543);
+$data .= pack("B8A*", "01001001", "longitude");
+$data .= pack("B8d>", "01101000", 37.6202);
+$data .= pack("B8A*", "01001010", "metro_code");
+$data .= pack("B8C", "10100001", 0);
 
-# organization database:
-#
-# "167772161","167772161","Nginx"
+# metadata
+
+$data .= "\xab\xcd\xefMaxMind.com";
 
-$data = '';
-
-for my $i (0 .. 31) {
-	$data .= pack_org(32) . pack_org($i + 1), next if $i == 4 or $i == 6;
-	$data .= pack_org(32) . pack_org($i + 2), next if $i == 31;
-	$data .= pack_org($i + 1) . pack_org(32);
-}
+$data .= pack("B8", "11101001");
+$data .= pack("B8A*", "01001010", "node_count");
+$data .= pack("B8C", "11000001", 1);
+$data .= pack("B8A*", "01001011", "record_size");
+$data .= pack("B8C", "10100001", 32);
+$data .= pack("B8A*", "01001010", "ip_version");
+$data .= pack("B8C", "10100001", 6);
+$data .= pack("B8A*", "01001101", "database_type");
+$data .= pack("B8A*", "01000100", "test");
+$data .= pack("B8A*", "01001001", "languages");
+$data .= pack("B8B8", "00000001", "00000100");
+$data .= pack("B8A*", "01000100", "test");
+$data .= pack("B8A*", "01011011", "binary_format_major_version");
+$data .= pack("B8C", "10100001", 2);
+$data .= pack("B8A*", "01011011", "binary_format_minor_version");
+$data .= pack("B8C", "10100001", 0);
+$data .= pack("B8A*", "01001011", "build_epoch");
+$data .= pack("B8B8C", "00000001", "00000010", 1);
+$data .= pack("B8A*", "01001011", "description");
+$data .= pack("B8", "11100000");
 
-$data .= chr(42);
-$data .= pack('Z*', 'Nginx');
-$data .= chr(0xFF) x 3;
-$data .= chr(5);
-$data .= pack_node(32);
+$t->write_file('test.mmdb', $data);
 
-$t->write_file('org.dat', $data);
 $t->write_file('index.html', '');
-$t->try_run('no inet6 support')->plan(20);
+$t->try_run('no geoip mmdb')->plan(17);
 
 ###############################################################################
 
-my $r = http_xff('10.0.0.1');
+my $r = http_get('/');
+
 like($r, qr/X-Country-Code: RU/, 'geoip country code');
-like($r, qr/X-Country-Code3: RUS/, 'geoip country code 3');
+like($r, qr/X-Country-Code3: :none/, 'geoip country code 3');
 like($r, qr/X-Country-Name: Russian Federation/, 'geoip country name');
 
-like($r, qr/X-Area-Code: 0/, 'geoip area code');
+like($r, qr/X-Area-Code: :none/, 'geoip area code');
 like($r, qr/X-C-Continent-Code: EU/, 'geoip city continent code');
 like($r, qr/X-C-Country-Code: RU/, 'geoip city country code');
-like($r, qr/X-C-Country-Code3: RUS/, 'geoip city country code 3');
+like($r, qr/X-C-Country-Code3: :none/, 'geoip city country code 3');
 like($r, qr/X-C-Country-Name: Russian Federation/, 'geoip city country name');
 like($r, qr/X-Dma-Code: 0/, 'geoip dma code');
 like($r, qr/X-Latitude: 55.7543/, 'geoip latitude');
 like($r, qr/X-Longitude: 37.6202/, 'geoip longitude');
-like($r, qr/X-Region: 48/, 'geoip region');
-like($r, qr/X-Region-Name: Moscow City/, 'geoip region name');
+like($r, qr/X-Region: MOW/, 'geoip region');
+like($r, qr/X-Region-Name: Moscow/, 'geoip region name');
 like($r, qr/X-City: Moscow/, 'geoip city');
 like($r, qr/X-Postal-Code: 119034/, 'geoip postal code');
 
-like($r, qr/X-Org: Nginx/, 'geoip org');
-
-like(http_xff('::ffff:10.0.0.1'), qr/X-Org: Nginx/, 'geoip ipv6 ipv4-mapped');
+like($r, qr/X-Org: freenginx.org/, 'geoip org');
 
-$r = http_xff('2001:db8::');
-like($r, qr/X-Country-Code: US/, 'geoip ipv6 country code');
-like($r, qr/X-Country-Code3: USA/, 'geoip ipv6 country code 3');
-like($r, qr/X-Country-Name: United States/, 'geoip ipv6 country name');
+like($r, qr/X-ASN: 64511/, 'geoip set asn');
 
 ###############################################################################
-
-sub http_xff {
-	my ($xff) = @_;
-	return http(<<EOF);
-GET / HTTP/1.0
-Host: localhost
-X-Forwarded-For: $xff
-
-EOF
-}
-
-sub pack_node {
-	substr pack('V', shift), 0, 3;
-}
-
-sub pack_org {
-	pack('V', shift);
-}
-
-###############################################################################
diff --git a/stream_geoip.t b/stream_geoip.t
--- a/stream_geoip.t
+++ b/stream_geoip.t
@@ -144,7 +144,7 @@ for my $i (0 .. 31) {
 $data .= pack_node(32);
 
 $t->write_file('org.dat', $data);
-$t->try_run('no inet6 support')->plan(20);
+$t->try_run('no geoip legacy')->plan(20);
 
 ###############################################################################
 
diff --git a/stream_geoip.t b/stream_geoip_mmdb.t
copy from stream_geoip.t
copy to stream_geoip_mmdb.t
--- a/stream_geoip.t
+++ b/stream_geoip_mmdb.t
@@ -1,9 +1,10 @@
 #!/usr/bin/perl
 
+# (C) Maxim Dounin
 # (C) Andrey Zelenkov
 # (C) Nginx, Inc.
 
-# Tests for stream geoip module.
+# Tests for stream geoip module with MMDB databases.
 
 ###############################################################################
 
@@ -25,8 +26,7 @@ use Test::Nginx::Stream qw/ stream /;
 select STDERR; $| = 1;
 select STDOUT; $| = 1;
 
-my $t = Test::Nginx->new()->has(qw/stream stream_geoip stream_return/)
-	->has('stream_realip');
+my $t = Test::Nginx->new()->has(qw/stream stream_geoip stream_return/);
 
 $t->write_file_expand('nginx.conf', <<'EOF');
 
@@ -40,22 +40,22 @@ events {
 stream {
     %%TEST_GLOBALS_STREAM%%
 
-    set_real_ip_from  127.0.0.1/32;
+    geoip_country  test.mmdb;
+    geoip_city     test.mmdb;
+    geoip_org      test.mmdb;
 
-    geoip_country  %%TESTDIR%%/country.dat;
-    geoip_city     %%TESTDIR%%/city.dat;
-    geoip_org      %%TESTDIR%%/org.dat;
+    geoip_set      $asn  test.mmdb  autonomous_system_number;
 
     server {
-        listen  127.0.0.1:8080 proxy_protocol;
+        listen  127.0.0.1:8080;
         return  "country_code:$geoip_country_code
-                 country_code3:$geoip_country_code3
+                 country_code3:$geoip_country_code3:none
                  country_name:$geoip_country_name
 
-                 area_code:$geoip_area_code
+                 area_code:$geoip_area_code:none
                  city_continent_code:$geoip_city_continent_code
                  city_country_code:$geoip_city_country_code
-                 city_country_code3:$geoip_city_country_code3
+                 city_country_code3:$geoip_city_country_code3:none
                  city_country_name:$geoip_city_country_name
                  dma_code:$geoip_dma_code
                  latitude:$geoip_latitude
@@ -65,7 +65,9 @@ stream {
                  city:$geoip_city
                  postal_code:$geoip_postal_code
 
-                 org:$geoip_org";
+                 org:$geoip_org
+
+                 asn:$asn";
     }
 }
 
@@ -73,123 +75,125 @@ EOF
 
 my $d = $t->testdir();
 
-# country database:
-#
-# "10.0.0.1","10.0.0.1","RU","Russian Federation"
-# "2001:db8::","2001:db8::","US","United States"
+# MMDB format specification:
+# https://github.com/maxmind/MaxMind-DB/blob/main/MaxMind-DB-spec.md
 
 my $data = '';
 
-for my $i (0 .. 156) {
-	# skip to offset 32 if 1st bit set in ipv6 address wins
-	$data .= pack_node($i + 1) . pack_node(32), next if $i == 2;
-	# otherwise default to RU
-	$data .= pack_node(0xffffb9) . pack_node(0xffff00), next if $i == 31;
-	# continue checking bits set in ipv6 address
-	$data .= pack_node(0xffff00) . pack_node($i + 1), next
-		if grep $_ == $i, (44, 49, 50, 52, 53, 55, 56, 57);
-	# last bit set in ipv6 address
-	$data .= pack_node(0xffffe1) . pack_node(0xffff00), next if $i == 156;
-	$data .= pack_node($i + 1) . pack_node(0xffff00);
-}
+# binary search tree
+# just one node (two records), 32-bit records
+
+$data .= pack('NN', 17, 17);
+
+# data section
+
+$data .= pack('x16');
+
+$data .= pack("B8", "11101000");
+
+$data .= pack("B8A*", "01011000", "autonomous_system_number");
+$data .= pack("B8N", "11000100", 64511);
+
+$data .= pack("B8CA*", "01011101", 30 - 29, "autonomous_system_organization");
+$data .= pack("B8A*", "01001101", "freenginx.org");
 
-$data .= chr(0x00) x 3;
-$data .= chr(0xFF) x 3;
-$data .= chr(12);
-
-$t->write_file('country.dat', $data);
+$data .= pack("B8A*", "01000111", "country");
+$data .= pack("B8", "11100010");
+$data .= pack("B8A*", "01001000", "iso_code");
+$data .= pack("B8A*", "01000010", "RU");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01010010", "Russian Federation");
 
-# city database:
-#
-# "167772161","167772161","RU","48","Moscow","119034","55.7543",37.6202",,
-
-$data = '';
+$data .= pack("B8A*", "01001001", "continent");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000100", "code");
+$data .= pack("B8A*", "01000010", "EU");
 
-for my $i (0 .. 31) {
-	$data .= pack_node(32) . pack_node($i + 1), next if $i == 4 or $i == 6;
-	$data .= pack_node(32) . pack_node($i + 2), next if $i == 31;
-	$data .= pack_node($i + 1) . pack_node(32);
-}
+$data .= pack("B8A*", "01001100", "subdivisions");
+$data .= pack("B8C", "00000001", 11 - 7);
+$data .= pack("B8", "11100010");
+$data .= pack("B8A*", "01001000", "iso_code");
+$data .= pack("B8A*", "01000011", "MOW");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01000110", "Moscow");
 
-$data .= chr(42);
-$data .= chr(185);
-$data .= pack('Z*', 48);
-$data .= pack('Z*', 'Moscow');
-$data .= pack('Z*', 119034);
-$data .= pack_node(int((55.7543 + 180) * 10000));
-$data .= pack_node(int((37.6202 + 180) * 10000));
-$data .= chr(0) x 3;
-$data .= chr(0xFF) x 3;
-$data .= chr(2);
-$data .= pack_node(32);
+$data .= pack("B8A*", "01000100", "city");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000101", "names");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000010", "en");
+$data .= pack("B8A*", "01000110", "Moscow");
+
+$data .= pack("B8A*", "01000110", "postal");
+$data .= pack("B8", "11100001");
+$data .= pack("B8A*", "01000100", "code");
+$data .= pack("B8A*", "01000110", "119034");
 
-$t->write_file('city.dat', $data);
+$data .= pack("B8A*", "01001000", "location");
+$data .= pack("B8", "11100011");
+$data .= pack("B8A*", "01001000", "latitude");
+$data .= pack("B8d>", "01101000", 55.7543);
+$data .= pack("B8A*", "01001001", "longitude");
+$data .= pack("B8d>", "01101000", 37.6202);
+$data .= pack("B8A*", "01001010", "metro_code");
+$data .= pack("B8C", "10100001", 0);
+
+# metadata
+
+$data .= "\xab\xcd\xefMaxMind.com";
 
-# organization database:
-#
-# "167772161","167772161","Nginx"
-
-$data = '';
+$data .= pack("B8", "11101001");
+$data .= pack("B8A*", "01001010", "node_count");
+$data .= pack("B8C", "11000001", 1);
+$data .= pack("B8A*", "01001011", "record_size");
+$data .= pack("B8C", "10100001", 32);
+$data .= pack("B8A*", "01001010", "ip_version");
+$data .= pack("B8C", "10100001", 6);
+$data .= pack("B8A*", "01001101", "database_type");
+$data .= pack("B8A*", "01000100", "test");
+$data .= pack("B8A*", "01001001", "languages");
+$data .= pack("B8B8", "00000001", "00000100");
+$data .= pack("B8A*", "01000100", "test");
+$data .= pack("B8A*", "01011011", "binary_format_major_version");
+$data .= pack("B8C", "10100001", 2);
+$data .= pack("B8A*", "01011011", "binary_format_minor_version");
+$data .= pack("B8C", "10100001", 0);
+$data .= pack("B8A*", "01001011", "build_epoch");
+$data .= pack("B8B8C", "00000001", "00000010", 1);
+$data .= pack("B8A*", "01001011", "description");
+$data .= pack("B8", "11100000");
 
-for my $i (0 .. 31) {
-	$data .= pack_org(32) . pack_org($i + 1), next if $i == 4 or $i == 6;
-	$data .= pack_org(32) . pack_org($i + 2), next if $i == 31;
-	$data .= pack_org($i + 1) . pack_org(32);
-}
+$t->write_file('test.mmdb', $data);
 
-$data .= chr(42);
-$data .= pack('Z*', 'Nginx');
-$data .= chr(0xFF) x 3;
-$data .= chr(5);
-$data .= pack_node(32);
-
-$t->write_file('org.dat', $data);
-$t->try_run('no inet6 support')->plan(20);
+$t->try_run('no geoip mmdb')->plan(17);
 
 ###############################################################################
 
-my %data = stream_pp('10.0.0.1') =~ /(\w+):(.*)/g;
+my %data = stream('127.0.0.1:' . port(8080))->read() =~ /(\w+):(.*)/g;
+
 is($data{country_code}, 'RU', 'geoip country code');
-is($data{country_code3}, 'RUS', 'geoip country code 3');
+is($data{country_code3}, ':none', 'geoip country code 3');
 is($data{country_name}, 'Russian Federation', 'geoip country name');
 
-is($data{area_code}, 0, 'geoip area code');
+is($data{area_code}, ':none', 'geoip area code');
 is($data{city_continent_code}, 'EU', 'geoip city continent code');
 is($data{city_country_code}, 'RU', 'geoip city country code');
-is($data{city_country_code3}, 'RUS', 'geoip city country code 3');
+is($data{city_country_code3}, ':none', 'geoip city country code 3');
 is($data{city_country_name}, 'Russian Federation', 'geoip city country name');
 is($data{dma_code}, 0, 'geoip dma code');
 is($data{latitude}, 55.7543, 'geoip latitude');
 is($data{longitude}, 37.6202, 'geoip longitude');
-is($data{region}, 48, 'geoip region');
-is($data{region_name}, 'Moscow City', 'geoip region name');
+is($data{region}, 'MOW', 'geoip region');
+is($data{region_name}, 'Moscow', 'geoip region name');
 is($data{city}, 'Moscow', 'geoip city');
 is($data{postal_code}, 119034, 'geoip postal code');
 
-is($data{org}, 'Nginx', 'geoip org');
-
-like(stream_pp('::ffff:10.0.0.1'), qr/org:Nginx/, 'geoip ipv6 ipv4-mapped');
+is($data{org}, 'freenginx.org', 'geoip org');
 
-%data = stream_pp('2001:db8::') =~ /(\w+):(.*)/g;
-is($data{country_code}, 'US', 'geoip ipv6 country code');
-is($data{country_code3}, 'USA', 'geoip ipv6 country code 3');
-is($data{country_name}, 'United States', 'geoip ipv6 country name');
+is($data{asn}, '64511', 'geoip set asn');
 
 ###############################################################################
-
-sub stream_pp {
-	my ($ip) = @_;
-	my $type = ($ip =~ ':' ? 'TCP6' : 'TCP4');
-	return stream('127.0.0.1:' . port(8080))
-		->io("PROXY $type $ip 127.0.0.1 8080 8080${CRLF}");
-}
-
-sub pack_node {
-	substr pack('V', shift), 0, 3;
-}
-
-sub pack_org {
-	pack('V', shift);
-}
-
-###############################################################################



More information about the nginx-devel mailing list