ReconfigureInstitutionRequestValidator::validateInstitutionsExist() - Code Metrics - Inspection of "Merge pull request #186 from OpenConext/bugfix/ins..." - OpenConext/Stepup-Middleware - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 86d803...16ff4f )

by A.

created 2017-02-16 10:09 UTC

validateInstitutionsExist() A

↳ Parent: ReconfigureInstitutionRequestValidator

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	1

<?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\Validator;

use Assert\Assertion;
use Assert\InvalidArgumentException as AssertionException;
use InvalidArgumentException as CoreInvalidArgumentException;
use Surfnet\StepupBundle\Value\SecondFactorType;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Entity\ConfiguredInstitution;
use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\ConfiguredInstitutionService;
use Surfnet\StepupMiddleware\ManagementBundle\Exception\InvalidArgumentException;
use Surfnet\StepupMiddleware\ManagementBundle\Validator\Assert as StepupAssert;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;

final class ReconfigureInstitutionRequestValidator extends ConstraintValidator
{
    /**
     * @var ConfiguredInstitutionService
     */
    private $configuredInstitutionsService;

    /**
     * @var string[] internal cache, access through getConfiguredInstitutions()
     */
    private $configuredInstitutions;

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

    public function validate($value, Constraint $constraint)
    {
        /** @var \Symfony\Component\Validator\Violation\ConstraintViolationBuilder|false $violation */
        $violation = false;

        try {
            $this->validateRoot($value);
        } catch (AssertionException $exception) {
            // method is not in the interface yet, but the old method is deprecated.
            $violation = $this->context->buildViolation($exception->getMessage());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            $violation->atPath($exception->getPropertyPath());
        } catch (CoreInvalidArgumentException $exception) {
            $violation = $this->context->buildViolation($exception->getMessage());
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }

        if ($violation) {
            $violation->addViolation();
        }
    }

    public function validateRoot(array $configuration)
    {
        Assertion::isArray($configuration, 'Invalid body structure, must be an object', '(root)');
        $this->validateInstitutionsExist(array_keys($configuration));

        foreach ($configuration as $institution => $options) {
            $this->validateInstitutionConfigurationOptions($options, $institution);
        }
    }

    /**
     * @param array $institutions
     */
    public function validateInstitutionsExist(array $institutions)
    {
        $configuredInstitutions = $this->getConfiguredInstitutions();

        $nonExistentInstitutions = $this->determineNonExistentInstitutions($institutions, $configuredInstitutions);

        if (!empty($nonExistentInstitutions)) {
            throw new InvalidArgumentException(
                sprintf('Cannot reconfigure non-existent institution(s): %s', implode(', ', $nonExistentInstitutions))
            );
        }
    }

    /**
     * @param array $options
     * @param string $institution
     */
    public function validateInstitutionConfigurationOptions($options, $institution)
    {
        $propertyPath = sprintf('Institution(%s)', $institution);

        Assertion::isArray($options, 'Invalid institution configuration, must be an object', $propertyPath);

        $acceptedOptions = ['use_ra_locations', 'show_raa_contact_information', 'allowed_second_factors'];
        StepupAssert::keysMatch(
            $options,
            $acceptedOptions,
            sprintf('Expected only options "%s" for "%s"', join(', ', $acceptedOptions), $institution),
            $propertyPath
        );

        Assertion::boolean(
            $options['use_ra_locations'],
            sprintf('Option "use_ra_locations" for "%s" must be a boolean value', $institution),
            $propertyPath
        );

        Assertion::boolean(
            $options['show_raa_contact_information'],
            sprintf('Option "show_raa_contact_information" for "%s" must be a boolean value', $institution),
            $propertyPath
        );

        Assertion::isArray(
            $options['allowed_second_factors'],
            sprintf('Option "allowed_second_factors" for "%s" must be an array of strings', $institution),
            $propertyPath
        );
        Assertion::allString(
            $options['allowed_second_factors'],
            sprintf('Option "allowed_second_factors" for "%s" must be an array of strings', $institution),
            $propertyPath
        );
        Assertion::allInArray(
            $options['allowed_second_factors'],
            SecondFactorType::getAvailableSecondFactorTypes(),
            'Option "allowed_second_factors" for "%s" must contain valid second factor types',
            $propertyPath
        );
    }

    /**
     * Accessor for configured institutions to be able to use an internal cache
     *
     * @return string[]
     */
    private function getConfiguredInstitutions()
    {
        if (!empty($this->configuredInstitutions)) {
            return $this->configuredInstitutions;
        }

        $this->configuredInstitutions = array_map(
            function (ConfiguredInstitution $configuredInstitution) {
                return $configuredInstitution->institution->getInstitution();
            },
            $this->configuredInstitutionsService->getAll()
        );

        return $this->configuredInstitutions;
    }

    /**
     * @param string[] $institutions
     * @param $configuredInstitutions
     * @return string[]
     */
    public function determineNonExistentInstitutions(array $institutions, $configuredInstitutions)
    {
        $normalizedConfiguredInstitutions = array_map(

            function ($institution) {
                return strtolower($institution);
            },
            $configuredInstitutions
        );

        return array_filter(
            $institutions,
            function ($institution) use ($normalizedConfiguredInstitutions) {
                $normalizedInstitution = strtolower($institution);

                return !in_array($normalizedInstitution, $normalizedConfiguredInstitutions);
            }
        );
    }
}


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\Validator;
20
21			use Assert\Assertion;
22			use Assert\InvalidArgumentException as AssertionException;
23			use InvalidArgumentException as CoreInvalidArgumentException;
24			use Surfnet\StepupBundle\Value\SecondFactorType;
25			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Entity\ConfiguredInstitution;
26			use Surfnet\StepupMiddleware\ApiBundle\Configuration\Service\ConfiguredInstitutionService;
27			use Surfnet\StepupMiddleware\ManagementBundle\Exception\InvalidArgumentException;
28			use Surfnet\StepupMiddleware\ManagementBundle\Validator\Assert as StepupAssert;
29			use Symfony\Component\Validator\Constraint;
30			use Symfony\Component\Validator\ConstraintValidator;
31
32			final class ReconfigureInstitutionRequestValidator extends ConstraintValidator
33			{
34			/**
35			* @var ConfiguredInstitutionService
36			*/
37			private $configuredInstitutionsService;
38
39			/**
40			* @var string[] internal cache, access through getConfiguredInstitutions()
41			*/
42			private $configuredInstitutions;
43
44			public function __construct(ConfiguredInstitutionService $configuredInstitutionsService)
45			{
46			$this->configuredInstitutionsService = $configuredInstitutionsService;
47			}
48
49			public function validate($value, Constraint $constraint)
50			{
51			/** @var \Symfony\Component\Validator\Violation\ConstraintViolationBuilder\|false $violation */
52			$violation = false;
53
54			try {
55			$this->validateRoot($value);
56			} catch (AssertionException $exception) {
57			// method is not in the interface yet, but the old method is deprecated.
58			$violation = $this->context->buildViolation($exception->getMessage());
			0 ignored issues – show Bug introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Valida...ecutionContextInterface` as the method `buildViolation()` does only exist in the following implementations of said interface: `Symfony\Component\Valida...ontext\ExecutionContext`, `Symfony\Component\Valida...\LegacyExecutionContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
59			$violation->atPath($exception->getPropertyPath());
60			} catch (CoreInvalidArgumentException $exception) {
61			$violation = $this->context->buildViolation($exception->getMessage());
			0 ignored issues – show Bug introduced 2016-07-26 14:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Valida...ecutionContextInterface` as the method `buildViolation()` does only exist in the following implementations of said interface: `Symfony\Component\Valida...ontext\ExecutionContext`, `Symfony\Component\Valida...\LegacyExecutionContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
62			}
63
64			if ($violation) {
65			$violation->addViolation();
66			}
67			}
68
69			public function validateRoot(array $configuration)
70			{
71			Assertion::isArray($configuration, 'Invalid body structure, must be an object', '(root)');
72			$this->validateInstitutionsExist(array_keys($configuration));
73
74			foreach ($configuration as $institution => $options) {
75			$this->validateInstitutionConfigurationOptions($options, $institution);
76			}
77			}
78
79			/**
80			* @param array $institutions
81			*/
82			public function validateInstitutionsExist(array $institutions)
83			{
84			$configuredInstitutions = $this->getConfiguredInstitutions();
85
86			$nonExistentInstitutions = $this->determineNonExistentInstitutions($institutions, $configuredInstitutions);
87
88			if (!empty($nonExistentInstitutions)) {
89			throw new InvalidArgumentException(
90			sprintf('Cannot reconfigure non-existent institution(s): %s', implode(', ', $nonExistentInstitutions))
91			);
92			}
93			}
94
95			/**
96			* @param array $options
97			* @param string $institution
98			*/
99			public function validateInstitutionConfigurationOptions($options, $institution)
100			{
101			$propertyPath = sprintf('Institution(%s)', $institution);
102
103			Assertion::isArray($options, 'Invalid institution configuration, must be an object', $propertyPath);
104
105			$acceptedOptions = ['use_ra_locations', 'show_raa_contact_information', 'allowed_second_factors'];
106			StepupAssert::keysMatch(
107			$options,
108			$acceptedOptions,
109			sprintf('Expected only options "%s" for "%s"', join(', ', $acceptedOptions), $institution),
110			$propertyPath
111			);
112
113			Assertion::boolean(
114			$options['use_ra_locations'],
115			sprintf('Option "use_ra_locations" for "%s" must be a boolean value', $institution),
116			$propertyPath
117			);
118
119			Assertion::boolean(
120			$options['show_raa_contact_information'],
121			sprintf('Option "show_raa_contact_information" for "%s" must be a boolean value', $institution),
122			$propertyPath
123			);
124
125			Assertion::isArray(
126			$options['allowed_second_factors'],
127			sprintf('Option "allowed_second_factors" for "%s" must be an array of strings', $institution),
128			$propertyPath
129			);
130			Assertion::allString(
131			$options['allowed_second_factors'],
132			sprintf('Option "allowed_second_factors" for "%s" must be an array of strings', $institution),
133			$propertyPath
134			);
135			Assertion::allInArray(
136			$options['allowed_second_factors'],
137			SecondFactorType::getAvailableSecondFactorTypes(),
138			'Option "allowed_second_factors" for "%s" must contain valid second factor types',
139			$propertyPath
140			);
141			}
142
143			/**
144			* Accessor for configured institutions to be able to use an internal cache
145			*
146			* @return string[]
147			*/
148			private function getConfiguredInstitutions()
149			{
150			if (!empty($this->configuredInstitutions)) {
151			return $this->configuredInstitutions;
152			}
153
154			$this->configuredInstitutions = array_map(
155			function (ConfiguredInstitution $configuredInstitution) {
156			return $configuredInstitution->institution->getInstitution();
157			},
158			$this->configuredInstitutionsService->getAll()
159			);
160
161			return $this->configuredInstitutions;
162			}
163
164			/**
165			* @param string[] $institutions
166			* @param $configuredInstitutions
167			* @return string[]
168			*/
169			public function determineNonExistentInstitutions(array $institutions, $configuredInstitutions)
170			{
171			$normalizedConfiguredInstitutions = array_map(
			0 ignored issues – show Comprehensibility Naming introduced 2017-02-16 09:44 UTC by Report Bug Copy Issue Report The variable name `$normalizedConfiguredInstitutions` 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...
172			function ($institution) {
173			return strtolower($institution);
174			},
175			$configuredInstitutions
176			);
177
178			return array_filter(
179			$institutions,
180			function ($institution) use ($normalizedConfiguredInstitutions) {
181			$normalizedInstitution = strtolower($institution);
182
183			return !in_array($normalizedInstitution, $normalizedConfiguredInstitutions);
184			}
185			);
186			}
187			}
188

OpenConext / Stepup-Middleware

Push — develop ( 86d803...16ff4f )

validateInstitutionsExist() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like