, (*1)
Auto-magic tests for caldera-interop Interoperable Servies, (*2)
Why?
- Every interoperable set MUST transform between array/entitiy/model/collection/HTTP message/ etc. consistently.
- We can only trust that claim if we test a reasonable approximation of all of the possible combination of values for an entity's properties.
- Writing all those tests takes to long.
Install
composer require calderawp/caldera-interop-fixture --dev, (*3)
Requires
Status
BETA, (*4)
Usage
This testing component is designed to be used with interoperable sets that are provided to the container using a InteropProvider. This component is comprised of two parts., (*5)
Fixture and Prop Description
The InteropFixture class takes an array-like set of data PropData that describes the properties and possible values of an entity. The PropData is the least auto-magic part of this process., (*6)
PropData
For each property, we provide that property's name and an array of values. For example, to add a xpLevel prop:, (*7)
```php, (*8)
$propData = new PropData();
$propData->testProps = [
'xpLevel' => [
'values' => []
]
];, (*9)
The `values` index collects arrays that provides an input value and an expected output value. For example, to test that the absolute value of our property is always returned:
```php
[
'value' => -10,
'expect' => 10
],
Completer example:, (*10)
```php, (*11)
$propData = new PropData();
$propData->testProps = [
'xpLevel' => [
'values' => [
[
'value' => -10,
'expect' => 10
],
[
'value' => 10,
'expect' => 10
],
]
],
'otherLevel' => [
'values' => [
[
'value' => 10,
'expect' => 10
],
[
'value' => 10,
'expect' => 10
],
]
]
];, (*12)
#### `InteropFixture`
```php
use calderawp\InteropFixture\Entities\PropData;
use calderawp\InteropFixture\InteropFixture;
$fixture = new InteropFixture($propData);
Using In Tests
use calderawp\HelloExtension\HelloInteropService;
use calderawp\interop\CalderaForms;
use calderawp\interop\Interfaces\CalderaFormsApp;
use calderawp\InteropFixture\Entities\PropData;
/**
* Class HelloInteropTest
*
* Test the example Hello interop binding
*/
class MyInteropTest extends UnitTestCase
{
//Make fixture tests available
use TestsInterops;
public function testInterop()
{
//This provides 64 assertions for a set with two properties :)
$this->checkFixture(
new InteropFixture(PropData::fromArray([
//array like examples above
])),
//The interoperable service provider for this set
new SomeService(),
//main app
CalderaForms::factory()
);
}
}
Complete Example
See Tests/example for an example interoperable set that is tested in by the test in tests/Unit/HelloInteropTest. This example has two properites. Both with custom validation logic. 64 assertions are generated for this set., (*13)
Development
Install
Requires git and Composer, (*14)
git clone git@github.com:calderawp/caldera-interop-fixture.gitcd caldera-interop-fixturecomposer install
Coding Standard: Caldera (psr2 with tabs). Enforces using phpcs., (*15)
Testing
Tests are divided between unit tests and currently no other types of tests., (*16)
Install
All testing dependencies are installed with composer., (*17)
Use
Run these commands from the plugin's root directory., (*18)
- Run All Tests and Code Formatting
composer tests- Includes lints, unit tests and fixes documented below
- Run Unit Tests
composer unit-tests- Unit tests are located in
/Tests/Unit
- Fix All Code Formatting
composer formatting- Runs code sniffs and code fixes and lints.
Stuff.
Copyright 2018 CalderaWP LLC. License: GPL v2 or later., (*19)
Wallogit.com
