espocrm/tests/integration/Core/BaseTestCase.php

<?php
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM - Open Source CRM application.
 * Copyright (C) 2014-2023 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
 * Website: https://www.espocrm.com
 *
 * EspoCRM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * EspoCRM is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with EspoCRM. If not, see http://www.gnu.org/licenses/.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

namespace tests\integration\Core;

use Espo\Core\{
    Api\RequestWrapper,
    Api\ResponseWrapper,
    Application,
    Container,
    DataManager,
    InjectableFactory,
    Utils\Config,
    Utils\File\Manager as FileManager,
    Utils\Metadata};

use Espo\Entities\User;

use Espo\ORM\EntityManager;
use Slim\Psr7\Factory\RequestFactory;
use Slim\Psr7\Factory\ResponseFactory;
use Slim\Psr7\Factory\StreamFactory;

abstract class BaseTestCase extends \PHPUnit\Framework\TestCase
{
    /**
     * @var Tester
     */
    protected $espoTester;

    private $espoApplication;

    /**
     * Path to file with data.
     *
     * @var string|null
     */
    protected $dataFile = null;

    /**
     * Path to files which needs to be copied.
     *
     * @var string|null
     */
    protected $pathToFiles = null;

    /**
     * Username used for authentication.
     */
    protected $userName = null;

    /**
     * Password used for authentication.
     */
    protected $password = null;

    protected $portalId = null;

    protected $initData = null;

    protected $authenticationMethod = null;

    protected function createApplication(bool $clearCache = true, ?string $portalId = null): Application
    {
        return $this->espoTester->getApplication(true, $clearCache, $portalId);
    }

    protected function setApplication(Application $application): void
    {
        $this->espoApplication = $application;
    }

    protected function auth(
        ?string $userName = null,
        ?string $password = null,
        ?string $portalId = null,
        ?string $authenticationMethod = null,
        ?RequestWrapper $request = null
    ): void {

        $this->userName = $userName;
        $this->password = $password;
        $this->portalId = $portalId;
        $this->authenticationMethod = $authenticationMethod;

        if (isset($this->espoTester)) {
            $this->espoTester->auth($userName, $password, $portalId, $authenticationMethod, $request);
        }
    }

    /**
     * Get the application.
     */
    protected function getApplication(): Application
    {
        return $this->espoApplication;
    }

    /**
     * Get container.
     */
    protected function getContainer(): Container
    {
        return $this->getApplication()->getContainer();
    }

    protected function getFileManager(): FileManager
    {
        return $this->getApplication()->getContainer()->get('fileManager');
    }

    protected function getDataManager(): DataManager
    {
        return $this->getApplication()->getContainer()->get('dataManager');
    }

    protected function getInjectableFactory(): InjectableFactory
    {
        return $this->getApplication()->getContainer()->get('injectableFactory');
    }

    protected function getMetadata(): Metadata
    {
        return $this->getApplication()->getContainer()->get('metadata');
    }

    protected function getEntityManager(): EntityManager
    {
        return $this->getApplication()->getContainer()->get('entityManager');
    }

    protected function getConfig(): Config
    {
        return $this->getApplication()->getContainer()->get('config');
    }

    protected function normalizePath($path)
    {
        return $this->espoTester->normalizePath($path);
    }

    protected function sendRequest($method, $action, $data = null)
    {
        return $this->espoTester->sendRequest($method, $action, $data);
    }

    protected function setUp(): void
    {
        $params = [
            'className' => get_class($this),
            'dataFile' => $this->dataFile,
            'pathToFiles' => $this->pathToFiles,
            'initData' => $this->initData,
        ];

        $this->espoTester = new Tester($params);

        $this->beforeSetUp();

        $this->espoTester->initialize();

        $this->auth($this->userName, $this->password, null, $this->authenticationMethod);

        $this->beforeStartApplication();

        $this->espoApplication = $this->createApplication();

        $this->afterStartApplication();
    }

    /**
     * Re-create an application.
     */
    protected function reCreateApplication(): void
    {
        $this->espoApplication = $this->createApplication();
    }

    protected function tearDown(): void
    {
        $this->espoTester->terminate();
        $this->espoTester = NULL;
        $this->espoApplication = NULL;
    }

    protected function createUser($userData, ?array $role = null, bool $isPortal = false): User
    {
        return $this->espoTester->createUser($userData, $role, $isPortal);
    }

    protected function beforeSetUp()
    {

    }

    protected function beforeStartApplication()
    {

    }

    protected function afterStartApplication()
    {

    }

    protected function createRequest(
        string $method,
        array $queryParams = [],
        array $headers = [],
        ?string $body = null,
        array $routeParams = []
    ): RequestWrapper {

        $request = (new RequestFactory())
            ->createRequest($method, 'http://localhost/?' . http_build_query($queryParams));

        foreach ($headers as $name => $value) {
            $request = $request->withHeader($name, $value);
        }

        if ($body) {
            $request = $request->withBody(
                (new StreamFactory)->createStream($body)
            );
        }

        return new RequestWrapper($request, '', $routeParams);
    }

    protected function createResponse(): ResponseWrapper
    {
        return new ResponseWrapper(
            (new ResponseFactory())->createResponse()
        );
    }

    protected function setData(array $data): void
    {
        $this->espoTester->setData($data);
    }

    protected function fullReset(): void
    {
        $this->espoTester->setParam('fullReset', true);
    }
}