Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Codeception/AspectMock

The most powerful and flexible mocking framework for PHPUnit / Codeception.
https://github.com/Codeception/AspectMock

Last synced: about 2 months ago
JSON representation

The most powerful and flexible mocking framework for PHPUnit / Codeception.

Lists

README 

        
AspectMock

==========



AspectMock is not an ordinary PHP mocking framework.

With the power of Aspect Oriented programming and the awesome [Go-AOP](https://github.com/goaop/framework) library,

AspectMock allows you to stub and mock practically anything in your PHP code!



**Documentation** | [Test Doubles Builder](https://github.com/Codeception/AspectMock/blob/master/docs/Test.md) | [ClassProxy](https://github.com/Codeception/AspectMock/blob/master/docs/ClassProxy.md) | [InstanceProxy](https://github.com/Codeception/AspectMock/blob/master/docs/InstanceProxy.md) | [FuncProxy](https://github.com/Codeception/AspectMock/blob/master/docs/FuncProxy.md)



[![Actions Status](https://github.com/Codeception/AspectMock/workflows/CI/badge.svg)](https://github.com/Codeception/AspectMock/actions)

[![Latest Stable Version](https://poser.pugx.org/codeception/aspect-mock/v/stable.png)](https://packagist.org/packages/codeception/aspect-mock)

[![Total Downloads](https://poser.pugx.org/codeception/aspect-mock/downloads)](https://packagist.org/packages/codeception/aspect-mock)

[![Monthly Downloads](https://poser.pugx.org/codeception/aspect-mock/d/monthly)](https://packagist.org/packages/codeception/aspect-mock)

[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)



## Motivation



PHP is a language that was not designed to be testable. Really. 

How would you fake the `time()` function to produce the same result for each test call?

Is there any way to stub a static method of a class? Can you redefine a class method at runtime?

Dynamic languages like Ruby or JavaScript allow us to do this. 

These features are essential for testing. AspectMock to the rescue!



Thousands of lines of untested code are written everyday in PHP.

In most cases, this code is not actually bad, 

but PHP does not provide capabilities to test it. You may suggest rewriting it from scratch following test driven design practices and use dependency injection wherever possible. Should this be done for stable working code? Well, there are much better ways to waste time.



With AspectMock you can unit-test practically any OOP code. PHP powered with AOP incorporates features of dynamic languages we have long been missing. There is no excuse for not testing your code.

You do not have to rewrite it from scratch to make it testable. Just install AspectMock with PHPUnit or Codeception and try to write some tests. It's really, really simple!



## Features



* Create test doubles for **static methods**.

* Create test doubles for **class methods called anywhere**.

* Redefine methods on the fly.

* Simple syntax that's easy to remember.



## Code Pitch



#### Allows stubbing and mocking of static methods.



Let's redefine static methods and verify their calls at runtime.



``` php

assertSame('users', UserModel::tableName());	

	$userModel = test::double('UserModel', ['tableName' => 'my_users']);

	$this->assertSame('my_users', UserModel::tableName());

	$userModel->verifyInvoked('tableName');	

}

```



#### Allows replacement of class methods.



Testing code developed with the **ActiveRecord** pattern. Does the use of the ActiveRecord pattern sound like bad practice? No. But the code below is untestable in classic unit testing.



``` php

setName($name);

    	$user->save();

    }

}

```



Without AspectMock you need to introduce `User` as an explicit dependency into class `UserService` to get it tested.

But lets leave the code as it is. It works. Nevertheless, we should still test it to avoid regressions.



We don't want the `$user->save` method to actually get executed, as it will hit the database.

Instead we will replace it with a dummy and verify that it gets called by `createUserByName`:



``` php

 null]);

	$service = new UserService;

	$service->createUserByName('davert');

	$this->assertSame('davert', $user->getName());

	$user->verifyInvoked('save');

}

```



#### Intercept even parent class methods and magic methods



``` php

 null]));

	test::double('User', ['findByNameAndEmail' => new User(['name' => 'jon'])])); 

	$user = User::findByNameAndEmail('jon','[email protected]'); // magic method

	$this->assertSame('jon', $user->getName());

	$user->save(['name' => 'miles']); // ActiveRecord->save did not hit database

	$AR->verifyInvoked('save');

	$this->assertSame('miles', $user->getName());

}

```



#### Override even standard PHP functions



``` php

assertSame('now', time());

```



#### Beautifully simple



Only 4 methods are necessary for method call verification and one method to define test doubles:



``` php

 'davert']);

	$this->assertSame('davert', $user->getName());

	$user->verifyInvoked('getName');

	$user->verifyInvokedOnce('getName');

	$user->verifyNeverInvoked('setName');

	$user->verifyInvokedMultipleTimes('setName',1);

}

```



To check that method `setName` was called with `davert` as argument.



``` php

verifyMethodInvoked('setName', ['davert']);

```



## Wow! But how does it work?



No PECL extensions is required. The [Go! AOP](http://go.aopphp.com/) library does the heavy lifting by patching autoloaded PHP classes on the fly. By introducing pointcuts to every method call, Go! allows intercepting practically any call to a method. AspectMock is a very tiny framework consisting of only 8 files using the power of the [Go! AOP Framework](http://go.aopphp.com/). Check out Aspect Oriented Development and the Go! library itself.



## Requirements



* `PHP 7.4`.

* `Go! AOP 3.0`



## Installation



### 1. Add aspect-mock to your composer.json.



```

{

	"require-dev": {

		"codeception/aspect-mock": "*"

	}

}

```



### 2. Install AspectMock with Go! AOP as a dependency.



```

php composer.phar update

```



## Configuration



Include `AspectMock\Kernel` class into your tests bootstrap file. 



### With Composer's Autoloader



``` php

init([

    'debug' => true,

    'includePaths' => [__DIR__.'/../src']

]);

```



If your project uses Composer's autoloader, that's all you need to get started.



### With Custom Autoloader



If you use a custom autoloader (like in Yii/Yii2 frameworks), you should explicitly point AspectMock to modify it:



``` php

init([

    'debug' => true,

    'includePaths' => [__DIR__.'/../src']

]);

$kernel->loadFile('YourAutoloader.php'); // path to your autoloader

```



Load all autoloaders of your project this way, if you do not rely on Composer entirely.



### Without Autoloader



If it still doesn't work for you... 



Explicitly load all required files before testing:



``` php

init([

    'debug' => true,

    'includePaths' => [__DIR__.'/../src']

]);

require 'YourAutoloader.php';

$kernel->loadPhpFiles('/../common');

```



### Customization



There are a few options you can customize setting up AspectMock. All them are defined in Go! Framework.

They might help If you still didn't get AspectMock running on your project.



* `appDir` defines the root of web application which is being tested. All classes outside the root will be replaced with the proxies generated by AspectMock. By default it is a directory in which `vendor` dir of composer if located. **If you don't use Composer** or you have custom path to composer's vendor's folder, you should specify appDir

* `cacheDir` a dir where updated source PHP files can be stored. If this directory is not set, proxie classes will be built on each run. Otherwise all PHP files used in tests will be updated with aspect injections and stored into `cacheDir` path.

* `includePaths` directories with files that should be enhanced by Go Aop. Should point to your applications source files as well as framework files and any libraries you use..

* `excludePaths` a paths in which PHP files should not be affected by aspects. **You should exclude your tests files from interception**.



Example:



``` php

init([

    'appDir'    => __DIR__ . '/../../',

    'cacheDir'  => '/tmp/myapp',

    'includePaths' => [__DIR__.'/../src']

    'excludePaths' => [__DIR__] // tests dir should be excluded

]);

```



[More configs for different frameworks](https://github.com/Codeception/AspectMock/wiki/Example-configs).



**It's pretty important to configure AspectMock properly. Otherwise it may not work as expected or you get side effects. Please make sure you included all files that you need to mock, but your test files as well as testing frameworks are excluded.**



## Usage in PHPUnit



Use newly created `bootstrap` in your `phpunit.xml` configuration. Also disable `backupGlobals`:



``` xml



```



Clear the test doubles registry between tests.



``` php

 null]);

        \demo\UserModel::tableName();

        \demo\UserModel::tableName();

        $user->verifyInvokedMultipleTimes('tableName',2);

    }

```



## Usage in Codeception.



Include `AspectMock\Kernel` into `tests/_bootstrap.php`.

We recommend including a call to `test::clean()` from your `CodeHelper` class:



``` php