AssertIntegrationForm.php

Go to the documentation of this file.

<?php
namespace Magento\Integration\Test\Constraint;

use Magento\Integration\Test\Fixture\Integration;
use Magento\Integration\Test\Page\Adminhtml\IntegrationIndex;
use Magento\Integration\Test\Page\Adminhtml\IntegrationNew;
use Magento\Mtf\Constraint\AbstractAssertForm;

class AssertIntegrationForm extends AbstractAssertForm
{
    protected $skippedFields = [
        'integration_id',
    ];

    protected $errorMessagePattern = "Data in '%s' field not equal.\nExpected: %s\nActual: %s";

    protected $strictResourcesVerify;

    public function processAssert(
        IntegrationIndex $integrationIndexPage,
        IntegrationNew $integrationNewPage,
        Integration $integration,
        Integration $initialIntegration = null,
        $strictResourcesVerify = false
    ) {
        $this->strictResourcesVerify = $strictResourcesVerify;
        $data = ($initialIntegration === null)
            ? $integration->getData()
            : array_merge($initialIntegration->getData(), $integration->getData());
        $filter = [
            'name' => $data['name'],
        ];

        $integrationIndexPage->open();
        $integrationIndexPage->getIntegrationGrid()->searchAndOpen($filter);
        $formData = $integrationNewPage->getIntegrationForm()->getData();
        unset($formData['current_password']);
        unset($data['current_password']);
        $dataDiff = $this->verifyForm($formData, $data);
        \PHPUnit\Framework\Assert::assertEmpty(
            $dataDiff,
            'Integration form was filled incorrectly.'
            . "\nLog:\n" . implode(";\n", $dataDiff)
        );
    }

    protected function verifyForm(array $formData, array $fixtureData)
    {
        $errorMessages = [];
        foreach ($fixtureData as $key => $value) {
            if (in_array($key, $this->skippedFields)) {
                continue;
            } elseif ($key === 'resources') {
                $errorMessages = array_merge(
                    $errorMessages,
                    $this->checkResources($formData[$key], $fixtureData[$key])
                );
            } elseif ($value !== $formData[$key]) {
                $errorMessages[] = $this->getErrorMessage($value, $formData[$key], $key);
            }
        }

        return $errorMessages;
    }

    protected function checkResources(array $formData, $fixtureData)
    {
        $errorMessages = [];
        $diff = $this->getResourcesDifferentData($formData, $fixtureData);
        if (array_filter($diff)) {
            $errorMessages[] = $this->getErrorMessage($fixtureData, $formData, 'resources');
        }

        return $errorMessages;
    }

    protected function getResourcesDifferentData(array $formData, $fixtureData)
    {
        $fixtureData = is_array($fixtureData) ? $fixtureData : [$fixtureData];
        return $this->strictResourcesVerify
            ? array_diff($formData, $fixtureData)
            : $this->notStrictVerification($formData, $fixtureData);
    }

    protected function notStrictVerification(array $formData, array $fixtureData)
    {
        $diff = [];
        foreach ($fixtureData as $itemData) {
            $diff[] = in_array($itemData, $formData) ? null : true;
        }

        return $diff;
    }

    protected function getErrorMessage($fixtureData, $formData, $field)
    {
        $fixtureData = is_array($fixtureData) ? $this->arrayToString($fixtureData) : $fixtureData;
        $formData = is_array($formData) ? $this->arrayToString($formData) : $formData;
        return sprintf($this->errorMessagePattern, $field, $fixtureData, $formData);
    }

    public function toString()
    {
        return 'Integration form was filled correctly.';
    }
}