https://github.com/silinternational/yii2-codeception

Patches to implement nice features of yii2-codeception since it was abandoned
https://github.com/silinternational/yii2-codeception

Last synced: about 1 month ago
JSON representation

Patches to implement nice features of yii2-codeception since it was abandoned

• Host: GitHub
• URL: https://github.com/silinternational/yii2-codeception
• Owner: silinternational
• License: mit
• Created: 2017-01-03T20:18:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-02T17:44:55.000Z (over 2 years ago)
• Last Synced: 2024-11-08T13:45:07.778Z (about 1 month ago)
• Language: PHP
• Size: 14.6 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# yii2-codeception

Patches to implement nice features of yii2-codeception since it was abandoned

# What / Why

We've been developing with Yii2 for a couple years now and have several projects using the 

[yiisoft/yii2-codeception](https://github.com/yiisoft/yii2-codeception) library for unit tests.  

This library has been deprecated in favor of using a 

[Codeception module](https://github.com/Codeception/Codeception/blob/2.2/docs/modules/Yii2.md).

Unfortunately this module requires quite a bit of refactoring to run tests in a simlar way as `yii2-codeception` allowed.

After a few hours of tracing and debugging we figured out that two main things had changed that we depended on and so 

we decided to create a standalone repo to bring in the needed features.

## Loading fixtures into database

The first thing we found was that after reconfiguring Codeception to use the Yii2 module, to look like:

```yaml

# Codeception Test Suite Configuration

# suite for unit (internal) tests.

class_name: UnitTester

modules:

    enabled:

      - Asserts

      - UnitHelper

      - Yii2:

          configFile: 'tests/codeception/config/unit.php'

          cleanup: true

```

Running tests it was unable to load the fixtures due to foreign key constraints. We created a new base class for 

our active record classes that `beforeLoad` and `afterLoad` it will disable and enable foreign key constraints 

respectively. 

This new base class is `Sil\yii\test\ActiveFixture`. To use, simply update your fixture files to extend from it instead 

of the previous `yii\test\ActiveFixture` class. 

### Example fixtures class

```php

fixtureType('fixtureName')` to access a specific 

fixture record. After migrating to using `Codeception\TestCase\Test` as our unit test base class instead of 

`yii\codeception\DbTestCase` we got fatal errors about the method `fixtureType` does not exist on the object. When 

using the Yii2 Codeception module you access fixtures by calling 

`$this->tester->grabFixture('fixtureType', 'fixtureName')`. So to work around this we created a new base class for our 

tests that implements the `__call()` magic method to take the method name and argument and pass them to the new 

`$this->tester->grabFixture()` method. You can use this by updating your unit tests to extend 

`Sil\Codeception\TestCase\Test` instead of `Codeception\TestCase\Test`.

### Example test case file

```php

 UserFixture::className(),

        ];

    }

    

    public function testGetUser1()

    {

        $user1 = $this->users('user1');

        $this->assertEquals(1, $user1->id);

    }

}

```