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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2019 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
require_once 'vendor/autoload.php';
require_once dirname(__FILE__).'/../../include/defines.inc.php';
require_once dirname(__FILE__).'/../../include/hosts.inc.php';
require_once dirname(__FILE__).'/helpers/CDBHelper.php';
require_once dirname(__FILE__).'/helpers/CExceptionHelper.php';
/**
* Base class of php unit tests.
*/
class CTest extends PHPUnit_Framework_TestCase {
// Table that should be backed up at the test suite level.
protected static $suite_backup = null;
// Table that should be backed up at the test case level.
protected $case_backup = null;
// Table that should be backed up at the test case level once (for multiple case executions).
protected static $case_backup_once = null;
// Name of the last executed test.
protected static $last_test_case = null;
// Test case data key.
protected $data_key = null;
// Lists of test case data set keys.
protected static $test_data_sets = [];
// List of backups to be performed.
protected $backup = [];
// Test case annotations.
protected $annotations = null;
// Test case warnings.
protected $warnings = [];
/**
* Overriden constructor for collecting data on data sets from dataProvider annotations.
*
* @param string $name
* @param array $data
* @param string $data_name
*/
public function __construct($name = null, array $data = [], $data_name = '') {
parent::__construct($name, $data, $data_name);
// If data limits are enabled and test case uses data.
if (defined('PHPUNIT_ENABLE_DATA_LIMITS') && PHPUNIT_ENABLE_DATA_LIMITS && $data) {
$this->data_key = $data_name;
self::$test_data_sets[$name][] = $data_name;
}
}
/**
* Get annotations by type name.
* Helper function for method / class annotation processing.
*
* @param array $annotations annotations
* @param string $type type name
*
* @return array or null
*/
protected function getAnnotationsByType($annotations, $type) {
return (array_key_exists($type, $annotations) && is_array($annotations[$type]))
? $annotations[$type]
: null;
}
/**
* Callback executed before every test suite.
*/
protected function onBeforeTestSuite() {
// Test suite level annotations.
$class_annotations = $this->getAnnotationsByType($this->annotations, 'class');
// Backup performed before test suite execution.
$suite_backup = $this->getAnnotationsByType($class_annotations, 'backup');
if ($suite_backup !== null && count($suite_backup) === 1) {
self::$suite_backup = $suite_backup[0];
CDBHelper::backupTables(self::$suite_backup);
}
}
/**
* Callback executed before every test case.
*
* @before
*/
public function onBeforeTestCase() {
global $DB;
static $suite = null;
$class_name = get_class($this);
$case_name = $this->getName(false);
$this->backup = [];
if (!isset($DB['DB'])) {
DBconnect($error);
}
$this->annotations = $this->getAnnotations();
// Restore data from backup if test case changed
if (self::$case_backup_once !== null && self::$last_test_case !== $case_name) {
CDBHelper::restoreTables(self::$case_backup_once);
self::$case_backup_once = null;
}
// Test case level annotations.
$method_annotations = $this->getAnnotationsByType($this->annotations, 'method');
if ($method_annotations !== null) {
// Backup performed before every test case execution.
$case_backup = $this->getAnnotationsByType($method_annotations, 'backup');
if ($case_backup !== null && count($case_backup) === 1) {
$this->case_backup = $case_backup[0];
CDBHelper::backupTables($this->case_backup);
}
if (self::$last_test_case !== $case_name) {
if (array_key_exists($case_name, self::$test_data_sets)) {
// Check for data data set limit.
$limit = $this->getAnnotationsByType($method_annotations, 'data-limit');
if ($limit !== null && count($limit) === 1 && is_numeric($limit[0]) && $limit[0] >= 1
&& count(self::$test_data_sets[$case_name]) > $limit[0]) {
$sets = self::$test_data_sets[$case_name];
shuffle($sets);
self::$test_data_sets[$case_name] = array_slice($sets, 0, (int)$limit[0]);
}
}
// Backup performed once before first test case execution.
$case_backup_once = $this->getAnnotationsByType($method_annotations, 'backup-once');
if ($case_backup_once !== null && count($case_backup_once) === 1) {
self::$case_backup_once = $case_backup_once[0];
CDBHelper::backupTables(self::$case_backup_once);
}
}
}
// Class name change is used to determine suite change.
if ($suite !== $class_name) {
$this->onBeforeTestSuite();
}
$suite = $class_name;
self::$last_test_case = $case_name;
// Mark excessive test cases as skipped.
if (array_key_exists($case_name, self::$test_data_sets)
&& !in_array($this->data_key, self::$test_data_sets[$case_name])) {
self::markTestSkipped('Test case skipped by data provider limit check.');
}
}
/**
* Callback executed after every test case.
*
* @after
*/
public function onAfterTestCase() {
if ($this->case_backup !== null) {
CDBHelper::restoreTables($this->case_backup);
}
DBclose();
if ($this->warnings) {
throw new PHPUnit_Framework_Warning(implode("\n", $this->warnings));
}
}
/**
* Callback executed after every test suite.
*
* @afterClass
*/
public static function onAfterTestSuite() {
global $DB;
if (self::$suite_backup !== null || self::$case_backup_once !== null) {
DBconnect($error);
// Restore suite level backups.
if (self::$suite_backup !== null) {
CDBHelper::restoreTables(self::$suite_backup);
self::$suite_backup = null;
}
// Restore case level backups.
if (self::$case_backup_once !== null) {
CDBHelper::restoreTables(self::$case_backup_once);
self::$case_backup_once = null;
}
DBclose();
}
}
/**
* Add warning to test case warning list.
*
* @param string $warning warning text
*/
public function addWarning($warning) {
if (defined('PHPUNIT_REPORT_WARNINGS') && PHPUNIT_REPORT_WARNINGS && !in_array($warning, $this->warnings)) {
$this->warnings[] = $warning;
}
}
}
|
