Add Input Validation to Console Commands

composer.json

@@ -39,5 +39,10 @@
             "php qt core:version"
         ],
         "test": "vendor/bin/phpunit --stderr --coverage-clover coverage.xml"
+    },
+    "config": {
+        "audit": {
+            "block-insecure": false
+        }
     }
 }

shared/Commands/CommandValidationTrait.php

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * Quantum PHP Framework
+ *
+ * An open source software development framework for PHP
+ *
+ * @package Quantum
+ * @author Arman Ag. <arman.ag@softberg.org>
+ * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
+ * @link http://quantum.softberg.org/
+ * @since 2.9.9
+ */
+
+namespace Shared\Commands;
+
+use Quantum\Libraries\Validation\Validator;
+
+/**
+ * Trait CommandValidationTrait
+ * @package Shared\Commands
+ */
+trait CommandValidationTrait
+{
+
+    /**
+     * @var Validator
+     */
+    protected $validator;
+
+    /**
+     * Initiates the validator
+     */
+    protected function initValidator(): void
+    {
+        $this->validator = new Validator();
+    }
+
+    /**
+     * Validates rules
+     * @param array $rules
+     * @param array $data
+     * @return bool
+     */
+    protected function validate(array $rules, array $data): bool
+    {
+        $this->validator->setRules($rules);
+
+        if (!$this->validator->isValid($data)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Gets the first validation error
+     * @return string|null
+     */
+    public function firstError(): ?string
+    {
+        $errors = $this->validator->getErrors();
+
+        foreach ($errors as $fieldErrors) {
+            if (!empty($fieldErrors)) {
+                return $fieldErrors[0];
+            }
+        }
+
+        return null;
+    }
+}

shared/Commands/CommentCreateCommand.php

@@ -14,30 +14,70 @@
 
 namespace Shared\Commands;
 
+use Quantum\Service\Exceptions\ServiceException;
 use Quantum\Service\Factories\ServiceFactory;
+use Quantum\Libraries\Validation\Rule;
+use Quantum\Di\Exceptions\DiException;
 use Shared\Services\CommentService;
 use Quantum\Console\QtCommand;
+use ReflectionException;
 
 /**
  * Class CommentCreateCommand
  * @package Shared\Commands
  */
 class CommentCreateCommand extends QtCommand
 {
+
+    use CommandValidationTrait;
+
+    /**
+     * Command name
+     * @var string
+     */
     protected $name = 'comment:create';
 
+    /**
+     * Command description
+     * @var string
+     */
     protected $description = 'Allows to create a comment record';
 
+    /**
+     * Command help text
+     * @var string
+     */
     protected $help = 'Use the following format to create a comment record:' . PHP_EOL . 'php qt comment:create `Post UUID` `User UUID` `Content`';
 
+    /**
+     * Command arguments
+     * @var array[]
+     */
     protected $args = [
         ['post_uuid', 'required', 'The post uuid the comment belongs to'],
         ['user_uuid', 'required', 'The user uuid who writes the comment'],
         ['content', 'required', 'Comment text'],
     ];
 
+    /**
+     * Executes the command
+     * @throws DiException
+     * @throws ServiceException
+     * @throws ReflectionException
+     */
     public function exec()
     {
+        $this->initValidator();
+
+        $data = [
+            'content' => $this->getArgument('content'),
+        ];
+
+        if (!$this->validate($this->validationRules(), $data)) {
+            $this->error($this->firstError() ?? 'Validation failed');
+            return;
+        }
+
         $commentService = ServiceFactory::create(CommentService::class);
 
         $comment = [
@@ -50,4 +90,19 @@ public function exec()
 
         $this->info('Comment created successfully');
     }
+
+    /**
+     * Validation rules
+     * @return array[]
+     */
+    protected function validationRules(): array
+    {
+        return [
+            'content' => [
+                Rule::required(),
+                Rule::minLen(2),
+                Rule::maxLen(100),
+            ],
+        ];
+    }
 }

shared/Commands/PostCreateCommand.php

@@ -16,6 +16,7 @@
 
 use Quantum\Service\Exceptions\ServiceException;
 use Quantum\Service\Factories\ServiceFactory;
+use Quantum\Libraries\Validation\Rule;
 use Quantum\Di\Exceptions\DiException;
 use Shared\Services\PostService;
 use Quantum\Console\QtCommand;
@@ -28,6 +29,8 @@
 class PostCreateCommand extends QtCommand
 {
 
+    use CommandValidationTrait;
+
     /**
      * Command name
      * @var string
@@ -66,6 +69,18 @@ class PostCreateCommand extends QtCommand
      */
     public function exec()
     {
+        $this->initValidator();
+
+        $data = [
+            'title' => $this->getArgument('title'),
+            'content' => $this->getArgument('description'),
+        ];
+
+        if (!$this->validate($this->validationRules(), $data)) {
+            $this->error($this->firstError() ?? 'Validation failed');
+            return;
+        }
+
         $postService = ServiceFactory::get(PostService::class);
 
         $post = [
@@ -80,4 +95,24 @@ public function exec()
 
         $this->info('Post created successfully');
     }
+
+    /**
+     * Validation rules
+     * @return array[]
+     */
+    protected function validationRules(): array
+    {
+        return [
+            'title' => [
+                Rule::required(),
+                Rule::minLen(10),
+                Rule::maxLen(50),
+            ],
+            'content' => [
+                Rule::required(),
+                Rule::minLen(10),
+                Rule::maxLen(1000),
+            ],
+        ];
+    }
 }

shared/Commands/PostUpdateCommand.php

@@ -9,13 +9,14 @@
  * @author Arman Ag. <arman.ag@softberg.org>
  * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
  * @link http://quantum.softberg.org/
- * @since 2.9.8
+ * @since 2.9.9
  */
 
 namespace Shared\Commands;
 
 use Quantum\Service\Exceptions\ServiceException;
 use Quantum\Service\Factories\ServiceFactory;
+use Quantum\Libraries\Validation\Rule;
 use Quantum\Di\Exceptions\DiException;
 use Shared\Services\PostService;
 use Quantum\Console\QtCommand;
@@ -28,6 +29,8 @@
 class PostUpdateCommand extends QtCommand
 {
 
+    use CommandValidationTrait;
+
     /**
      * Command name
      * @var string
@@ -72,6 +75,8 @@ class PostUpdateCommand extends QtCommand
      */
     public function exec()
     {
+        $this->initValidator();
+
         $postService = ServiceFactory::get(PostService::class);
 
         $postId = $this->getArgument('uuid');
@@ -83,6 +88,16 @@ public function exec()
             return;
         }
 
+        $data = [
+            'title' => $this->getOption('title') ?: $post->title,
+            'content' => $this->getOption('description') ?: $post->content,
+        ];
+
+        if (!$this->validate($this->validationRules(), $data)) {
+            $this->error($this->firstError() ?? 'Validation failed');
+            return;
+        }
+
         $postData = [
             'title' => $this->getOption('title') ?: $post->title,
             'content' => $this->getOption('description') ?: $post->content,
@@ -95,4 +110,21 @@ public function exec()
         $this->info('Post updated successfully');
     }
 
+    /**
+     * Validation rules
+     * @return array[]
+     */
+    protected function validationRules(): array
+    {
+        return [
+            'title' => [
+                Rule::minLen(10),
+                Rule::maxLen(50),
+            ],
+            'content' => [
+                Rule::minLen(10),
+                Rule::maxLen(1000),
+            ],
+        ];
+    }
 }