4 * Class CRM_Extension_Manager_ModuleTest
7 class CRM_Extension_Manager_ModuleTest
extends CiviUnitTestCase
{
9 public function setUp() {
11 // $query = "INSERT INTO civicrm_domain ( name, version ) VALUES ( 'domain', 3 )";
12 // $result = CRM_Core_DAO::executeQuery($query);
13 global $_test_extension_manager_moduletest_counts;
14 $_test_extension_manager_moduletest_counts = array();
15 $this->basedir
= $this->createTempDir('ext-');
16 $this->system
= new CRM_Extension_System(array(
17 'extensionsDir' => $this->basedir
,
18 'extensionsURL' => 'http://testbase/',
20 $this->setExtensionSystem($this->system
);
23 public function tearDown() {
29 * Install an extension with a valid type name.
31 public function testInstallDisableUninstall() {
32 $manager = $this->system
->getManager();
33 $this->assertModuleActiveByName(FALSE, 'moduletest');
35 $manager->install(array('test.extension.manager.moduletest'));
36 $this->assertHookCounts('moduletest', array(
43 $this->assertModuleActiveByName(TRUE, 'moduletest');
44 $this->assertModuleActiveByKey(TRUE, 'test.extension.manager.moduletest');
46 $manager->disable(array('test.extension.manager.moduletest'));
47 $this->assertHookCounts('moduletest', array(
54 $this->assertModuleActiveByName(FALSE, 'moduletest');
55 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
57 $manager->uninstall(array('test.extension.manager.moduletest'));
58 $this->assertHookCounts('moduletest', array(
65 $this->assertModuleActiveByName(FALSE, 'moduletest');
66 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
70 * Install an extension with a valid type name.
72 public function testInstallDisableEnable() {
73 $manager = $this->system
->getManager();
74 $this->assertModuleActiveByName(FALSE, 'moduletest');
75 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
77 $manager->install(array('test.extension.manager.moduletest'));
78 $this->assertHookCounts('moduletest', array(
84 $this->assertModuleActiveByName(TRUE, 'moduletest');
85 $this->assertModuleActiveByKey(TRUE, 'test.extension.manager.moduletest');
87 $manager->disable(array('test.extension.manager.moduletest'));
88 $this->assertHookCounts('moduletest', array(
94 $this->assertModuleActiveByName(FALSE, 'moduletest');
95 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
97 $manager->enable(array('test.extension.manager.moduletest'));
98 $this->assertHookCounts('moduletest', array(
104 $this->assertModuleActiveByName(TRUE, 'moduletest');
105 $this->assertModuleActiveByKey(TRUE, 'test.extension.manager.moduletest');
109 * Install an extension then forcibly remove the code and cleanup DB afterwards.
111 public function testInstall_DirtyRemove_Disable_Uninstall() {
112 // create temporary extension (which can dirtily remove later)
113 $this->_createExtension('test.extension.manager.module.auto1', 'module', 'test_extension_manager_module_auto1');
114 $mainfile = $this->basedir
. '/test.extension.manager.module.auto1/test_extension_manager_module_auto1.php';
115 $this->assertTrue(file_exists($mainfile));
116 $manager = $this->system
->getManager();
117 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto1');
118 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.module.auto1');
121 $manager->install(array('test.extension.manager.module.auto1'));
122 $this->assertEquals('installed', $manager->getStatus('test.extension.manager.module.auto1'));
123 $this->assertHookCounts('test_extension_manager_module_auto1', array(
129 $this->assertModuleActiveByName(TRUE, 'test_extension_manager_module_auto1');
130 $this->assertModuleActiveByKey(TRUE, 'test.extension.manager.module.auto1');
133 CRM_Utils_File
::cleanDir($this->basedir
. '/test.extension.manager.module.auto1', TRUE, FALSE);
135 $this->assertEquals('installed-missing', $manager->getStatus('test.extension.manager.module.auto1'));
137 // disable while missing
138 $manager->disable(array('test.extension.manager.module.auto1'));
139 $this->assertEquals('disabled-missing', $manager->getStatus('test.extension.manager.module.auto1'));
140 $this->assertHookCounts('test_extension_manager_module_auto1', array(
143 'disable' => 0, // normally called -- but not for missing modules!
146 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto1');
147 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
149 $manager->uninstall(array('test.extension.manager.module.auto1'));
150 $this->assertHookCounts('test_extension_manager_module_auto1', array(
153 'disable' => 0, // normally called -- but not for missing modules!
154 'uninstall' => 0, // normally called -- but not for missing modules!
156 $this->assertEquals('unknown', $manager->getStatus('test.extension.manager.module.auto1'));
157 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto1');
158 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.module.auto1');
162 * Install an extension then forcibly remove the code and cleanup DB afterwards.
164 public function testInstall_DirtyRemove_Disable_Restore() {
165 // create temporary extension (which can dirtily remove later)
166 $this->_createExtension('test.extension.manager.module.auto2', 'module', 'test_extension_manager_module_auto2');
167 $mainfile = $this->basedir
. '/test.extension.manager.module.auto2/test_extension_manager_module_auto2.php';
168 $this->assertTrue(file_exists($mainfile));
169 $manager = $this->system
->getManager();
170 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto2');
171 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.module.auto2');
174 $manager->install(array('test.extension.manager.module.auto2'));
175 $this->assertEquals('installed', $manager->getStatus('test.extension.manager.module.auto2'));
176 $this->assertHookCounts('test_extension_manager_module_auto2', array(
182 $this->assertModuleActiveByName(TRUE, 'test_extension_manager_module_auto2');
183 $this->assertModuleActiveByKey(TRUE, 'test.extension.manager.module.auto2');
186 CRM_Utils_File
::cleanDir($this->basedir
. '/test.extension.manager.module.auto2', TRUE, FALSE);
188 $this->assertEquals('installed-missing', $manager->getStatus('test.extension.manager.module.auto2'));
190 // disable while missing
191 $manager->disable(array('test.extension.manager.module.auto2'));
192 $this->assertEquals('disabled-missing', $manager->getStatus('test.extension.manager.module.auto2'));
193 $this->assertHookCounts('test_extension_manager_module_auto2', array(
196 'disable' => 0, // normally called -- but not for missing modules!
199 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto2');
200 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.moduletest');
203 $this->_createExtension('test.extension.manager.module.auto2', 'module', 'test_extension_manager_module_auto2');
205 $this->assertHookCounts('test_extension_manager_module_auto2', array(
211 $this->assertEquals('disabled', $manager->getStatus('test.extension.manager.module.auto2'));
212 $this->assertModuleActiveByName(FALSE, 'test_extension_manager_module_auto2');
213 $this->assertModuleActiveByKey(FALSE, 'test.extension.manager.module.auto2');
218 * @param array $counts
219 * Expected hook invocation counts ($hookName => $count).
221 public function assertHookCounts($module, $counts) {
222 global $_test_extension_manager_moduletest_counts;
223 foreach ($counts as $key => $expected) {
224 $actual = @$_test_extension_manager_moduletest_counts[$module][$key];
225 $this->assertEquals($expected, $actual,
226 sprintf('Expected %d call(s) to hook_civicrm_%s -- found %d', $expected, $key, $actual)
232 * @param $expectedIsActive
235 public function assertModuleActiveByName($expectedIsActive, $prefix) {
236 $activeModules = CRM_Core_PseudoConstant
::getModuleExtensions(TRUE); // FIXME
237 foreach ($activeModules as $activeModule) {
238 if ($activeModule['prefix'] == $prefix) {
239 $this->assertEquals($expectedIsActive, TRUE);
243 $this->assertEquals($expectedIsActive, FALSE);
247 * @param $expectedIsActive
250 public function assertModuleActiveByKey($expectedIsActive, $key) {
251 foreach (CRM_Core_Module
::getAll() as $module) {
252 if ($module->name
== $key) {
253 $this->assertEquals((bool) $expectedIsActive, (bool) $module->is_active
);
257 $this->assertEquals($expectedIsActive, FALSE);
264 * @param string $template
266 public function _createExtension($key, $type, $file, $template = self
::MODULE_TEMPLATE
) {
267 $basedir = $this->basedir
;
268 mkdir("$basedir/$key");
269 file_put_contents("$basedir/$key/info.xml", "<extension key='$key' type='$type'><file>$file</file></extension>");
270 file_put_contents("$basedir/$key/$file.php", strtr($template, array('_FILE_' => $file)));
271 $this->system
->getCache()->flush();
272 $this->system
->getManager()->refresh();
277 * @param string $name
279 public static function incHookCount($module, $name) {
280 global $_test_extension_manager_moduletest_counts;
281 if (!isset($_test_extension_manager_moduletest_counts[$module][$name])) {
282 $_test_extension_manager_moduletest_counts[$module][$name] = 0;
284 $_test_extension_manager_moduletest_counts[$module][$name] = 1 +
(int) $_test_extension_manager_moduletest_counts[$module][$name];
287 const MODULE_TEMPLATE
= "<?php
288 function _FILE__civicrm_install() {
289 CRM_Extension_Manager_ModuleTest::incHookCount('_FILE_', 'install');
292 function _FILE__civicrm_postInstall() {
293 CRM_Extension_Manager_ModuleTest::incHookCount('_FILE_', 'postInstall');
296 function _FILE__civicrm_uninstall() {
297 CRM_Extension_Manager_ModuleTest::incHookCount('_FILE_', 'uninstall');
300 function _FILE__civicrm_enable() {
301 CRM_Extension_Manager_ModuleTest::incHookCount('_FILE_', 'enable');
304 function _FILE__civicrm_disable() {
305 CRM_Extension_Manager_ModuleTest::incHookCount('_FILE_', 'disable');