AuthenticationService::validateTicketTrackingPlatform() - Code Metrics - Inspection of "Authentication Service introduced" - zelaznymarek/app-builder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4cb925...613187 )

by Marek

created 2017-06-22 12:41 UTC

validateTicketTrackingPlatform() A

↳ Parent: AuthenticationService

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	19
c	0
b	0
f	0
ccs	11
cts	11
cp	1
rs	9.4285
cc	3
eloc	12
nc	3
nop	0
crap	3

<?php

declare(strict_types = 1);

namespace AppBuilder\Application\Configuration;

use AppBuilder\Application\Configuration\ValueObject\Parameters;
use AppBuilder\Application\Module\HttpClient\ExternalLibraryHttpClient;
use AppBuilder\Application\Module\Jira\QueryRepository;
use AppBuilder\Application\Utils\FileManager\FileManagerService;
use AppBuilder\Event\Application\ApplicationInitializedEvent;
use AppBuilder\Event\Application\ApplicationInitializedEventAware;
use AppBuilder\Event\Application\CredentialsValidatedEvent;
use Exception;
use FileNotFoundException;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ConnectException;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Filesystem\Exception\IOException;

class AuthenticationService implements Authentication, ApplicationInitializedEventAware
{
    private const HTTP_OK = 200;
    /** @var QueryRepository */
    private $queryRepository;

    /** @var ExternalLibraryHttpClient */
    private $httpClient;

    /** @var FileManagerService */
    private $fileManager;

    /** @var LoggerInterface */
    private $logger;

    /** @var EventDispatcherInterface */
    private $dispatcher;

    public function __construct(
        QueryRepository $queryRepository,
        ExternalLibraryHttpClient $httpClient,
        FileManagerService $fileManager,
        LoggerInterface $logger,
        EventDispatcherInterface $dispatcher
    ) {
        $this->queryRepository = $queryRepository;
        $this->httpClient      = $httpClient;
        $this->fileManager     = $fileManager;
        $this->logger          = $logger;
        $this->dispatcher      = $dispatcher;
    }

    public function onApplicationInitialized(ApplicationInitializedEvent $event = null) : void
    {
        if ($this->hasProperAccess()) {
            $this->dispatcher->dispatch(
                CredentialsValidatedEvent::NAME,
                new CredentialsValidatedEvent()
            );
        }
    }

    /**
     * Checks wether you have permission to access chosen ticket tracking platform.
     */
    public function validateTicketTrackingPlatform() : bool
    {
        try {
            $this->httpClient->request(
                ExternalLibraryHttpClient::GET,
                $this->createUrl($this->queryRepository->validateCredentials())
            );
        } catch (ClientException $exception) {
            $this->logger->critical('Invalid login or password');

            return false;
        } catch (ConnectException $exception) {
            $this->logger->critical('Invalid host');

            return false;
        }

        return true;
    }

    /**
     * Checks wether you have permission to access chosen git platform.
     *
     * @throws ClientException
     */
    public function validateGitPlatform() : bool
    {
        /** @var string */
        $bitbucketPath = '/bitbucket';

        try {
            $response = $this->httpClient->request(
                ExternalLibraryHttpClient::GET,
                $bitbucketPath
            );

            if (self::HTTP_OK !== $response->getStatusCode()) {
                $this->logger->warning('Failed to login Bitbucket.');

                return false;
            }
        } catch (ClientException $exception) {
            $this->logger->warning(
                sprintf(
                    'Failed to login Bitbucket. %s ',
                    $exception->getMessage()
                )
            );

            return false;
        }

        return true;
    }

    /**
     * Checks wether you have permission to access filesystem.
     */
    public function validateFilesystem() : bool
    {
        /** @var Parameters */
        $applicationParams = $this->httpClient->applicationParams();

        /** @var string */
        $fakeKey = 'fakeKey';

        /** @var string */
        $projectHomedir = $applicationParams->path($fakeKey);

        /** @var string */
        $snapshot = $applicationParams->snapshotPath('fakeKey');

        /** @var string */
        $symlinkTarget = $applicationParams->symlinkTarget($fakeKey);

        /** @var string */
        $symlinkSource = $applicationParams->symlinkSource($fakeKey);

        /** @var string */
        $fakeContent = 'content';

        try {
            return $this->createDirectories($projectHomedir, $symlinkTarget)
                && $this->createFiles($snapshot, $fakeContent, $symlinkTarget, $symlinkSource)
                && $this->removeFilesAndDirs($projectHomedir, $symlinkTarget, $snapshot);
        } catch (Exception $exception) {
            $this->logger->critical('Filesystem error: ' . $exception->getMessage());

            return false;
        }
    }

    private function hasProperAccess() : bool
    {
        return $this->validateTicketTrackingPlatform()
            && $this->validateGitPlatform()
            && $this->validateFilesystem();
    }

    /**
     * Combines jira rest api url with jql.
     */
    private function createUrl(string $jql) : string
    {
        return $this->httpClient->applicationParams()->jiraHost()
            . '/rest/api/2/search?jql='
            . $jql
            . '&maxResults='
            . $this->httpClient->applicationParams()->jiraSearchMaxResults();
    }

    /**
     * Check wether user has permissions to create necessary directories.
     * Returns true if yes, false otherwise.
     */
    private function createDirectories(string $projectHomedir, string $symlinkTarget) : bool
    {
        return $this->fileManager->createDir($projectHomedir)
            && $this->fileManager->createDir($symlinkTarget);
    }

    /**
     * Check wether user has permissions to create necessary files.
     * Tries to write to and read from file.
     * Returns true if yes, false otherwise.
     *
     * @throws IOException
     * @throws FileNotFoundException
     */
    private function createFiles(
        string $snapshot,
        string $fakeContent,
        string $symlinkTarget,
        string $symlinkSource
    ) : bool {
        return $this->fileManager->filePutContent($snapshot, $fakeContent)
            && $this->fileManager->fileGetContent($snapshot) === $fakeContent
            && $this->fileManager->createSymlink($symlinkTarget, $symlinkSource);
    }

    /**
     * Check wether user has permissions to remove necessary directories and files.
     * Returns true if yes, false otherwise.
     *
     * @throws IOException
     */
    private function removeFilesAndDirs(string $projectHomedir, string $symlinkTarget, string $snapshot) : bool
    {
        $this->fileManager->remove($symlinkTarget);
        $this->fileManager->removeFile($snapshot);
        $this->fileManager->remove($projectHomedir);

        return !$this->fileManager->fileExists($snapshot)
            && !$this->fileManager->fileExists($projectHomedir);
    }
}


1		<?php
2
3		declare(strict_types = 1);
4
5		namespace AppBuilder\Application\Configuration;
6
7		use AppBuilder\Application\Configuration\ValueObject\Parameters;
8		use AppBuilder\Application\Module\HttpClient\ExternalLibraryHttpClient;
9		use AppBuilder\Application\Module\Jira\QueryRepository;
10		use AppBuilder\Application\Utils\FileManager\FileManagerService;
11		use AppBuilder\Event\Application\ApplicationInitializedEvent;
12		use AppBuilder\Event\Application\ApplicationInitializedEventAware;
13		use AppBuilder\Event\Application\CredentialsValidatedEvent;
14		use Exception;
15		use FileNotFoundException;
16		use GuzzleHttp\Exception\ClientException;
17		use GuzzleHttp\Exception\ConnectException;
18		use Psr\Log\LoggerInterface;
19		use Symfony\Component\EventDispatcher\EventDispatcherInterface;
20		use Symfony\Component\Filesystem\Exception\IOException;
21
22		class AuthenticationService implements Authentication, ApplicationInitializedEventAware
23		{
24		private const HTTP_OK = 200;
25		/** @var QueryRepository */
26		private $queryRepository;
27
28		/** @var ExternalLibraryHttpClient */
29		private $httpClient;
30
31		/** @var FileManagerService */
32		private $fileManager;
33
34		/** @var LoggerInterface */
35		private $logger;
36
37		/** @var EventDispatcherInterface */
38		private $dispatcher;
39
40	10	public function __construct(
41		QueryRepository $queryRepository,
42		ExternalLibraryHttpClient $httpClient,
43		FileManagerService $fileManager,
44		LoggerInterface $logger,
45		EventDispatcherInterface $dispatcher
46		) {
47	10	$this->queryRepository = $queryRepository;
48	10	$this->httpClient = $httpClient;
49	10	$this->fileManager = $fileManager;
50	10	$this->logger = $logger;
51	10	$this->dispatcher = $dispatcher;
52	10	}
53
54	1	public function onApplicationInitialized(ApplicationInitializedEvent $event = null) : void
55		{
56	1	if ($this->hasProperAccess()) {
57	1	$this->dispatcher->dispatch(
58	1	CredentialsValidatedEvent::NAME,
59	1	new CredentialsValidatedEvent()
60		);
61		}
62	1	}
63
64		/**
65		* Checks wether you have permission to access chosen ticket tracking platform.
66		*/
67	4	public function validateTicketTrackingPlatform() : bool
68		{
69		try {
70	4	$this->httpClient->request(
71	4	ExternalLibraryHttpClient::GET,
72	4	$this->createUrl($this->queryRepository->validateCredentials())
73		);
74	2	} catch (ClientException $exception) {
75	1	$this->logger->critical('Invalid login or password');
76
77	1	return false;
78	1	} catch (ConnectException $exception) {
79	1	$this->logger->critical('Invalid host');
80
81	1	return false;
82		}
83
84	2	return true;
85		}
86
87		/**
88		* Checks wether you have permission to access chosen git platform.
89		*
90		* @throws ClientException
91		*/
92	4	public function validateGitPlatform() : bool
93		{
94		/** @var string */
95	4	$bitbucketPath = '/bitbucket';
96
97		try {
98	4	$response = $this->httpClient->request(
99	4	ExternalLibraryHttpClient::GET,
100		$bitbucketPath
101		);
102
103	3	if (self::HTTP_OK !== $response->getStatusCode()) {
104	1	$this->logger->warning('Failed to login Bitbucket.');
105
106	3	return false;
107		}
108	1	} catch (ClientException $exception) {
109	1	$this->logger->warning(
110		sprintf(
111	1	'Failed to login Bitbucket. %s ',
112	1	$exception->getMessage()
113		)
114		);
115
116	1	return false;
117		}
118
119	2	return true;
120		}
121
122		/**
123		* Checks wether you have permission to access filesystem.
124		*/
125	4	public function validateFilesystem() : bool
126		{
127		/** @var Parameters */
128	4	$applicationParams = $this->httpClient->applicationParams();
129
130		/** @var string */
131	4	$fakeKey = 'fakeKey';
132
133		/** @var string */
134	4	$projectHomedir = $applicationParams->path($fakeKey);
135
136		/** @var string */
137	4	$snapshot = $applicationParams->snapshotPath('fakeKey');
138
139		/** @var string */
140	4	$symlinkTarget = $applicationParams->symlinkTarget($fakeKey);
141
142		/** @var string */
143	4	$symlinkSource = $applicationParams->symlinkSource($fakeKey);
144
145		/** @var string */
146	4	$fakeContent = 'content';
147
148		try {
149	4	return $this->createDirectories($projectHomedir, $symlinkTarget)
150	4	&& $this->createFiles($snapshot, $fakeContent, $symlinkTarget, $symlinkSource)
151	2	&& $this->removeFilesAndDirs($projectHomedir, $symlinkTarget, $snapshot);
152	2	} catch (Exception $exception) {
153	2	$this->logger->critical('Filesystem error: ' . $exception->getMessage());
154
155	2	return false;
156		}
157		}
158
159	1	private function hasProperAccess() : bool
160		{
161	1	return $this->validateTicketTrackingPlatform()
162	1	&& $this->validateGitPlatform()
163	1	&& $this->validateFilesystem();
164		}
165
166		/**
167		* Combines jira rest api url with jql.
168		*/
169	4	private function createUrl(string $jql) : string
170		{
171	4	return $this->httpClient->applicationParams()->jiraHost()
172	4	. '/rest/api/2/search?jql='
173	4	. $jql
174	4	. '&maxResults='
175	4	. $this->httpClient->applicationParams()->jiraSearchMaxResults();
176		}
177
178		/**
179		* Check wether user has permissions to create necessary directories.
180		* Returns true if yes, false otherwise.
181		*/
182	4	private function createDirectories(string $projectHomedir, string $symlinkTarget) : bool
183		{
184	4	return $this->fileManager->createDir($projectHomedir)
185	4	&& $this->fileManager->createDir($symlinkTarget);
186		}
187
188		/**
189		* Check wether user has permissions to create necessary files.
190		* Tries to write to and read from file.
191		* Returns true if yes, false otherwise.
192		*
193		* @throws IOException
194		* @throws FileNotFoundException
195		*/
196	4	private function createFiles(
197		string $snapshot,
198		string $fakeContent,
199		string $symlinkTarget,
200		string $symlinkSource
201		) : bool {
202	4	return $this->fileManager->filePutContent($snapshot, $fakeContent)
203	3	&& $this->fileManager->fileGetContent($snapshot) === $fakeContent
204	2	&& $this->fileManager->createSymlink($symlinkTarget, $symlinkSource);
205		}
206
207		/**
208		* Check wether user has permissions to remove necessary directories and files.
209		* Returns true if yes, false otherwise.
210		*
211		* @throws IOException
212		*/
213	2	private function removeFilesAndDirs(string $projectHomedir, string $symlinkTarget, string $snapshot) : bool
214		{
215	2	$this->fileManager->remove($symlinkTarget);
216	2	$this->fileManager->removeFile($snapshot);
217	2	$this->fileManager->remove($projectHomedir);
218
219	2	return !$this->fileManager->fileExists($snapshot)
220	2	&& !$this->fileManager->fileExists($projectHomedir);
221		}
222		}
223

zelaznymarek / app-builder

Push — master ( 4cb925...613187 )

validateTicketTrackingPlatform() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like