diff options
Diffstat (limited to 'plugins/UserCountry/tests/Integration/VisitorGeolocatorTest.php')
| -rw-r--r-- | plugins/UserCountry/tests/Integration/VisitorGeolocatorTest.php | 378 |
1 files changed, 378 insertions, 0 deletions
diff --git a/plugins/UserCountry/tests/Integration/VisitorGeolocatorTest.php b/plugins/UserCountry/tests/Integration/VisitorGeolocatorTest.php new file mode 100644 index 0000000000..4217f189e6 --- /dev/null +++ b/plugins/UserCountry/tests/Integration/VisitorGeolocatorTest.php @@ -0,0 +1,378 @@ +<?php +/** + * Piwik - free/libre analytics platform + * + * @link http://piwik.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + * + */ +namespace Piwik\Plugins\UserCountry\tests\Integration; + +use PHPUnit_Framework_MockObject_MockObject; +use Piwik\Common; +use Piwik\Db; +use Piwik\Network\IPUtils; +use Piwik\Plugins\UserCountry\VisitorGeolocator; +use Piwik\Plugins\UserCountry\LocationProvider; +use Piwik\Tests\Framework\TestCase\IntegrationTestCase; +use Piwik\Tracker\Cache; +use Piwik\Tracker\Visit; +use Piwik\Tests\Framework\Mock\LocationProvider as MockLocationProvider; + +require_once PIWIK_INCLUDE_PATH . '/tests/PHPUnit/Framework/Mock/LocationProvider.php'; + +/** + * @group UserCountry + */ +class VisitorGeolocatorTest extends IntegrationTestCase +{ + const TEST_IP = '1.2.3.4'; + + public function test_getLocation_shouldReturnLocationForProvider_IfLocationIsSetForCurrentProvider() + { + $location = array( + 'city' => 'Wroclaw', + 'country_code' => 'pl' + ); + + $provider = $this->getProviderMock(); + $provider->expects($this->once()) + ->method('getLocation') + ->will($this->returnValue($location)); + + $geolocator = new VisitorGeolocator($provider); + + $this->assertEquals( + $location, + $geolocator->getLocation(array('ip' => '127.0.0.1')) + ); + } + + public function test_getLocation_shouldReturnLocationForProvider_IfLocationCountryCodeIsNotSetShouldSetAsxx() + { + $location = array( + 'city' => 'Wroclaw' + ); + + $provider = $this->getProviderMock(); + $provider->expects($this->once()) + ->method('getLocation') + ->will($this->returnValue($location)); + + $geolocator = new VisitorGeolocator($provider); + + $this->assertEquals( + array_merge( + $location, + array( + 'country_code' => Visit::UNKNOWN_CODE + ) + ), + $geolocator->getLocation(array('ip' => '127.0.0.2')) + ); + } + + public function test_getLocation_shouldReturnLocationForProviderAndReadFromCacheIfIPIsNotChanged() + { + $locations = array( + 'pl' => array( + 'city' => 'Wroclaw', + 'country_code' => 'pl' + ), + + 'nz' => array( + 'city' => 'Wellington', + 'country_code' => 'nz' + ), + ); + + $poland = $this->getProviderMock(); + $poland->expects($this->once()) + ->method('getLocation') + ->will($this->returnValue($locations['pl'])); + + $geolocator = new VisitorGeolocator($poland); + $geolocator->getLocation(array('ip' => '10.0.0.1')); + + $nz = $this->getProviderMock(); + $nz->expects($this->once()) + ->method('getLocation') + ->will($this->returnValue($locations['nz'])); + + $geolocator = new VisitorGeolocator($nz); + $geolocator->getLocation(array('ip' => '10.0.0.2')); + + $this->assertEquals( + $locations, + array( + 'pl' => $geolocator->getLocation(array('ip' => '10.0.0.1')), + 'nz' => $geolocator->getLocation(array('ip' => '10.0.0.2')) + ) + ); + } + + public function test_get_shouldReturnDefaultProvider_IfCurrentProviderReturnFalse() + { + Cache::setCacheGeneral(array('currentLocationProviderId' => 'nonexistant')); + $geolocator = new VisitorGeolocator(); + + $this->assertEquals(LocationProvider\DefaultProvider::ID, $geolocator->getProvider()->getId()); + } + + public function test_get_shouldReturnCurrentProvider_IfCurrentProviderIsSet() + { + Cache::setCacheGeneral(array('currentLocationProviderId' => MockLocationProvider::ID)); + $geolocator = new VisitorGeolocator(); + + $this->assertEquals(MockLocationProvider::ID, $geolocator->getProvider()->getId()); + } + + public function getDataForAttributeExistingVisitTests() + { + $basicTestLocation = array( + LocationProvider::COUNTRY_CODE_KEY => 'US', + LocationProvider::REGION_CODE_KEY => 'rg', + LocationProvider::CITY_NAME_KEY => 'the city', + LocationProvider::LATITUDE_KEY => '29.959698', + LocationProvider::LONGITUDE_KEY => '-90.064880' + ); + + // note: floating point values should be used for expected properties so floating point comparison is done + // by PHPUnit + $basicExpectedVisitProperties = array( + 'location_country' => 'us', + 'location_region' => 'rg', + 'location_city' => 'the city', + 'location_latitude' => 29.959698, + 'location_longitude' => -90.064880 + ); + + return array( + array( // test normal re-attribution + $basicTestLocation, + + $basicExpectedVisitProperties + ), + + array( // test w/ garbage in location provider result + array( + LocationProvider::COUNTRY_CODE_KEY => 'US', + 'garbage' => 'field', + LocationProvider::REGION_CODE_KEY => 'rg', + LocationProvider::CITY_NAME_KEY => 'the city', + LocationProvider::LATITUDE_KEY => '29.959698', + LocationProvider::LONGITUDE_KEY => '-90.064880', + 'another' => 'garbage field' + ), + + array( + 'location_country' => 'us', + 'location_region' => 'rg', + 'location_city' => 'the city', + 'location_latitude' => 29.959698, + 'location_longitude' => -90.064880 + ) + ), + + array( // test when visit has some correct properties already + $basicTestLocation, + + $basicExpectedVisitProperties, + + array( + 'location_country' => 'US', + 'location_region' => 'rg', + 'location_city' => 'the city' + ), + + array( + 'location_country' => 'us', + 'location_latitude' => 29.959698, + 'location_longitude' => -90.064880 + ) + ), + + array( // test when visit has all correct properties already + $basicTestLocation, + + $basicExpectedVisitProperties, + + $basicExpectedVisitProperties, + + array() + ) + ); + } + + /** + * @dataProvider getDataForAttributeExistingVisitTests + */ + public function test_attributeExistingVisit_CorrectlySetsLocationProperties_AndReturnsCorrectResult( + $mockLocation, $expectedVisitProperties, $visitProperties = array(), $expectedUpdateValues = null) + { + $mockLocationProvider = $this->getProviderMockThatGeolocates($mockLocation); + + $visit = $this->insertVisit($visitProperties); + $this->insertTwoConversions($visit); + + $geolocator = new VisitorGeolocator($mockLocationProvider); + $valuesUpdated = $geolocator->attributeExistingVisit($visit, $useCache = false); + + $this->assertEquals($expectedVisitProperties, $this->getVisit($visit['idvisit']), $message = '', $delta = 0.001); + + $expectedUpdateValues = $expectedUpdateValues === null ? $expectedVisitProperties : $expectedUpdateValues; + $this->assertEquals($expectedUpdateValues, $valuesUpdated, $message = '', $delta = 0.001); + + $conversions = $this->getConversions($visit); + $this->assertEquals(array($expectedVisitProperties, $expectedVisitProperties), $conversions, $message = '', $delta = 0.001); + } + + public function test_attributeExistingVisit_ReturnsNull_AndSkipsAttribution_IfIdVisitMissingFromInput() + { + $mockLocationProvider = $this->getProviderMock(); + $geolocator = new VisitorGeolocator($mockLocationProvider); + + $result = $geolocator->attributeExistingVisit(array()); + + $this->assertNull($result); + } + + public function test_attributeExistingVisit_ReturnsNull_AndSkipsAttribution_IfIdVisitPresent_AndLocationIpMissingFromInput() + { + $mockLocationProvider = $this->getProviderMock(); + $geolocator = new VisitorGeolocator($mockLocationProvider); + + $result = $geolocator->attributeExistingVisit(array('idvisit' => 1)); + + $this->assertNull($result); + } + + /** + * @return PHPUnit_Framework_MockObject_MockObject|LocationProvider + */ + protected function getProviderMock() + { + return $this->getMockBuilder('\Piwik\Plugins\UserCountry\LocationProvider') + ->setMethods(array('getId', 'getLocation', 'isAvailable', 'isWorking', 'getSupportedLocationInfo')) + ->disableOriginalConstructor() + ->getMock(); + } + + private function getProviderMockThatGeolocates($locationResult) + { + $mock = $this->getProviderMock(); + $mock->expects($this->once())->method('getLocation')->will($this->returnCallback(function ($info) use ($locationResult) { + if ($info['ip'] == VisitorGeolocatorTest::TEST_IP) { + return $locationResult; + } else { + return null; + } + })); + return $mock; + } + + private function insertVisit($visit = array()) + { + $defaultProperties = array( + 'idsite' => 1, + 'idvisitor' => hex2bin('ea95f303f2165aa0'), + 'visit_last_action_time' => '2012-01-01 00:00:00', + 'config_id' => hex2bin('ea95f303f2165aa0'), + 'location_ip' => IPUtils::stringToBinaryIP(self::TEST_IP), + 'visitor_localtime' => '2012-01-01 00:00:00', + 'location_country' => 'xx', + 'config_os' => 'xxx', + 'visit_total_events' => 0, + 'visitor_days_since_last' => 0, + 'config_quicktime' => 0, + 'config_pdf' => 0, + 'config_realplayer' => 0, + 'config_silverlight' => 0, + 'config_windowsmedia' => 0, + 'config_java' => 0, + 'config_gears' => 0, + 'config_resolution' => 0, + 'config_resolution' => '', + 'config_cookie' => 0, + 'config_director' => 0, + 'config_flash' => 0, + 'config_browser_version' => '', + 'visitor_count_visits' => 1, + 'visitor_returning' => 0, + 'visit_total_time' => 123, + 'visit_entry_idaction_name' => 0, + 'visit_entry_idaction_url' => 0, + 'visitor_days_since_order' => 0, + 'visitor_days_since_first' => 0, + 'visit_first_action_time' => '2012-01-01 00:00:00', + 'visit_goal_buyer' => 0, + 'visit_goal_converted' => 0, + 'visit_exit_idaction_name' => 0, + 'referer_url' => '', + 'location_browser_lang' => 'xx', + 'config_browser_engine' => '', + 'config_browser_name' => '', + 'referer_type' => 0, + 'referer_name' => '', + 'visit_total_actions' => 0, + 'visit_total_searches' => 0 + ); + + $visit = array_merge($defaultProperties, $visit); + + $this->insertInto('log_visit', $visit); + + $idVisit = Db::fetchOne("SELECT LAST_INSERT_ID()"); + return $this->getVisit($idVisit, $allColumns = true); + } + + private function getVisit($idVisit, $allColumns = false) + { + $columns = $allColumns ? "*" : "location_country, location_region, location_city, location_latitude, location_longitude"; + $visit = Db::fetchRow("SELECT $columns FROM " . Common::prefixTable('log_visit') . " WHERE idvisit = ?", array($idVisit)); + + return $visit; + } + + private function insertTwoConversions($visit) + { + $conversionProperties = array( + 'idvisit' => $visit['idvisit'], + 'idsite' => $visit['idsite'], + 'idvisitor' => $visit['idvisitor'], + 'server_time' => '2012-01-01 00:00:00', + 'idgoal' => 1, + 'buster' => 1, + 'url' => '', + 'location_longitude' => $visit['location_longitude'], + 'location_latitude' => $visit['location_latitude'], + 'location_region' => $visit['location_region'], + 'location_country' => $visit['location_country'], + 'location_city' => $visit['location_city'], + 'visitor_count_visits' => $visit['visitor_count_visits'], + 'visitor_returning' => $visit['visitor_returning'], + 'visitor_days_since_order' => 0, + 'visitor_days_since_first' => 0 + ); + + $this->insertInto('log_conversion', $conversionProperties); + + $conversionProperties['buster'] = 2; + $this->insertInto('log_conversion', $conversionProperties); + } + + private function insertInto($table, $row) + { + $columns = implode(', ', array_keys($row)); + $columnsPlaceholders = Common::getSqlStringFieldsArray($row); + $values = array_values($row); + + Db::query("INSERT INTO " . Common::prefixTable($table) . " ($columns) VALUES ($columnsPlaceholders)", $values); + } + + private function getConversions($visit) + { + return Db::fetchAll("SELECT location_country, location_region, location_city, location_latitude, location_longitude + FROM " . Common::prefixTable('log_conversion') . " WHERE idvisit = ?", array($visit['idvisit'])); + } +}
\ No newline at end of file |