ManyVisitorsOneWebsiteTest.php

<?php
/**
 * Piwik - Open source web analytics
 *
 * @link	http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 * @version $Id$
 */

require_once PIWIK_INCLUDE_PATH . '/tests/PHPUnit/MockLocationProvider.php';

/**
 * Tests w/ 14 visitors w/ 2 visits each. Uses geoip location provider to test city/region reports.
 * 
 * TODO Test ServerBased GeoIP implementation somehow.
 * TODO When added, test PECL implementation.
 */
class Test_Piwik_Integration_ManyVisitorsOneWebsiteTest extends IntegrationTestCase
{
	protected static $idSite = 1;
	protected static $dateTime = '2010-01-03 11:22:33';
	
	public static $ips = array(
		'194.57.91.215', // in Besançon, FR (unicode city name)
		
		'137.82.130.49', // in British Columbia
		
		'137.82.130.0', // anonymization tests
		'137.82.0.0',
		
		'151.100.101.92', // in Rome, Italy (using country DB, so only Italy will show)
		
		'103.29.196.229', // in Indonesia (Bali), (only Indonesia will show up)
	);
	
	public static $geoIpDbUrl = 'http://piwik-team.s3.amazonaws.com/GeoIP.dat.gz';
	public static $geoLiteCityDbUrl = 'http://piwik-team.s3.amazonaws.com/GeoLiteCity.dat.gz';

	public static function setUpBeforeClass()
	{
		parent::setUpBeforeClass();
		try {
			self::setUpWebsitesAndGoals();
			self::downloadGeoIpDbs();
			
			self::setMockLocationProvider();
			self::trackVisits(8, false);
			
			self::setLocationProvider('GeoLiteCity.dat');
			self::trackVisits(4, true);
			
			self::setLocationProvider('GeoIP.dat');
			self::trackVisits(2, true);
		} catch(Exception $e) {
			// Skip whole test suite if an error occurs while setup
			throw new PHPUnit_Framework_SkippedTestSuiteError($e->getMessage());
		}
	}
	
	public static function tearDownAfterClass()
	{
		self::unsetLocationProvider();
		parent::tearDownAfterClass();
	}
	
	/**
	 * @dataProvider getApiForTesting
	 * @group        Integration
	 * @group        TwoVisitors_TwoWebsites_DifferentDays_ArchivingDisabled
	 */
	public function testApi($api, $params)
	{
		$this->runApiTests($api, $params);
	}

	public function getApiForTesting()
	{
		return array(
			array('UserCountry', array('idSite'		=> self::$idSite,
									   'date'		=> self::$dateTime,
									   'periods'	=> array('month'))),
			
			array('UserCountry', array('idSite'		=> self::$idSite,
									   'date'		=> self::$dateTime,
									   'periods'	=> array('month'),
									   'testSuffix' => '_segment_region',
									   'segment'    => 'region==P3;country==gb')),
			
			array('UserCountry', array('idSite'		=> self::$idSite,
									   'date'		=> self::$dateTime,
									   'periods'	=> array('month'),
									   'testSuffix' => '_segment_city',
									   'segment'    => 'city==Stratford-upon-Avon;region==P3;country==gb')),
			
			array('UserCountry', array('idSite'		=> self::$idSite,
									   'date'		=> self::$dateTime,
									   'periods'	=> array('month'),
									   'testSuffix' => '_segment_lat_long',
									   'segment'    => 'lat>45;lat<49.3;long>-125;long<-122')),
			
			array('UserCountry.getCountry', array('idSite'		=> self::$idSite,
												  'date'		=> self::$dateTime,
												  'periods'		=> array('month'),
												  'testSuffix'	=> '_segment_continent',
												  'segment'   	=> 'continent==eur'))
		);
	}
	
	public static function setUpWebsitesAndGoals()
	{
		self::createWebsite(self::$dateTime, 0, "Site 1");
	}
	
	protected static function trackVisits( $visitorCount, $setIp = false )
	{
		$dateTime = self::$dateTime;
		$idSite   = self::$idSite;
		
		// use local tracker so mock location provider can be used
		$t = self::getTracker($idSite, $dateTime, $defaultInit = true, $useLocal = true);
		for ($i = 0; $i != $visitorCount; ++$i)
		{
			$t->setNewVisitorId();
			if ($setIp)
			{
				$t->setIp(current(self::$ips));
				next(self::$ips);
			}
			else
			{
				$t->setIp("1.2.4.$i");
			}
			
			// first visit
			$date = Piwik_Date::factory($dateTime)->addDay($i);
			$t->setForceVisitDateTime($date->getDatetime());
			$t->setUrl("http://piwik.net/grue/lair");
			self::checkResponse($t->doTrackPageView('It\'s pitch black...'));
			
			// second visit
			$date = $date->addHour(1);
			$t->setForceVisitDateTime($date->getDatetime());
			$t->setUrl("http://piwik.net/space/quest/iv");
			self::checkResponse($t->doTrackPageView("Space Quest XII"));
		}
	}
	
	public static function setLocationProvider( $file )
	{
		Piwik_UserCountry_LocationProvider_GeoIp::$dbNames['loc'] = array($file);
		Piwik_UserCountry_LocationProvider::$providers = null;
		Piwik_UserCountry_LocationProvider::setCurrentProvider('geoip_php');
	}
	
	public static function setMockLocationProvider()
	{
		Piwik_UserCountry_LocationProvider::$providers = null;
		Piwik_UserCountry_LocationProvider::setCurrentProvider('mock_provider');
		Piwik_UserCountry_LocationProvider::getCurrentProvider()->setLocations(array(
			self::makeLocation('Stratford-upon-Avon', 'P3', 'gb'), // template location
			
			// same region, different city, same country
			self::makeLocation('Nuneaton and Bedworth', 'P3', 'gb'),
			
			// same region, city & country
			self::makeLocation('Stratford-upon-Avon', 'P3', 'gb'),
			
			// same country, different region & city
			self::makeLocation('London', 'H9', 'gb'),
			
			// same country, different region, same city
			self::makeLocation('Stratford-upon-Avon', 'G5', 'gb'),
			
			// different country, diff region, same city
			self::makeLocation('Stratford-upon-Avon', '66', 'ru'),
			
			// different country, diff region (same as last), different city
			self::makeLocation('Hluboká nad Vltavou', '66', 'ru'),
			
			// different country, diff region (same as last), same city
			self::makeLocation('Stratford-upon-Avon', '66', 'mk'),
		));
	}
	
	public static function unsetLocationProvider()
	{
		Piwik_UserCountry_LocationProvider::setCurrentProvider('default');
	}
	
	public static function downloadGeoIpDbs()
	{
		$geoIpOutputDir = PIWIK_INCLUDE_PATH.'/tests/lib/geoip-files';
		self::downloadAndUnzip(self::$geoIpDbUrl, $geoIpOutputDir, 'GeoIP.dat');
		self::downloadAndUnzip(self::$geoLiteCityDbUrl, $geoIpOutputDir, 'GeoLiteCity.dat');
	}
	
	public static function downloadAndUnzip( $url, $outputDir, $filename )
	{
		$bufferSize = 1024 * 1024;
		
		try
		{
			if (!is_dir($outputDir)) 
			{
				mkdir($outputDir);
			}
			
			$deflatedOut = $outputDir.'/'.$filename;
			$outfileName = $deflatedOut.'.gz';
			
			if (file_exists($deflatedOut))
			{
				return;
			}
			
			$dump = fopen($url, 'rb');
			$outfile = fopen($outfileName, 'wb');
			$bytesRead = 0;
			while (!feof($dump))
			{
				fwrite($outfile, fread($dump, $bufferSize), $bufferSize);
				$bytesRead += $bufferSize;
			}
			fclose($dump);
			fclose($outfile);
			
			// unzip the dump
			exec("gunzip -c \"".$outfileName."\" > \"$deflatedOut\"", $output, $return);
			if ($return !== 0)
			{
				throw new Exception("gunzip failed($return): ".implode("\n", $output));
			}
		}
		catch (Exception $ex)
		{
			self::markTestSkipped(
				"Cannot download GeoIp DBs, skipping: ".$ex->getMessage()."\n".$ex->getTraceAsString());
		}
	}
	
	public static function makeLocation( $city, $region, $country )
	{
		return array(Piwik_UserCountry_LocationProvider::CITY_NAME_KEY => $city,
					  Piwik_UserCountry_LocationProvider::REGION_CODE_KEY => $region,
					  Piwik_UserCountry_LocationProvider::COUNTRY_CODE_KEY => $country);
	}
}