App\TestCase

Complexity

Total Complexity

24

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	5	3
B	input()	0	35	8
A	assert()	0	11	3
A	__construct()	0	17	1
A	source()	0	3	1
B	run()	0	45	7
A	fail()	0	6	1

<?php
/*
 * This file is part of RSTS
 *
 * (c) Johnny Mast <mastjohnny@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App;

use Axiom\Rivescript\Rivescript;
use AssertionError;

/**
 * TestCase trait
 *
 * The TestCase class will test a single file
 * with tests.
 *
 * PHP version 7.4 and higher.
 *
 * @category Core
 * @package  Tests
 * @author   Johnny Mast <mastjohnny@gmail.com>
 * @license  https://opensource.org/licenses/MIT MIT
 * @link     https://github.com/axiom-labs/rivescript-php
 * @since    0.1.0
 */
class TestCase
{

    /**
     * @var string
     */
    protected string $file;

    /**
     * @var string
     */
    protected string $name;

    /**
     * Instance of the rivescript interpreter.
     *
     * @var \Axiom\Rivescript\Rivescript
     */
    protected Rivescript $rs;

    /**
     * The test client id.
     *
     * @var string
     */
    protected string $client_id = "test-user";

    /**
     * Stores the cases for this test.
     *
     * @var mixed
     */
    private array $cases;

    /**
     * TestCase constructor.
     *
     * @param string $file  The test file to load.
     * @param string $name  The name of the test.
     * @param array  $cases The testcases to run.
     */
    public function __construct(string $file, string $name, array $cases)
    {
        $this->rs = new Rivescript();
        $this->rs->setClientId($this->client_id);

        $this->rs->onSay = function ($msg) {

The parameter $msg is not used and could be removed.

            //   echo "{$msg}\n";
        };


        $this->rs->onWarn = function ($msg) {

The parameter $msg is not used and could be removed.

            //    echo "{$msg}\n";
        };
        $this->file = $file;
        $this->name = ucfirst(str_replace("_", " ", $name));

        $this->cases = $cases['tests'];
    }

    /**
     * @param string $source
     *
     * @return void
     */
    private function source(string $source): void
    {
        $this->rs->stream($source);
    }

    /**
     * Input tests an input string against the interpreter.
     *
     * @param array $step The input step to test.
     *
     * @return void
     */
    private function input(array $step): void
    {

        $reply = $this->rs->reply($step['input'], $this->client_id);

        if (!isset($step['reply'])) {
            return;
        }

        $expected = $step['reply'];

        if (is_string($expected) === true) {
            $expected = rtrim($expected, "\n");
            if (strtolower($reply) !== strtolower($expected)) {
                throw new AssertionError(
                    "Got unexpected exception from reply() for input: {$step['input']}\n\n" .
                    " Expected: {$expected}\n" .
                    " Got: {$reply}"
                );
            }
        } elseif (is_array($expected) === true) {
            $correct = 0;
            foreach ($expected as $item) {
                $item = rtrim($item, "\n");
                if (strtolower($reply) === strtolower($item)) {
                    $correct++;
                }
            }

            if ($correct === 0) {
                $expected = implode(' or ', $expected);
                throw new AssertionError(
                    "Got unexpected exception from reply() for input: {$step['input']}\n\n" .
                    " Expected: {$expected}\n" .
                    " Got: {$reply}"
                );
            }
        }
    }

    /**
     * Ser a user variable.
     *
     * @param array $vars The variables to set.
     *
     * @return void
     */
    public function set(array $vars): void
    {
        if (count($vars) > 0) {
            foreach ($vars as $key => $value) {
                $this->rs->set_uservar($key, $value);
            }
        }
    }

    /**
     * Assert the value of a user variable.
     *
     * @param array $vars The variables to test.
     *
     * @return void
     */
    private function assert(array $vars): void
    {
        foreach ($vars as $key => $value) {
            $expected = $value;
            $actual = $this->rs->get_uservar($key);

            if ($actual != $value) {
                throw new AssertionError(
                    "Failed to assert that the value of user variable: {$key}\n\n" .
                    " Expected: {$expected}\n" .
                    " Got: {$actual}"
                );
            }
        }
    }

    /**
     * @return array
     */
    public function run(): array
    {
        $stats = [
            'success' => 0,
            'failed' => 0,
            'asserts' => 0,
        ];

        try {

            foreach ($this->cases as $step) {
                $key = key($step);

                switch ($key) {
                    case "assert":
                        $this->assert($step[$key]);
                        $stats['asserts']++;
                        break;
                    case "source":
                        $this->source($step[$key]);
                        break;

                    case "input":
                        $this->input($step);
                        $stats['success']++;
                        break;

                    case "set":
                        $this->set($step[$key]);
                        break;

                    default:
                        throw new AssertionError("Unsupported test step called \"{$key}\"");
                }
            }

            $sym = "✓";
            $name = ucfirst(str_replace("_", " ", $this->name));
            echo " {$sym} {$name}\n";
        } catch (AssertionError $e) {
            $stats['failed']++;
            $this->fail($e);
        }

        return $stats;
    }

    /**
     * Show a failure message.
     *
     * @param \AssertionError $e
     *
     * @return void
     */
    private function fail(AssertionError $e): void
    {
        $banner = "x {$this->name}";
        $banner .= "\n " . str_repeat("=", strlen($banner)) . "\n";

        echo " {$banner} {$e->getMessage()} \n\n";
    }
}