MDL-32868 fix iplookup inconsistencies and add missing unit tests

Please note you need to define PHPUNIT_LONGTEST in config.php or phpunit.xml to get the tests to execute because it takes long time to fetch the geoip data and we do not want to DDOS geoPlugin server.
ericmerrill · May 12, 2012 · 64b0f3a · 64b0f3a
1 parent 71d7bc3
commit 64b0f3a
Show file tree

Hide file tree

Showing 4 changed files with 159 additions and 5 deletions.
diff --git a/iplookup/lib.php b/iplookup/lib.php
@@ -52,16 +52,21 @@ function iplookup_find_location($ip) {
             $info['title'][] = $info['city'];
         }
 
-        if (!empty($location->country_code)) {
+        if (!empty($location->countryCode)) {
             $countries = get_string_manager()->get_list_of_countries(true);
-            if (isset($countries[$location->country_code])) {
+            if (isset($countries[$location->countryCode])) {
                 // prefer our localized country names
-                $info['country'] = $countries[$location->country_code];
+                $info['country'] = $countries[$location->countryCode];
             } else {
-                $info['country'] = $location->country_name;
+                $info['country'] = $location->countryName;
             }
             $info['title'][] = $info['country'];
+
+        } else if (!empty($location->countryName)) {
+            $info['country'] = $location->countryName;
+            $info['title'][] = $info['country'];
         }
+
         $info['longitude'] = $location->longitude;
         $info['latitude']  = $location->latitude;
         $info['note'] = get_string('iplookupmaxmindnote', 'admin');
@@ -95,8 +100,8 @@ function iplookup_find_location($ip) {
 
         $info['note'] = get_string('iplookupgeoplugin', 'admin');
 
-        $info['title'][] = $info['country'];
         $info['title'][] = $info['city'];
+        $info['title'][] = $info['country'];
 
         return $info;
     }

diff --git a/iplookup/tests/geoip_test.php b/iplookup/tests/geoip_test.php
@@ -0,0 +1,86 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * GeoIP tests
+ *
+ * @package    core_iplookup
+ * @category   phpunit
+ * @copyright  2012 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * GeoIp data file parsing test.
+ */
+class geoip_testcase extends advanced_testcase {
+
+    public function test_geoip() {
+        global $CFG;
+        require_once("$CFG->libdir/filelib.php");
+        require_once("$CFG->dirroot/iplookup/lib.php");
+
+        if (!PHPUNIT_LONGTEST) {
+            // this may take a long time
+            return;
+        }
+
+        $this->resetAfterTest();
+
+        // let's store the file somewhere
+        $gzfile = "$CFG->dataroot/phpunit/geoip/GeoLiteCity.dat.gz";
+        check_dir_exists(dirname($gzfile));
+        if (file_exists($gzfile) and (filemtime($gzfile) < time() - 60*60*24*30)) {
+            // delete file if older than 1 month
+            unlink($gzfile);
+        }
+
+        if (!file_exists($gzfile)) {
+            download_file_content('http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz', null, null, false, 300, 20, false, $gzfile);
+        }
+
+        $this->assertTrue(file_exists($gzfile));
+
+        $zd = gzopen($gzfile, "r");
+        $contents = gzread($zd, 50000000);
+        gzclose($zd);
+
+        $geoipfile = "$CFG->dataroot/geoip/GeoLiteCity.dat";
+        check_dir_exists(dirname($geoipfile));
+        $fp = fopen($geoipfile, 'w');
+        fwrite($fp, $contents);
+        fclose($fp);
+
+        $this->assertTrue(file_exists($geoipfile));
+
+        $CFG->geoipfile = $geoipfile;
+
+        $result = iplookup_find_location('147.230.16.1');
+
+        $this->assertEquals('array', gettype($result));
+        $this->assertEquals('Liberec', $result['city']);
+        $this->assertEquals(15.0653, $result['longitude'], '', 0.001);
+        $this->assertEquals(50.7639, $result['latitude'], '', 0.001);
+        $this->assertNull($result['error']);
+        $this->assertEquals('array', gettype($result['title']));
+        $this->assertEquals('Liberec', $result['title'][0]);
+        $this->assertEquals('Czech Republic', $result['title'][1]);
+    }
+}
+
diff --git a/iplookup/tests/geoplugin_test.php b/iplookup/tests/geoplugin_test.php
@@ -0,0 +1,60 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * GeoIP tests
+ *
+ * @package    core_iplookup
+ * @category   phpunit
+ * @copyright  2012 Petr Skoda {@link http://skodak.org}
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * GeoIp data file parsing test.
+ */
+class geoplugin_testcase extends advanced_testcase {
+
+    public function test_geoip() {
+        global $CFG;
+        require_once("$CFG->libdir/filelib.php");
+        require_once("$CFG->dirroot/iplookup/lib.php");
+
+        if (!PHPUNIT_LONGTEST) {
+            // we do not want to DDOS their server, right?
+            return;
+        }
+
+        $this->resetAfterTest();
+
+        $CFG->geoipfile = '';
+
+        $result = iplookup_find_location('147.230.16.1');
+
+        $this->assertEquals('array', gettype($result));
+        $this->assertEquals('Liberec', $result['city']);
+        $this->assertEquals(15.0653, $result['longitude'], '', 0.001);
+        $this->assertEquals(50.7639, $result['latitude'], '', 0.001);
+        $this->assertNull($result['error']);
+        $this->assertEquals('array', gettype($result['title']));
+        $this->assertEquals('Liberec', $result['title'][0]);
+        $this->assertEquals('Czech Republic', $result['title'][1]);
+    }
+}
+
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -45,6 +45,9 @@
         <testsuite name="core_blog">
             <directory suffix="_test.php">blog/tests</directory>
         </testsuite>
+        <testsuite name="core_iplookup">
+            <directory suffix="_test.php">iplookup/tests</directory>
+        </testsuite>
         <testsuite name="core_course">
             <directory suffix="_test.php">course/tests</directory>
         </testsuite>