tvdijen / simplesamlphp-module-monitor

src/TestCase/Module.php

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\monitor\TestCase;

use SimpleSAML\Module\monitor\State as State;
use SimpleSAML\Module\monitor\TestData as TestData;
use SimpleSAML\Module\monitor\TestResult as TestResult;

use function explode;
use function in_array;
use function is_null;

class Module extends \SimpleSAML\Module\monitor\TestCaseFactory
{
    /** @var array */
    private array $parsed = [];

    /** @var array */
    private array $available = [];

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


    /**
     * @param \SimpleSAML\Module\monitor\TestData $testData
     *
     * @return void
     */
    protected function initialize(TestData $testData): void
    {
        $this->module = $testData->getInputItem('required');
        $available = $testData->getInputItem('available');
        if (!is_null($available)) {
            $this->available = $available;
        }
        $this->parsed = explode('|', $this->module);

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

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

        parent::initialize($testData);
    }


    /**
     * @return void
     */
    public function invokeTest(): void
    {
        $testResult = new TestResult($this->getCategory(), $this->getModuleName());

        $state = State::ERROR;
        $available = $this->getAvailable();

        foreach ($this->parsed as $module) {
            if (in_array($module, $available)) {
                $state = State::OK;
                break 1;
            }
        }

        if ($state == State::OK) {
            $testResult->setMessage('Module loaded');
        } else {
            $testResult->setMessage('Module not loaded');
        }

        $testResult->setState($state);
        $this->setTestResult($testResult);
    }


    /**
     * @return array
     */
    private function getAvailable(): array
    {
        return $this->available;
    }


    /**
     * @return string
     */
    private function getModule(): string
    {
        return $this->module;
    }


    /**
     * @return string
     */
    public function getModuleName(): string
    {
        $available = $this->available;

        foreach ($this->parsed as $module) {
            if (in_array($module, $available)) {
                return $module;
            }
        }

        return $this->getModule();
    }
}