Skip to content

Integration test data fixture change proposal #373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Integration test data fixture change proposal #373

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c702b96
Proposal for reusable and customizable data fixtures
bubasuma Apr 23, 2020
81d9d5e
Proposal for reusable and customizable data fixtures
bubasuma Apr 27, 2020
ab892ec
Replace comma with space for consistency with other fixture annotations
bubasuma Apr 27, 2020
4371ad8
Correct typo
bubasuma Apr 27, 2020
c16ef3d
Replace the json format with a new format that allows resolving depen…
bubasuma May 21, 2020
d7a7ee7
Fix grammar
bubasuma Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace the json format with a new format that allows resolving depen… 
…dencies
  • Loading branch information
@bubasuma
bubasuma committed Jun 1, 2020
commit c16ef3d3e11f1adc8760aa3c45715e2ea02a8502
214 changes: 174 additions & 40 deletions design-documents/testing/integration/data-fixtures.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Problem
When it comes to write a data fixture for your test case, the first thing you would do is to search for existing data fixture you can reuse in your test case. Most of the time you will find such data fixture that almost meets the requirements of your test case except that it's missing something very important to your test case.
Therefore you end up writing a new data fixture for your test case that is 99% a copy of existing one.
Therefore, you end up writing a new data fixture for your test case that is 99% a copy of existing one.
Here is a real example:

- dev/tests/integration/testsuite/Magento/Catalog/_files/product_virtual.php
Expand All @@ -16,59 +16,100 @@ So if you need a virtual product with available quantity 1, you will probably ha

## Solution

We could certainly redesign data fixtures to be object oriented. But if we just want to tackle this issue as simpler as we can, we could extend the format of data fixture annotation
to support a second parameter which will be injected to the data fixture file as following.
Extend the format of data fixture annotation as following:

```php
/**
* @magentoDataFixture Magento/Catalog/_files/product_virtual.php {"productData":{"stock_data": {"qty":1}}}
*/
class QuoteTest extends \PHPUnit\Framework\TestCase
{
/**
* @magentoDataFixture Magento/Catalog/_files/product_virtual.php as virtualProduct
* @magentoDataFixture Magento/Customer/_files/customer.php as customer
* @magentoDataFixture Magento/Customer/_files/customer_address.php as customerAddress require customer
* @magentoDataFixture Magento/Checkout/_files/quote.php as quote require customer, virtualProduct
*/
public function testCollectTotals(): void
{
}

public function collectTotalsDataFixture(): array
{
return [
'virtualProduct' => [
'special_price' => 15
],
'customerAddress' => [
'telephone' => '+15129000201',
'@customer' => 'customer',
],
'quote' => [
'is_multi_shipping' => 1,
'@customer' => 'customer',
'@products[]' => [
'virtualProduct' => [
'qty' => 2
]
],
],
];
}
}
```
The string following the fixture file name is indeed the data that needs to be injected into the fixture file for customization. The format is well known JSON format that gives a flexible way to pass any type of data to the fixture (string, int, float and array).
With the `as` and `require` keywords, we'll be able to inject data and resolve dependencies between fixtures.
The `as` keyword is used for aliasing a fixture and the `require` keyword is used to declare fixtures dependencies on each other using fixtures aliases.

The method `collectTotalsDataFixture` deducted from the test name with suffix `DataFixture` is the data provider for all fixtures defined for test case. Test class fixture data provider method would be `dataFixture`. The data fixture provider should return an associative array with fixtures aliases as key and data to overwrite the corresponding fixture data.
The data fixture provider uses `@` before attribute name to resolve dependencies. The `@` prefixed attribute value must be an associative array which keys are dependent fixtures aliases and values are an array containing the relationship data.

In the example above, `Magento/Catalog/_files/product_virtual.php`, `Magento/Customer/_files/customer.php`, `Magento/Customer/_files/customer_address.php` and `Magento/Checkout/_files/quote.php` are respectively aliased as _virtualProduct_, _customer_, _customerAddress_ and _quote_.
`Magento/Customer/_files/customer_address.php` requires _customer_ (`Magento/Customer/_files/customer.php`) and `Magento/Checkout/_files/quote.php` requires _virtualProduct_ (`Magento/Catalog/_files/product_virtual.php`) and _customer_ (`Magento/Customer/_files/customer.php`) fixtures.
The data fixture provider overwrites the fixtures _virtualProduct_, _customerAddress_ and _quote_ data as well as resolves fixtures dependencies using the `@` keyword.

```php
use Magento\TestFramework\Catalog\Model\ProductFixtureFactory;
#Magento/Catalog/_files/product_virtual.php
use Magento\Catalog\Fixtures\ProductFixture;
use Magento\TestFramework\Helper\Bootstrap;

$objectManager = Bootstrap::getObjectManager();
$productFactory = $objectManager->get(ProductFixtureFactory::class);
$product = $productFactory->create($productData ?? []);
$productFixture = $objectManager->get(ProductFixture::class);
$product = $productFixture->create($data ?? []);
return $product;
```

```php
namespace Magento\TestFramework;
#Magento/Customer/_files/customer.php
use Magento\Customer\Fixtures\CustomerFixture;
use Magento\TestFramework\Helper\Bootstrap;

use Magento\Framework\DataObject;
$objectManager = Bootstrap::getObjectManager();
$customerFixture = $objectManager->get(CustomerFixture::class);
$customer = $customerFixture->create($data ?? []);
return $customer;
```

class DataObjectHydrator
{
/**
* @param DataObject $object
* @param array $data
* @return DataObject
*/
public function hydrate(DataObject $object, array $data): DataObject
{
foreach ($data as $key => $value) {
$camelCaseProperty = str_replace('_', '', ucwords($key, '_'));
$setterName = 'set' . $camelCaseProperty;
$boolSetterName = 'setIs' . $camelCaseProperty;
if (method_exists($object, $setterName)) {
$object->$setterName($value);
unset($data[$key]);
} elseif (method_exists($object, $boolSetterName)) {
$object->$boolSetterName($value);
unset($data[$key]);
}
}
$object->addData($data);
return $object;
}
}
```php
#Magento/Customer/_files/customer_address.php
use Magento\Customer\Fixtures\CustomerAddressFixture;
use Magento\TestFramework\Helper\Bootstrap;

$objectManager = Bootstrap::getObjectManager();
$customerAddressFixture = $objectManager->get(CustomerAddressFixture::class);
$customerAddress = $customerAddressFixture->create(['customer' => $customer, 'data' => $data ?? []]);
return $customerAddress;
```

```php
namespace Magento\TestFramework\Catalog\Model;
#Magento/Checkout/_files/quote.php
use Magento\Checkout\Fixtures\QuoteFixture;
use Magento\TestFramework\Helper\Bootstrap;

$objectManager = Bootstrap::getObjectManager();
$quoteFixture = $objectManager->get(QuoteFixture::class);
$quote = $quoteFixture->create(['customer' => $customer, 'products' => $products, 'data' => $data ?? []]);
return $quote;
```

```php
namespace Magento\Catalog\Fixtures;

use Magento\Catalog\Api\Data\ProductInterface;
use Magento\Catalog\Api\Data\ProductInterfaceFactory;
Expand All @@ -77,8 +118,9 @@ use Magento\Catalog\Model\Product\Attribute\Source\Status;
use Magento\Catalog\Model\Product\Type;
use Magento\Catalog\Model\Product\Visibility;
use Magento\TestFramework\DataObjectHydrator;
use Magento\TestFramework\FixtureInterface;

class ProductFixtureFactory
class ProductFixture implements FixtureInterface
{
/**
* @var ProductInterfaceFactory
Expand Down Expand Up @@ -112,7 +154,7 @@ class ProductFixtureFactory
* @param array $data
* @return ProductInterface
*/
public function create(array $data): ProductInterface
public function create(array $data)
{
$product = $this->factory->create();
$product = $this->dataObjectHydrator->hydrate($product, array_merge($this->defaultData(), $data));
Expand Down Expand Up @@ -145,6 +187,98 @@ class ProductFixtureFactory
}
}
```
With the examples above, one can notice that there is absolutely no need for fixtures file anymore. Instead, we can simply use the fixture class in the data fixture annotation as following:

```php
class QuoteTest extends \PHPUnit\Framework\TestCase
{
/**
* @magentoDataFixture \Magento\Catalog\Fixtures\ProductFixture as virtualProduct
* @magentoDataFixture \Magento\Customer\Fixtures\CustomerFixture as customer
* @magentoDataFixture \Magento\Customer\Fixtures\CustomerAddressFixture as customerAddress require customer
* @magentoDataFixture \Magento\Checkout\Fixtures\QuoteFixture as quote require customer, virtualProduct
*/
public function testCollectTotals(): void
{
}

public function collectTotalsDataFixture(): array
{
return [];
}
}
```
You can create as many instances of a fixture as you wish for your test case:

```php
class ProductsList extends \PHPUnit\Framework\TestCase
{
/**
* @magentoDataFixture \Magento\Catalog\Fixtures\ProductFixture as product1
* @magentoDataFixture \Magento\Catalog\Fixtures\ProductFixture as product2
* @magentoDataFixture \Magento\Catalog\Fixtures\ProductFixture as product3
*/
public function testGetProductsCount(): void
{
}

public function getProductsCountDataFixture(): array
{
return [
'product1' => [
'sku' => 'simple1'
],
'product2' => [
'sku' => 'simple2'
],
'product3' => [
'sku' => 'simple3',
'status' => Status::STATUS_DISABLED,
],
];
}
}
```

**Integration test extensibility**

```xml
<test class="Magento\Quote\Model\Quote">
<method name="testCollectTotals">
<!-- Add new fixture -->
<magentoDataFixture path="Magento/Catalog/_files/product_simple.php" before="Magento/Checkout/_files/quote.php" as="simpleProduct"/>
<fixtureDataProvider>
<fixtures>
<fixture name="virtualProduct">
<attributes>
<!-- Overwrite attribute -->
<attribute name="special_price" xsi:type="number">15.0</attribute>
<!-- Add new attribute -->
<attribute name="stock_data" xsi:type="array">
<attribute name="qty">1</attribute>
</attribute>
</attributes>
</fixture>
<fixture name="quote">
<attributes>
<attribute name="@products[]" xsi:type="array">
<!-- Overwrite dependency -->
<attribute name="virtualProduct" xsi:type="array">
<attribute name="qty">1</attribute>
</attribute>
<!-- Add new dependency -->
<attribute name="simpleProduct" xsi:type="array">
<attribute name="qty">2</attribute>
</attribute>
</attribute>
</attributes>
</fixture>
</fixtures>
</fixtureDataProvider>
</method>
</test>
```


**Pros**
- Reduces duplicate codes in data fixtures files
Expand Down