WebinoDev\Test\Selenium\WebTrait

Complexity

Total Complexity

14

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	getWebTitle()	0	4	1
A	getWebSource()	0	4	1
A	getServerUrl()	0	5	1
A	getSessionId()	0	4	1
A	is404()	0	6	2
A	assertWebContains()	0	5	1
A	assertWebNotContains()	0	5	1
A	assertWebNotError()	0	15	1
A	assertNotError()	0	5	1
A	open()	0	7	1
A	openOk()	0	4	1
A	source()	0	6	2

<?php
/**
 * Webino (http://webino.sk/)
 *
 * @link        https://github.com/webino/WebinoDev/ for the canonical source repository
 * @copyright   Copyright (c) 2018 Webino, s. r. o. (http://webino.sk/)
 * @license     BSD-3-Clause
 */

namespace WebinoDev\Test\Selenium;

/**
 * Trait SourceTrait
 *
 * @property-read object $session
 *
 * @method assertContains($haystack, $needle)
 * @method assertNotContains($haystack, $needle)
 */
trait WebTrait
{
    /**
     * Return web title
     *
     * @return string
     */
    public function getWebTitle()
    {
        return (string) $this->session->title();
    }

    /**
     * Return web source
     *
     * @return string
     */
    public function getWebSource()
    {
        return (string) $this->session->source();
    }

    /**
     * @return string
     */
    protected function getServerUrl()
    {
        $parts = parse_url($this->session->url());
        return $parts['scheme'] . '://' . $parts['host'];
    }

    /**
     * @return string
     */
    protected function getSessionId()
    {
        return $this->session->getCookie('PHPSESSID')['value'];
    }

    /**
     * @return bool
     */
    public function is404()
    {
        $url = $this->session->url();
        $headers = get_headers($url);
        return empty($headers[0]) ? true : ('HTTP/1.0 404 Not Found' === $headers[0]);
    }

    /**
     * Assert that page source contains given string
     *
     * @param string $string
     * @return $this
     */
    public function assertWebContains($string)
    {
        $this->assertContains((string) $string, $this->getWebSource());
        return $this;
    }

    /**
     * Assert that page source does not contains given string
     *
     * @param string $string
     * @return $this
     */
    public function assertWebNotContains($string)
    {
        $this->assertNotContains((string) $string, $this->getWebSource());
        return $this;
    }

    /**
     * Assert that web page is without errors
     *
     * @return $this
     */
    protected function assertWebNotError()
    {
        $title = $this->getWebTitle();
        $this->assertNotContains('Error', $title);
        $this->assertNotContains('Exception', $title);

        // strip script contents & tags
        $text = substr($this->getWebSource(), 0, 10000);
        $expr = '~<(script).*?>.*?</script>~si';
        $src  = strip_tags(preg_replace($expr, '', $text));

        $this->assertNotContains('Error', $src);
        $this->assertNotContains('Exception', $src);
        return $this;
    }

    /**
     * @todo remove, deprecated
     * @deprecated use assertWebNotError() instead
     * @return $this
     */
    protected function assertNotError()
    {
        $this->assertWebNotError();
        return $this;
    }

    /**
     * Opens URI and asserts not error
     *
     * @param string $path
     * @param string|null $caption
     * @return $this
     */
    protected function open($path = '', $caption = null)
    {
        $this->session->open($this->uri . $path);

The property uri does not exist. Did you maybe forget to declare it?

        $this->debugNotify($caption);

It seems like debugNotify() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->assertWebNotError();
        return $this;
    }

    /**
     * @param string $path
     * @param string $caption
     * @return $this
     * @deprecated use open()
     * @todo remove
     */
    protected function openOk($path = '', $caption = 'Home')
    {
        return $this->open($path, $caption);
    }

    /**
     * Get raw source from URL
     *
     * @param string $url
     * @param null $sessId
     * @return string
     */
    protected function source($url, $sessId = null)
    {
        $sid = $sessId ? $sessId : $this->getSessionId();
        $opts = ['http' => ['header' => 'Cookie: PHPSESSID=' . $sid ."\r\n"]];
        return file_get_contents($url, false, stream_context_create($opts));
    }
}