[ValidationException] - Add config option to turn off ValidationException (#108)

* Adds config to turn off ValidationException, fixes failing tests

Author: cnizzardini

.github/workflows/pull-request.yml

@@ -64,7 +64,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        version: ['~4.2.0', '~4.3.0']
+        version: ['~4.2.0', '~4.3.0', '^4.4']
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.gitignore

@@ -1,11 +1,3 @@
-# MIXERAPI               #
-##########################
-/mixerapi_dev_test
-/src/Controller/*
-/coverage-reports/
-/plugins/cakephp-swagger-bake
-/plugins/cakephp-swagger-bake/*
-
 # MKDOCS                 #
 ##########################
 site/*
@@ -54,5 +46,14 @@ nbproject/*
 .vscode
 # Sass preprocessor
 .sass-cache/
+
+# MIXERAPI               #
+##########################
+/mixerapi_dev_test
+/src/Controller/*
+/coverage-reports/
+/plugins/cakephp-swagger-bake
+/plugins/cakephp-swagger-bake/*
 /plugins/jwt-auth/tests/mixerapi_dev_test
 /plugins/jwt-auth/mixerapi_dev_test
+/plugins/exception-render/tests/TestCase/mixerapi_dev_test

composer.lock

@@ -146,6 +146,20 @@ If for instance you have a custom exception that is thrown, such as `InventoryEx
 Providing an Exception name, in conjunction with the status code already provided by CakePHP, enables API clients
 to tailor their exception handling.
 
+### Disabling ValidationExceptions
+
+There may be times when you don't want ValidationExceptions to run. You can easily disable the event:
+
+```php
+Configure::write('MixerApi.ExceptionRender.entity_validation', false);
+```
+
+Another example is you may only want the event to run for non-CLI portions of your application:
+
+```php
+Configure::write('MixerApi.ExceptionRender.entity_validation', PHP_SAPI !== 'cli');
+```
+
 ### Changing Error Messages
 
 ExceptionRender dispatches a `MixerApi.ExceptionRender.beforeRender` event that you can listen for to alter `viewVars`

plugins/exception-render/README.md

@@ -4,6 +4,7 @@
 namespace MixerApi\ExceptionRender;
 
 use ArrayObject;
+use Cake\Core\Configure;
 use Cake\Datasource\EntityInterface;
 use Cake\Event\EventInterface;
 use Cake\Event\EventManager;
@@ -24,12 +25,14 @@ class EntityValidationListener
      */
     public function __construct()
     {
-        EventManager::instance()->on(
-            'Model.afterMarshal',
-            function ($event, $entity, $options) {
-                $this->handler($event, $entity, $options);
-            }
-        );
+        if (Configure::read('MixerApi.ExceptionRender.entity_validation') !== false) {
+            EventManager::instance()->on(
+                'Model.afterMarshal',
+                function ($event, $entity, $options) {
+                    $this->handler($event, $entity, $options);
+                }
+            );
+        }
     }
 
     /**

plugins/exception-render/src/EntityValidationListener.php

@@ -2,6 +2,8 @@
 
 namespace MixerApi\ExceptionRender\Test\TestCase;
 
+use Cake\Core\Configure;
+use Cake\Datasource\EntityInterface;
 use Cake\TestSuite\TestCase;
 use MixerApi\ExceptionRender\EntityValidationListener;
 use MixerApi\ExceptionRender\ValidationException;
@@ -48,4 +50,18 @@ public function test_validation_exception(): void
             'last_name' => ''
         ]);
     }
+
+    public function test_validation_exception_does_not_run_when_cli(): void
+    {
+        Configure::write('MixerApi.ExceptionRender.entity_validation', false);
+        new EntityValidationListener();
+
+        $actorsTable = new ActorsTable();
+        $entity = $actorsTable->patchEntity($actorsTable->newEmptyEntity(), [
+            'first_name' => '',
+            'last_name' => ''
+        ]);
+
+        $this->assertInstanceOf(EntityInterface::class, $entity);
+    }
 }

plugins/exception-render/tests/TestCase/EntityValidationTest.php

@@ -79,9 +79,9 @@ public function test_login_fails(string $alg): void
     public function test_auth_required(string $alg): void
     {
         $alg === 'RS' ? TestHelper::createRs256Config() : TestHelper::createHs256Config();
-        TestHelper::createHs256Config();
         $this->get('/test/index.json');
-        $this->assertResponseCode(401);
+        $this->assertResponseContains('Authentication is required to continue');
+
     }
 
     public function dataProviderForAlg(): array

plugins/jwt-auth/tests/ControllerTest.php

@@ -17,8 +17,8 @@ class TestController extends Controller
     public function beforeFilter(EventInterface $event)
     {
         parent::beforeFilter($event);
-        $this->loadComponent('Authentication.Authentication');
         $this->loadComponent('RequestHandler');
+        $this->loadComponent('Authentication.Authentication');
         $this->Authentication->allowUnauthenticated(['login','jwks']);
     }