Assertions for Form Validation

Author: jasonmccreary

src/Traits/HttpTestAssertions.php

@@ -2,55 +2,100 @@
 
 namespace JMac\Testing\Traits;
 
+use Illuminate\Foundation\Testing\Assert as LaravelAssert;
 use Illuminate\Support\Facades\Route;
-use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\Assert as PHPUnitAssert;
+use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
 
 trait HttpTestAssertions
 {
-    public function assertRouteUsesFormRequest(string $routeName, string $formRequest) {
-		$controllerAction = collect(Route::getRoutes())->filter(function (\Illuminate\Routing\Route $route) use ($routeName) {
-			return $route->getName() == $routeName;
-		})->pluck('action.controller');
+    public function assertRouteUsesFormRequest(string $routeName, string $formRequest)
+    {
+        $controllerAction = collect(Route::getRoutes())->filter(function (\Illuminate\Routing\Route $route) use ($routeName) {
+            return $route->getName() == $routeName;
+        })->pluck('action.controller');
 
-		Assert::assertNotEmpty($controllerAction, 'Route "' . $routeName . '" is not defined.');
-		Assert::assertCount(1, $controllerAction, 'Route "' . $routeName . '" is defined multiple times, route names should be unique.');
+        PHPUnitAssert::assertNotEmpty($controllerAction, 'Route "' . $routeName . '" is not defined.');
+        PHPUnitAssert::assertCount(1, $controllerAction, 'Route "' . $routeName . '" is defined multiple times, route names should be unique.');
 
-		[$controller, $method] = explode('@', $controllerAction->first());
+        [$controller, $method] = explode('@', $controllerAction->first());
 
-		$this->assertActionUsesFormRequest($controller, $method, $formRequest);
-	}
+        $this->assertActionUsesFormRequest($controller, $method, $formRequest);
+    }
 
     public function assertActionUsesFormRequest(string $controller, string $method, string $form_request)
     {
-        Assert::assertTrue(is_subclass_of($form_request, 'Illuminate\\Foundation\\Http\\FormRequest'), $form_request . ' is not a type of Form Request');
+        PHPUnitAssert::assertTrue(is_subclass_of($form_request, 'Illuminate\\Foundation\\Http\\FormRequest'), $form_request . ' is not a type of Form Request');
 
         try {
             $reflector = new \ReflectionClass($controller);
             $action = $reflector->getMethod($method);
         } catch (\ReflectionException $exception) {
-            Assert::fail('Controller action could not be found: ' . $controller . '@' . $method);
+            PHPUnitAssert::fail('Controller action could not be found: ' . $controller . '@' . $method);
         }
 
-        Assert::assertTrue($action->isPublic(), 'Action "' . $method . '" is not public, controller actions must be public.');
+        PHPUnitAssert::assertTrue($action->isPublic(), 'Action "' . $method . '" is not public, controller actions must be public.');
 
         $actual = collect($action->getParameters())->contains(function ($parameter) use ($form_request) {
             return $parameter->getType() instanceof \ReflectionNamedType && $parameter->getType()->getName() === $form_request;
         });
 
-        Assert::assertTrue($actual, 'Action "' . $method . '" does not have validation using the "' . $form_request . '" Form Request.');
+        PHPUnitAssert::assertTrue($actual, 'Action "' . $method . '" does not have validation using the "' . $form_request . '" Form Request.');
     }
 
     public function assertActionUsesMiddleware($controller, $method, $middleware)
     {
         $router = resolve(\Illuminate\Routing\Router::class);
         $route = $router->getRoutes()->getByAction($controller . '@' . $method);
 
-        Assert::assertNotNull($route, 'Unable to find route for controller action (' . $controller . '@' . $method . ')');
+        PHPUnitAssert::assertNotNull($route, 'Unable to find route for controller action (' . $controller . '@' . $method . ')');
 
         if (is_array($middleware)) {
-            Assert::assertSame([], array_diff($middleware, $route->gatherMiddleware()), 'Controller action does not use middleware (' . implode(', ', $middleware) . ')');
+            PHPUnitAssert::assertSame([], array_diff($middleware, $route->gatherMiddleware()), 'Controller action does not use middleware (' . implode(', ', $middleware) . ')');
         } else {
-            Assert::assertTrue(in_array($middleware, $route->gatherMiddleware()), 'Controller action does not use middleware (' . $middleware . ')');
+            PHPUnitAssert::assertTrue(in_array($middleware, $route->gatherMiddleware()), 'Controller action does not use middleware (' . $middleware . ')');
+        }
+    }
+
+    public function createFormRequest(string $form_request, array $data = [])
+    {
+        return $form_request::createFromBase(SymfonyRequest::create(null, 'POST', $data));
+    }
+
+    public function assertValidationRules(array $expected, array $actual)
+    {
+        LaravelAssert::assertArraySubset($this->normalizeRules($expected), $this->normalizeRules($actual));
+    }
+
+    public function assertExactValidationRules(array $expected, array $actual)
+    {
+        PHPUnitAssert::assertEquals($this->normalizeRules($expected), $this->normalizeRules($actual));
+    }
+
+    public function assertValidationRuleContains($rule, string $class)
+    {
+        if (is_object($rule)) {
+            PHPUnitAssert::assertInstanceOf($rule, $class);
+
+            return;
+        }
+
+        $matches = array_filter($this->expandRules($rule), function ($rule) use ($class) {
+            return $rule instanceof $class;
+        });
+
+        if (empty($matches)) {
+            PHPUnitAssert::fail('Failed asserting rule contains ' . $class);
         }
     }
+
+    private function normalizeRules(array $rules)
+    {
+        return array_map([$this, 'expandRules'], $rules);
+    }
+
+    private function expandRules($rule)
+    {
+        return is_string($rule) ? explode('|', $rule) : $rule;
+    }
 }