1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
use Piwik\Piwik;
use Piwik\Access;
use Piwik\AssetManager;
use Piwik\Plugins\VisitsSummary\API;
/**
* Tests UI code by grabbing screenshots of webpages and comparing with expected files.
*
* Uses cutycapt.
*
* TODO:
* - allow instrumentation javascript to be injected before screenshot is taken (so we can, say,
* take a screenshot of column documentation)
*/
class Test_Piwik_Integration_UIIntegrationTest extends IntegrationTestCase
{
const IMAGE_TYPE = 'png';
const CUTYCAPT_DELAY = 1000;
public static $fixture = null; // initialized below class definition
private static $useXvfb = false;
public static function createAccessInstance()
{
Access::setSingletonInstance($access = new Test_Access_OverrideLogin());
Piwik_PostEvent('FrontController.initAuthenticationObject');
}
public static function setUpBeforeClass()
{
if (self::isXvfbAvailable()) {
self::$useXvfb = true;
} else if (!self::isCutyCaptAvailable()) {
self::markTestSkipped("cutycapt is not available, skipping UI integration tests. "
. "(install with 'sudo apt-get intsall cutycapt')");
}
parent::setUpBeforeClass();
AssetManager::removeMergedAssets();
// launch archiving so tests don't run out of time
API::getInstance()->get(self::$fixture->idSite, 'year', '2012-08-09');
}
public static function tearDownAfterClass()
{
if (!Zend_Registry::get('db')) {
Piwik::createDatabaseObject();
}
parent::tearDownAfterClass();
}
public function setUp()
{
parent::setUp();
list($processedDir, $expectedDir) = $this->getProcessedAndExpectedDirs();
if (!is_dir($processedDir)) {
mkdir($processedDir);
}
if (!is_dir($expectedDir)) {
mkdir($expectedDir);
}
if (!Zend_Registry::get('db')) {
Piwik::createDatabaseObject();
}
}
public function tearDown()
{
parent::tearDown();
\Zend_Registry::get('db')->closeConnection();
\Zend_Registry::set('db', false);
}
public function getUrlsForTesting()
{
$generalParams = 'idSite=1&period=week&date=2012-08-09';
$evolutionParams = 'idSite=1&period=day&date=2012-08-11&evolution_day_last_n=30';
$urlBase = 'module=CoreHome&action=index&' . $generalParams;
$widgetizeParams = "module=Widgetize&action=iframe";
$segment = urlencode("browserCode==FF");
return array(
// dashboard
array('dashboard1', "?$urlBase#$generalParams&module=Dashboard&action=embeddedIndex&idDashboard=1"),
array('dashboard2', "?$urlBase#$generalParams&module=Dashboard&action=embeddedIndex&idDashboard=2"),
array('dashboard3', "?$urlBase#$generalParams&module=Dashboard&action=embeddedIndex&idDashboard=3"),
// visitors pages (except real time map since it displays current time)
array('visitors_overview', "?$urlBase#$generalParams&module=VisitsSummary&action=index"),
array('visitors_visitorlog', "?$urlBase#$generalParams&module=Live&action=indexVisitorLog"),
array('visitors_devices', "?$urlBase#$generalParams&module=DevicesDetection&action=index"),
array('visitors_locations_provider', "?$urlBase#$generalParams&module=UserCountry&action=index"),
array('visitors_settings', "?$urlBase#$generalParams&module=UserSettings&action=index"),
array('visitors_times', "?$urlBase#$generalParams&module=VisitTime&action=index"),
array('visitors_engagement', "?$urlBase#$generalParams&module=VisitFrequency&action=index"),
array('visitors_custom_vars', "?$urlBase#$generalParams&module=CustomVariables&action=index"),
// actions pages
array('actions_pages', "?$urlBase#$generalParams&module=Actions&action=indexPageUrls"),
array('actions_entry_pages', "?$urlBase#$generalParams&module=Actions&action=indexEntryPageUrls"),
array('actions_exit_pages', "?$urlBase#$generalParams&module=Actions&action=indexExitPageUrls"),
array('actions_page_titles', "?$urlBase#$generalParams&module=Actions&action=indexPageTitles"),
array('actions_site_search', "?$urlBase#$generalParams&module=Actions&action=indexSiteSearch"),
array('actions_outlinks', "?$urlBase#$generalParams&module=Actions&action=indexOutlinks"),
array('actions_downloads', "?$urlBase#$generalParams&module=Actions&action=indexDownloads"),
// referrers pages
array('referrers_overview', "?$urlBase#$generalParams&module=Referers&action=index"),
array('referrers_search_engines_keywords',
"?$urlBase#$generalParams&module=Referers&action=getSearchEnginesAndKeywords"),
array('referrers_websites_social', "?$urlBase#$generalParams&module=Referers&action=indexWebsites"),
array('referrers_campaigns', "?$urlBase#$generalParams&module=Referers&action=indexCampaigns"),
// goals pages
array('goals_ecommerce',
"?$urlBase#$generalParams&module=Goals&action=ecommerceReport&idGoal=ecommerceOrder"),
array('goals_overview', "?$urlBase#$generalParams&module=Goals&action=index"),
array('goals_individual_goal', "?$urlBase#$generalParams&module=Goals&action=goalReport&idGoal=1"),
// one page w/ segment
array('visitors_overview_segment',
"?$urlBase#$generalParams&module=VisitsSummary&action=index&segment=$segment"),
// widgetize
array("widgetize_visitor_log",
"?$widgetizeParams&$generalParams&moduleToWidgetize=Live&actionToWidgetize=getVisitorLog"),
array("widgetize_html_table",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=table"),
array("widgetize_goals_table",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=tableGoals"),
array("widgetize_goals_table_ecommerce",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=tableGoals&idGoal=ecommerceOrder"),
array("widgetize_goals_table_single",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=tableGoals&idGoal=1"),
array("widgetize_goals_table_full",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=tableGoals&idGoal=0"),
array("widgetize_all_columns_table",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=tableAllColumns"),
array("widgetize_pie_graph",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=graphPie"),
array("widgetize_bar_graph",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=graphVerticalBar"),
array("widgetize_evolution_graph",
"?$widgetizeParams&$evolutionParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=graphEvolution"),
array("widgetize_tag_cloud",
"?$widgetizeParams&$generalParams&moduleToWidgetize=UserCountry&actionToWidgetize=getCountry"
. "&viewDataTable=cloud"),
array("widgetize_actions_search",
"?$widgetizeParams&$generalParams&moduleToWidgetize=Actions&actionToWidgetize=getPageUrls"
. "&filter_column_recursive=label&filter_pattern_recursive=i"),
array("widgetize_actions_flat",
"?$widgetizeParams&$generalParams&moduleToWidgetize=Actions&actionToWidgetize=getPageUrls"
. "&flat=1"),
array("widgetize_actions_excludelowpop",
"?$widgetizeParams&$generalParams&moduleToWidgetize=Actions&actionToWidgetize=getPageUrls"
. "&enable_filter_excludelowpop=1"),
// row evolution
array("row_evolution_popup",
"?$widgetizeParams&moduleToWidgetize=CoreHome&actionToWidgetize=getRowEvolutionPopover"
. "&apiMethod=UserSettings.getBrowser&label=Chrome&disableLink=1&idSite=1&period=day"
. "&date=2012-08-11"),
array("multi_row_evolution_popup",
"?$widgetizeParams&moduleToWidgetize=CoreHome&actionToWidgetize=getMultiRowEvolutionPopover"
. "&label=" . urlencode("Chrome,Firefox") . "&apiMethod=UserSettings.getBrowser&idSite=1&period=day"
. "&date=2012-08-11&disableLink=1"),
);
}
/**
* @dataProvider getUrlsForTesting
* @group Integration
* @group UITests
*/
public function testUIUrl($name, $urlQuery)
{
list($processedDir, $expectedDir) = $this->getProcessedAndExpectedDirs();
$processedScreenshotPath = $processedDir . "$name." . self::IMAGE_TYPE;
$expectedScreenshotPath = $expectedDir . "$name." . self::IMAGE_TYPE;
// run cutycapt w/ url and output to /processed-ui-screenshots/$name.svg
$this->runCutyCapt($urlQuery, $processedScreenshotPath);
// compare processed w/ expected
$this->compareScreenshot($name, $expectedScreenshotPath, $processedScreenshotPath, $urlQuery);
}
private function runCutyCapt($urlQuery, $processedPath)
{
$url = self::getProxyUrl() . $urlQuery;
$cmd = "cutycapt --url=\"$url\" --out=\"$processedPath\" --min-width=1366 --delay=".self::CUTYCAPT_DELAY." 2>&1";
if (self::$useXvfb) {
$cmd = 'xvfb-run --server-args="-screen 0, 1024x768x24" ' . $cmd;
}
exec($cmd, $output, $result);
if ($result !== 0) {
throw new Exception("cutycapt failed: " . implode("\n", $output) . "\n\ncommand used: $cmd");
}
return $output;
}
private function compareScreenshot($name, $expectedPath, $processedPath, $urlQuery)
{
$processed = file_get_contents($processedPath);
if (!file_exists($expectedPath)) {
$this->markTestIncomplete("expected screenshot for processed '$processedPath' is missing");
}
$expected = file_get_contents($expectedPath);
if ($expected != $processed) {
echo "\nFail: '$processedPath' for '$urlQuery'\n";
}
$this->assertTrue($expected == $processed, "screenshot compare failed for '$processedPath'");
}
private static function isCutyCaptAvailable()
{
exec("cutycapt --help 2>&1", $output, $result);
return $result === 0 || $result === 1;
}
private static function isXvfbAvailable()
{
exec("xvfb-run --help 2>&1", $output, $result);
return $result === 0 || $result === 1;
}
protected function getProcessedAndExpectedDirs()
{
$path = $this->getPathToTestDirectory() . '/../UI';
return array($path . '/processed-ui-screenshots/', $path . '/expected-ui-screenshots/');
}
public static function getProxyUrl()
{
return Test_Piwik_BaseFixture::getRootUrl() . 'tests/PHPUnit/proxy/index.php';
}
}
Test_Piwik_Integration_UIIntegrationTest::$fixture = new Test_Piwik_Fixture_ManySitesImportedLogsWithXssAttempts();
|
