PSFS\tests\services\DocumentorServiceTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	clearContext()	0	4	1
A	testApiDocumentation()	0	14	2
A	prepareDocumentRoot()	0	10	2

<?php

namespace PSFS\tests\services;

use PHPUnit\Framework\Attributes\Before;

The type PHPUnit\Framework\Attributes\Before was not found. Maybe you did not declare it correctly or list all dependencies?

use PSFS\base\Router;
use PSFS\base\types\helpers\GeneratorHelper;
use PSFS\services\DocumentorService as Service;

/**
 * Class DocumentServiceTest
 * @package PSFS\tests\services
 */
class DocumentorServiceTest extends GeneratorServiceTest
{

    public static $namespaces = [
        '\CLIENT\Api\Test\Test',
        '\CLIENT\Api\Related\Related',
        '\CLIENT\Api\Solo',
    ];

    /**
     * @throws \PSFS\base\exception\GeneratorException
     */
    #[Before]
    public function prepareDocumentRoot(): void
    {
        if (file_exists(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json')) {
            unlink(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json');
        }
        $this->assertFileDoesNotExist(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json', 'Previous generated domains json, please delete it before testing');
        GeneratorHelper::deleteDir(CACHE_DIR);
        $this->assertDirectoryDoesNotExist(CACHE_DIR, 'Cache folder already exists with data');
        GeneratorHelper::createRoot(WEB_DIR, null, true);
    }

    /**
     * @param string $modulePath
     */
    protected function clearContext(string $modulePath): void
    {
        GeneratorHelper::deleteDir($modulePath);
        $this->assertDirectoryDoesNotExist($modulePath, 'Error trying to delete the module');
    }

    /**
     * @throws \PSFS\base\exception\GeneratorException
     * @throws \ReflectionException
     */
    public function testApiDocumentation()
    {
        $modulePath = $this->checkCreateExistingModule();
        $this->assertDirectoryExists($modulePath, 'Module did not exists');

        Router::getInstance()->init();
        $documentorService = Service::getInstance();
        $module = $documentorService->getModules(self::MODULE_NAME);
        $doc = $documentorService->extractApiEndpoints($module);
        foreach ($doc as $namespace => $endpoints) {
            $this->assertContains($namespace, self::$namespaces, 'Namespace not included in the test');
            $this->assertCount(7, $endpoints, 'Different number of endpoints');
        }
        $this->clearContext($modulePath);
    }
}