Arsse/tests/lib/AbstractTest.php

<?php
/** @license MIT
 * Copyright 2017 J. King, Dustin Wilson et al.
 * See LICENSE and AUTHORS files for details */

declare(strict_types=1);
namespace JKingWeb\Arsse\Test;

use Eloquent\Phony\Mock\Handle\InstanceHandle;
use Eloquent\Phony\Phpunit\Phony;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Exception\RequestException;
use JKingWeb\Arsse\Exception;
use JKingWeb\Arsse\Arsse;
use JKingWeb\Arsse\Conf;
use JKingWeb\Arsse\Db\Driver;
use JKingWeb\Arsse\Db\Result;
use JKingWeb\Arsse\Factory;
use JKingWeb\Arsse\Misc\Date;
use JKingWeb\Arsse\Misc\ValueInfo;
use JKingWeb\Arsse\Misc\URL;
use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;
use Laminas\Diactoros\ServerRequest;
use Laminas\Diactoros\Response\JsonResponse;
use Laminas\Diactoros\Response\XmlResponse;

/** @coversNothing */
abstract class AbstractTest extends \PHPUnit\Framework\TestCase {
    use \DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;

    protected const COL_DEFS = [
        'arsse_meta' => [
            'key'   => "str",
            'value' => "str",
        ],
        'arsse_users' => [
            'id'       => "str",
            'password' => "str",
            'num'      => "int",
            'admin'    => "bool",
        ],
        'arsse_user_meta' => [
            'owner'    => "str",
            'key'      => "str",
            'modified' => "datetime",
            'value'    => "str",
        ],
        'arsse_sessions' => [
            'id'      => "str",
            'created' => "datetime",
            'expires' => "datetime",
            'user'    => "str",
        ],
        'arsse_tokens' => [
            'id'      => "str",
            'class'   => "str",
            'user'    => "str",
            'created' => "datetime",
            'expires' => "datetime",
            'data'    => "str",
        ],
        'arsse_feeds' => [
            'id'         => "int",
            'url'        => "str",
            'title'      => "str",
            'source'     => "str",
            'updated'    => "datetime",
            'modified'   => "datetime",
            'next_fetch' => "datetime",
            'orphaned'   => "datetime",
            'etag'       => "str",
            'err_count'  => "int",
            'err_msg'    => "str",
            'username'   => "str",
            'password'   => "str",
            'size'       => "int",
            'icon'       => "int",
        ],
        'arsse_icons' => [
            'id'         => "int",
            'url'        => "str",
            'modified'   => "datetime",
            'etag'       => "str",
            'next_fetch' => "datetime",
            'orphaned'   => "datetime",
            'type'       => "str",
            'data'       => "blob",
        ],
        'arsse_articles' => [
            'id'                 => "int",
            'feed'               => "int",
            'url'                => "str",
            'title'              => "str",
            'author'             => "str",
            'published'          => "datetime",
            'edited'             => "datetime",
            'modified'           => "datetime",
            'guid'               => "str",
            'url_title_hash'     => "str",
            'url_content_hash'   => "str",
            'title_content_hash' => "str",
            'content_scraped'    => "str",
            'content'            => "str",
        ],
        'arsse_editions' => [
            'id'       => "int",
            'article'  => "int",
            'modified' => "datetime",
        ],
        'arsse_enclosures' => [
            'article' => "int",
            'url'     => "str",
            'type'    => "str",
        ],
        'arsse_categories' => [
            'article' => "int",
            'name'    => "str",
        ],
        'arsse_marks' => [
            'article'      => "int",
            'subscription' => "int",
            'read'         => "bool",
            'starred'      => "bool",
            'modified'     => "datetime",
            'note'         => "str",
            'touched'      => "bool",
            'hidden'       => "bool",
        ],
        'arsse_subscriptions' => [
            'id'         => "int",
            'owner'      => "str",
            'feed'       => "int",
            'added'      => "datetime",
            'modified'   => "datetime",
            'title'      => "str",
            'order_type' => "int",
            'pinned'     => "bool",
            'folder'     => "int",
            'keep_rule'  => "str",
            'block_rule' => "str",
            'scrape'     => "bool",
        ],
        'arsse_folders' => [
            'id'       => "int",
            'owner'    => "str",
            'parent'   => "int",
            'name'     => "str",
            'modified' => "datetime",
        ],
        'arsse_tags' => [
            'id'       => "int",
            'owner'    => "str",
            'name'     => "str",
            'modified' => "datetime",
        ],
        'arsse_tag_members' => [
            'tag'          => "int",
            'subscription' => "int",
            'assigned'     => "bool",
            'modified'     => "datetime",
        ],
        'arsse_labels' => [
            'id'       => "int",
            'owner'    => "str",
            'name'     => "str",
            'modified' => "datetime",
        ],
        'arsse_label_members' => [
            'label'        => "int",
            'article'      => "int",
            'subscription' => "int",
            'assigned'     => "bool",
            'modified'     => "datetime",
        ],
    ];

    protected $objMock;
    protected $confMock;
    protected $langMock;
    protected $dbMock;
    protected $userMock;

    public function setUp(): void {
        self::clearData();
        // create the object factory as a mock
        $this->objMock = Arsse::$obj = $this->mock(Factory::class);
        $this->objMock->get->does(function(string $class) {
            return new $class;
        });
    }

    public static function clearData(bool $loadLang = true): void {
        date_default_timezone_set("America/Toronto");
        $r = new \ReflectionClass(\JKingWeb\Arsse\Arsse::class);
        $props = array_keys($r->getStaticProperties());
        foreach ($props as $prop) {
            Arsse::$$prop = null;
        }
        if ($loadLang) {
            Arsse::$lang = new \JKingWeb\Arsse\Lang;
        }
    }

    public static function setConf(array $conf = [], bool $force = true): void {
        $defaults = [
            'dbSQLite3File'      => ":memory:",
            'dbSQLite3Timeout'   => 0,
            'dbPostgreSQLHost'   => $_ENV['ARSSE_TEST_PGSQL_HOST'] ?: "",
            'dbPostgreSQLPort'   => $_ENV['ARSSE_TEST_PGSQL_PORT'] ?: 5432,
            'dbPostgreSQLUser'   => $_ENV['ARSSE_TEST_PGSQL_USER'] ?: "arsse_test",
            'dbPostgreSQLPass'   => $_ENV['ARSSE_TEST_PGSQL_PASS'] ?: "arsse_test",
            'dbPostgreSQLDb'     => $_ENV['ARSSE_TEST_PGSQL_DB'] ?: "arsse_test",
            'dbPostgreSQLSchema' => $_ENV['ARSSE_TEST_PGSQL_SCHEMA'] ?: "arsse_test",
            'dbMySQLHost'        => $_ENV['ARSSE_TEST_MYSQL_HOST'] ?: "localhost",
            'dbMySQLPort'        => $_ENV['ARSSE_TEST_MYSQL_PORT'] ?: 3306,
            'dbMySQLUser'        => $_ENV['ARSSE_TEST_MYSQL_USER'] ?: "arsse_test",
            'dbMySQLPass'        => $_ENV['ARSSE_TEST_MYSQL_PASS'] ?: "arsse_test",
            'dbMySQLDb'          => $_ENV['ARSSE_TEST_MYSQL_DB'] ?: "arsse_test",
        ];
        Arsse::$conf = (($force ? null : Arsse::$conf) ?? (new Conf))->import($defaults)->import($conf);
    }

    protected function serverRequest(string $method, string $url, string $urlPrefix, array $headers = [], array $vars = [], $body = null, string $type = "", $params = [], string $user = null): ServerRequestInterface {
        $server = [
            'REQUEST_METHOD' => $method,
            'REQUEST_URI'    => $url,
        ];
        if (strlen($type)) {
            $server['HTTP_CONTENT_TYPE'] = $type;
        }
        if (isset($params)) {
            if (is_array($params)) {
                $params = implode("&", array_map(function($v, $k) {
                    return rawurlencode($k).(isset($v) ? "=".rawurlencode($v) : "");
                }, $params, array_keys($params)));
            }
            $url = URL::queryAppend($url, (string) $params);
            $params = null;
        }
        $q = parse_url($url, \PHP_URL_QUERY);
        if (strlen($q ?? "")) {
            parse_str($q, $params);
        } else {
            $params = [];
        }
        $parsedBody = null;
        if (isset($body)) {
            if (is_string($body) && in_array(strtolower($type), ["", "application/x-www-form-urlencoded"])) {
                parse_str($body, $parsedBody);
            } elseif (!is_string($body) && in_array(strtolower($type), ["application/json", "text/json"])) {
                $body = json_encode($body, \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE);
            } elseif (!is_string($body) && in_array(strtolower($type), ["", "application/x-www-form-urlencoded"])) {
                $parsedBody = $body;
                $body = http_build_query($body, "a", "&");
            }
        }
        $server = array_merge($server, $vars);
        $req = new ServerRequest($server, [], $url, $method, "php://memory", [], [], $params, $parsedBody);
        if (isset($user)) {
            if (strlen($user)) {
                $req = $req->withAttribute("authenticated", true)->withAttribute("authenticatedUser", $user);
            } else {
                $req = $req->withAttribute("authenticationFailed", true);
            }
        }
        if (strlen($type) && strlen($body ?? "")) {
            $req = $req->withHeader("Content-Type", $type);
        }
        foreach ($headers as $key => $value) {
            if (!is_null($value)) {
                $req = $req->withHeader($key, $value);
            } else {
                $req = $req->withoutHeader($key);
            }
        }
        $target = substr(URL::normalize($url), strlen($urlPrefix));
        $req = $req->withRequestTarget($target);
        if (strlen($body ?? "")) {
            $p = $req->getBody();
            $p->write($body);
            $req = $req->withBody($p);
        }
        return $req;
    }

    public static function assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void {
        if (method_exists(parent::class, "assertMatchesRegularExpression")) {
            parent::assertMatchesRegularExpression($pattern, $string, $message);
        } else {
            parent::assertRegExp($pattern, $string, $message);
        }
    }

    public static function assertFileDoesNotExist(string $filename, string $message = ''): void {
        if (method_exists(parent::class, "assertFileDoesNotExist")) {
            parent::assertFileDoesNotExist($filename, $message);
        } else {
            parent::assertFileNotExists($filename, $message);
        }
    }

    public function assertException($msg = "", string $prefix = "", string $type = "Exception"): void {
        if (func_num_args()) {
            if ($msg instanceof \JKingWeb\Arsse\AbstractException) {
                $this->expectException(get_class($msg));
                $this->expectExceptionCode($msg->getCode());
            } else {
                $class = \JKingWeb\Arsse\NS_BASE.($prefix !== "" ? str_replace("/", "\\", $prefix)."\\" : "").$type;
                $msgID = ($prefix !== "" ? $prefix."/" : "").$type.".$msg";
                if (array_key_exists($msgID, Exception::CODES)) {
                    $code = Exception::CODES[$msgID];
                } else {
                    $code = 0;
                }
                $this->expectException($class);
                $this->expectExceptionCode($code);
            }
        } else {
            // expecting a standard PHP exception
            $this->expectException(\Throwable::class);
        }
    }

    protected function assertMessage(MessageInterface $exp, MessageInterface $act, string $text = ''): void {
        if ($exp instanceof ResponseInterface) {
            $this->assertInstanceOf(ResponseInterface::class, $act, $text);
            $this->assertSame($exp->getStatusCode(), $act->getStatusCode(), $text);
        } elseif ($exp instanceof RequestInterface) {
            if ($exp instanceof ServerRequestInterface) {
                $this->assertInstanceOf(ServerRequestInterface::class, $act, $text);
                $this->assertEquals($exp->getAttributes(), $act->getAttributes(), $text);
            }
            $this->assertInstanceOf(RequestInterface::class, $act, $text);
            $this->assertSame($exp->getMethod(), $act->getMethod(), $text);
            $this->assertSame($exp->getRequestTarget(), $act->getRequestTarget(), $text);
        }
        if ($exp instanceof JsonResponse) {
            $this->assertInstanceOf(JsonResponse::class, $act, $text);
            $this->assertEquals($exp->getPayload(), $act->getPayload(), $text);
            $this->assertSame($exp->getPayload(), $act->getPayload(), $text);
        } elseif ($exp instanceof XmlResponse) {
            $this->assertInstanceOf(XmlResponse::class, $act, $text);
            $this->assertXmlStringEqualsXmlString((string) $exp->getBody(), (string) $act->getBody(), $text);
        } else {
            $this->assertSame((string) $exp->getBody(), (string) $act->getBody(), $text);
        }
        $this->assertEquals($exp->getHeaders(), $act->getHeaders(), $text);
    }

    public function assertTime($exp, $test, string $msg = ''): void {
        $test = $this->approximateTime($exp, $test);
        $exp = Date::transform($exp, "iso8601");
        $test = Date::transform($test, "iso8601");
        $this->assertSame($exp, $test, $msg);
    }

    public function approximateTime($exp, $act) {
        if (is_null($act)) {
            return null;
        } elseif (is_null($exp)) {
            return $act;
        }
        $target = Date::normalize($exp)->getTimeStamp();
        $value = Date::normalize($act)->getTimeStamp();
        if ($value >= ($target - 1) && $value <= ($target + 1)) {
            // if the actual time is off by no more than one second, it's acceptable
            return $exp;
        } else {
            return $act;
        }
    }

    public function stringify($value) {
        if (!is_array($value)) {
            return $value;
        }
        foreach ($value as $k => $v) {
            if (is_array($v)) {
                $value[$k] = $this->stringify($v);
            } elseif (is_int($v) || is_float($v)) {
                $value[$k] = (string) $v;
            }
        }
        return $value;
    }

    /** Inserts into the database test data in the following format:
     * 
     * ```php
     * $data = [
     *  'some_table' => [
     *   'columns' => ["id", "name"],
     *   'rows'    => [
     *    [1,"Dupond"],
     *    [2,"Dupont"],
     *   ]
     *  ],
     *  'other_table' => [
     *   ...
     *  ]
     * ];
     * ```
     */
    public function primeDatabase(Driver $drv, array $data): bool {
        $tr = $drv->begin();
        foreach ($data as $table => $info) {
            $cols = array_map(function($v) {
                return '"'.str_replace('"', '""', $v).'"';
            }, $info['columns']);
            $cols = implode(",", $cols);
            $bindings = array_map(function($c) use ($table) {
                return self::COL_DEFS[$table][$c];
            }, $info['columns']);
            $params = implode(",", array_fill(0, sizeof($info['columns']), "?"));
            $s = $drv->prepareArray("INSERT INTO $table($cols) values($params)", $bindings);
            foreach ($info['rows'] as $row) {
                $s->runArray($row);
            }
        }
        $tr->commit();
        $this->primed = true;
        return true;
    }

    public function compareExpectations(Driver $drv, array $expected): void {
        foreach ($expected as $table => $info) {
            // serialize the rows of the expected output
            $exp = [];
            $dates = [];
            foreach ($info['rows'] as $r) {
                $row = [];
                foreach ($r as $c => $v) {
                    // store any date values for later comparison
                    if (is_string($v) && preg_match("/^\d{4}-\d\d-\d\d \d\d:\d\d:\d\d$/", $v)) {
                        $dates[] = $v;
                    }
                    // serialize to CSV, null being represented by no value
                    if ($v === null) {
                        $row[] = "";
                    } elseif ($drv->stringOutput() || is_string($v)) {
                        $row[] = '"'.str_replace('"', '""', (string) $v).'"';
                    } else {
                        $row[] = (string) $v;
                    }
                }
                $exp[] = implode(",", $row);
            }
            // serialize the rows of the actual output
            $cols = implode(",", array_map(function($v) {
                return '"'.str_replace('"', '""', $v).'"';
            }, $info['columns']));
            $data = $drv->prepare("SELECT $cols from $table")->run()->getAll();
            $act = [];
            $extra = [];
            foreach ($data as $r) {
                $row = [];
                foreach ($r as $c => $v) {
                    // account for dates which might be off by one second
                    if (is_string($v) && preg_match("/^\d{4}-\d\d-\d\d \d\d:\d\d:\d\d$/", $v)) {
                        if (array_search($v, $dates, true) === false) {
                            $v = Date::transform(Date::sub("PT1S", $v), "sql");
                            if (array_search($v, $dates, true) === false) {
                                $v = Date::transform(Date::add("PT2S", $v), "sql");
                                if (array_search($v, $dates, true) === false) {
                                    $v = Date::transform(Date::sub("PT1S", $v), "sql");
                                }
                            }
                        }
                    }
                    if ($v === null) {
                        $row[] = "";
                    } elseif (is_string($v)) {
                        $row[] = '"'.str_replace('"', '""', (string) $v).'"';
                    } else {
                        $row[] = (string) $v;
                    }
                }
                $row = implode(",", $row);
                // now search for the actual output row in the expected output
                $found = array_keys($exp, $row, true);
                foreach ($found as $k) {
                    if(!isset($act[$k])) {
                        $act[$k] = $row;
                        // skip to the next row
                        continue 2;
                    }
                }
                // if the row was not found, add it to a buffer which will be added to the actual output once all found rows are processed
                $extra[] = $row;
            }
            // add any unfound rows to the end of the actual array
            $base = sizeof($exp);
            foreach ($extra as $k => $v) {
                $act[$base + $k] = $v;
            }
            // sort the actual output by keys
            ksort($act);
            // finally perform the comparison to be shown to the tester
            $this->assertSame($exp, $act, "Actual table $table does not match expectations");
        }
    }

    public function primeExpectations(array $source, array $tableSpecs): array {
        $out = [];
        foreach ($tableSpecs as $table => $columns) {
            // make sure the source has the table we want
            if (!isset($source[$table])) {
                throw new Exception("Source for expectations does not contain requested table $table.");
            }
            // fill the output, particularly the correct number of (empty) rows
            $rows = sizeof($source[$table]['rows']);
            $out[$table] = [
                'columns' => $columns,
                'rows'    => array_fill(0, $rows, []),
            ];
            // fill the rows with the requested data, column-wise
            foreach ($columns as $c) {
                if (($index = array_search($c, $source[$table]['columns'], true)) === false) {
                    throw new exception("Expected column $table.$c is not present in test data");
                }
                for ($a = 0; $a < $rows; $a++) {
                    $out[$table]['rows'][$a][] = $source[$table]['rows'][$a][$index];
                }
            }
        }
        return $out;
    }

    public function assertResult(array $expected, Result $data): void {
        $data = $data->getAll();
        // stringify our expectations if necessary
        if (static::$stringOutput ?? false) {
            $expected = $this->stringify($expected);
        }
        $this->assertCount(sizeof($expected), $data, "Number of result rows (".sizeof($data).") differs from number of expected rows (".sizeof($expected).")");
        if (sizeof($expected)) {
            // make sure the expectations are consistent
            foreach ($expected as $exp) {
                if (!isset($keys)) {
                    $keys = $exp;
                    continue;
                }
                $this->assertSame(array_keys($keys), array_keys($exp), "Result set expectations are irregular");
            }
            // filter the result set to contain just the desired keys (we don't care if the result has extra keys)
            $rows = [];
            $keys = array_keys($keys);
            foreach ($data as $row) {
                $r = [];
                foreach ($keys as $k) {
                    if (array_key_exists($k, $row)) {
                        $r[$k] = $row[$k];
                    }
                }
                $rows[] = $r;
            }
            // compare the result set to the expectations
            foreach ($rows as $row) {
                $this->assertContains($row, $expected, "Result set contains unexpected record.\n".var_export($expected, true));
                $found = array_search($row, $expected);
                unset($expected[$found]);
            }
            $this->assertArraySubset($expected, [], false, "Expectations not in result set.");
        }
    }

    /** Guzzle's exception classes require some fairly complicated construction; this abstracts it all away so that only message and code need be supplied  */
    protected function mockGuzzleException(string $class, ?string $message = null, ?int $code = null, ?\Throwable $e = null): GuzzleException {
        if (is_a($class, RequestException::class, true)) {
            $req = $this->mock(RequestInterface::class);
            $res = $this->mock(ResponseInterface::class);
            $res->getStatusCode->returns($code ?? 0);
            return new $class($message ?? "", $req->get(), $res->get(), $e);
        } else {
            return new $class($message ?? "", $code ?? 0, $e);
        }
    }

    protected function mock(string $class): InstanceHandle {
        return Phony::mock($class);
    }

    protected function partialMock(string $class, ...$argument): InstanceHandle {
        return Phony::partialMock($class, $argument);
    }
}