diff options
Diffstat (limited to 'plugins/CustomDimensions/tests/System/ApiTest.php')
| m--------- | plugins/CustomDimensions | 0 | ||||
| -rw-r--r-- | plugins/CustomDimensions/tests/System/ApiTest.php | 247 |
2 files changed, 247 insertions, 0 deletions
diff --git a/plugins/CustomDimensions b/plugins/CustomDimensions deleted file mode 160000 -Subproject 318661a2fb1ef3b3e5d6d999ae8b9628cb5a113 diff --git a/plugins/CustomDimensions/tests/System/ApiTest.php b/plugins/CustomDimensions/tests/System/ApiTest.php new file mode 100644 index 0000000000..29852e9319 --- /dev/null +++ b/plugins/CustomDimensions/tests/System/ApiTest.php @@ -0,0 +1,247 @@ +<?php +/** + * Matomo - free/libre analytics platform + * + * @link https://matomo.org + * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later + */ + +namespace Piwik\Plugins\CustomDimensions\tests\System; + +use Piwik\Plugins\CustomDimensions\tests\Fixtures\TrackVisitsWithCustomDimensionsFixture; +use Piwik\Tests\Framework\TestCase\SystemTestCase; + +/** + * @group CustomDimensions + * @group ApiTest + * @group Plugins + */ +class ApiTest extends SystemTestCase +{ + /** + * @var TrackVisitsWithCustomDimensionsFixture + */ + public static $fixture = null; // initialized below class definition + + /** + * @dataProvider getApiForTesting + */ + public function testApi($api, $params) + { + $this->runApiTests($api, $params); + } + + public function getApiForTesting() + { + $api = array( + 'CustomDimensions.getCustomDimension', + ); + + $tests = array( + array('idSite' => 1, 'idDimension' => 1), + array('idSite' => 1, 'idDimension' => 2), + array('idSite' => 1, 'idDimension' => 3), + array('idSite' => 1, 'idDimension' => 4), + array('idSite' => 1, 'idDimension' => 5), + array('idSite' => 1, 'idDimension' => 6), + array('idSite' => 2, 'idDimension' => 1), + array('idSite' => 1, 'idDimension' => 999), // dimension does not exist + ); + + $removeColumns = [ + 'sum_time_generation', + 'sum_bandwidth', + 'nb_hits_with_bandwidth', + 'min_bandwidth', + 'max_bandwidth', + 'avg_bandwidth', + 'nb_total_overall_bandwidth', + 'nb_total_pageview_bandwidth', + 'nb_total_download_bandwidth', + 'nb_visits_converted' + ]; + + $apiToTest = array(); + + foreach ($tests as $test) { + $idSite = $test['idSite']; + $idDimension = $test['idDimension']; + + foreach (array('day', 'year') as $period) { + $apiToTest[] = array($api, + array( + 'idSite' => $idSite, + 'date' => self::$fixture->dateTime, + 'periods' => array($period), + 'otherRequestParameters' => array( + 'idDimension' => $idDimension, + 'expanded' => '0', + 'flat' => '0', + ), + 'testSuffix' => "${period}_site_${idSite}_dimension_${idDimension}", + 'xmlFieldsToRemove' => $removeColumns + ) + ); + } + + } + + $apiToTest[] = array($api, array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('day'), + 'otherRequestParameters' => array( + 'idDimension' => 3, + 'expanded' => '1', + 'flat' => '0', + ), + 'testSuffix' => "day_site_1_dimension_3_expanded", + 'xmlFieldsToRemove' => $removeColumns + )); + + $apiToTest[] = array($api, array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('day'), + 'otherRequestParameters' => array( + 'idDimension' => 3, + 'expanded' => '0', + 'flat' => '1', + ), + 'testSuffix' => "day_site_1_dimension_3_flat", + 'xmlFieldsToRemove' => $removeColumns + )); + + $apiToTest[] = array($api, + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('year'), + 'segment' => 'dimension1=@value5', + 'otherRequestParameters' => array( + 'idDimension' => 1, + ), + 'testSuffix' => "year_site_1_dimension_1_withsegment", + 'xmlFieldsToRemove' => $removeColumns + ) + ); + + foreach (array(1, 2, 99) as $idSite) { + $api = array('CustomDimensions.getConfiguredCustomDimensions', + 'CustomDimensions.getAvailableScopes'); + $apiToTest[] = array($api, + array( + 'idSite' => $idSite, + 'date' => self::$fixture->dateTime, + 'periods' => array('day'), + 'testSuffix' => '_' . $idSite + ) + ); + + $apiToTest[] = array('CustomDimensions.getConfiguredCustomDimensionsHavingScope', + array( + 'idSite' => $idSite, + 'date' => self::$fixture->dateTime, + 'periods' => array('day'), + 'testSuffix' => '_' . $idSite, + 'otherRequestParameters' => [ + 'scope' => 'visit', + ], + ), + ); + } + + $apiToTest[] = array(array('CustomDimensions.getAvailableExtractionDimensions'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('day') + ) + ); + + $apiToTest[] = array( + array('API.getReportMetadata'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('day') + ) + ); + + $apiToTest[] = array(array('API.getSegmentsMetadata'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('year'), + 'otherRequestParameters' => [ + 'hideColumns' => 'acceptedValues' // hide accepted values as they might change + ] + ) + ); + + $apiToTest[] = array(array('API.getProcessedReport'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('year'), + 'otherRequestParameters' => array( + 'apiModule' => 'CustomDimensions', + 'apiAction' => 'getCustomDimension', + 'idDimension' => '3' + ), + 'testSuffix' => '_actionDimension', + 'xmlFieldsToRemove' => ['idsubdatatable'] + ) + ); + + $apiToTest[] = array(array('API.getProcessedReport'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('year'), + 'otherRequestParameters' => array( + 'apiModule' => 'CustomDimensions', + 'apiAction' => 'getCustomDimension', + 'idDimension' => '1' + ), + 'testSuffix' => '_visitDimension', + 'xmlFieldsToRemove' => ['nb_visits_converted'] + ) + ); + + $removeColumns = [ + 'generationTimeMilliseconds', + 'totalEcommerceRevenue', + 'totalEcommerceConversions', + 'totalEcommerceItems', + 'totalAbandonedCarts', + 'totalAbandonedCartsRevenue', + 'totalAbandonedCartsItems' + ]; + + $apiToTest[] = array( + array('Live.getLastVisitsDetails'), + array( + 'idSite' => 1, + 'date' => self::$fixture->dateTime, + 'periods' => array('year'), + 'xmlFieldsToRemove' => $removeColumns + ) + ); + + return $apiToTest; + } + + public static function getOutputPrefix() + { + return ''; + } + + public static function getPathToTestDirectory() + { + return dirname(__FILE__); + } + +} + +ApiTest::$fixture = new TrackVisitsWithCustomDimensionsFixture();
\ No newline at end of file |