README

Auto-mocking test Dependency Injector component

Will automatically mock all injected dependencies of an object using the BigCommerce Injector. This allows objects to be refactored to have dependencies removed or new ones added without needing to rebuild all the mock definitions or modify many tests, making decoupled DI driven development much easier.

Mocks can be configured with expectations by calling getMock(CLASS_NAME) on the TestInjector within your tests. This will return an ObjectProphecy object (a mock generated by Prophecy - the mocking library included in PHPUnit).

A single mock instance is created per Fully Qualified Class Name, so if the object you're testing takes two of the same typed parameter, the same mock will be passed to both (so ensure your expectations are set appropriately).

Construction Usage:

// All constructor dependencies resolved through mocking
$testObject = $testInjector->create(My\Test\Object::class); 

// Parameter injection - will provide parameters either by type, name or position - otherwise resolve via mocking
$testObject = $testInjector->create(My\Test\Object::class, [
    "enabled" => true,              // Named
    7 => "fish",                    // Positional
    Logger::class => new Logger(),  // Type
]);

Invocation usage

// Call the method 'createUser' on an existing object
$result = $testInjector->invoke($instanceOfThing, "createUser");

// Parameter injection - will provide parameters either by type, name or position - otherwise resolve via mocking
$result = $testInjector->invoke($instanceOfThing, "createUser", [
    "enabled" => true,              // Named
    7 => "fish",                    // Positional
    Logger::class => new Logger(),  // Type
]);

For integration with your PHPUnit tests, see: AutoMockingTest.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

bigcommerce / mock-injector

Maintainers

Details

README