VisitsInPast_InvalidateOldReportsTest.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$
 */

/**
 *
 */
class Test_Piwik_Integration_VisitsInPast_InvalidateOldReports extends IntegrationTestCase
{
    protected static $dateTimeFirstDateWebsite1 = '2010-03-06 01:22:33';
    protected static $dateTimeDateInPastWebsite1 = '2010-01-06 01:22:33';

    protected static $dateTimeFirstDateWebsite2 = '2010-01-03 20:22:33';
    protected static $dateTimeDateInPastWebsite2 = '2009-10-30 01:22:33';
    protected static $idSite = 1;
    protected static $idSite2 = 2;

    /**
     * @dataProvider getApiForTesting
     * @group        Integration
     * @group        VisitsInPast_InvalidateOldReports
     */
    public function testApi($api, $params)
    {
        $this->runApiTests($api, $params);
    }

    /**
     * This should NOT return data for old dates before website creation
     */
    public function getApiForTesting()
    {
        // We test a typical Numeric and a Recursive blob reports
        $apiToCall = array('VisitsSummary.get', 'Actions.getPageUrls');

        // We also test a segment
        //TODO

        // Build tests for the 2 websites
        return array(
            array($apiToCall, array('idSite'                 => self::$idSite,
                                    'testSuffix'             => 'Website' . self::$idSite . '_OldReportsShouldNotAppear',
                                    'date'                   => self::$dateTimeDateInPastWebsite1,
                                    'periods'                => 'month',
                                    'setDateLastN'           => 4, // 4months ahead
                                    'otherRequestParameters' => array('expanded' => 1))),
            array($apiToCall, array('idSite'                 => self::$idSite2,
                                    'testSuffix'             => 'Website' . self::$idSite2 . '_OldReportsShouldNotAppear',
                                    'date'                   => self::$dateTimeDateInPastWebsite2,
                                    'periods'                => 'month',
                                    'setDateLastN'           => 4, // 4months ahead
                                    'otherRequestParameters' => array('expanded' => 1))),
        );
    }

    /**
     * @dataProvider getAnotherApiForTesting
     * @group        Integration
     * @group        VisitsInPast_InvalidateOldReports
     */
    public function testAnotherApi($api, $params)
    {
        // 1) Invalidate old reports for the 2 websites
        // Test invalidate 1 date only
        $r = new Piwik_API_Request("module=API&method=CoreAdminHome.invalidateArchivedReports&idSites=4,5,6,55,-1,s',1&dates=2010-01-03");
        ($r->process());
        // Test invalidate comma separated dates
        $r = new Piwik_API_Request("module=API&method=CoreAdminHome.invalidateArchivedReports&idSites=" . self::$idSite . "," . self::$idSite2 . "&dates=2010-01-06,2009-10-30");
        ($r->process());
        // test invalidate date in the past
        $r = new Piwik_API_Request("module=API&method=CoreAdminHome.invalidateArchivedReports&idSites=" . self::$idSite2 . "&dates=2009-06-29");
        ($r->process());
        // invalidate a date more recent to check the date is only updated when it's earlier than current
        $r = new Piwik_API_Request("module=API&method=CoreAdminHome.invalidateArchivedReports&idSites=" . self::$idSite2 . "&dates=2010-03-03");
        ($r->process());

        // 2) Call API again, with an older date, which should now return data
        $this->runApiTests($api, $params);
    }

    /**
     * This is called after getApiToTest()
     * WE invalidate old reports and check that data is now returned for old dates
     */
    public function getAnotherApiForTesting()
    {
        $apiToCall = array('VisitsSummary.get', 'Actions.getPageUrls');

        return array(
            array($apiToCall, array('idSite'                 => self::$idSite,
                                    'testSuffix'             => 'Website' . self::$idSite . '_OldReportsShouldAppear',
                                    'date'                   => self::$dateTimeDateInPastWebsite1,
                                    'periods'                => 'month',
                                    'setDateLastN'           => 4, // 4months ahead
                                    'otherRequestParameters' => array('expanded' => 1))),
            array($apiToCall, array('idSite'                 => self::$idSite2,
                                    'testSuffix'             => 'Website' . self::$idSite2 . '_OldReportsShouldAppear',
                                    'date'                   => self::$dateTimeDateInPastWebsite2,
                                    'periods'                => 'month',
                                    'setDateLastN'           => 4, // 4months ahead
                                    'otherRequestParameters' => array('expanded' => 1))),
        );
    }

    public function getOutputPrefix()
    {
        return 'VisitsInPast_InvalidateOldReports';
    }

    public function setUpWebsitesAndGoals()
    {
        $this->createWebsite(self::$dateTimeFirstDateWebsite1);
        $this->createWebsite(self::$dateTimeFirstDateWebsite2);
    }

    protected function trackVisits()
    {
        /**
         * Track Visits normal date for the 2 websites
         */

        // WEBSITE 1
        $t = $this->getTracker(self::$idSite, self::$dateTimeFirstDateWebsite1, $defaultInit = true);
        $t->setUrl('http://example.org/category/Page1');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page2');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page3');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Home');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Contact');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Contact/ThankYou');
        $this->checkResponse($t->doTrackPageView('Hello'));

        // WEBSITE 2
        $t = $this->getTracker(self::$idSite2, self::$dateTimeFirstDateWebsite2, $defaultInit = true);
        $t->setIp('156.15.13.12');
        $t->setUrl('http://example.org/category/Page1');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page2');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page3');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Home');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Contact');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/Contact/ThankYou');
        $this->checkResponse($t->doTrackPageView('Hello'));

        /**
         * Track visits in the past (before website creation date) for the 2 websites
         */
        // WEBSITE1
        $t = $this->getTracker(self::$idSite, self::$dateTimeDateInPastWebsite1, $defaultInit = true);
        $t->setIp('156.5.55.2');
        $t->setUrl('http://example.org/category/Page1');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page2');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page3');

        // WEBSITE2
        $t = $this->getTracker(self::$idSite2, self::$dateTimeDateInPastWebsite2, $defaultInit = true);
        $t->setIp('156.52.3.22');
        $t->setUrl('http://example.org/category/Page1');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page2');
        $this->checkResponse($t->doTrackPageView('Hello'));
        $t->setUrl('http://example.org/category/Page3');
    }
}