ModuleContainerTest.php 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. <?php
  2. namespace Codeception\Lib;
  3. use Codeception\Lib\Interfaces\ConflictsWithModule;
  4. use Codeception\Lib\Interfaces\DependsOnModule;
  5. use Codeception\Util\Stub;
  6. // @codingStandardsIgnoreFile
  7. class ModuleContainerTest extends \PHPUnit_Framework_TestCase
  8. {
  9. use \Codeception\Specify;
  10. /**
  11. * @var ModuleContainer
  12. */
  13. protected $moduleContainer;
  14. protected function setUp()
  15. {
  16. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), []);
  17. }
  18. protected function tearDown()
  19. {
  20. \Codeception\Module\UniversalFramework::$includeInheritedActions = true;
  21. \Codeception\Module\UniversalFramework::$onlyActions = [];
  22. \Codeception\Module\UniversalFramework::$excludeActions = [];
  23. \Codeception\Module\UniversalFramework::$aliases = [];
  24. }
  25. /**
  26. * @group core
  27. * @throws \Codeception\Exception\ConfigurationException
  28. */
  29. public function testCreateModule()
  30. {
  31. $module = $this->moduleContainer->create('EmulateModuleHelper');
  32. $this->assertInstanceOf('Codeception\Module\EmulateModuleHelper', $module);
  33. $module = $this->moduleContainer->create('Codeception\Module\EmulateModuleHelper');
  34. $this->assertInstanceOf('Codeception\Module\EmulateModuleHelper', $module);
  35. $this->assertTrue($this->moduleContainer->hasModule('EmulateModuleHelper'));
  36. $this->assertInstanceOf(
  37. 'Codeception\Module\EmulateModuleHelper',
  38. $this->moduleContainer->getModule('EmulateModuleHelper')
  39. );
  40. }
  41. /**
  42. * @group core
  43. */
  44. public function testActions()
  45. {
  46. $this->moduleContainer->create('EmulateModuleHelper');
  47. $actions = $this->moduleContainer->getActions();
  48. $this->assertArrayHasKey('seeEquals', $actions);
  49. $this->assertEquals('EmulateModuleHelper', $actions['seeEquals']);
  50. }
  51. /**
  52. * @group core
  53. */
  54. public function testActionsInExtendedModule()
  55. {
  56. $this->moduleContainer->create('\Codeception\Module\UniversalFramework');
  57. $actions = $this->moduleContainer->getActions();
  58. $this->assertArrayHasKey('amOnPage', $actions);
  59. $this->assertArrayHasKey('see', $actions);
  60. $this->assertArrayHasKey('click', $actions);
  61. }
  62. /**
  63. * @group core
  64. */
  65. public function testActionsInExtendedButNotInheritedModule()
  66. {
  67. \Codeception\Module\UniversalFramework::$includeInheritedActions = false;
  68. $this->moduleContainer->create('\Codeception\Module\UniversalFramework');
  69. $actions = $this->moduleContainer->getActions();
  70. $this->assertArrayNotHasKey('amOnPage', $actions);
  71. $this->assertArrayNotHasKey('see', $actions);
  72. $this->assertArrayNotHasKey('click', $actions);
  73. $this->assertArrayHasKey('useUniversalFramework', $actions);
  74. }
  75. /**
  76. * @group core
  77. */
  78. public function testExplicitlySetActionsOnNotInherited()
  79. {
  80. \Codeception\Module\UniversalFramework::$includeInheritedActions = false;
  81. \Codeception\Module\UniversalFramework::$onlyActions = ['see'];
  82. $this->moduleContainer->create('\Codeception\Module\UniversalFramework');
  83. $actions = $this->moduleContainer->getActions();
  84. $this->assertArrayNotHasKey('amOnPage', $actions);
  85. $this->assertArrayHasKey('see', $actions);
  86. $this->assertArrayNotHasKey('click', $actions);
  87. }
  88. /**
  89. * @group core
  90. */
  91. public function testActionsExplicitlySetForNotInheritedModule()
  92. {
  93. \Codeception\Module\UniversalFramework::$onlyActions = ['see'];
  94. $this->moduleContainer->create('\Codeception\Module\UniversalFramework');
  95. $actions = $this->moduleContainer->getActions();
  96. $this->assertArrayNotHasKey('amOnPage', $actions);
  97. $this->assertArrayHasKey('see', $actions);
  98. }
  99. /**
  100. * @group core
  101. */
  102. public function testCreateModuleWithoutRequiredFields()
  103. {
  104. $this->setExpectedException('\Codeception\Exception\ModuleConfigException');
  105. $this->moduleContainer->create('Codeception\Lib\StubModule');
  106. }
  107. /**
  108. * @group core
  109. */
  110. public function testCreateModuleWithCorrectConfig()
  111. {
  112. $config = [
  113. 'modules' => [
  114. 'config' => [
  115. 'Codeception\Lib\StubModule' => [
  116. 'firstField' => 'firstValue',
  117. 'secondField' => 'secondValue',
  118. ]
  119. ]
  120. ]
  121. ];
  122. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  123. $module = $this->moduleContainer->create('Codeception\Lib\StubModule');
  124. $this->assertEquals('firstValue', $module->_getFirstField());
  125. $this->assertEquals('secondValue', $module->_getSecondField());
  126. }
  127. /**
  128. * @group core
  129. */
  130. public function testReconfigureModule()
  131. {
  132. $config = [
  133. 'modules' => [
  134. 'config' => [
  135. 'Codeception\Lib\StubModule' => [
  136. 'firstField' => 'firstValue',
  137. 'secondField' => 'secondValue',
  138. ]
  139. ]
  140. ]
  141. ];
  142. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  143. $module = $this->moduleContainer->create('Codeception\Lib\StubModule');
  144. $module->_reconfigure(['firstField' => '1st', 'secondField' => '2nd']);
  145. $this->assertEquals('1st', $module->_getFirstField());
  146. $this->assertEquals('2nd', $module->_getSecondField());
  147. $module->_resetConfig();
  148. $this->assertEquals('firstValue', $module->_getFirstField());
  149. $this->assertEquals('secondValue', $module->_getSecondField());
  150. }
  151. public function testConflictsByModuleName()
  152. {
  153. $this->setExpectedException('Codeception\Exception\ModuleConflictException');
  154. $this->moduleContainer->create('Codeception\Lib\ConflictedModule');
  155. $this->moduleContainer->create('Cli');
  156. $this->moduleContainer->validateConflicts();
  157. }
  158. public function testConflictsByClass()
  159. {
  160. $this->setExpectedException('Codeception\Exception\ModuleConflictException');
  161. $this->moduleContainer->create('Codeception\Lib\ConflictedModule2');
  162. $this->moduleContainer->create('Cli');
  163. $this->moduleContainer->validateConflicts();
  164. }
  165. public function testConflictsByInterface()
  166. {
  167. $this->setExpectedException('Codeception\Exception\ModuleConflictException');
  168. $this->moduleContainer->create('Codeception\Lib\ConflictedModule3');
  169. $this->moduleContainer->create('Symfony2');
  170. $this->moduleContainer->validateConflicts();
  171. }
  172. public function testConflictsByWebInterface()
  173. {
  174. $this->setExpectedException('Codeception\Exception\ModuleConflictException');
  175. $this->moduleContainer->create('Laravel5');
  176. $this->moduleContainer->create('Symfony2');
  177. $this->moduleContainer->validateConflicts();
  178. }
  179. public function testConflictsForREST()
  180. {
  181. $config = ['modules' =>
  182. ['config' => [
  183. 'REST' => [
  184. 'depends' => 'ZF1',
  185. ]
  186. ]
  187. ]
  188. ];
  189. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  190. $this->moduleContainer->create('ZF1');
  191. $this->moduleContainer->create('REST');
  192. $this->moduleContainer->validateConflicts();
  193. }
  194. public function testConflictsOnDependentModules()
  195. {
  196. $config = ['modules' =>
  197. ['config' => [
  198. 'WebDriver' => ['url' => 'localhost', 'browser' => 'firefox'],
  199. 'REST' => [
  200. 'depends' => 'PhpBrowser',
  201. ]
  202. ]
  203. ]
  204. ];
  205. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  206. $this->moduleContainer->create('WebDriver');
  207. $this->moduleContainer->create('REST');
  208. $this->moduleContainer->validateConflicts();
  209. }
  210. public function testNoConflictsForPartedModules()
  211. {
  212. $config = ['modules' =>
  213. ['config' => [
  214. 'Laravel5' => [
  215. 'part' => 'ORM',
  216. ]
  217. ]
  218. ]
  219. ];
  220. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  221. $this->moduleContainer->create('Laravel5');
  222. $this->moduleContainer->create('Symfony2');
  223. $this->moduleContainer->validateConflicts();
  224. }
  225. public function testModuleDependenciesFail()
  226. {
  227. $this->setExpectedException('Codeception\Exception\ModuleRequireException');
  228. $this->moduleContainer->create('Codeception\Lib\DependencyModule');
  229. }
  230. public function testModuleDependencies()
  231. {
  232. $config = ['modules' => [
  233. 'enabled' => ['Codeception\Lib\DependencyModule'],
  234. 'config' => [
  235. 'Codeception\Lib\DependencyModule' => [
  236. 'depends' => 'Codeception\Lib\ConflictedModule'
  237. ]
  238. ]
  239. ]];
  240. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  241. $this->moduleContainer->create('Codeception\Lib\DependencyModule');
  242. $this->moduleContainer->hasModule('\Codeception\Lib\DependencyModule');
  243. }
  244. public function testModuleParts1()
  245. {
  246. $config = ['modules' => [
  247. 'enabled' => ['\Codeception\Lib\PartedModule'],
  248. 'config' => [
  249. '\Codeception\Lib\PartedModule' => [
  250. 'part' => 'one'
  251. ]
  252. ]
  253. ]
  254. ];
  255. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  256. $this->moduleContainer->create('\Codeception\Lib\PartedModule');
  257. $actions = $this->moduleContainer->getActions();
  258. $this->assertArrayHasKey('partOne', $actions);
  259. $this->assertArrayNotHasKey('partTwo', $actions);
  260. }
  261. public function testModuleParts2()
  262. {
  263. $config = ['modules' => [
  264. 'enabled' => ['\Codeception\Lib\PartedModule'],
  265. 'config' => ['\Codeception\Lib\PartedModule' => [
  266. 'part' => ['Two']
  267. ]
  268. ]
  269. ]
  270. ];
  271. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  272. $this->moduleContainer->create('\Codeception\Lib\PartedModule');
  273. $actions = $this->moduleContainer->getActions();
  274. $this->assertArrayHasKey('partTwo', $actions);
  275. $this->assertArrayNotHasKey('partOne', $actions);
  276. }
  277. public function testShortConfigParts()
  278. {
  279. $config = [
  280. 'modules' => [
  281. 'enabled' => [
  282. ['\Codeception\Lib\PartedModule' => [
  283. 'part' => 'one'
  284. ]
  285. ]
  286. ],
  287. ]
  288. ];
  289. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  290. $this->moduleContainer->create('\Codeception\Lib\PartedModule');
  291. $actions = $this->moduleContainer->getActions();
  292. $this->assertArrayHasKey('partOne', $actions);
  293. $this->assertArrayNotHasKey('partTwo', $actions);
  294. }
  295. public function testShortConfigFormat()
  296. {
  297. $config = [
  298. 'modules' =>
  299. ['enabled' => [
  300. ['Codeception\Lib\StubModule' => [
  301. 'firstField' => 'firstValue',
  302. 'secondField' => 'secondValue',
  303. ]
  304. ]
  305. ]
  306. ]
  307. ];
  308. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  309. $module = $this->moduleContainer->create('Codeception\Lib\StubModule');
  310. $this->assertEquals('firstValue', $module->_getFirstField());
  311. $this->assertEquals('secondValue', $module->_getSecondField());
  312. }
  313. public function testShortConfigDependencies()
  314. {
  315. $config = ['modules' => [
  316. 'enabled' => [['Codeception\Lib\DependencyModule' => [
  317. 'depends' => 'Codeception\Lib\ConflictedModule'
  318. ]]],
  319. ]];
  320. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  321. $this->moduleContainer->create('Codeception\Lib\DependencyModule');
  322. $this->moduleContainer->hasModule('\Codeception\Lib\DependencyModule');
  323. }
  324. public function testInjectModuleIntoHelper()
  325. {
  326. $config = ['modules' => [
  327. 'enabled' => ['Codeception\Lib\HelperModule'],
  328. ]];
  329. $this->moduleContainer = new ModuleContainer(Stub::make('Codeception\Lib\Di'), $config);
  330. $this->moduleContainer->create('Codeception\Lib\HelperModule');
  331. $this->moduleContainer->hasModule('Codeception\Lib\HelperModule');
  332. }
  333. }
  334. class StubModule extends \Codeception\Module
  335. {
  336. protected $requiredFields = [
  337. 'firstField',
  338. 'secondField',
  339. ];
  340. public function _getFirstField()
  341. {
  342. return $this->config['firstField'];
  343. }
  344. public function _getSecondField()
  345. {
  346. return $this->config['secondField'];
  347. }
  348. }
  349. class HelperModule extends \Codeception\Module
  350. {
  351. public function _inject(ConflictedModule $module)
  352. {
  353. $this->module = $module;
  354. }
  355. }
  356. class ConflictedModule extends \Codeception\Module implements ConflictsWithModule
  357. {
  358. public function _conflicts()
  359. {
  360. return 'Cli';
  361. }
  362. }
  363. class ConflictedModule2 extends \Codeception\Module implements ConflictsWithModule
  364. {
  365. public function _conflicts()
  366. {
  367. return '\Codeception\Module\Cli';
  368. }
  369. }
  370. class ConflictedModule3 extends \Codeception\Module implements ConflictsWithModule
  371. {
  372. public function _conflicts()
  373. {
  374. return 'Codeception\Lib\Interfaces\Web';
  375. }
  376. }
  377. class DependencyModule extends \Codeception\Module implements DependsOnModule
  378. {
  379. public function _depends()
  380. {
  381. return ['Codeception\Lib\ConflictedModule' => 'Error message'];
  382. }
  383. public function _inject()
  384. {
  385. }
  386. }
  387. class PartedModule extends \Codeception\Module implements \Codeception\Lib\Interfaces\PartedModule
  388. {
  389. public function _parts()
  390. {
  391. return ['one'];
  392. }
  393. /**
  394. * @part one
  395. */
  396. public function partOne()
  397. {
  398. }
  399. /**
  400. * @part two
  401. */
  402. public function partTwo()
  403. {
  404. }
  405. }