FilesExpand file tree

 develop

/

phpbb_test_case_helpers.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

308 lines (262 loc) · 7.26 KB

 develop

/

phpbb_test_case_helpers.php

Copy path

Top

File metadata and controls

• Code
• Blame

308 lines (262 loc) · 7.26 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

<?php

/**

*

* This file is part of the phpBB Forum Software package.

*

* @copyright (c) phpBB Limited <https://www.phpbb.com>

* @license GNU General Public License, version 2 (GPL-2.0)

*

* For full copyright and license information, please see

* the docs/CREDITS.txt file.

*

*/

class phpbb_test_case_helpers

{

protected $expectedTriggerError = false;

protected $test_case;

public function __construct($test_case)

{

$this->test_case = $test_case;

}

/**

* This should only be called once before the tests are run.

* This is used to copy the fixtures to the phpBB install

*/

public function copy_ext_fixtures($fixtures_dir, $fixtures)

{

global $phpbb_root_path;

if (file_exists($phpbb_root_path . 'ext/'))

{

// First, move any extensions setup on the board to a temp directory

$this->copy_dir($phpbb_root_path . 'ext/', $phpbb_root_path . 'store/temp_ext/');

// Then empty the ext/ directory on the board (for accurate test cases)

$this->empty_dir($phpbb_root_path . 'ext/');

}

// Copy our ext/ files from the test case to the board

foreach ($fixtures as $fixture)

{

$this->copy_dir($fixtures_dir . $fixture, $phpbb_root_path . 'ext/' . $fixture);

}

}

/**

* This should only be called once after the tests are run.

* This is used to remove the fixtures from the phpBB install

*/

public function restore_original_ext_dir()

{

global $phpbb_root_path;

// Remove all of the files we copied from test ext -> board ext

$this->empty_dir($phpbb_root_path . 'ext/');

// Copy back the board installed extensions from the temp directory

if (file_exists($phpbb_root_path . 'store/temp_ext/'))

{

$this->copy_dir($phpbb_root_path . 'store/temp_ext/', $phpbb_root_path . 'ext/');

// Remove all of the files we copied from board ext -> temp_ext

$this->empty_dir($phpbb_root_path . 'store/temp_ext/');

}

if (file_exists($phpbb_root_path . 'store/temp_ext/'))

{

$this->empty_dir($phpbb_root_path . 'store/temp_ext/');

}

}

public function setExpectedTriggerError($errno, $message = '')

{

$exceptionName = '';

switch ($errno)

{

case E_NOTICE:

case E_STRICT:

PHPUnit_Framework_Error_Notice::$enabled = true;

$exceptionName = 'PHPUnit_Framework_Error_Notice';

break;

case E_WARNING:

PHPUnit_Framework_Error_Warning::$enabled = true;

$exceptionName = 'PHPUnit_Framework_Error_Warning';

break;

default:

$exceptionName = 'PHPUnit_Framework_Error';

break;

}

$this->expectedTriggerError = true;

$this->test_case->setExpectedException($exceptionName, (string) $message, $errno);

}

public function makedirs($path)

{

// PHP bug #55124 (fixed in 5.4.0)

$path = str_replace('/./', '/', $path);

mkdir($path, 0777, true);

}

static public function get_test_config()

{

$config = array();

if (extension_loaded('sqlite3'))

{

$config = array_merge($config, array(

'dbms' => 'phpbb\db\driver\sqlite3',

'dbhost' => dirname(__FILE__) . '/../phpbb_unit_tests.sqlite3', // filename

'dbport' => '',

'dbname' => '',

'dbuser' => '',

'dbpasswd' => '',

));

}

else if (extension_loaded('sqlite'))

{

$config = array_merge($config, array(

'dbms' => 'phpbb\db\driver\sqlite',

'dbhost' => dirname(__FILE__) . '/../phpbb_unit_tests.sqlite2', // filename

'dbport' => '',

'dbname' => '',

'dbuser' => '',

'dbpasswd' => '',

));

}

if (isset($_SERVER['PHPBB_TEST_CONFIG']))

{

// Could be an absolute path

$test_config = $_SERVER['PHPBB_TEST_CONFIG'];

}

else

{

$test_config = dirname(__FILE__) . '/../test_config.php';

}

if (file_exists($test_config))

{

include($test_config);

if (!function_exists('phpbb_convert_30_dbms_to_31'))

{

require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php';

}

$config = array_merge($config, array(

'dbms' => phpbb_convert_30_dbms_to_31($dbms),

'dbhost' => $dbhost,

'dbport' => $dbport,

'dbname' => $dbname,

'dbuser' => $dbuser,

'dbpasswd' => $dbpasswd,

'custom_dsn' => isset($custom_dsn) ? $custom_dsn : '',

));

if (isset($phpbb_functional_url))

{

$config['phpbb_functional_url'] = $phpbb_functional_url;

}

if (isset($phpbb_redis_host))

{

$config['redis_host'] = $phpbb_redis_host;

}

if (isset($phpbb_redis_port))

{

$config['redis_port'] = $phpbb_redis_port;

}

if (isset($fulltext_sphinx_id))

{

$config['fulltext_sphinx_id'] = $fulltext_sphinx_id;

}

}

if (isset($_SERVER['PHPBB_TEST_DBMS']))

{

if (!function_exists('phpbb_convert_30_dbms_to_31'))

{

require_once dirname(__FILE__) . '/../../phpBB/includes/functions.php';

}

$config = array_merge($config, array(

'dbms' => isset($_SERVER['PHPBB_TEST_DBMS']) ? phpbb_convert_30_dbms_to_31($_SERVER['PHPBB_TEST_DBMS']) : '',

'dbhost' => isset($_SERVER['PHPBB_TEST_DBHOST']) ? $_SERVER['PHPBB_TEST_DBHOST'] : '',

'dbport' => isset($_SERVER['PHPBB_TEST_DBPORT']) ? $_SERVER['PHPBB_TEST_DBPORT'] : '',

'dbname' => isset($_SERVER['PHPBB_TEST_DBNAME']) ? $_SERVER['PHPBB_TEST_DBNAME'] : '',

'dbuser' => isset($_SERVER['PHPBB_TEST_DBUSER']) ? $_SERVER['PHPBB_TEST_DBUSER'] : '',

'dbpasswd' => isset($_SERVER['PHPBB_TEST_DBPASSWD']) ? $_SERVER['PHPBB_TEST_DBPASSWD'] : '',

'custom_dsn' => isset($_SERVER['PHPBB_TEST_CUSTOM_DSN']) ? $_SERVER['PHPBB_TEST_CUSTOM_DSN'] : '',

));

}

if (isset($_SERVER['PHPBB_FUNCTIONAL_URL']))

{

$config = array_merge($config, array(

'phpbb_functional_url' => isset($_SERVER['PHPBB_FUNCTIONAL_URL']) ? $_SERVER['PHPBB_FUNCTIONAL_URL'] : '',

));

}

if (isset($_SERVER['PHPBB_TEST_REDIS_HOST']))

{

$config['redis_host'] = $_SERVER['PHPBB_TEST_REDIS_HOST'];

}

if (isset($_SERVER['PHPBB_TEST_REDIS_PORT']))

{

$config['redis_port'] = $_SERVER['PHPBB_TEST_REDIS_PORT'];

}

return $config;

}

/**

* Recursive directory copying function

*

* @param string $source

* @param string $dest

* @return array list of files copied

*/

public function copy_dir($source, $dest)

{

$source = (substr($source, -1) == '/') ? $source : $source . '/';

$dest = (substr($dest, -1) == '/') ? $dest : $dest . '/';

$copied_files = array();

if (!is_dir($dest))

{

$this->makedirs($dest);

}

$files = scandir($source);

foreach ($files as $file)

{

if ($file == '.' || $file == '..')

{

continue;

}

if (is_dir($source . $file))

{

$created_dir = false;

if (!is_dir($dest . $file))

{

$created_dir = true;

$this->makedirs($dest . $file);

}

$copied_files = array_merge($copied_files, self::copy_dir($source . $file, $dest . $file));

if ($created_dir)

{

$copied_files[] = $dest . $file;

}

}

else

{

if (!file_exists($dest . $file))

{

copy($source . $file, $dest . $file);

$copied_files[] = $dest . $file;

}

}

}

return $copied_files;

}

/**

* Empty directory (remove any subdirectories/files below)

*

* @param array $file_list

*/

public function empty_dir($path)

{

$path = (substr($path, -1) == '/') ? $path : $path . '/';

$files = scandir($path);

foreach ($files as $file)

{

if ($file == '.' || $file == '..')

{

continue;

}

if (is_dir($path . $file))

{

$this->empty_dir($path . $file);

rmdir($path . $file);

}

else

{

unlink($path . $file);

}

}

}

}