SwaggerUiPage.php

Go to the documentation of this file.

<?php
namespace Magento\Swagger\Test\Page;

use Magento\Mtf\Client\Locator;
use Magento\Mtf\Client\BrowserInterface;

class SwaggerUiPage
{
    const MCA = 'swagger/';

    protected $url;

    protected $browser;

    protected $titleSelector = '.title';

    public function __construct(BrowserInterface $browser)
    {
        $this->browser = $browser;
        $this->url = $_ENV['app_frontend_url'] . self::MCA;
    }

    public function open()
    {
        $this->openSwaggerUrl();
        $this->waitForPageToLoad();
    }

    public function close()
    {
        $this->browser->closeWindow();
    }

    public function isElementVisible($selector, $strategy = Locator::SELECTOR_CSS)
    {
        return $this->browser->find($selector, $strategy)->isVisible();
    }

    public function expandServiceContent($serviceName)
    {
        $serviceSelector = '#operations-tag-%s';
        $endpointSelector = '//H4[@id=\'operations-tag-%s\']/following-sibling::DIV';
        $serviceSelector = sprintf($serviceSelector, $serviceName);
        $endpointSelector = sprintf($endpointSelector, $serviceName);
        if (!$this->isElementVisible($endpointSelector, Locator::SELECTOR_XPATH)) {
            $this->browser->find($serviceSelector, Locator::SELECTOR_CSS)->click();
        }
    }

    public function closeServiceContent($serviceName)
    {
        $serviceSelector = '#operations-tag-%s';
        $serviceSelector = sprintf($serviceSelector, $serviceName);
        $this->browser->find($serviceSelector, Locator::SELECTOR_CSS)->click();
    }

    public function expandEndpointContent($serviceName, $endpoint)
    {
        $this->expandServiceContent($serviceName);
        $endpointRefSelector = '#operations-%s-%s%s > div';
        $endpointRefSelector = sprintf($endpointRefSelector, $serviceName, $serviceName, $endpoint);
        $this->browser->find($endpointRefSelector, Locator::SELECTOR_CSS)->click();
    }

    public function closeEndpointContent($serviceName, $endpoint)
    {
        $this->expandServiceContent($serviceName);

        $endpointRefSelector = '#operations-%s-%s%s > div';

        $endpointRefSelector = sprintf($endpointRefSelector, $serviceName, $serviceName, $endpoint);
        $this->browser->find($endpointRefSelector, Locator::SELECTOR_CSS)->click();
    }

    private function waitForPageToLoad()
    {
        $this->waitForElementVisible($this->titleSelector);
    }

    private function waitForElementVisible($selector, $strategy = Locator::SELECTOR_CSS)
    {
        $browser = $this->browser;
        return $browser->waitUntil(
            function () use ($browser, $selector, $strategy) {
                $element = $browser->find($selector, $strategy);
                return $element->isVisible() ? true : null;
            }
        );
    }

    private function openSwaggerUrl()
    {
        $browser = $this->browser;
        $pattern = self::MCA;
        return $browser->waitUntil(
            function () use ($browser, $pattern) {
                try {
                    $url = $_ENV['app_frontend_url'] . $pattern;
                    $browser->open($url);
                    return true;
                } catch (\PHPUnit_Extensions_Selenium2TestCase_WebDriverException $e) {
                    return false;
                }
            }
        );
    }
}