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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
<?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\Tests\Unit\DataAccess;
use Piwik\DataAccess\LogQueryBuilder\JoinGenerator;
use Piwik\DataAccess\LogQueryBuilder\JoinTables;
use Piwik\Tests\Framework\Mock\Plugin\LogTablesProvider;
use Piwik\Tracker\Visit;
/**
* @group Core
*/
class JoinGeneratorTest extends \PHPUnit_Framework_TestCase
{
/**
* @var JoinGenerator
*/
private $generator;
public function setUp()
{
$this->generator = $this->makeTables(array(
'log_visit',
array('table' => 'log_conversion', 'joinOn' => 'log_conversion.idvisit = log_visit.idvisit'),
'log_action'));
}
public function test_constructor_shouldAddTablesIfNeeded()
{
$tables = $this->makeTables(array('log_visit', 'log_action'));
$this->makeGenerator($tables);
$this->assertEquals(array('log_visit', 'log_action', 'log_link_visit_action'), $tables->getTables());
}
public function test_generate_shouldJoinWithSubselect_IfBaseTableIsLogVisit()
{
$generator = $this->generate(array('log_visit', 'log_action'));
$this->assertTrue($generator->shouldJoinWithSelect());
}
public function test_generate_shouldNotJoinWithSubselect_IfBaseTableIsLogVisitButNoTableToJoin()
{
$generator = $this->generate(array('log_visit'));
$this->assertFalse($generator->shouldJoinWithSelect());
}
public function test_generate_shouldNotJoinWithSubselect_IfLogVisitIsGivenButItIsNotBaseTable()
{
$generator = $this->generate(array('log_conversion', 'log_visit'));
$this->assertFalse($generator->shouldJoinWithSelect());
}
public function test_generate_getJoinString()
{
$generator = $this->generate(array('log_action', 'log_link_visit_action', 'log_visit'));
$expected = 'log_action AS log_action ';
$expected .= 'LEFT JOIN log_link_visit_action AS log_link_visit_action ON log_link_visit_action.idaction_url = log_action.idaction ';
$expected .= 'LEFT JOIN log_visit AS log_visit ON log_visit.idvisit = log_link_visit_action.idvisit';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_OnlyOneTable()
{
$generator = $this->generate(array('log_visit'));
$this->assertEquals('log_visit AS log_visit', $generator->getJoinString());
}
public function test_generate_getJoinString_OnlyOneActionTable()
{
$generator = $this->generate(array('log_action'));
$this->assertEquals('log_action AS log_action', $generator->getJoinString());
}
public function test_generate_getJoinString_OnlyActionTables()
{
$generator = $this->generate(array('log_link_visit_action', 'log_action'));
$expected = 'log_link_visit_action AS log_link_visit_action';
$expected .= ' LEFT JOIN log_action AS log_action ON log_link_visit_action.idaction_url = log_action.idaction';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_manuallyJoinedAlready()
{
$generator = $this->generate(array(
'log_link_visit_action',
array('table' => 'log_visit', 'joinOn' => 'log_visit.idvisit = log_link_visit_action.idvisit'),
array('table' => 'log_action', 'joinOn' => 'log_link_visit_action.idaction_name = log_action.idaction'),
'log_action'
));
$expected = 'log_link_visit_action AS log_link_visit_action ';
$expected .= 'LEFT JOIN log_visit AS log_visit ON log_visit.idvisit = log_link_visit_action.idvisit ';
$expected .= 'LEFT JOIN log_action AS log_action ON (log_link_visit_action.idaction_name = log_action.idaction AND log_link_visit_action.idaction_url = log_action.idaction)';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_manuallyJoinedAlreadyWithCustomConditionInArray()
{
$generator = $this->generate(array(
'log_visit',
array('table' => 'log_conversion', 'joinOn' => 'log_visit.idvisit2 = log_conversion.idvisit2'),
'log_conversion'
));
$expected = 'log_visit AS log_visit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_visit.idvisit2 = log_conversion.idvisit2';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_manuallyJoinedAlreadyWithCustomConditionInArrayAndFurtherTablesAfterwards()
{
$generator = $this->generate(array(
'log_visit',
array('table' => 'log_conversion', 'joinOn' => 'log_visit.idvisit2 = log_conversion.idvisit2'),
'log_conversion',
'log_link_visit_action'
));
$expected = 'log_visit AS log_visit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_visit.idvisit2 = log_conversion.idvisit2 ';
$expected .= 'LEFT JOIN log_link_visit_action AS log_link_visit_action ON log_link_visit_action.idvisit = log_visit.idvisit';
$this->assertEquals($expected, $generator->getJoinString());
}
/**
* @expectedException \Exception
* @expectedExceptionMessage Please reorganize the joined tables as the table log_conversion in {"0":"log_visit","1":"log_conversion","2":"log_link_visit_action","3":{"table":"log_conversion","joinOn":"log_link_visit_action.idvisit2 = log_conversion.idvisit2"}} cannot be joined correctly.
*/
public function test_generate_getJoinString_manuallyJoinedAlreadyWithCustomConditionInArrayInverted()
{
$generator = $this->generate(array(
'log_visit',
'log_conversion',
'log_link_visit_action',
array('table' => 'log_conversion', 'joinOn' => 'log_link_visit_action.idvisit2 = log_conversion.idvisit2'),
));
$expected = 'log_visit AS log_visit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_visit.idvisit2 = log_conversion.idvisit2 ';
$expected .= 'LEFT JOIN log_link_visit_action AS log_link_visit_action ON log_link_visit_action.idvisit = log_visit.idvisit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_conversion.idvisit = log_visit.idvisit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_visit.idvisit2 = log_conversion.idvisit2 ';
$expected .= 'LEFT JOIN log_link_visit_action AS log_link_visit_action ON log_link_visit_action.idvisit = log_visit.idvisit';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_manuallyJoinedAlreadyPlusCustomJoinButAlsoLeft()
{
$generator = $this->generate(array(
'log_link_visit_action',
array('table' => 'log_visit', 'joinOn' => 'log_visit.idvisit = log_link_visit_action.idvisit'),
array('table' => 'log_action', 'join' => 'LeFt JOIN', 'joinOn' => 'log_link_visit_action.idaction_name = log_action.idaction'),
'log_action'
));
$expected = 'log_link_visit_action AS log_link_visit_action ';
$expected .= 'LEFT JOIN log_visit AS log_visit ON log_visit.idvisit = log_link_visit_action.idvisit ';
$expected .= 'LEFT JOIN log_action AS log_action ON (log_link_visit_action.idaction_name = log_action.idaction AND log_link_visit_action.idaction_url = log_action.idaction)';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_manualJoin()
{
$generator = $this->generate(array(
'log_link_visit_action',
array('table' => 'log_visit',
'join' => 'RIGHT JOIN','joinOn' => 'log_visit.idvisit = log_link_visit_action.idvisit'),
array('table' => 'log_action',
'tableAlias' => 'log_action_r',
'join' => 'RIGHT JOIN',
'joinOn' => 'log_link_visit_action.idaction_test = log_action_r.idaction'),
'log_action'
));
$expected = 'log_link_visit_action AS log_link_visit_action ';
$expected .= 'RIGHT JOIN log_visit AS log_visit ON log_visit.idvisit = log_link_visit_action.idvisit ';
$expected .= 'RIGHT JOIN log_action AS log_action_r ON log_link_visit_action.idaction_test = log_action_r.idaction ';
$expected .= 'LEFT JOIN log_action AS log_action ON log_link_visit_action.idaction_url = log_action.idaction';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_generate_getJoinString_allTables()
{
$generator = $this->generate(array(
'log_action',
'log_conversion_item',
'log_link_visit_action',
'log_conversion',
'log_visit',
));
$expected = 'log_action AS log_action ';
$expected .= 'LEFT JOIN log_link_visit_action AS log_link_visit_action ON log_link_visit_action.idaction_url = log_action.idaction ';
$expected .= 'LEFT JOIN log_visit AS log_visit ON log_visit.idvisit = log_link_visit_action.idvisit ';
$expected .= 'LEFT JOIN log_conversion AS log_conversion ON log_conversion.idvisit = log_link_visit_action.idvisit ';
$expected .= 'LEFT JOIN log_conversion_item AS log_conversion_item ON log_conversion_item.idvisit = log_link_visit_action.idvisit';
$this->assertEquals($expected, $generator->getJoinString());
}
public function test_sortTablesForJoin_shouldSortTablesAsSpecified()
{
$tables = array(
'log_action',
array('table' => 'log_conversion', 'joinOn' => 'log_conversion.idvisit = log_visit.idvisit'),
'log_conversion_item',
'log_link_visit_action',
'log_conversion',
'log_visit',
);
$generator = $this->makeGenerator($tables);
$tables[] = 'log_foo_bar';
usort($tables, array($generator, 'sortTablesForJoin'));
$expected = array(
array('table' => 'log_conversion', 'joinOn' => 'log_conversion.idvisit = log_visit.idvisit'),
'log_link_visit_action',
'log_action',
'log_visit',
'log_conversion',
'log_conversion_item',
'log_foo_bar'
);
$this->assertEquals($expected, $tables);
}
public function test_sortTablesForJoin_shouldSortTablesWithCustomJoinRequiringEachOther()
{
$tables = array(
'log_link_visit_action',
'log_action',
array(
'table' => 'log_link_visit_action',
'tableAlias' => 'log_link_visit_action_foo',
'joinOn' => "log_link_visit_action.idvisit = log_link_visit_action_foo.idvisit"
),
array(
'table' => 'log_action',
'tableAlias' => 'log_action_foo',
'joinOn' => "log_link_visit_action_foo.idaction_url = log_action_foo.idaction"
)
);
$generator = $this->makeGenerator($tables);
usort($tables, array($generator, 'sortTablesForJoin'));
$expected = array(
'log_link_visit_action',
array (
'table' => 'log_link_visit_action',
'tableAlias' => 'log_link_visit_action_foo',
'joinOn' => 'log_link_visit_action.idvisit = log_link_visit_action_foo.idvisit',
),
array (
'table' => 'log_action',
'tableAlias' => 'log_action_foo',
'joinOn' => 'log_link_visit_action_foo.idaction_url = log_action_foo.idaction',
),
'log_action',
);
$this->assertEquals($expected, $tables);
// should still be the same if inverted
$tables = array(
'log_link_visit_action',
'log_action',
array(
'table' => 'log_action',
'tableAlias' => 'log_action_foo',
'joinOn' => "log_link_visit_action_foo.idaction_url = log_action_foo.idaction"
),
array(
'table' => 'log_link_visit_action',
'tableAlias' => 'log_link_visit_action_foo',
'joinOn' => "log_link_visit_action.idvisit = log_link_visit_action_foo.idvisit"
),
);
$generator = $this->makeGenerator($tables);
usort($tables, array($generator, 'sortTablesForJoin'));
$this->assertEquals($expected, $tables);
}
public function test_sortTablesForJoin_shouldSortTablesWithCustomJoinRequiringEachOther2()
{
$tables = array(
array(
'table' => 'log_action',
'tableAlias' => 'log_action_visit_entry_idaction_name',
'joinOn' => "log_visit.visit_entry_idaction_name = log_action_visit_entry_idaction_name.idaction"
),
'log_link_visit_action',
array(
'table' => 'log_action',
'tableAlias' => 'log_action_idaction_event_action',
'joinOn' => "log_link_visit_action.idaction_event_action = log_action_idaction_event_action.idaction"
)
);
$generator = $this->makeGenerator($tables);
usort($tables, array($generator, 'sortTablesForJoin'));
$expected = array(
array(
'table' => 'log_action',
'tableAlias' => 'log_action_visit_entry_idaction_name',
'joinOn' => "log_visit.visit_entry_idaction_name = log_action_visit_entry_idaction_name.idaction"
),
'log_link_visit_action',
array(
'table' => 'log_action',
'tableAlias' => 'log_action_idaction_event_action',
'joinOn' => "log_link_visit_action.idaction_event_action = log_action_idaction_event_action.idaction"
)
);
$this->assertEquals($expected, $tables);
}
private function generate($tables)
{
$generator = $this->makeGenerator($tables);
$generator->generate();
return $generator;
}
private function makeGenerator($tables)
{
if (is_array($tables)) {
$tables = $this->makeTables($tables);
}
return new JoinGenerator($tables);
}
private function makeTables($tables)
{
return new JoinTables(new LogTablesProvider(), $tables);
}
}
|