Ldap::invokeTest() - Code Metrics - Inspection of "Remove any stray spaces" - tvdijen/simplesamlphp-module-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — monitor-2.7.x ( 9e4b6d...32a54b )

by Tim

created 2022-10-06 09:21 UTC

Ldap::invokeTest() B

↳ Parent: Ldap

Complexity

Conditions	7
Paths	4

Size

Total Lines	72
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	7
eloc	43
c	2
b	0
f	0
nc	4
nop	0
dl	0
loc	72
rs	8.2986

How to fix Long Method

<?php

namespace SimpleSAML\Module\monitor\TestSuite\AuthSource;

use SimpleSAML\Assert\Assert;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Configuration;
use SimpleSAML\Module\monitor\State;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Module\monitor\TestConfiguration;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Module\monitor\TestCase;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Module\monitor\TestData;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Module\monitor\TestResult;
filter:
    dependency_paths: ["lib/*"]

use function array_key_exists;
use function array_replace;
use function explode;
use function is_null;
use function parse_url;
use function preg_match;
use function preg_split;
use function stream_context_create;

final class Ldap extends \SimpleSAML\Module\monitor\TestSuiteFactory
filter:
    dependency_paths: ["lib/*"]
{
    /** @var ApplicationConfiguration */
filter:
    dependency_paths: ["lib/*"]
    private $authSourceData;

    /** @var array|null */
    private $authSourceSpecifics;

    /** @var string[] */
    private $hosts;

    /** @var integer|null */
    private $certExpirationWarning = null;


    /**
     * @param TestConfiguration $configuration
     * @param TestData $testData
     */
    public function __construct(TestConfiguration $configuration, TestData $testData)
    {
        $moduleConfig = $configuration->getModuleConfig();
        $authSourceData = $testData->getInputItem('authSourceData');
        $authSourceSpecifics = $testData->getInputItem('authSourceSpecifics');

        assert(is_array($authSourceData));
        assert(is_array($authSourceSpecifics) || is_null($authSourceSpecifics));

        $authSourceData = Configuration::loadFromArray($authSourceData);
        $this->hosts = preg_split('/\s+/', $authSourceData->getString('hostname'), -1, PREG_SPLIT_NO_EMPTY);
        $this->authSourceData = $authSourceData;

        $this->authSourceSpecifics = $authSourceSpecifics;
        $this->certExpirationWarning = $moduleConfig->getValue('certExpirationWarning', 28);
        $this->setCategory('LDAP authentication source');

        parent::__construct($configuration);
    }


    /**
     * @return void
     */
    public function invokeTest()
    {
        // Test LDAP configuration
        $confTest = new TestCase\AuthSource\Ldap\Configuration(
filter:
    dependency_paths: ["lib/*"]
            new TestData(['authSourceData' => $this->authSourceData])
        );
        $confTestResult = $confTest->getTestResult();
        $this->addTestResult($confTestResult);

        if ($confTestResult->getState() === State::OK) {
            $connection = $confTestResult->getOutput('connection');

            // Test connection for each configured LDAP-server
            $failure = count($this->hosts);
            foreach ($this->hosts as $hostname) {
                $preparedTestData = $this->prepareConnection($hostname);
                $connTest = new TestCase\Network\ConnectUri(
filter:
    dependency_paths: ["lib/*"]
                    new TestData($preparedTestData)
                );
                $connTestResult = $connTest->getTestResult();
                $this->addTestResult($connTestResult);

                if ($connTestResult->getState() === State::OK) {
                    $certData = $connTestResult->getOutput('certData');

                    // Test certificate when available
                    if ($certData !== null) {
                        $certTest = new TestCase\Cert(
filter:
    dependency_paths: ["lib/*"]
                            new TestData([
                                'certData' => $certData,
                                'category' => 'LDAP Server Certificate',
                                'certExpirationWarning' => $this->certExpirationWarning,
                            ])
                        );
                        $certTestResult = $certTest->getTestResult();
                        $this->addTestResult($certTestResult);
                    }
                    $failure--;
                }
            }

            if ($failure === 0) {
                // Test bind
                $bindTest = new TestCase\AuthSource\Ldap\Bind(
filter:
    dependency_paths: ["lib/*"]
                    new TestData([
                        'authSourceData' => $this->authSourceData,
                        'connection' => $connection
                    ])
                );
                $bindTestResult = $bindTest->getTestResult();
                $this->addTestResult($bindTestResult);

                if ($bindTestResult->getState() === State::OK) {
                    // Test search
                    $searchTest = new TestCase\AuthSource\Ldap\Search(
filter:
    dependency_paths: ["lib/*"]
                        new TestData([
                            'authSourceData' => $this->authSourceData,
                            'connection' => $connection
                        ])
                    );
                    $searchTestResult = $searchTest->getTestResult();
                    $this->addTestResult($searchTestResult);
                }
            }
            unset($connection);
        }

        $state = $this->calculateState();

        $testResult = new TestResult('LDAP Authentication');
        $testResult->setState($state);
        $this->setTestResult($testResult);
    }


    /**
     * @param string $connectString
     *
     * @return array
     */
    private function prepareConnection($connectString)
    {
        $hostname = parse_url($connectString, PHP_URL_HOST);
        $authSourceData = $this->authSourceData;
        $authSourceSpecifics = $this->authSourceSpecifics;

        if (preg_match('/^(ldaps:\/\/(.*))$/', $connectString, $matches)) {
            // The default context
            $sslContext = ['capture_peer_cert' => true, 'verify_peer' => true];

            // The non-default context, if configured ...
            if (!is_null($authSourceSpecifics) && array_key_exists('ssl', $authSourceSpecifics)) {
                $sslContext = array_replace($sslContext, $authSourceSpecifics['ssl']);
            }

            $port = parse_url($connectString, PHP_URL_PORT);
            $port = $port ?: $authSourceData->getInteger('port', 636);

            $uri = 'ssl://' .  $hostname . ':' . $port;
            $context = stream_context_create(['ssl' => $sslContext]);
        } else {
            $port = $authSourceData->getInteger('port', 389);
            $uri = 'tcp://' . $hostname . ':' . $port;
            $context = stream_context_create();
        }

        $timeout = $authSourceData->getInteger('timeout', null);
        return ['uri' => $uri, 'context' => $context, 'timeout' => $timeout];
    }
}


1			<?php
2
3			namespace SimpleSAML\Module\monitor\TestSuite\AuthSource;
4
5			use SimpleSAML\Assert\Assert;
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Assert\Assert` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use SimpleSAML\Configuration;
7			use SimpleSAML\Module\monitor\State;
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\State` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use SimpleSAML\Module\monitor\TestConfiguration;
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestConfiguration` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use SimpleSAML\Module\monitor\TestCase;
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestCase` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use SimpleSAML\Module\monitor\TestData;
			0 ignored issues – show Bug introduced 2021-07-30 09:17 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestData` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11			use SimpleSAML\Module\monitor\TestResult;
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestResult` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
12
13			use function array_key_exists;
14			use function array_replace;
15			use function explode;
16			use function is_null;
17			use function parse_url;
18			use function preg_match;
19			use function preg_split;
20			use function stream_context_create;
21
22			final class Ldap extends \SimpleSAML\Module\monitor\TestSuiteFactory
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestSuiteFactory` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
23			{
24			/** @var ApplicationConfiguration */
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monito...pplicationConfiguration` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
25			private $authSourceData;
26
27			/** @var array\|null */
28			private $authSourceSpecifics;
29
30			/** @var string[] */
31			private $hosts;
32
33			/** @var integer\|null */
34			private $certExpirationWarning = null;
35
36
37			/**
38			* @param TestConfiguration $configuration
39			* @param TestData $testData
40			*/
41			public function __construct(TestConfiguration $configuration, TestData $testData)
42			{
43			$moduleConfig = $configuration->getModuleConfig();
44			$authSourceData = $testData->getInputItem('authSourceData');
45			$authSourceSpecifics = $testData->getInputItem('authSourceSpecifics');
46
47			assert(is_array($authSourceData));
48			assert(is_array($authSourceSpecifics) \|\| is_null($authSourceSpecifics));
49
50			$authSourceData = Configuration::loadFromArray($authSourceData);
51			$this->hosts = preg_split('/\s+/', $authSourceData->getString('hostname'), -1, PREG_SPLIT_NO_EMPTY);
52			$this->authSourceData = $authSourceData;
			0 ignored issues – show Documentation Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report It seems like `$authSourceData` of type `SimpleSAML\Configuration` is incompatible with the declared type `SimpleSAML\Module\monito...pplicationConfiguration` of property `$authSourceData`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
53			$this->authSourceSpecifics = $authSourceSpecifics;
54			$this->certExpirationWarning = $moduleConfig->getValue('certExpirationWarning', 28);
55			$this->setCategory('LDAP authentication source');
56
57			parent::__construct($configuration);
58			}
59
60
61			/**
62			* @return void
63			*/
64			public function invokeTest()
65			{
66			// Test LDAP configuration
67			$confTest = new TestCase\AuthSource\Ldap\Configuration(
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monito...urce\Ldap\Configuration` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
68			new TestData(['authSourceData' => $this->authSourceData])
69			);
70			$confTestResult = $confTest->getTestResult();
71			$this->addTestResult($confTestResult);
72
73			if ($confTestResult->getState() === State::OK) {
74			$connection = $confTestResult->getOutput('connection');
75
76			// Test connection for each configured LDAP-server
77			$failure = count($this->hosts);
78			foreach ($this->hosts as $hostname) {
79			$preparedTestData = $this->prepareConnection($hostname);
80			$connTest = new TestCase\Network\ConnectUri(
			0 ignored issues – show Bug introduced 2018-01-13 11:16 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monito...Case\Network\ConnectUri` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
81			new TestData($preparedTestData)
82			);
83			$connTestResult = $connTest->getTestResult();
84			$this->addTestResult($connTestResult);
85
86			if ($connTestResult->getState() === State::OK) {
87			$certData = $connTestResult->getOutput('certData');
88
89			// Test certificate when available
90			if ($certData !== null) {
91			$certTest = new TestCase\Cert(
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monitor\TestCase\Cert` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
92			new TestData([
93			'certData' => $certData,
94			'category' => 'LDAP Server Certificate',
95			'certExpirationWarning' => $this->certExpirationWarning,
96			])
97			);
98			$certTestResult = $certTest->getTestResult();
99			$this->addTestResult($certTestResult);
100			}
101			$failure--;
102			}
103			}
104
105			if ($failure === 0) {
106			// Test bind
107			$bindTest = new TestCase\AuthSource\Ldap\Bind(
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monito...se\AuthSource\Ldap\Bind` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
108			new TestData([
109			'authSourceData' => $this->authSourceData,
110			'connection' => $connection
111			])
112			);
113			$bindTestResult = $bindTest->getTestResult();
114			$this->addTestResult($bindTestResult);
115
116			if ($bindTestResult->getState() === State::OK) {
117			// Test search
118			$searchTest = new TestCase\AuthSource\Ldap\Search(
			0 ignored issues – show Bug introduced 2022-10-06 09:35 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Module\monito...\AuthSource\Ldap\Search` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
119			new TestData([
120			'authSourceData' => $this->authSourceData,
121			'connection' => $connection
122			])
123			);
124			$searchTestResult = $searchTest->getTestResult();
125			$this->addTestResult($searchTestResult);
126			}
127			}
128			unset($connection);
129			}
130
131			$state = $this->calculateState();
132
133			$testResult = new TestResult('LDAP Authentication');
134			$testResult->setState($state);
135			$this->setTestResult($testResult);
136			}
137
138
139			/**
140			* @param string $connectString
141			*
142			* @return array
143			*/
144			private function prepareConnection($connectString)
145			{
146			$hostname = parse_url($connectString, PHP_URL_HOST);
147			$authSourceData = $this->authSourceData;
148			$authSourceSpecifics = $this->authSourceSpecifics;
149
150			if (preg_match('/^(ldaps:\/\/(.*))$/', $connectString, $matches)) {
151			// The default context
152			$sslContext = ['capture_peer_cert' => true, 'verify_peer' => true];
153
154			// The non-default context, if configured ...
155			if (!is_null($authSourceSpecifics) && array_key_exists('ssl', $authSourceSpecifics)) {
156			$sslContext = array_replace($sslContext, $authSourceSpecifics['ssl']);
157			}
158
159			$port = parse_url($connectString, PHP_URL_PORT);
160			$port = $port ?: $authSourceData->getInteger('port', 636);
161
162			$uri = 'ssl://' . $hostname . ':' . $port;
163			$context = stream_context_create(['ssl' => $sslContext]);
164			} else {
165			$port = $authSourceData->getInteger('port', 389);
166			$uri = 'tcp://' . $hostname . ':' . $port;
167			$context = stream_context_create();
168			}
169
170			$timeout = $authSourceData->getInteger('timeout', null);
171			return ['uri' => $uri, 'context' => $context, 'timeout' => $timeout];
172			}
173			}
174

tvdijen / simplesamlphp-module-monitor

Push — monitor-2.7.x ( 9e4b6d...32a54b )

Ldap::invokeTest() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like