File size: 9,359 Bytes
1f0da20 | 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
/**
* 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\CustomVariables\tests\Integration;
use Piwik\Plugins\CustomVariables\CustomVariables;
use Piwik\Plugins\CustomVariables\Tracker\CustomVariablesRequestProcessor;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Piwik\Tracker\Request;
/**
* @group Plugins
* @group CustomVariables
* @group CustomVariablesRequestProcessor
*/
class CustomVariablesRequestProcessorTest extends IntegrationTestCase
{
public function test_truncateCustomVariable_shouldNotTruncateAnything_IfValueIsShortEnough()
{
$len = CustomVariables::getMaxLengthCustomVariables();
$input = str_pad('test', $len - 2, 't');
$result = CustomVariablesRequestProcessor::truncateCustomVariable($input);
$this->assertSame($result, $input);
}
public function test_truncateCustomVariable_shouldActuallyTruncateTheValue()
{
$len = CustomVariables::getMaxLengthCustomVariables();
$input = str_pad('test', $len + 2, 't');
$this->assertGreaterThan(100, $len);
$truncated = CustomVariablesRequestProcessor::truncateCustomVariable($input);
$this->assertEquals(str_pad('test', $len, 't'), $truncated);
}
public function test_getCustomVariablesInVisitScope_ShouldReturnNoCustomVars_IfNoWerePassedInParams()
{
$this->assertEquals(array(), CustomVariablesRequestProcessor::getCustomVariablesInVisitScope($this->buildRequest(array('idsite' => '1'))));
}
public function test_getCustomVariablesInVisitScope_ShouldReturnNoCustomVars_IfPassedParamIsNotAnArray()
{
$this->assertCustomVariablesInVisitScope(array(), '{"mykey":"myval"}');
}
public function test_getCustomVariablesInVisitScope_ShouldReturnCustomVars_IfTheyAreValid()
{
$customVars = $this->buildCustomVars(array('mykey' => 'myval', 'test' => 'value'));
$expected = $this->buildExpectedCustomVars(array('mykey' => 'myval', 'test' => 'value'));
$this->assertCustomVariablesInVisitScope($expected, $customVars);
}
public function test_getCustomVariablesInVisitScope_ShouldIgnoreIndexesLowerThan1()
{
$customVars = array(
array('mykey', 'myval'),
array('test', 'value'),
);
$expected = $this->buildExpectedCustomVars(array('test' => 'value'));
$this->assertCustomVariablesInVisitScope($expected, json_encode($customVars));
}
public function test_getCustomVariablesInVisitScope_ShouldTruncateValuesIfTheyAreTooLong()
{
$maxLen = CustomVariables::getMaxLengthCustomVariables();
$customVars = $this->buildCustomVars(array(
'mykey' => 'myval',
'test' => str_pad('test', $maxLen + 5, 't'),
));
$expected = $this->buildExpectedCustomVars(array(
'mykey' => 'myval',
'test' => str_pad('test', $maxLen, 't'),
));
$this->assertCustomVariablesInVisitScope($expected, $customVars);
}
public function test_getCustomVariablesInVisitScope_ShouldIgnoreVarsThatDoNotHaveKeyAndValue()
{
$customVars = array(
1 => array('mykey', 'myval'),
2 => array('test'),
);
$expected = $this->buildExpectedCustomVars(array('mykey' => 'myval'));
$this->assertCustomVariablesInVisitScope($expected, json_encode($customVars));
}
public function test_getCustomVariablesInVisitScope_ShouldSetDefaultValueToEmptyStringAndHandleOtherTypes()
{
$input = array(
'myfloat' => 5.55,
'myint' => 53,
'mystring' => '',
);
$customVars = $this->buildCustomVars($input);
$expected = $this->buildExpectedCustomVars($input);
$this->assertCustomVariablesInVisitScope($expected, $customVars);
}
public function test_getCustomVariablesInPageScope_ShouldReturnNoCustomVars_IfNoWerePassedInParams()
{
$this->assertEquals(array(), CustomVariablesRequestProcessor::getCustomVariablesInPageScope($this->buildRequest(array('idsite' => '1'))));
}
public function test_getCustomVariablesInPageScope_ShouldReturnNoCustomVars_IfPassedParamIsNotAnArray()
{
$this->assertCustomVariablesInPageScope(array(), '{"mykey":"myval"}');
}
public function test_getCustomVariablesInPageScope_ShouldReturnCustomVars_IfTheyAreValid()
{
$customVars = $this->buildCustomVars(array('mykey' => 'myval', 'test' => 'value'));
$expected = $this->buildExpectedCustomVars(array('mykey' => 'myval', 'test' => 'value'));
$this->assertCustomVariablesInPageScope($expected, $customVars);
}
public function test_getCustomVariablesInPageScope_ShouldIgnoreIndexesLowerThan1()
{
$customVars = array(
array('mykey', 'myval'),
array('test', 'value'),
);
$expected = $this->buildExpectedCustomVars(array('test' => 'value'));
$this->assertCustomVariablesInPageScope($expected, json_encode($customVars));
}
public function test_getCustomVariablesInPageScope_ShouldTruncateValuesIfTheyAreTooLong()
{
$maxLen = CustomVariables::getMaxLengthCustomVariables();
$customVars = $this->buildCustomVars(array(
'mykey' => 'myval',
'test' => str_pad('test', $maxLen + 5, 't'),
));
$expected = $this->buildExpectedCustomVars(array(
'mykey' => 'myval',
'test' => str_pad('test', $maxLen, 't'),
));
$this->assertCustomVariablesInPageScope($expected, $customVars);
}
public function test_getCustomVariablesInPageScope_ShouldIgnoreVarsThatDoNotHaveKeyAndValue()
{
$customVars = array(
1 => array('mykey', 'myval'),
2 => array('test'),
);
$expected = $this->buildExpectedCustomVars(array('mykey' => 'myval'));
$this->assertCustomVariablesInPageScope($expected, json_encode($customVars));
}
public function test_getCustomVariablesInPageScope_ShouldSetDefaultValueToEmptyStringAndHandleOtherTypes()
{
$input = array(
'myfloat' => 5.55,
'myint' => 53,
'mystring' => '',
);
$customVars = $this->buildCustomVars($input);
$expected = $this->buildExpectedCustomVars($input);
$this->assertCustomVariablesInPageScope($expected, $customVars);
}
public function test_getCustomVariables_nonStringInput()
{
$input = array('mykey' => array('myarraykey' => 'myvalue'), 'myotherkey' => 2);
$customVars = $this->buildCustomVars($input);
// Int value should come through; array value is invalid so should be discarded
$expected = array('custom_var_k2' => 'myotherkey', 'custom_var_v2' => 2);
$this->assertCustomVariablesInPageScope($expected, $customVars);
}
public function test_internalBuildExpectedCustomVars()
{
$this->assertEquals(array(), $this->buildExpectedCustomVars(array()));
$this->assertEquals(
array('custom_var_k1' => 'key', 'custom_var_v1' => 'val'),
$this->buildExpectedCustomVars(array('key' => 'val'))
);
$this->assertEquals(array(
'custom_var_k1' => 'key', 'custom_var_v1' => 'val',
'custom_var_k2' => 'key2', 'custom_var_v2' => 'val2',
), $this->buildExpectedCustomVars(array('key' => 'val', 'key2' => 'val2')));
}
public function test_internalBuildCustomVars()
{
$this->assertEquals('[]', $this->buildCustomVars(array()));
$this->assertEquals(
'{"1":["key","val"]}',
$this->buildCustomVars(array('key' => 'val'))
);
$this->assertEquals(
'{"1":["key","val"],"2":["key2","val2"]}',
$this->buildCustomVars(array('key' => 'val', 'key2' => 'val2'))
);
}
private function buildRequest($params)
{
return new Request($params);
}
private function buildCustomVars($customVars)
{
$vars = array();
$index = 1;
foreach ($customVars as $key => $value) {
$vars[$index] = array($key, $value);
$index++;
}
return json_encode($vars);
}
private function buildExpectedCustomVars($customVars)
{
$vars = array();
$index = 1;
foreach ($customVars as $key => $value) {
$vars['custom_var_k' . $index] = $key;
$vars['custom_var_v' . $index] = $value;
$index++;
}
return $vars;
}
private function assertCustomVariablesInVisitScope($expectedCvars, $cvarsJsonEncoded)
{
$request = $this->buildRequest(array('_cvar' => $cvarsJsonEncoded));
$this->assertEquals($expectedCvars, CustomVariablesRequestProcessor::getCustomVariablesInVisitScope($request));
}
private function assertCustomVariablesInPageScope($expectedCvars, $cvarsJsonEncoded)
{
$request = $this->buildRequest(array('cvar' => $cvarsJsonEncoded));
$this->assertEquals($expectedCvars, CustomVariablesRequestProcessor::getCustomVariablesInPageScope($request));
}
}
|