Code Monkey home page Code Monkey logo

mock-injector's Introduction

bigcommerce/mock-injector

Build Status Scrutinizer Code Quality Code Coverage

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

(The MIT License) Copyright (C) 2015-2017 BigCommerce Inc. All rights reserved.

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.

mock-injector's People

Contributors

petrkotek avatar repzy avatar toma-r avatar precariouspanther avatar pascalzajac avatar filakhtov avatar funivan avatar bc-luke avatar bc-vincent-zhao avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.