Improve (#5)

Author: yoanm

.scrutinizer.yml

@@ -15,14 +15,14 @@ build:
     tests:
         stop_on_failure: true
         override:
-            - php-scrutinizer-run --enable-security-analysis
-            - make codestyle
             -
                 command: make coverage
                 idle_timeout: 1200
                 coverage:
                     file: 'build/coverage/clover.xml'
                     format: 'php-clover'
+            - php-scrutinizer-run --enable-security-analysis
+            - make codestyle
     cache:
         directories:
             - ~/.composer

.travis.yml

@@ -1,16 +1,19 @@
 language: php
 
 php:
-  - '7.0'
   - '7.1'
   - '7.2'
+  - '7.3'
 
 env:
   global:
     CI: 'true'
     TEST_OUTPUT_STYLE: 'pretty'
     PHPCS_REPORT_STYLE: 'full'
     COMPOSER_OPTIONS: '--optimize-autoloader'
+  matrix:
+  - SYMFONY_VERSION: '~3.0'
+  - SYMFONY_VERSION: '~4.0'
 
 sudo: false
 
@@ -19,9 +22,10 @@ matrix:
 
 before_install:
   # remove xdebug to speed up build
-  - phpenv config-rm xdebug.ini
+  - phpenv config-rm xdebug.ini || true
 
 install:
+  - composer require symfony/validator:$SYMFONY_VERSION
   - make build
 script:
   - make test-technical

composer.json

@@ -21,11 +21,12 @@
     "autoload-dev": {
         "psr-4": {
             "Tests\\": "tests",
-            "Tests\\Functional\\BehatContext\\": "features/bootstrap"
+            "Tests\\Functional\\BehatContext\\": "features/bootstrap",
+            "DemoApp\\": "features/demo_app/src"
         }
     },
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.1",
         "yoanm/jsonrpc-server-sdk": "dev-release/3.0.0",
         "symfony/validator": "^3.0 || ^4.0"
     },

features/bootstrap/FeatureContext.php

@@ -2,11 +2,86 @@
 namespace Tests\Functional\BehatContext;
 
 use Behat\Behat\Context\Context;
+use Behat\Behat\Context\Environment\InitializedContextEnvironment;
+use Behat\Behat\Hook\Scope\BeforeScenarioScope;
+use Behat\Gherkin\Node\PyStringNode;
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\Constraint\IsIdentical;
+use Prophecy\Argument;
+use Symfony\Component\Validator\ValidatorBuilder;
+use Tests\Functional\BehatContext\App\FakeEndpointCreator;
+use Yoanm\JsonRpcParamsSymfonyValidator\Infra\JsonRpcParamsValidator;
+use Yoanm\JsonRpcServer\Domain\Model\JsonRpcRequest;
 
 /**
  * Defines application features from the specific context.
  */
 class FeatureContext implements Context
 {
+    /** @var array */
+    private $lastViolationList = [];
 
+    /**
+     * @When I validate method :methodClass with:
+     */
+    public function whenIValidateMethodWith($methodClass, PyStringNode $payload)
+    {
+        $jsonRpcRequest = new JsonRpcRequest('2.0', $methodClass);
+        $jsonRpcRequest->setParamList(json_decode($payload->getRaw(), true));
+
+        $this->lastViolationList = $this->getValidator()->validate($jsonRpcRequest, new $methodClass);
+    }
+
+    /**
+     * @Then I should have no violation
+     */
+    public function thenIShouldHaveNoViolation()
+    {
+        Assert::assertEmpty($this->lastViolationList);
+    }
+
+    /**
+     * @Then I should have 1 violation
+     * @Then I should have :count violations
+     */
+    public function thenIShouldHaveXViolation($count = 1)
+    {
+        Assert::assertCount((int) $count, $this->lastViolationList);
+    }
+
+    /**
+     * @Then I should have the following validation error:
+     * @param PyStringNode $node
+     */
+    public function thenIShouldHaveTheFollowingViolation(PyStringNode $node)
+    {
+        $found = false;
+        $decoded = json_decode($node->getRaw(), true);
+        $constraint = new IsIdentical($decoded);
+        foreach ($this->lastViolationList as $violation) {
+            if (true === $constraint->evaluate($violation, '', true)) {
+                $found = true;
+                break;
+            }
+        }
+
+        if (true !== $found) {
+            throw new \Exception(
+                sprintf(
+                    'Violation "%s" not found in violation list : %s',
+                    json_encode($decoded),
+                    json_encode($this->lastViolationList)
+                )
+            );
+        }
+    }
+    /**
+     * @return JsonRpcParamsValidator
+     */
+    private function getValidator() : JsonRpcParamsValidator
+    {
+        return new JsonRpcParamsValidator(
+            (new ValidatorBuilder())->getValidator()
+        );
+    }
 }

features/demo_app/src/Method/BasicMethod.php

@@ -0,0 +1,15 @@
+<?php
+namespace DemoApp\Method;
+
+use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface;
+
+class BasicMethod implements JsonRpcMethodInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function apply(array $paramList = null)
+    {
+        return 'basic-method-result';
+    }
+}

features/demo_app/src/Method/BasicMethodWithRequiredParams.php

@@ -0,0 +1,34 @@
+<?php
+namespace DemoApp\Method;
+
+use Symfony\Component\Validator\Constraint;
+use Symfony\Component\Validator\Constraints\Collection;
+use Symfony\Component\Validator\Constraints\NotBlank;
+use Symfony\Component\Validator\Constraints\NotNull;
+use Yoanm\JsonRpcParamsSymfonyValidator\Domain\MethodWithValidatedParamsInterface;
+use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface;
+
+class BasicMethodWithRequiredParams implements JsonRpcMethodInterface, MethodWithValidatedParamsInterface
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function apply(array $paramList = null)
+    {
+        return 'basic-method-with-params-result';
+    }
+
+    public function getParamsConstraint(): Constraint
+    {
+        return new Collection(
+            [
+                'fields' => [
+                    'fieldA' => new NotNull(),
+                    'fieldB' => new NotBlank(),
+                ],
+                'allowExtraFields' => false,
+                'allowMissingFields' => false,
+            ]
+        );
+    }
+}

features/validator.feature

@@ -0,0 +1,47 @@
+Feature: Validator
+
+  Scenario: Validator should do nothing for method which does not implement right interface
+    When I validate method "DemoApp\Method\BasicMethod" with:
+    """
+    {
+      "fieldA": "A",
+      "unknownField": "B"
+    }
+    """
+    Then I should have no violation
+
+  Scenario: Validator should return an empty list if there is no violations
+    When I validate method "DemoApp\Method\BasicMethodWithRequiredParams" with:
+    """
+    {
+      "fieldA": "plop",
+      "fieldB": "plip"
+    }
+    """
+    Then I should have no violation
+
+  Scenario: Validator should return list of violations if there is some
+    When I validate method "DemoApp\Method\BasicMethodWithRequiredParams" with:
+    """
+    {
+      "fieldA": null,
+      "fieldB": ""
+    }
+    """
+    Then I should have 2 violations
+    And I should have the following validation error:
+    """
+    {
+      "path": "[fieldA]",
+      "message": "This value should not be null.",
+      "code": "ad32d13f-c3d4-423b-909a-857b961eb720"
+    }
+    """
+    And I should have the following validation error:
+    """
+    {
+      "path": "[fieldB]",
+      "message": "This value should not be blank.",
+      "code":"c1051bb4-d103-4f74-8988-acbcafc7fdc3"
+    }
+    """

phpunit.xml.dist

@@ -8,9 +8,6 @@
          processIsolation="false"
 
          stopOnRisky="true"
-         processUncoveredFilesFromWhitelist="true"
-         addUncoveredFilesFromWhitelist="true"
-         checkForUnintentionallyCoveredCode="true"
 
          stopOnError="true"
          stopOnFailure="true"

src/Domain/Model/MethodWithValidatedParams.php renamed to src/Domain/MethodWithValidatedParamsInterface.php

@@ -1,12 +1,12 @@
 <?php
-namespace Yoanm\JsonRpcParamsSymfonyValidator\Domain\Model;
+namespace Yoanm\JsonRpcParamsSymfonyValidator\Domain;
 
 use Symfony\Component\Validator\Constraint;
 
 /**
- * Interface MethodWithValidatedParams
+ * Interface MethodWithValidatedParamsInterface
  */
-interface MethodWithValidatedParams
+interface MethodWithValidatedParamsInterface
 {
     /**
      * @return Constraint Usually a Collection constraint

src/Infra/JsonRpcParamsValidator.php

@@ -3,13 +3,15 @@
 
 use Symfony\Component\Validator\ConstraintViolationInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
-use Yoanm\JsonRpcParamsSymfonyValidator\Domain\Model\MethodWithValidatedParams;
-use Yoanm\JsonRpcServer\Domain\Event\Action\ValidateParamsEvent;
+use Yoanm\JsonRpcParamsSymfonyValidator\Domain\MethodWithValidatedParamsInterface;
+use Yoanm\JsonRpcServer\Domain\JsonRpcMethodInterface;
+use Yoanm\JsonRpcServer\Domain\JsonRpcMethodParamsValidatorInterface;
+use Yoanm\JsonRpcServer\Domain\Model\JsonRpcRequest;
 
 /**
  * Class JsonRpcParamsValidator
  */
-class JsonRpcParamsValidator
+class JsonRpcParamsValidator implements JsonRpcMethodParamsValidatorInterface
 {
     /** @var ValidatorInterface */
     private $validator;
@@ -22,22 +24,26 @@ public function __construct(ValidatorInterface $validator)
         $this->validator = $validator;
     }
 
-    /**
-     * @param ValidateParamsEvent $event
-     */
-    public function validate(ValidateParamsEvent $event)
+    public function validate(JsonRpcRequest $jsonRpcRequest, JsonRpcMethodInterface $method) : array
     {
-        $method = $event->getMethod();
-        if (!$method instanceof MethodWithValidatedParams) {
-            return;
+        $violationList = [];
+        if (!$method instanceof MethodWithValidatedParamsInterface) {
+            return $violationList;
         }
-        foreach ($this->validator->validate($event->getParamList(), $method->getParamsConstraint()) as $violation) {
+        $sfViolationList = $this->validator->validate(
+            $jsonRpcRequest->getParamList(),
+            $method->getParamsConstraint()
+        );
+
+        foreach ($sfViolationList as $violation) {
             /** @var ConstraintViolationInterface $violation */
-            $event->addViolation([
+            $violationList[] = [
                 'path' => $violation->getPropertyPath(),
                 'message' => $violation->getMessage(),
                 'code' => $violation->getCode(),
-            ]);
+            ];
         }
+
+        return $violationList;
     }
 }