SimpleSAML\Module\monitor\TestCase\FileSystem\FreeSpace

Complexity

Total Complexity

8

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	invokeTest()	0	26	5
A	initialize()	0	5	1
A	setPath()	0	3	1
A	getPath()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\monitor\TestCase\FileSystem;

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

use function disk_free_space;
use function disk_total_space;
use function round;

final class FreeSpace extends \SimpleSAML\Module\monitor\TestCaseFactory
{
    /** @var string */
    private string $path = '';


    /**
     * @var \SimpleSAML\Module\monitor\TestData $testData
     *
     * @return void
     */
    protected function initialize(TestData $testData): void
    {
        $this->setPath($testData->getInputItem('path'));

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

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

It seems like $testData->getInputItem('category') 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);
    }


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


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


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

        $size = disk_total_space($path);
        $free = disk_free_space($path);
        if ($size !== false && $free !== false) {
            $free = round(100 - ((($size - $free) / $size) * 100));

            if ($free >= 15) {
                $testResult->setMessage($free . '% free space');
                $testResult->setState(State::OK);
            } elseif ($free < 5) {
                $testResult->setMessage('Critical: ' . $free . '% free space');
                $testResult->setState(State::ERROR);
            } else {
                $testResult->setMessage($free . '% free space');
                $testResult->setState(State::WARNING);
            }
            $testResult->addOutput($free, 'free_percentage');
        } else {
            $testResult->setMessage('Error collecting disk usage');
            $testResult->setState(State::FATAL);
        }
        $this->setTestResult($testResult);
    }
}