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
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Framework\Session\SaveHandler;
use Magento\Framework\App\ResourceConnection;
class DbTableTest extends \PHPUnit\Framework\TestCase
{
/**
* Test session ID
*/
const SESSION_ID = 'session_id_value';
/**#@+
* Session keys
*/
const SESSION_NEW = 'session_new';
const SESSION_EXISTS = 'session_exists';
/**#@-*/
/**#@+
* Table column names
*/
const COLUMN_SESSION_ID = 'session_id';
const COLUMN_SESSION_DATA = 'session_data';
const COLUMN_SESSION_EXPIRES = 'session_expires';
/**#@-*/
/**
* Test session data
*
* @var array
*/
protected $_sourceData = [
self::SESSION_NEW => ['new key' => 'new value'],
self::SESSION_EXISTS => ['existing key' => 'existing value'],
];
/**
* Data as objects for serialization
*
* @var array
*/
protected $_sessionData;
/**
* @var \Magento\TestFramework\ObjectManager
*/
protected $_objectManager;
/**
* Model under test
*
* @var \Magento\Framework\Session\SaveHandler\DbTable
*/
protected $_model;
/**
* Write connection adapter
*
* @var \Magento\Framework\DB\Adapter\AdapterInterface
*/
protected $_connection;
/**
* Session table name
*
* @var string
*/
protected $_sessionTable;
/**
* @return void
*/
protected function setUp()
{
$this->_objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
$this->_model = $this->_objectManager->get(\Magento\Framework\Session\SaveHandler\DbTable::class);
/** @var $resource \Magento\Framework\App\ResourceConnection */
$resource = $this->_objectManager->get(\Magento\Framework\App\ResourceConnection::class);
$this->_connection = $resource->getConnection();
$this->_sessionTable = $resource->getTableName('session');
// session stores serialized objects with protected properties
// we need to test this case to ensure that DB adapter successfully processes "\0" symbols in serialized data
foreach ($this->_sourceData as $key => $data) {
$this->_sessionData[$key] = new \Magento\Framework\DataObject($data);
}
}
/**
* @return void
*/
public function testCheckConnection()
{
$method = new \ReflectionMethod(\Magento\Framework\Session\SaveHandler\DbTable::class, 'checkConnection');
$method->setAccessible(true);
$this->assertNull($method->invoke($this->_model));
}
/**
* @return void
*/
public function testOpenAndClose()
{
$this->assertTrue($this->_model->open('', 'test'));
$this->assertTrue($this->_model->close());
}
/**
* @return void
*/
public function testWriteReadDestroy()
{
$data = serialize($this->_sessionData[self::SESSION_NEW]);
$this->_model->write(self::SESSION_ID, $data);
$this->assertEquals($data, $this->_model->read(self::SESSION_ID));
$data = serialize($this->_sessionData[self::SESSION_EXISTS]);
$this->_model->write(self::SESSION_ID, $data);
$this->assertEquals($data, $this->_model->read(self::SESSION_ID));
$this->_model->destroy(self::SESSION_ID);
$this->assertEmpty($this->_model->read(self::SESSION_ID));
}
/**
* @return void
*/
public function testGc()
{
$this->_model->write('test', 'test');
$this->assertEquals('test', $this->_model->read('test'));
$this->_model->gc(-1);
$this->assertEmpty($this->_model->read('test'));
}
/**
* Assert that session data writes to DB in base64 encoding
*
* @return void
*/
public function testWriteEncoded()
{
$data = serialize($this->_sessionData[self::SESSION_NEW]);
$this->_model->write(self::SESSION_ID, $data);
$select = $this->_connection->select()->from(
$this->_sessionTable
)->where(
self::COLUMN_SESSION_ID . ' = :' . self::COLUMN_SESSION_ID
);
$bind = [self::COLUMN_SESSION_ID => self::SESSION_ID];
$session = $this->_connection->fetchRow($select, $bind);
$this->assertEquals(self::SESSION_ID, $session[self::COLUMN_SESSION_ID]);
$this->assertTrue(
ctype_digit((string)$session[self::COLUMN_SESSION_EXPIRES]),
'Value of session expire field must have integer type'
);
$this->assertEquals($data, base64_decode($session[self::COLUMN_SESSION_DATA]));
}
/**
* Data provider for testReadEncoded
*
* @return array
*/
public function readEncodedDataProvider()
{
// we can't use object data as a fixture because not encoded serialized object
// might cause DB adapter fatal error, so we have to use array as a fixture
$sessionData = serialize($this->_sourceData[self::SESSION_NEW]);
return [
'session_encoded' => ['$sessionData' => base64_encode($sessionData)],
'session_not_encoded' => ['$sessionData' => $sessionData]
];
}
/**
* Assert that session data reads from DB correctly regardless of encoding
*
* @param string $sessionData
*
* @dataProvider readEncodedDataProvider
*
* @return void
*/
public function testReadEncoded($sessionData)
{
$sessionRecord = [self::COLUMN_SESSION_ID => self::SESSION_ID, self::COLUMN_SESSION_DATA => $sessionData];
$this->_connection->insertOnDuplicate($this->_sessionTable, $sessionRecord, [self::COLUMN_SESSION_DATA]);
$sessionData = $this->_model->read(self::SESSION_ID);
$this->assertEquals($this->_sourceData[self::SESSION_NEW], unserialize($sessionData));
}
}