AssertProductCustomOptionsOnProductPage.php

Go to the documentation of this file.

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

use Magento\Catalog\Test\Page\Product\CatalogProductView;
use Magento\Mtf\Client\BrowserInterface;
use Magento\Mtf\Constraint\AbstractAssertForm;
use Magento\Mtf\Fixture\FixtureInterface;

class AssertProductCustomOptionsOnProductPage extends AbstractAssertForm
{
    protected $skippedFieldOptions = [
        'Text/Field' => [
            'price_type',
            'sku',
        ],
        'Text/Area' => [
            'price_type',
            'sku',
        ],
        'Select/Drop-down' => [
            'price_type',
            'sku',
        ],
        'File/File' => [
            'price_type',
            'sku',
        ],
        'Select/Radio Buttons' => [
            'price_type',
            'sku',
        ],
        'Select/Checkbox' => [
            'price_type',
            'sku',
        ],
        'Select/Multiple Select' => [
            'price_type',
            'sku',
        ],
        'Date/Date' => [
            'price_type',
            'sku',
        ],
        'Date/Date & Time' => [
            'price_type',
            'sku',
        ],
        'Date/Time' => [
            'price_type',
            'sku',
        ],
    ];

    protected $isPrice = true;

    public function processAssert(
        CatalogProductView $catalogProductView,
        FixtureInterface $product,
        BrowserInterface $browser
    ) {
        $browser->open($_ENV['app_frontend_url'] . $product->getUrlKey() . '.html');
        $actualPrice = null;
        if ($this->isPrice) {
            $priceBlock = $catalogProductView->getViewBlock()->getPriceBlock();
            $specialPrice = $priceBlock->getSpecialPrice();
            $price = $priceBlock->getPrice();
            $actualPrice = $specialPrice ? $specialPrice : $price;
        }
        $fixtureCustomOptions = $this->prepareOptions($product, $actualPrice);
        $formCustomOptions = $catalogProductView->getViewBlock()->getOptions($product)['custom_options'];
        $error = $this->verifyData($fixtureCustomOptions, $formCustomOptions);
        \PHPUnit\Framework\Assert::assertEmpty($error, $error);
    }

    protected function prepareOptions(FixtureInterface $product, $actualPrice = null)
    {
        $result = [];
        $customOptions = $product->hasData('custom_options')
            ? $product->getDataFieldConfig('custom_options')['source']->getCustomOptions()
            : [];
        $actualPrice = $actualPrice ?: $product->getPrice();
        foreach ($customOptions as $customOption) {
            $result = $this->prepareEachCustomOption($actualPrice, $customOption, $result);
        }
        return $result;
    }

    protected function verifyData(array $fixtureData, array $formData, $isStrict = false, $isPrepareError = true)
    {
        $errors = [];
        foreach ($fixtureData as $key => $value) {
            if (in_array($key, $this->skippedFields, true)) {
                continue;
            }
            $formValue = isset($formData[$key]) ? $formData[$key] : null;
            $errors = $this->verifyDataForErrors($formValue, $key, $errors, $value);
        }
        return $this->prepareErrorsForOutput($fixtureData, $formData, $isStrict, $isPrepareError, $errors);
    }

    private function checkNotEqualValuesErrors($value, $formValue, $key)
    {
        if ((int)$value === (int)$formValue + 1) {
            return '';
        }
        if (is_array($value)) {
            $value = $this->arrayToString($value);
        }
        if (is_array($formValue)) {
            $formValue = $this->arrayToString($formValue);
        }
        return sprintf('- %s: "%s" instead of "%s"', $key, $formValue, $value);
    }

    private function prepareErrorsForOutput(array $fixtureData, array $formData, $isStrict, $isPrepareError, $errors)
    {
        if ($isStrict) {
            $diffData = array_diff(array_keys($formData), array_keys($fixtureData));
            if ($diffData) {
                $errors[] = '- fields ' . implode(', ', $diffData) . ' is absent in fixture';
            }
        }
        if ($isPrepareError) {
            return $this->prepareErrors($errors);
        }
        return $errors;
    }

    private function verifyDataForErrors($formValue, $key, $errors, $value)
    {
        if (is_numeric($formValue)) {
            $formValue = (float)$formValue;
        }
        if (null === $formValue) {
            $errors[] = '- field "' . $key . '" is absent in form';
        } elseif (is_array($value) && is_array($formValue)) {
            $valueErrors = $this->verifyData($value, $formValue, true, false);
            if (!empty($valueErrors)) {
                $errors[$key] = $valueErrors;
            }
        } elseif ($value != $formValue) {
            $notEqualValuesErrors = $this->checkNotEqualValuesErrors($value, $formValue, $key);
            if ($notEqualValuesErrors) {
                $errors[] = $notEqualValuesErrors;
            }
        }
        return $errors;
    }

    private function prepareEachCustomOption($actualPrice, $customOption, $result)
    {
        $skippedField = isset($this->skippedFieldOptions[$customOption['type']])
            ? $this->skippedFieldOptions[$customOption['type']]
            : [];
        foreach ($customOption['options'] as &$option) {
            // recalculate percent price
            if ('Percent' == $option['price_type']) {
                $option['price'] = ($actualPrice * $option['price']) / 100;
                $option['price'] = round($option['price'], 2);
            }

            $option = array_diff_key($option, array_flip($skippedField));
        }
        $result[$customOption['title']] = $customOption;
        return $result;
    }

    public function toString()
    {
        return 'Value of custom option on the page is correct.';
    }
}