blob: 6af96d8cff9fcb0faa37ba46b38e21838a4b5b29 (
plain)
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
|
<?php
/**
* Elgg testing framework.
*
* This library contains an Elgg unit test framework which can be used and extended by plugins to provide
* functional unit tests to aid diagnostics of problems.
*
* @package Elgg
* @subpackage Core
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Curverider Ltd <info@elgg.com>
* @copyright Curverider Ltd 2008-2009
* @link http://elgg.org/
*/
/**
* Elgg test result object.
* This class is used to return the values of the test in order to generate a report.
*/
class ElggTestResult {
/**
* Textual description of the test being performed (used for reporting).
*
* @var string
*/
private $details;
/**
* Boolean, true if the test was executed successfully - false if not.
*
* @var bool
*/
private $successful;
/**
* Any debug information for the report.
*
* @var string
*/
private $debug;
/**
* Create a test result object.
*
*/
function __construct($success, $details = "", $debug = "")
{
$success = (bool)$success;
$this->successful = $success;
$this->details = $details;
$this->debug = $debug;
}
/**
* Successful execution or not?
*
* @return bool
*/
public function isSuccess() { return $this->successful; }
/**
* Retrieve details.
*
* @return string
*/
public function getDetails() { return $this->details; }
/**
* Retrieve debug.
*
* @return string
*/
public function getDebug() { return $this->debug; }
/**
* Factory function to generate a successful result.
*
*/
static public function CreateSuccessResult($details) { return new ElggTestResult(true, $details); }
/**
* Factory function to generate a successful result.
*
*/
static public function CreateFailResult($details, $debug = "") { return new ElggTestResult(false, $details, $debug); }
}
/**
* Execute an elgg test.
*
* @param string $function The test function
*/
function execute_elgg_test($function)
{
global $ELGG_TEST_REGISTRY;
if ((is_callable($function)) && (isset($ELGG_TEST_REGISTRY[$function]))) // must be callable, and registered (for security)
return array('function' => $function, 'result' => $function());
return array('function' => $function, 'result' => false);
}
/**
* Execute all tests.
*
* @return array
*/
function execute_elgg_tests()
{
global $ELGG_TEST_REGISTRY;
$report = array(); // An array to be populated with ElggTestResult objects
foreach ($ELGG_TEST_REGISTRY as $func => $desc)
{
$report[] = execute_elgg_test($func);
}
return $report;
}
/**
* Register an Elgg unit test.
*
* @param string $description elgg_echo description of test.
* @param string $function Function to execute. This function should execute the test and return a ElggTestResult object.
*/
function register_elgg_test($description, $function)
{
global $ELGG_TEST_REGISTRY;
if (!$ELGG_TEST_REGISTRY) $ELGG_TEST_REGISTRY = array();
$ELGG_TEST_REGISTRY[$function] = $description;
}
/**
* Return a list of available tests.
*
* @return array
*/
function get_available_tests()
{
global $ELGG_TEST_REGISTRY;
return $ELGG_TEST_REGISTRY;
}
?>
|
