<?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/>.

namespace core;

/**
 * GeoIp data file parsing test.
 *
 * @package    core
 * @category   test
 * @copyright  2012 Petr Skoda {@link http://skodak.org}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class geoip_test extends \advanced_testcase {
    #[\Override]
    public static function setUpBeforeClass(): void {
        global $CFG;

        parent::setUpBeforeClass();

        require_once("{$CFG->libdir}/filelib.php");
        require_once("{$CFG->dirroot}/iplookup/lib.php");
    }

    /**
     * Setup the GeoIP2File system.
     */
    public function setup_geoip2file(): void {
        global $CFG;
        $CFG->geoip2file = "$CFG->dirroot/iplookup/tests/fixtures/GeoIP2-City-Test.mmdb";
    }

    /**
     * Test that iplookup_find_location doesn't throw up GeoIp2 exceptions.
     *
     * @covers ::iplookup_find_location
     */
    public function test_not_found_ip(): void {
        $this->resetAfterTest();
        $this->setup_geoip2file();

        $result = iplookup_find_location('10.0.0.1');

        $this->assertIsArray($result);
        $this->assertNull($result['latitude']);
        $this->assertNull($result['longitude']);
        $this->assertNull($result['city']);
        $this->assertNull($result['country']);
        $this->assertIsArray($result['title']);
        $this->assertEmpty($result['title']);
        $this->assertEquals('Cannot find geo information about this IP address 10.0.0.1', $result['error']);
    }

    /**
     * Test the format of data returned in the iplookup_find_location function.
     *
     * @dataProvider ip_provider
     * @param   string  $ip The IP to test
     */
    public function test_ip($ip): void {
        global $CFG;
        if (!defined('TEST_GEOIP_APIKEY') || empty(TEST_GEOIP_APIKEY)) {
            $this->markTestSkipped('External geo tests are disabled.');
        }
        $this->resetAfterTest();
        $CFG->geopluginapikey = TEST_GEOIP_APIKEY;
        $this->setup_geoip2file();

        // Note: The results we get from the iplookup tests are beyond our control.
        // We used to check a specific IP to a known location, but these have become less reliable and change too
        // frequently to be used for testing.

        $result = iplookup_find_location($ip);

        $this->assertIsArray($result);
        $this->assertIsFloat($result['latitude']);
        $this->assertIsFloat($result['longitude']);
        $this->assertIsString($result['city']);
        $this->assertIsString($result['country']);
        $this->assertIsArray($result['title']);
        $this->assertIsString($result['title'][0]);
        $this->assertIsString($result['title'][1]);
        $this->assertNull($result['error']);
    }

    /**
     * Data provider for IP lookup test.
     *
     * @return array
     */
    public static function ip_provider(): array {
        return [
            'IPv4: IPV4 test' => ['81.2.69.142'],
            'IPv6: IPV6 test' => ['2001:252:1::1:1:1'],
        ];
    }
}
