Merge pull request #23 from boite/develop

joostfaassen · web-flow · commit 04f534df6cff · 2016-10-20T13:31:36.000+02:00
Stablilising
diff --git a/composer.json b/composer.json
@@ -13,7 +13,7 @@
     ],
     "require": {
         "php": ">=5.3.0",
-        "droid/droid-model": "~1.0",
+        "droid/droid-model": "~1.3",
         "psr/log": "^1.0",
         "symfony/property-access": "^3.1",
         "symfony/console": "~2.7",
diff --git a/src/Application.php b/src/Application.php
@@ -10,6 +10,7 @@
 use Droid\Model\Inventory\Remote\Enabler;
 use Droid\Model\Inventory\Remote\SynchroniserComposer;
 use Droid\Model\Inventory\Remote\SynchroniserPhar;
+use Droid\Model\Project\Environment;
 use Droid\Model\Project\Project;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 use Symfony\Component\Console\Application as ConsoleApplication;
@@ -51,6 +52,8 @@ public function __construct($autoLoader, $basePath = '')
         $this->setVersion('1.0.0');
 
         $this->inventory = new Inventory();
+        $environment = new Environment;
+        $this->inventory->setEnvironment($environment);
         $this->transformer = $this->buildTransformer();
 
         $loader = new YamlLoader($this->basePath, $this->transformer);
@@ -76,7 +79,7 @@ public function __construct($autoLoader, $basePath = '')
         $this->project = new Project($filename);
 
         // Load droid.yml
-        $loader->load($this->project, $this->inventory);
+        $loader->load($this->project, $this->inventory, $environment);
 
         $this->loaderErrors = $loader->errors;
         if ($this->loaderErrors) {
@@ -167,18 +170,6 @@ protected function registerCustomCommands()
         // which is used when using the --help option
         $defaultCommands = parent::getDefaultCommands();
 
-        if ($this->hasProject()) {
-            // Register commands defined in project's droid.yml
-            foreach ($this->getProject()->getRegisteredCommands() as $registeredCommand) {
-                $className = $registeredCommand->getClassName();
-                $command = new $className();
-                if ($registeredCommand->hasProperty('name')) {
-                    $command->setName($registeredCommand->getProperty('name'));
-                }
-                $this->add($command);
-            }
-        }
-
         // Automatically register commands by scanning namespaces for a 'DroidPlugin' class.
         //print_r($this->autoLoader);
         $prefixes = $this->autoLoader->getPrefixesPsr4();
diff --git a/src/Command/ConfigCommand.php b/src/Command/ConfigCommand.php
@@ -21,23 +21,35 @@ protected function configure()
 
     public function execute(InputInterface $input, OutputInterface $output)
     {
-
-        $output->writeln("Droid configuration:");
         $project = $this->getApplication()->getProject();
+        if (! $project) {
+            return;
+        }
+
+        $header = 'Droid configuration:';
+        if ($project->name) {
+            $header .= sprintf(' "%s"', $project->name);
+        }
+        $output->writeln($header);
+        if ($project->description) {
+            $output->writeln($project->description);
+        }
 
-        $output->writeln("Modules: ");
+        if ($project->getModules()) {
+            $output->writeln("Modules: ");
+        }
         foreach ($project->getModules() as $module) {
             $output->writeln("<info>Module: " . $module->getName() . "</info> " . $module->getSource());
             $output->writeLn("     Description: " . $module->getDescription());
             $output->writeln("     Variables: " . $module->getVariablesAsString());
         }
-        
+
         foreach ($project->getTargets() as $target) {
             $output->writeln("<info>Target: " . $target->getName() . "</info>");
             if ($target->getHosts()) {
                 $output->writeln("     Hosts: " . $target->getHosts());
             }
-            
+
             $output->writeln("     Variables: " . $target->getVariablesAsString());
             foreach ($target->getModules() as $module) {
                 $output->writeln("    <comment> Module: <info>" . $module->getName() . "</info></comment>");
@@ -56,6 +68,6 @@ public function execute(InputInterface $input, OutputInterface $output)
                 }
             }
         }
-        $output->writeln("Done: ");
+        $output->writeln("Done.");
     }
 }
diff --git a/src/Command/InventoryCommand.php b/src/Command/InventoryCommand.php
@@ -25,20 +25,41 @@ public function execute(InputInterface $input, OutputInterface $output)
         $output->writeln("Droid inventory:");
         $inventory = $this->getApplication()->getInventory();
 
-        foreach ($inventory->getVariables() as $name => $value) {
-            $output->writeln("- $name=`$value`");
-        }
-        
         $output->writeln("HOSTS");
         foreach ($inventory->getHosts() as $host) {
             $output->writeln('   <comment>'. $host->getName() . "</comment>");
-            $output->writeln("      Public: " . $host->getPublicIp() . ':' . $host->getPublicPort());
-            if ($host->getPrivateIp()) {
-                $output->writeln("      Private: " . $host->getPrivateIp() . ':' . $host->getPrivatePort());
+            if ($host->droid_ip) {
+                $output->writeln(
+                    sprintf(
+                        '      Droid socket: %s:%d',
+                        $host->droid_ip,
+                        $host->getConnectionPort()
+                    )
+                );
+            }
+            if ($host->public_ip) {
+                $output->writeln(
+                    sprintf(
+                        '      Public: %s:%d',
+                        $host->public_ip,
+                        $host->getConnectionPort()
+                    )
+                );
             }
-            
-            $output->writeln("      Auth: " . $host->getAuth());
-            foreach ($host->getVariables() as $name => $value) {
+            if ($host->private_ip) {
+                $output->writeln(
+                    sprintf(
+                        '      Private: %s:%d',
+                        $host->private_ip,
+                        $host->getConnectionPort()
+                    )
+                );
+            }
+
+            foreach ($host->variables as $name => $value) {
+                if (is_array($value)) {
+                    $value = '{...}';
+                }
                 $output->writeln("      - $name=`$value`");
             }
         }
@@ -53,6 +74,9 @@ public function execute(InputInterface $input, OutputInterface $output)
             $output->writeln(trim($hostnames, ' ,'));
 
             foreach ($group->getVariables() as $name => $value) {
+                if (is_array($value)) {
+                    $value = '{...}';
+                }
                 $output->writeln("    - $name=`$value`");
             }
         }
diff --git a/src/Command/PingCommand.php b/src/Command/PingCommand.php
@@ -58,9 +58,9 @@ protected function initialize(InputInterface $input, OutputInterface $output)
 
     public function execute(InputInterface $input, OutputInterface $output)
     {
-        $hosts = array();
+        $hosts = null;
         if ($input->getArgument('hostname')) {
-            $hosts[] = $this->getInventory()->getHostsByName($input->getArgument('hostname'));
+            $hosts = $this->getInventory()->getHostsByName($input->getArgument('hostname'));
         } else {
             $hosts = $this->getInventory()->getHosts();
         }
diff --git a/src/Loader/YamlLoader.php b/src/Loader/YamlLoader.php
@@ -9,9 +9,9 @@
 use Droid\Model\Inventory\Host;
 use Droid\Model\Inventory\HostGroup;
 use Droid\Model\Inventory\Inventory;
+use Droid\Model\Project\Environment;
 use Droid\Model\Project\Module;
 use Droid\Model\Project\Project;
-use Droid\Model\Project\RegisteredCommand;
 use Droid\Model\Project\Target;
 use Droid\Model\Project\Task;
 use Symfony\Component\Yaml\Exception\ParseException;
@@ -39,9 +39,13 @@ public function __construct(
         $this->transformer = $transformer;
     }
 
-    public function load(Project $project, Inventory $inventory)
-    {
+    public function load(
+        Project $project,
+        Inventory $inventory,
+        Environment $environment
+    ) {
         $data = $this->loadYaml($project->getConfigFilePath());
+        $this->loadEnvironment($environment, $data);
         $this->loadInventory($inventory, $data);
         $this->loadProject($project, $data);
     }
@@ -106,18 +110,31 @@ public function loadYaml($filename)
 
     }
 
-    private function loadProject(Project $project, $data)
+    private function loadEnvironment(Environment $environment, $data)
     {
-        $this->loadVariables($data, $project);
+        if (! array_key_exists('environment', $data)
+            || ! is_array($data['environment'])
+        ) {
+            return;
+        }
 
-        if (isset($data['register'])) {
-            foreach ($data['register'] as $registerNode) {
-                foreach ($registerNode as $className => $parameters) {
-                    $command = new RegisteredCommand($className, $parameters);
-                    $project->addRegisteredCommand($command);
-                }
+        foreach ($data['environment'] as $k => $v) {
+            if (property_exists(Environment::class, $k)) {
+                $environment->$k = $v;
             }
         }
+    }
+
+    private function loadProject(Project $project, $data)
+    {
+        if (array_key_exists('name', $data) && is_string($data['name'])) {
+            $project->name = $data['name'];
+        }
+        if (array_key_exists('description', $data) && is_string($data['description'])) {
+            $project->description = $data['description'];
+        }
+
+        $this->loadVariables($data, $project);
 
         if (isset($data['modules'])) {
             foreach ($data['modules'] as $name => $source) {
@@ -185,7 +202,9 @@ public function loadModule(Module $module)
         $filename = $path . '/droid.yml';
         $data = $this->loadYaml($filename);
         $module->setBasePath($path);
-        $module->setDescription($data['project']['description']);
+        if (array_key_exists('description', $data) && is_string($data['description'])) {
+            $module->setDescription($data['description']);
+        }
         $this->loadVariables($data, $module);
         $this->loadTasks($data, $module, 'tasks');
         $this->loadTasks($data, $module, 'triggers');
@@ -242,42 +261,35 @@ private function loadHosts(Inventory $inventory, $hosts)
         foreach ($hosts as $hostName => $hostData) {
             $host = new Host($hostName);
             $this->loadRules($host, $hostData);
-            $inventory->addHost($host);
-            if (!$hostData) {
-                continue;
-            }
             foreach ($hostData as $key => $value) {
                 switch ($key) {
                     case 'variables':
                         $this->loadVariables($hostData, $host);
                         break;
+                    case 'droid_ip':
+                        $host->droid_ip = $value;
+                        break;
+                    case 'droid_port':
+                        if (! is_numeric($value)) {
+                            throw new RuntimeException('Expected numeric droid_port.');
+                        }
+                        $host->droid_port = (int) $value;
+                        break;
                     case 'public_ip':
                         $host->public_ip = $value;
                         break;
                     case 'private_ip':
                         $host->private_ip = $value;
                         break;
-                    case 'public_port':
-                        $host->public_port = $value;
-                        break;
-                    case 'private_port':
-                        $host->private_port = $value;
-                        break;
                     case 'username':
                         $host->setUsername($value);
                         break;
-                    case 'password':
-                        $host->setPassword($value);
-                        break;
-                    case 'auth':
-                        $host->setAuth($value);
+                    case 'firewall_policy':
+                        $host->setFirewallPolicy($value);
                         break;
                     case 'keyfile':
                         $host->setKeyFile(Utils::absoluteFilename($value));
                         break;
-                    case 'keypass':
-                        $host->setKeyPass($value);
-                        break;
                     case 'ssh_options':
                         $host->setSshOptions($value);
                         break;
@@ -294,6 +306,7 @@ private function loadHosts(Inventory $inventory, $hosts)
                         throw new RuntimeException("Unknown host property: " . $key);
                 }
             }
+            $inventory->addHost($host);
         }
         foreach ($want_gateway as $want => $gateway) {
             if (! $inventory->hasHost($gateway)) {
@@ -323,7 +336,7 @@ private function loadHosts(Inventory $inventory, $hosts)
         }
         if ($incompleteHosts) {
             $this->errors[] = sprintf(
-                'The following hosts fail to meet the minimum requirement that they exhibit an IP address (public_ip): %s.',
+                'The following hosts fail to meet the minimum requirement that they exhibit an IP address (droid_ip or public_ip): %s.',
                 implode(', ', $incompleteHosts)
             );
         }
@@ -335,6 +348,10 @@ private function loadHostGroups(Inventory $inventory, $groups)
             $group = new HostGroup($groupName);
             $this->loadRules($group, $groupNode);
 
+            if (isset($groupNode['firewall_policy'])) {
+                $group->setFirewallPolicy($groupNode['firewall_policy']);
+            }
+
             if (isset($groupNode['hosts'])) {
                 foreach ($groupNode['hosts'] as $hostName) {
                     if (!$inventory->hasHost($hostName)) {
diff --git a/src/TaskRunner.php b/src/TaskRunner.php
@@ -85,9 +85,14 @@ public function runTaskRemotely(Task $task, $variables, $hostsExpression)
             );
             $commandInput = array();
             foreach ($taskHosts as $host) {
-                $perHostVars = array_merge($variables, array('host' => $host));
-                // Allow host-level variables to override project, module and target variables
-                $perHostVars = array_merge($perHostVars, $host->getVariables());
+                $perHostVars = $variables;
+                // Allow group variables to override target, project and module variables
+                foreach ($this->app->getInventory()->getHostGroupsByHost($host) as $group) {
+                    $perHostVars = array_replace_recursive($perHostVars, $group->variables);
+                }
+                // Allow host variables to override group, target, project and module variables
+                $perHostVars = array_replace_recursive($perHostVars, $host->variables);
+                $perHostVars = array_merge($perHostVars, array('host' => $host));
                 $commandInput[$host->name] = $this
                     ->prepareCommandInput($command, $task->getArguments(), $perHostVars)
                 ;
@@ -183,12 +188,12 @@ public function runTarget($project, $targetName)
         }
 
         foreach ($target->getModules() as $module) {
-            $variables = array_merge($module->variables, $project->variables, $target->variables);
+            $variables = array_replace_recursive($module->variables, $project->variables, $target->variables);
             $variables['mod_path'] = $module->getBasePath();
             $this->runTaskList($module, $variables, $target->getHosts());
         }
 
-        $variables = array_merge($project->variables, $target->variables);
+        $variables = array_replace_recursive($project->variables, $target->variables);
         $this->runTaskList($target, $variables, $target->getHosts());
         return 0;
     }
diff --git a/src/Transform/InventoryTransformer.php b/src/Transform/InventoryTransformer.php
@@ -91,9 +91,6 @@ protected function resolve($expression)
         if ($this->inventory->hasHostGroup($expression)) {
             return $this->inventory->getHostGroup($expression);
         }
-        if ($this->inventory->hasVariable($expression)) {
-            return $this->inventory->getVariable($expression);
-        }
         return false;
     }
 }
diff --git a/test/Droid/TaskRunner/RunTaskRemotelyTest.php b/test/Droid/TaskRunner/RunTaskRemotelyTest.php
diff --git a/test/Droid/Transform/InventoryTransformerTest.php b/test/Droid/Transform/InventoryTransformerTest.php

Original file line number	Diff line number	Diff line change
`@@ -58,9 +58,9 @@ protected function initialize(InputInterface $input, OutputInterface $output)`
`58`	`58`
`59`	`59`	`public function execute(InputInterface $input, OutputInterface $output)`
`60`	`60`	`{`
`61`		`- $hosts = array();`
	`61`	`+ $hosts = null;`
`62`	`62`	`if ($input->getArgument('hostname')) {`
`63`		`- $hosts[] = $this->getInventory()->getHostsByName($input->getArgument('hostname'));`
	`63`	`+ $hosts = $this->getInventory()->getHostsByName($input->getArgument('hostname'));`
`64`	`64`	`} else {`
`65`	`65`	`$hosts = $this->getInventory()->getHosts();`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -91,9 +91,6 @@ protected function resolve($expression)`
`91`	`91`	`if ($this->inventory->hasHostGroup($expression)) {`
`92`	`92`	`return $this->inventory->getHostGroup($expression);`
`93`	`93`	`}`
`94`		`- if ($this->inventory->hasVariable($expression)) {`
`95`		`- return $this->inventory->getVariable($expression);`
`96`		`- }`
`97`	`94`	`return false;`
`98`	`95`	`}`
`99`	`96`	`}`