InstitutionConfigurationController::getAllowedSecondFactorListService() - Code Metrics - Inspection of "Provide a test for retrieving institution config" - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/add-number-of-tokens-t... ( 90db2f )

unknown

created 2018-04-10 13:43 UTC

getAllowedSecondFactorListService() A

↳ Parent: InstitutionConfigurationController

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * Copyright 2016 SURFnet B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Surfnet\StepupMiddleware\ManagementBundle\Controller;

use DateTime;
use Exception;
use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
use Rhumsaa\Uuid\Uuid;
use Surfnet\Stepup\Configuration\Value\Institution;
use Surfnet\Stepup\Helper\JsonHelper;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\AllowedSecondFactorListService;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionConfigurationOptionsService;
use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;

use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\ForbiddenException;
use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
use Symfony\Bridge\Monolog\Logger;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;

/**
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
final class InstitutionConfigurationController extends Controller
{
    public function showAction()
    {
        $this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);

        $institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()

            ->findAllInstitutionConfigurationOptions();

        $allowedSecondFactorMap = $this->getAllowedSecondFactorListService()->getAllowedSecondFactorMap();

        $overview = [];
        foreach ($institutionConfigurationOptions as $options) {
            // Load the numberOfTokensPerIdentity from the institution config options service
            $numberOfTokensPerIdentity = $this->getInstitutionConfigurationOptionsService()
                ->getMaxNumberOfTokensFor(new Institution($options->institution->getInstitution()));

            $overview[$options->institution->getInstitution()] = [
                'use_ra_locations' => $options->useRaLocationsOption,
                'show_raa_contact_information' => $options->showRaaContactInformationOption,
                'verify_email' => $options->verifyEmailOption,
                'number_of_tokens_per_identity' => $numberOfTokensPerIdentity,
                'allowed_second_factors' => $allowedSecondFactorMap->getAllowedSecondFactorListFor(
                    $options->institution
                ),
            ];
        }

        return new JsonResponse($overview);
    }

    public function reconfigureAction(Request $request)
    {
        $this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);

        $configuration = JsonHelper::decode($request->getContent());

        $violations = $this->getValidator()->validate($configuration, new ValidReconfigureInstitutionsRequest());
        if ($violations->count() > 0) {
            throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
        }

        if (empty($configuration)) {
            $this->getLogger()->notice(sprintf('No institutions to reconfigure: empty configuration received'));

            return new JsonResponse([
                'status'       => 'OK',
                'processed_by' =>  $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
                'applied_at'   => (new DateTime())->format(DateTime::ISO8601),
            ]);
        }

        $commands = [];
        foreach ($configuration as $institution => $options) {
            $command                                  = new ReconfigureInstitutionConfigurationOptionsCommand();
            $command->UUID                            = (string) Uuid::uuid4();
            $command->institution                     = $institution;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            $command->useRaLocationsOption            = $options['use_ra_locations'];
            $command->showRaaContactInformationOption = $options['show_raa_contact_information'];
            $command->verifyEmailOption               = $options['verify_email'];
            $command->numberOfTokensPerIdentityOption = $options['number_of_tokens_per_identity'];
            $command->allowedSecondFactors            = $options['allowed_second_factors'];

            $commands[] = $command;
        }

        $this->getLogger()->notice(
            sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
        );

        $this->handleCommands($commands);

        return new JsonResponse([
            'status'       => 'OK',
            'processed_by' =>  $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
            'applied_at'   => (new DateTime())->format(DateTime::ISO8601),
        ]);
    }

    /**
     * @param Command[] $commands
     * @throws Exception
     */
    private function handleCommands(array $commands)
    {
        $pipeline         = $this->getPipeline();
        $connectionHelper = $this->getConnectionHelper();

        $connectionHelper->beginTransaction();

        foreach ($commands as $command) {
            try {
                $pipeline->process($command);
            } catch (ForbiddenException $e) {
                $connectionHelper->rollBack();

                throw new AccessDeniedHttpException(
                    sprintf('Processing of command "%s" is forbidden for this client', $command),
                    $e
                );
            } catch (Exception $exception) {
                $connectionHelper->rollBack();

                throw $exception;
            }
        }

        $connectionHelper->commit();
    }

    /**
     * @return InstitutionConfigurationOptionsService
     */
    private function getInstitutionConfigurationOptionsService()
    {
        return $this->get('surfnet_stepup_middleware_api.service.institution_configuration_options');
    }

    /**
     * @return AllowedSecondFactorListService
     */
    private function getAllowedSecondFactorListService()
    {
        return $this->get('surfnet_stepup_middleware_api.service.allowed_second_factor_list');
    }

    /**
     * @return DataCollectingValidator
     */
    private function getValidator()
    {
        return $this->get('validator');
    }

    /**
     * @return Logger
     */
    private function getLogger()
    {
        return $this->get('logger');
    }

    /**
     * @return Pipeline
     */
    private function getPipeline()
    {
        return $this->get('pipeline');
    }

    /**
     * @return DBALConnectionHelper
     */
    private function getConnectionHelper()
    {
        return $this->get('surfnet_stepup_middleware_management.dbal_connection_helper');
    }
}


1			<?php
2
3			/**
4			* Copyright 2016 SURFnet B.V.
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License");
7			* you may not use this file except in compliance with the License.
8			* You may obtain a copy of the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS,
14			* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15			* See the License for the specific language governing permissions and
16			* limitations under the License.
17			*/
18
19			namespace Surfnet\StepupMiddleware\ManagementBundle\Controller;
20
21			use DateTime;
22			use Exception;
23			use Liip\FunctionalTestBundle\Validator\DataCollectingValidator;
24			use Rhumsaa\Uuid\Uuid;
25			use Surfnet\Stepup\Configuration\Value\Institution;
26			use Surfnet\Stepup\Helper\JsonHelper;
27			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\AllowedSecondFactorListService;
28			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\InstitutionConfigurationOptionsService;
29			use Surfnet\StepupMiddleware\ApiBundle\Exception\BadCommandRequestException;
30			use Surfnet\StepupMiddleware\CommandHandlingBundle\Command\Command;
31			use Surfnet\StepupMiddleware\CommandHandlingBundle\Configuration\Command\ReconfigureInstitutionConfigurationOptionsCommand;
			0 ignored issues – show Coding Style introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 123 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
32			use Surfnet\StepupMiddleware\CommandHandlingBundle\Exception\ForbiddenException;
33			use Surfnet\StepupMiddleware\CommandHandlingBundle\Pipeline\Pipeline;
34			use Surfnet\StepupMiddleware\ManagementBundle\Service\DBALConnectionHelper;
35			use Surfnet\StepupMiddleware\ManagementBundle\Validator\Constraints\ValidReconfigureInstitutionsRequest;
36			use Symfony\Bridge\Monolog\Logger;
37			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
38			use Symfony\Component\HttpFoundation\JsonResponse;
39			use Symfony\Component\HttpFoundation\Request;
40			use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
41
42			/**
43			* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
44			*/
45			final class InstitutionConfigurationController extends Controller
46			{
47			public function showAction()
48			{
49			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
50
51			$institutionConfigurationOptions = $this->getInstitutionConfigurationOptionsService()
			0 ignored issues – show Comprehensibility Naming introduced 2016-07-29 08:48 UTC by Report Bug Copy Issue Report The variable name `$institutionConfigurationOptions` exceeds the maximum configured length of `30`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
52			->findAllInstitutionConfigurationOptions();
53
54			$allowedSecondFactorMap = $this->getAllowedSecondFactorListService()->getAllowedSecondFactorMap();
55
56			$overview = [];
57			foreach ($institutionConfigurationOptions as $options) {
58			// Load the numberOfTokensPerIdentity from the institution config options service
59			$numberOfTokensPerIdentity = $this->getInstitutionConfigurationOptionsService()
60			->getMaxNumberOfTokensFor(new Institution($options->institution->getInstitution()));
61
62			$overview[$options->institution->getInstitution()] = [
63			'use_ra_locations' => $options->useRaLocationsOption,
64			'show_raa_contact_information' => $options->showRaaContactInformationOption,
65			'verify_email' => $options->verifyEmailOption,
66			'number_of_tokens_per_identity' => $numberOfTokensPerIdentity,
67			'allowed_second_factors' => $allowedSecondFactorMap->getAllowedSecondFactorListFor(
68			$options->institution
69			),
70			];
71			}
72
73			return new JsonResponse($overview);
74			}
75
76			public function reconfigureAction(Request $request)
77			{
78			$this->denyAccessUnlessGranted(['ROLE_MANAGEMENT']);
79
80			$configuration = JsonHelper::decode($request->getContent());
81
82			$violations = $this->getValidator()->validate($configuration, new ValidReconfigureInstitutionsRequest());
83			if ($violations->count() > 0) {
84			throw BadCommandRequestException::withViolations('Invalid reconfigure institutions request', $violations);
85			}
86
87			if (empty($configuration)) {
88			$this->getLogger()->notice(sprintf('No institutions to reconfigure: empty configuration received'));
89
90			return new JsonResponse([
91			'status' => 'OK',
92			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
93			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
94			]);
95			}
96
97			$commands = [];
98			foreach ($configuration as $institution => $options) {
99			$command = new ReconfigureInstitutionConfigurationOptionsCommand();
100			$command->UUID = (string) Uuid::uuid4();
101			$command->institution = $institution;
			0 ignored issues – show Documentation Bug introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report It seems like `$institution` can also be of type `integer`. However, the property `$institution` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
102			$command->useRaLocationsOption = $options['use_ra_locations'];
103			$command->showRaaContactInformationOption = $options['show_raa_contact_information'];
104			$command->verifyEmailOption = $options['verify_email'];
105			$command->numberOfTokensPerIdentityOption = $options['number_of_tokens_per_identity'];
106			$command->allowedSecondFactors = $options['allowed_second_factors'];
107
108			$commands[] = $command;
109			}
110
111			$this->getLogger()->notice(
112			sprintf('Executing %s reconfigure institution configuration options commands', count($commands))
113			);
114
115			$this->handleCommands($commands);
116
117			return new JsonResponse([
118			'status' => 'OK',
119			'processed_by' => $request->server->get('SERVER_NAME') ?: $request->server->get('SERVER_ADDR'),
120			'applied_at' => (new DateTime())->format(DateTime::ISO8601),
121			]);
122			}
123
124			/**
125			* @param Command[] $commands
126			* @throws Exception
127			*/
128			private function handleCommands(array $commands)
129			{
130			$pipeline = $this->getPipeline();
131			$connectionHelper = $this->getConnectionHelper();
132
133			$connectionHelper->beginTransaction();
134
135			foreach ($commands as $command) {
136			try {
137			$pipeline->process($command);
138			} catch (ForbiddenException $e) {
139			$connectionHelper->rollBack();
140
141			throw new AccessDeniedHttpException(
142			sprintf('Processing of command "%s" is forbidden for this client', $command),
143			$e
144			);
145			} catch (Exception $exception) {
146			$connectionHelper->rollBack();
147
148			throw $exception;
149			}
150			}
151
152			$connectionHelper->commit();
153			}
154
155			/**
156			* @return InstitutionConfigurationOptionsService
157			*/
158			private function getInstitutionConfigurationOptionsService()
159			{
160			return $this->get('surfnet_stepup_middleware_api.service.institution_configuration_options');
161			}
162
163			/**
164			* @return AllowedSecondFactorListService
165			*/
166			private function getAllowedSecondFactorListService()
167			{
168			return $this->get('surfnet_stepup_middleware_api.service.allowed_second_factor_list');
169			}
170
171			/**
172			* @return DataCollectingValidator
173			*/
174			private function getValidator()
175			{
176			return $this->get('validator');
177			}
178
179			/**
180			* @return Logger
181			*/
182			private function getLogger()
183			{
184			return $this->get('logger');
185			}
186
187			/**
188			* @return Pipeline
189			*/
190			private function getPipeline()
191			{
192			return $this->get('pipeline');
193			}
194
195			/**
196			* @return DBALConnectionHelper
197			*/
198			private function getConnectionHelper()
199			{
200			return $this->get('surfnet_stepup_middleware_management.dbal_connection_helper');
201			}
202			}
203

OpenConext / Stepup-Middleware

Push — feature/add-number-of-tokens-t... ( 90db2f )

getAllowedSecondFactorListService() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like