Ldap::invokeTest() - Code Metrics - Inspection of "Update composer.json" - tvdijen/simplesamlphp-module-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4541b1...3f3f73 )

by Tim

created 2018-05-17 07:33 UTC

Ldap::invokeTest() B

↳ Parent: Ldap

Complexity

Conditions	6
Paths	3

Size

Total Lines	70
Code Lines	41

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	41
nc	3
nop	0
dl	0
loc	70
rs	8.5454
c	0
b	0
f	0

How to fix Long Method

<?php

namespace SimpleSAML\Module\monitor\TestSuite\AuthSource;

use \SimpleSAML_Configuration as ApplicationConfiguration;
use \SimpleSAML\Module\monitor\State as State;
use \SimpleSAML\Module\monitor\TestConfiguration as TestConfiguration;
use \SimpleSAML\Module\monitor\TestCase as TestCase;
use \SimpleSAML\Module\monitor\TestData as TestData;
use \SimpleSAML\Module\monitor\TestResult as TestResult;

final class Ldap extends \SimpleSAML\Module\monitor\TestSuiteFactory
{
    /**
     * @var ApplicationConfiguration
     */
    private $authSourceData;

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

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

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

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

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

        $this->hosts = explode(' ', $authSourceData->getString('hostname'));
        $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(
            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
            foreach ($this->hosts as $hostname) {
                $preparedTestData = $this->prepareConnection($hostname, $this->authSourceData, $this->authSourceSpecifics);
                $connTest = new TestCase\Network\ConnectUri(
                    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(
                            new TestData([
                                'certData' => $certData,
                                'category' => 'LDAP Server Certificate',
                                'certExpirationWarning' => $this->certExpirationWarning,
                            ])
                        );
                        $certTestResult = $certTest->getTestResult();
                        $this->addTestResult($certTestResult);
                    }
                }
            }

            // Test bind
            $testData = new TestData([
                'authSourceData' => $this->authSourceData,
                'connection' => $connection
            ]);
            $bindTest = new TestCase\AuthSource\Ldap\Bind(
                $testData
            );
            $bindTestResult = $bindTest->getTestResult();
            $this->addTestResult($bindTestResult);

            if ($bindTestResult->getState() === State::OK) {
                // Test search
                $testData = new TestData([
                    'authSourceData' => $this->authSourceData,
                    'connection' => $connection
                ]);

                $searchTest = new TestCase\AuthSource\Ldap\Search(
                    $testData
                );
                $searchTestResult = $searchTest->getTestResult();
                $this->addTestResult($searchTestResult);
            }
        }

        $state = $this->calculateState();

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

    /**
     * @param string $connectString
     * @param ApplicationConfiguration $authSourceData
     * @param array|null $authSourceSpecifics
     *
     * @return array
     */
    private function prepareConnection($connectString, $authSourceData, $authSourceSpecifics)
    {
        $hostname = parse_url($connectString, PHP_URL_HOST);

        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');

            $uri = 'ssl://' .  $hostname . ':' . $port;
            $context = stream_context_create(['ssl' => $sslContext]);
        } else {
            $port = $authSourceData->getInteger('port');
            $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_Configuration as ApplicationConfiguration;
6			use \SimpleSAML\Module\monitor\State as State;
7			use \SimpleSAML\Module\monitor\TestConfiguration as TestConfiguration;
8			use \SimpleSAML\Module\monitor\TestCase as TestCase;
9			use \SimpleSAML\Module\monitor\TestData as TestData;
10			use \SimpleSAML\Module\monitor\TestResult as TestResult;
11
12			final class Ldap extends \SimpleSAML\Module\monitor\TestSuiteFactory
13			{
14			/**
15			* @var ApplicationConfiguration
16			*/
17			private $authSourceData;
18
19			/**
20			* @var array\|null
21			*/
22			private $authSourceSpecifics;
23
24			/**
25			* @var string[]
26			*/
27			private $hosts;
28
29			/**
30			* @param integer\|null;
31			*/
32			private $certExpirationWarning = null;
33
34			/**
35			* @param TestConfiguration $configuration
36			* @param TestData $testData
37			*/
38			public function __construct($configuration, $testData)
39			{
40			$moduleConfig = $configuration->getModuleConfig();
41			$authSourceData = $testData->getInputItem('authSourceData');
42			$authSourceSpecifics = $testData->getInputItem('authSourceSpecifics');
43
44			assert($authSourceData instanceof ApplicationConfiguration);
45			assert(is_array($authSourceSpecifics) \|\| is_null($authSourceSpecifics));
46
47			$this->hosts = explode(' ', $authSourceData->getString('hostname'));
48			$this->authSourceData = $authSourceData;
49			$this->authSourceSpecifics = $authSourceSpecifics;
50			$this->certExpirationWarning = $moduleConfig->getValue('certExpirationWarning', 28);
51			$this->setCategory('LDAP authentication source');
52
53			parent::__construct($configuration);
54			}
55
56			/**
57			* @return void
58			*/
59			public function invokeTest()
60			{
61			// Test LDAP configuration
62			$confTest = new TestCase\AuthSource\Ldap\Configuration(
63			new TestData(['authSourceData' => $this->authSourceData])
64			);
65			$confTestResult = $confTest->getTestResult();
66			$this->addTestResult($confTestResult);
67
68			if ($confTestResult->getState() === State::OK) {
69			$connection = $confTestResult->getOutput('connection');
70
71			// Test connection for each configured LDAP-server
72			foreach ($this->hosts as $hostname) {
73			$preparedTestData = $this->prepareConnection($hostname, $this->authSourceData, $this->authSourceSpecifics);
74			$connTest = new TestCase\Network\ConnectUri(
75			new TestData($preparedTestData)
76			);
77			$connTestResult = $connTest->getTestResult();
78			$this->addTestResult($connTestResult);
79
80			if ($connTestResult->getState() === State::OK) {
81			$certData = $connTestResult->getOutput('certData');
82
83			// Test certificate when available
84			if ($certData !== null) {
85			$certTest = new TestCase\Cert(
86			new TestData([
87			'certData' => $certData,
88			'category' => 'LDAP Server Certificate',
89			'certExpirationWarning' => $this->certExpirationWarning,
90			])
91			);
92			$certTestResult = $certTest->getTestResult();
93			$this->addTestResult($certTestResult);
94			}
95			}
96			}
97
98			// Test bind
99			$testData = new TestData([
100			'authSourceData' => $this->authSourceData,
101			'connection' => $connection
102			]);
103			$bindTest = new TestCase\AuthSource\Ldap\Bind(
104			$testData
105			);
106			$bindTestResult = $bindTest->getTestResult();
107			$this->addTestResult($bindTestResult);
108
109			if ($bindTestResult->getState() === State::OK) {
110			// Test search
111			$testData = new TestData([
112			'authSourceData' => $this->authSourceData,
113			'connection' => $connection
114			]);
115
116			$searchTest = new TestCase\AuthSource\Ldap\Search(
117			$testData
118			);
119			$searchTestResult = $searchTest->getTestResult();
120			$this->addTestResult($searchTestResult);
121			}
122			}
123
124			$state = $this->calculateState();
125
126			$testResult = new TestResult('LDAP Authentication');
127			$testResult->setState($state);
128			$this->setTestResult($testResult);
129			}
130
131			/**
132			* @param string $connectString
133			* @param ApplicationConfiguration $authSourceData
134			* @param array\|null $authSourceSpecifics
135			*
136			* @return array
137			*/
138			private function prepareConnection($connectString, $authSourceData, $authSourceSpecifics)
139			{
140			$hostname = parse_url($connectString, PHP_URL_HOST);
141
142			if (preg_match('/^(ldaps:\/\/(.*))$/', $connectString, $matches)) {
143			// The default context
144			$sslContext = ['capture_peer_cert' => true, 'verify_peer' => true];
145
146			// The non-default context, if configured ...
147			if (!is_null($authSourceSpecifics) && array_key_exists('ssl', $authSourceSpecifics)) {
148			$sslContext = array_replace($sslContext, $authSourceSpecifics['ssl']);
149			}
150
151			$port = parse_url($connectString, PHP_URL_PORT);
152			$port = $port ?: $authSourceData->getInteger('port');
153
154			$uri = 'ssl://' . $hostname . ':' . $port;
155			$context = stream_context_create(['ssl' => $sslContext]);
156			} else {
157			$port = $authSourceData->getInteger('port');
158			$uri = 'tcp://' . $hostname . ':' . $port;
159			$context = stream_context_create();
160			}
161
162			$timeout = $authSourceData->getInteger('timeout', null);
163			return ['uri' => $uri, 'context' => $context, 'timeout' => $timeout];
164			}
165			}
166

tvdijen / simplesamlphp-module-monitor

Push — master ( 4541b1...3f3f73 )

Ldap::invokeTest() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like