SimpleSAML\Module\monitor\TestSuite\Modules\ModuleSet

Complexity

Total Complexity

16

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	setDependencies()	0	3	1
A	setType()	0	3	1
A	invokeTest()	0	29	5
A	setTestResult()	0	11	3
A	setAvailable()	0	3	1
A	__construct()	0	9	1
A	findMissingDependencies()	0	11	3
A	setRequired()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\monitor\TestSuite\Modules;

use SimpleSAML\Assert\Assert;
use SimpleSAML\Module;
use SimpleSAML\Module\monitor\State;
use SimpleSAML\Module\monitor\TestCase;
use SimpleSAML\Module\monitor\TestConfiguration;
use SimpleSAML\Module\monitor\TestData;
use SimpleSAML\Module\monitor\TestResult;

use function array_search;

final class ModuleSet extends \SimpleSAML\Module\monitor\TestSuiteFactory
{
    /** @var array */
    private array $required;

    /** @var array */
    private array $available;

    /** @var array */
    private array $dependencies;

    /** @var string */
    private string $type;


    /**
     * @param \SimpleSAML\Module\monitor\TestConfiguration $configuration
     * @param \SimpleSAML\Module\monitor\TestData $testData
     */
    public function __construct(TestConfiguration $configuration, TestData $testData)
    {
        $this->setRequired($testData->getInputItem('required'));

It seems like $testData->getInputItem('required') can also be of type null; however, parameter $required of SimpleSAML\Module\monitor\TestSuite\Modules\ModuleSet::setRequired() does only seem to accept array, maybe add an additional type check?

        $this->setAvailable($testData->getInputItem('available'));

It seems like $testData->getInputItem('available') can also be of type null; however, parameter $available of SimpleSAML\Module\monitor\TestSuite\Modules\ModuleSet::setAvailable() does only seem to accept array, maybe add an additional type check?

        $this->setDependencies($testData->getInputItem('dependencies'));

It seems like $testData->getInputItem('dependencies') can also be of type null; however, parameter $dependencies of SimpleSAML\Module\monitor\TestSuite\Modules\ModuleSet::setDependencies() does only seem to accept array, maybe add an additional type check?

        $this->setType($testData->getInputItem('type'));

It seems like $testData->getInputItem('type') can also be of type null; however, parameter $type of SimpleSAML\Module\monitor\TestSuite\Modules\ModuleSet::setType() does only seem to accept string, maybe add an additional type check?

        $this->setCategory($this->type . ' modules');

        parent::__construct($configuration);
    }


    /**
     * @param array $required
     * @return void
     */
    private function setRequired(array $required): void
    {
        $this->required = $required;
    }


    /**
     * @param array $available
     * @return void
     */
    private function setAvailable(array $available): void
    {
        $this->available = $available;
    }


    /**
     * @param array $dependencies
     * @return void
     */
    private function setDependencies(array $dependencies): void
    {
        $this->dependencies = $dependencies;
    }


    /**
     * @param string $type
     * @return void
     */
    private function setType(string $type): void
    {
        $this->type = $type;
    }


    /**
     * @return void
     */
    public function invokeTest(): void
    {
        if (empty($this->available)) {
            $state = State::SKIPPED;
        } else {
            foreach ($this->required as $module) {
                $testData = new TestData([
                    'required' => $module,
                    'available' => $this->available,
                    'type' => $this->type,
                ]);

                $moduleTest = new TestCase\Module($testData);
                $moduleTestResult = $moduleTest->getTestResult();
                if ($moduleTestResult->getState() !== State::OK) {
                    $missing = $this->findMissingDependencies($module);
                    if (!empty($missing)) {
                        $moduleTestResult->setSubject($moduleTest->getModuleName());
                        $moduleTestResult->setMessage('Module not loaded; dependency for ' . implode(', ', $missing));
                    }
                }
                $this->addTestResult($moduleTestResult);
            }
            $state = $this->calculateState();
        }

        $testResult = new TestResult($this->type, implode(', ', $this->required));
        $testResult->setState($state);
        $this->setTestResult($testResult);
    }


    /**
     * @param \SimpleSAML\Module\monitor\TestResult $testResult
     *
     * return void
     */
    protected function setTestResult(TestResult $testResult): void
    {
        $state = $testResult->getState();
        if ($state === State::OK) {
            $testResult->setMessage('All required modules are loaded');
        } elseif ($state === State::SKIPPED) {
            $testResult->setMessage('Unable to verify installed modules');
        } else {
            $testResult->setMessage('Not all required modules are loaded');
        }
        parent::setTestResult($testResult);
    }


    /**
     * @param string $module
     *
     * @return array
     */
    private function findMissingDependencies(string $module): array
    {
        $dependencies = $this->dependencies;
        $missing = [];
        while ($dependency = array_search($module, $dependencies)) {
            if (Module::isModuleEnabled($dependency)) {
                $missing[] = $dependency;
            }
            unset($dependencies[$dependency]);
        }
        return $missing;
    }
}