Disallow command names with more than 3 words.

cakephp · Dec 18, 2018 · 62f328e · 62f328e
1 parent 0c8ce43
commit 62f328e
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git a/src/Console/CommandCollection.php b/src/Console/CommandCollection.php
@@ -64,6 +64,12 @@ public function add($name, $command)
                 "Cannot use '$class' for command '$name' it is not a subclass of Cake\Console\Shell or Cake\Console\Command."
             );
         }
+        if (!preg_match('/^[\p{L}\p{N}\-_:.]+(?:(?: [\p{L}\p{N}\-_:.]+){1,2})?$/ui', $name)) {
+            throw new InvalidArgumentException(
+                "The command name `{$name}` is invalid. " .
+                'Names must use only letters/numbers + punctuation characters and be 3 words or fewer.'
+            );
+        }
 
         $this->commands[$name] = $command;
 

diff --git a/tests/TestCase/Console/CommandCollectionTest.php b/tests/TestCase/Console/CommandCollectionTest.php
@@ -136,6 +136,39 @@ public function testAddInvalidInstance()
         $collection->add('routes', $shell);
     }
 
+    /**
+     * Provider for invalid names.
+     *
+     * @return array
+     */
+    public function invalidNameProvider()
+    {
+        return [
+            // Empty
+            [''],
+            // Leading spaces
+            [' spaced'],
+            // Trailing spaces
+            ['spaced '],
+            // Too many words
+            ['one two three four'],
+        ];
+    }
+
+    /**
+     * test adding a command instance.
+     *
+     * @dataProvider invalidNameProvider
+     * @return void
+     */
+    public function testAddCommandInvalidName($name)
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid command name');
+        $collection = new CommandCollection();
+        $collection->add($name, DemoCommand::class);
+    }
+
     /**
      * Class names that are not shells should fail
      *