[Console] Fix input validation when required arguments are missing

jakzal · jakzal · commit f12a4c1aee97 · 2015-09-14T10:33:21.000+01:00
Previous rule was only working when arguments are passed from command line, as in command line there is no way of skipping an argument. The rule does not work for arguments set on the Input after a command is run.
diff --git a/src/Symfony/Component/Console/Input/Input.php b/src/Symfony/Component/Console/Input/Input.php
@@ -72,8 +72,15 @@ abstract protected function parse();
      */
     public function validate()
     {
-        if (count($this->arguments) < $this->definition->getArgumentRequiredCount()) {
-            throw new \RuntimeException('Not enough arguments.');
+        $definition = $this->definition;
+        $givenArguments = $this->arguments;
+
+        $missingArguments = array_filter(array_keys($definition->getArguments()), function ($argument) use ($definition, $givenArguments) {
+            return !array_key_exists($argument, $givenArguments) && $definition->getArgument($argument)->isRequired();
+        });
+
+        if (count($missingArguments) > 0) {
+            throw new \RuntimeException(sprintf('Not enough arguments (missing: "%s").', implode(', ', $missingArguments)));
         }
     }
 
diff --git a/src/Symfony/Component/Console/Tests/Input/InputTest.php b/src/Symfony/Component/Console/Tests/Input/InputTest.php
@@ -94,7 +94,7 @@ public function testGetInvalidArgument()
 
     /**
      * @expectedException        \RuntimeException
-     * @expectedExceptionMessage Not enough arguments.
+     * @expectedExceptionMessage Not enough arguments (missing: "name").
      */
     public function testValidateWithMissingArguments()
     {
@@ -103,6 +103,17 @@ public function testValidateWithMissingArguments()
         $input->validate();
     }
 
+    /**
+     * @expectedException        \RuntimeException
+     * @expectedExceptionMessage Not enough arguments (missing: "name").
+     */
+    public function testValidateWithMissingRequiredArguments()
+    {
+        $input = new ArrayInput(array('bar' => 'baz'));
+        $input->bind(new InputDefinition(array(new InputArgument('name', InputArgument::REQUIRED), new InputArgument('bar', InputArgument::OPTIONAL))));
+        $input->validate();
+    }
+
     public function testValidate()
     {
         $input = new ArrayInput(array('name' => 'foo'));

Original file line number	Diff line number	Diff line change
`@@ -72,8 +72,15 @@ abstract protected function parse();`
`72`	`72`	`*/`
`73`	`73`	`public function validate()`
`74`	`74`	`{`
`75`		`- if (count($this->arguments) < $this->definition->getArgumentRequiredCount()) {`
`76`		`- throw new \RuntimeException('Not enough arguments.');`
	`75`	`+ $definition = $this->definition;`
	`76`	`+ $givenArguments = $this->arguments;`
	`77`	`+`
	`78`	`+ $missingArguments = array_filter(array_keys($definition->getArguments()), function ($argument) use ($definition, $givenArguments) {`
	`79`	`+ return !array_key_exists($argument, $givenArguments) && $definition->getArgument($argument)->isRequired();`
	`80`	`+ });`
	`81`	`+`
	`82`	`+ if (count($missingArguments) > 0) {`
	`83`	`+ throw new \RuntimeException(sprintf('Not enough arguments (missing: "%s").', implode(', ', $missingArguments)));`
`77`	`84`	`}`
`78`	`85`	`}`
`79`	`86`