Ldap::invokeTest() - Code Metrics - Inspection of "Feature connection contexts" - tvdijen/simplesamlphp-module-monitor - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

by Tim

created 2018-05-07 20:20 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\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 array
     */
    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(is_array($authSourceData));
        assert(is_array($authSourceSpecifics) || is_null($authSourceSpecifics));

        $this->hosts = explode(' ', $authSourceData['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 array $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['port'];

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

        $timeout = isSet($authSourceData['timeout']) ? $authSourceData['timeout'] : null;
        return ['uri' => $uri, 'context' => $context, 'timeout' => $timeout];
    }
}


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

tvdijen / simplesamlphp-module-monitor

Pull Request — master (#6)

Ldap::invokeTest() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like