René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Fully automate the module without requiring changes to tests","articleBody":"Currently using this module requires changes in each test.\r\nI have found an ugly way to alleviate that problem.\r\n\r\nThe code below was tested for `Cest` type tests only. It should not break for any other test type but might simply not work.\r\n\r\n```php\r\n\r\nuse Codeception\\Lib\\Di;\r\nuse Codeception\\Module;\r\nuse Codeception\\TestInterface;\r\n\r\nclass Mockery extends Module\r\n{\r\n\r\n\r\n    public function _before(TestInterface $test)\r\n    {\r\n        $meta = $test-\u003egetMetadata();\r\n        $rc = new \\ReflectionClass($meta);\r\n        $prop = $rc-\u003egetProperty('services');\r\n        $prop-\u003esetAccessible(true);\r\n        $services = $prop-\u003egetValue($meta);\r\n        /** @var Di $di */\r\n        $di = $services['di'];\r\n\r\n        $services['di'] = new class($di, $test) extends Di {\r\n            public function __construct(Di $fallback, private readonly TestInterface $test)\r\n            {\r\n                parent::__construct($fallback);\r\n\r\n            }\r\n\r\n\r\n            public function injectDependencies(object $object, string $injectMethodName = self::DEFAULT_INJECT_METHOD_NAME, array $defaults = []): void\r\n            {\r\n                if ($object === $this-\u003etest) {\r\n                    parent::injectDependencies(...func_get_args());\r\n                    return;\r\n                }\r\n                // We check if the object is our test, if so we close mockery after.\r\n\r\n                codecept_debug(['CALLING',\r\n                    get_class($object),\r\n                    $injectMethodName\r\n                ]);\r\n                try {\r\n                    parent::injectDependencies(...func_get_args());\r\n                    \\Mockery::close();\r\n                } catch (\\Throwable $t) {\r\n                    \\Mockery::resetContainer();\r\n                    throw $t;\r\n                }\r\n                \\Mockery::close();\r\n            }\r\n        };\r\n        $prop-\u003esetValue($meta, $services);\r\n    }\r\n}\r\n```\r\n\r\nEssentially we hijack the `Di` container and replace it with a custom implementation. Based on the fact that for `Cest` files the actual test is ran like this:\r\n```php\r\n$this-\u003egetMetadata()-\u003egetService('di')-\u003einjectDependencies($this-\u003etestInstance, $methodName, $context);\r\n```\r\nWe abuse this to insert a mockery closure after calling the test method.\r\n\r\n\r\nWhile I'm happy to make a PR for this, I'm not sure it should be in an \"official\" repository. I probably don't have time to implement a proper fix where we add an event to allow modules to fail a test before it is finished.\r\n","author":{"url":"https://github.com/SamMousa","@type":"Person","name":"SamMousa"},"datePublished":"2023-11-13T16:01:02.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/23/MockeryModule/issues/23"}