Add command, templates and tests

Author: pyldin601

Migrate/Command/AbstractEnvCommand.php

@@ -69,10 +69,6 @@ protected function init(InputInterface $input, OutputInterface $output, $env = n
 
         $parser = $configLocator->locate($env);
 
-        if (is_null($parser)) {
-            throw new \RuntimeException("Could not locate supported environment file");
-        }
-
         $conf = $parser->parse();
 
         $this->config = $conf;

Migrate/Command/AddEnvCommand.php

@@ -7,6 +7,8 @@
 
 namespace Migrate\Command;
 
+use Migrate\Config\ConfigLocator;
+use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Question\ChoiceQuestion;
@@ -19,11 +21,26 @@ protected function configure()
         $this
             ->setName('migrate:addenv')
             ->setDescription('Initialise an environment to work with php db migrate')
+            ->addArgument(
+                'format',
+                InputArgument::OPTIONAL,
+                'Environment file format: (yml, json or php), default: yml'
+            )
         ;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        $format = $input->getArgument('format');
+        $supportedFormats = array_keys(ConfigLocator::$SUPPORTED_PARSERS);
+
+        if (is_null($format)) {
+            $format = 'yml';
+        }
+
+        if (!in_array($format, $supportedFormats)) {
+            throw new \RuntimeException(sprintf('Invalid file format: %s', $format));
+        }
 
         // init directories
         if(! file_exists($this->getMainDir())) {
@@ -46,7 +63,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $envQuestion = new Question("Please enter the name of the new environment <info>(default dev)</info>: ", "dev");
         $envName = $questions->ask($input, $output, $envQuestion );
 
-        $envConfigFile = $this->getEnvironmentDir() . '/' . $envName . '.yml';
+        $envConfigFile = $this->getEnvironmentDir() . '/' . $envName . '.' . $format;
         if (file_exists($envConfigFile)) {
             throw new \InvalidArgumentException("environment [$envName] is already defined!");
         }
@@ -75,7 +92,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $defaultEditorQuestion = new Question("Please enter the text editor to use by default <info>(default vim)</info>: ", "vim");
         $defaultEditor = $questions->ask($input, $output, $defaultEditorQuestion);
 
-        $confTemplate = file_get_contents(__DIR__ . '/../../templates/env.yml.tpl');
+        $confTemplate = file_get_contents(__DIR__ . '/../../templates/env.' . $format . '.tpl');
         $confTemplate = str_replace('{DRIVER}', $driver, $confTemplate);
         $confTemplate = str_replace('{HOST}', $dbHost, $confTemplate);
         $confTemplate = str_replace('{PORT}', $dbPort, $confTemplate);

Migrate/Config/ConfigLocator.php

@@ -10,11 +10,11 @@
 
 class ConfigLocator
 {
-    static $SUPPORTED_PARSERS = [
-        'yaml' => '\Migrate\Config\YamlConfigParser',
+    public static $SUPPORTED_PARSERS = array(
+        'yml' => '\Migrate\Config\YamlConfigParser',
         'json' => '\Migrate\Config\JsonConfigParser',
         'php' => '\Migrate\Config\PhpConfigParser'
-    ];
+    );
 
     private $configPath;
 
@@ -32,6 +32,8 @@ public function locate($nameWithoutExt)
                 return new $parserClass($path);
             }
         }
-        return null;
+        throw new \RuntimeException(
+            sprintf('Environment file %s does not exist or file not supported', $nameWithoutExt)
+        );
     }
 }

templates/env.json.tpl

@@ -0,0 +1,12 @@
+{
+    "connection": {
+        "host": "{HOST}",
+        "driver": "{DRIVER}",
+        "port": "{PORT}",
+        "username": "{USERNAME}",
+        "password": "{PASSWORD}",
+        "database": "{DATABASE}"
+    },
+    "changelog": "{CHANGELOG}",
+    "default_editor": "{EDITOR}"
+}

templates/env.php.tpl

@@ -0,0 +1,14 @@
+<?php
+
+return [
+    "connection" => [
+        "host" => "{HOST}",
+        "driver" => "{DRIVER}",
+        "port" => "{PORT}",
+        "username" => "{USERNAME}",
+        "password" => "{PASSWORD}",
+        "database" => "{DATABASE}"
+    ],
+    "changelog" => "{CHANGELOG}",
+    "default_editor" => "{EDITOR}"
+];

tests/Command/AbstractCommandTester.php

@@ -34,7 +34,7 @@ public function cleanEnv()
         }
     }
 
-    public function createEnv()
+    public function createEnv($format = 'yml')
     {
         $application = new Application();
         $application->add(new AddEnvCommand());
@@ -49,7 +49,7 @@ public function createEnv()
         $question = $command->getHelper('question');
         $question->setInputStream(InputStreamUtil::type("testing\n$driverKey\ntest.sqlite\n\n\n\n\nchangelog\nvim\n"));
 
-        $commandTester->execute(array('command' => $command->getName()));
+        $commandTester->execute(array('command' => $command->getName(), 'format' => $format));
     }
 
     public function initEnv()

tests/Command/EnvFormatsTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Migrate\Test\Command;
+
+use SebastianBergmann\GlobalState\RuntimeException;
+
+class EnvFormatsTest extends AbstractCommandTester
+{
+    public function testYamlFormat()
+    {
+        $this->createEnv('yml');
+        $this->cleanEnv();
+    }
+
+    public function testJsonFormat()
+    {
+        $this->createEnv('json');
+        $this->cleanEnv();
+    }
+
+    public function testPhpFormat()
+    {
+        $this->createEnv('php');
+        $this->cleanEnv();
+    }
+
+    /**
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage Invalid file format: xml
+     */
+    public function testUnsupportedXmlFormat()
+    {
+        $this->createEnv('xml');
+        $this->cleanEnv();
+    }
+}