Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fully automate the module without requiring changes to tests #23

Open
SamMousa opened this issue Nov 13, 2023 · 0 comments
Open

Fully automate the module without requiring changes to tests #23

SamMousa opened this issue Nov 13, 2023 · 0 comments

Comments

@SamMousa
Copy link

Currently using this module requires changes in each test.
I have found an ugly way to alleviate that problem.

The code below was tested for Cest type tests only. It should not break for any other test type but might simply not work.

use Codeception\Lib\Di;
use Codeception\Module;
use Codeception\TestInterface;

class Mockery extends Module
{


    public function _before(TestInterface $test)
    {
        $meta = $test->getMetadata();
        $rc = new \ReflectionClass($meta);
        $prop = $rc->getProperty('services');
        $prop->setAccessible(true);
        $services = $prop->getValue($meta);
        /** @var Di $di */
        $di = $services['di'];

        $services['di'] = new class($di, $test) extends Di {
            public function __construct(Di $fallback, private readonly TestInterface $test)
            {
                parent::__construct($fallback);

            }


            public function injectDependencies(object $object, string $injectMethodName = self::DEFAULT_INJECT_METHOD_NAME, array $defaults = []): void
            {
                if ($object === $this->test) {
                    parent::injectDependencies(...func_get_args());
                    return;
                }
                // We check if the object is our test, if so we close mockery after.

                codecept_debug(['CALLING',
                    get_class($object),
                    $injectMethodName
                ]);
                try {
                    parent::injectDependencies(...func_get_args());
                    \Mockery::close();
                } catch (\Throwable $t) {
                    \Mockery::resetContainer();
                    throw $t;
                }
                \Mockery::close();
            }
        };
        $prop->setValue($meta, $services);
    }
}

Essentially 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:

$this->getMetadata()->getService('di')->injectDependencies($this->testInstance, $methodName, $context);

We abuse this to insert a mockery closure after calling the test method.

While 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant