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
|
<?php
/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
namespace Icinga\Test {
use Exception;
use Icinga\Util\Csp;
use Icinga\Web\Request;
use Icinga\Web\Response;
use Icinga\Web\Session;
use ipl\I18n\NoopTranslator;
use ipl\I18n\StaticTranslator;
use RuntimeException;
use Mockery;
use Icinga\Application\Icinga;
use Icinga\Data\ConfigObject;
use Icinga\Data\ResourceFactory;
use Icinga\Data\Db\DbConnection;
use Tests\Icinga\Lib\FakeSession;
/**
* Class BaseTestCase
*/
abstract class BaseTestCase extends Mockery\Adapter\Phpunit\MockeryTestCase implements DbTest
{
/**
* Path to application/
*
* @var string
* @deprecated Use Icinga::app()->getApplicationDir() instead
*/
public static $appDir;
/**
* Path to library/Icinga
*
* @var string
* @deprecated Use Icinga::app()->getLibraryDir('Icinga') instead
*/
public static $libDir;
/**
* Path to etc/
*
* @var string
* @deprecated Use Icinga::app()->getBaseDir('etc') instead
*/
public static $etcDir;
/**
* Path to test/php/
*
* @var string
* @deprecated Use Icinga::app()->getBaseDir('test/php') instead
*/
public static $testDir;
/**
* Path to share/icinga2-web
*
* @var string
* @deprecated Unused
*/
public static $shareDir;
/**
* Path to modules/
*
* @var string
* @deprecated Use Icinga::app()->getModuleManager()->getModuleDirs() instead
*/
public static $moduleDir;
/**
* Resource configuration for different database types
*
* @var array
*/
protected static $dbConfiguration = array(
'mysql' => array(
'type' => 'db',
'db' => 'mysql',
'host' => '127.0.0.1',
'port' => 3306,
'dbname' => 'icinga_unittest',
'username' => 'icinga_unittest',
'password' => 'icinga_unittest'
),
'pgsql' => array(
'type' => 'db',
'db' => 'pgsql',
'host' => '127.0.0.1',
'port' => 5432,
'dbname' => 'icinga_unittest',
'username' => 'icinga_unittest',
'password' => 'icinga_unittest'
),
);
/** @var Request */
private $requestMock;
/** @var Response */
private $responseMock;
/**
* Setup MVC bootstrapping and ensure that the Icinga-Mock gets reinitialized
*/
public function setUp(): void
{
parent::setUp();
$this->setupRequestMock();
$this->setupResponseMock();
Session::create(new FakeSession());
Csp::createNonce();
StaticTranslator::$instance = new NoopTranslator();
}
private function setupRequestMock()
{
$this->requestMock = Mockery::mock('Icinga\Web\Request')->shouldDeferMissing();
$this->requestMock->shouldReceive('getPathInfo')->andReturn('')->byDefault()
->shouldReceive('getBaseUrl')->andReturn('/')->byDefault()
->shouldReceive('getQuery')->andReturn(array())->byDefault()
->shouldReceive('getParam')->with(Mockery::type('string'), Mockery::type('string'))
->andReturnUsing(function ($name, $default) {
return $default;
})->byDefault();
Icinga::app()->setRequest($this->requestMock);
}
private function setupResponseMock()
{
$this->responseMock = Mockery::mock('Icinga\Web\Response')->shouldDeferMissing();
Icinga::app()->setResponse($this->responseMock);
}
/**
* Return the currently active request mock object
*
* @return Request
*/
public function getRequestMock()
{
return $this->requestMock;
}
/**
* Return the currently active response mock object
*
* @return Response
*/
public function getResponseMock()
{
return $this->responseMock;
}
/**
* Create Config for database configuration
*
* @param string $name
*
* @return ConfigObject
* @throws RuntimeException
*/
protected function createDbConfigFor($name)
{
if (array_key_exists($name, self::$dbConfiguration)) {
$config = new ConfigObject(self::$dbConfiguration[$name]);
$host = getenv(sprintf('ICINGAWEB_TEST_%s_HOST', strtoupper($name)));
if ($host) {
$config['host'] = $host;
}
$port = getenv(sprintf('ICINGAWEB_TEST_%s_PORT', strtoupper($name)));
if ($port) {
$config['port'] = $port;
}
return $config;
}
throw new RuntimeException('Configuration for database type not available: ' . $name);
}
/**
* Creates an array of Icinga\Data\Db\DbConnection
*
* @param string $name
*
* @return array
*/
protected function createDbConnectionFor($name)
{
try {
$conn = ResourceFactory::createResource($this->createDbConfigFor($name));
} catch (Exception $e) {
$conn = $e->getMessage();
}
return array(
array($conn)
);
}
/**
* PHPUnit provider for mysql
*
* @return DbConnection
*/
public function mysqlDb()
{
return $this->createDbConnectionFor('mysql');
}
/**
* PHPUnit provider for pgsql
*
* @return DbConnection
*/
public function pgsqlDb()
{
return $this->createDbConnectionFor('pgsql');
}
/**
* PHPUnit provider for oracle
*
* @return DbConnection
*/
public function oracleDb()
{
return $this->createDbConnectionFor('oracle');
}
/**
* Executes sql file by using the database connection
*
* @param DbConnection $resource
* @param string $filename
*
* @throws RuntimeException
*/
public function loadSql(DbConnection $resource, $filename)
{
if (!is_file($filename)) {
throw new RuntimeException(
'Sql file not found: ' . $filename . ' (test=' . $this->getName() . ')'
);
}
$sqlData = file_get_contents($filename);
if (!$sqlData) {
throw new RuntimeException(
'Sql file is empty: ' . $filename . ' (test=' . $this->getName() . ')'
);
}
$resource->getDbAdapter()->exec($sqlData);
}
/**
* Setup provider for testcase
*
* @param string|DbConnection|null $resource
*/
public function setupDbProvider($resource)
{
if (!$resource instanceof DbConnection) {
if (is_string($resource)) {
$this->markTestSkipped('Could not initialize provider: ' . $resource);
} else {
$this->markTestSkipped('Could not initialize provider');
}
return;
}
$adapter = $resource->getDbAdapter();
try {
$adapter->getConnection();
} catch (Exception $e) {
$this->markTestSkipped('Could not connect to provider: '. $e->getMessage());
}
$tables = $adapter->listTables();
foreach ($tables as $table) {
$adapter->exec('DROP TABLE ' . $table . ';');
}
}
/**
* Add assertMatchesRegularExpression() method for phpunit >= 8.0 < 9.0 for compatibility with PHP 7.2.
*
* @TODO Remove once PHP 7.2 support is not needed for testing anymore.
*/
public static function assertMatchesRegularExpression(
string $pattern,
string $string,
string $message = ''
): void {
if (method_exists(parent::class, 'assertMatchesRegularExpression')) {
parent::assertMatchesRegularExpression($pattern, $string, $message);
} else {
static::assertRegExp($pattern, $string, $message);
}
}
}
}
|
