Move options.ssh-options to ssh.options (#3210)

drush-ops · Dec 7, 2017 · d42ea79 · d42ea79
1 parent 2d3aeae
commit d42ea79
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 5 deletions.
diff --git a/isolation/tests/LegacyAliasConverterTest.php b/isolation/tests/LegacyAliasConverterTest.php
@@ -192,7 +192,9 @@ public function convertLegacyFileTestData()
                             'options' => [
                                 'db-url' => 'mysql://pantheon:pw@dbserver.dev.site-id.drush.in:21086/pantheon',
                                 'db-allows-remote' => true,
-                                'ssh-options' => '-p 2222 -o "AddressFamily inet"',
+                            ],
+                            'ssh' => [
+                                'options' => '-p 2222 -o "AddressFamily inet"',
                             ],
                         ],
                         'live' =>
@@ -207,7 +209,9 @@ public function convertLegacyFileTestData()
                             'options' => [
                                 'db-url' => 'mysql://pantheon:pw@dbserver.live.site-id.drush.in:10516/pantheon',
                                 'db-allows-remote' => true,
-                                'ssh-options' => '-p 2222 -o "AddressFamily inet"',
+                            ],
+                            'ssh' => [
+                                'options' => '-p 2222 -o "AddressFamily inet"',
                             ],
                         ],
                         'test' =>
@@ -222,7 +226,9 @@ public function convertLegacyFileTestData()
                             'options' => [
                                 'db-url' => 'mysql://pantheon:pw@dbserver.test.site-id.drush.in:11621/pantheon',
                                 'db-allows-remote' => true,
-                                'ssh-options' => '-p 2222 -o "AddressFamily inet"',
+                            ],
+                            'ssh' => [
+                                'options' => '-p 2222 -o "AddressFamily inet"',
                             ],
                         ],
                     ],

diff --git a/src/SiteAlias/LegacyAliasConverter.php b/src/SiteAlias/LegacyAliasConverter.php
@@ -2,6 +2,7 @@
 namespace Drush\SiteAlias;
 
 use Symfony\Component\Yaml\Yaml;
+use Dflydev\DotAccessData\Data;
 
 /**
  * Find all legacy alias files and convert them to an equivalent '.yml' file.
@@ -386,9 +387,30 @@ protected function fixSiteData($data)
         }
         ksort($data);
 
-        return $data;
+        return $this->remapData($data);
     }
 
+    protected function remapData($data)
+    {
+        $converter = new Data($data);
+
+        foreach ($this->dataRemap() as $from => $to) {
+            if ($converter->has($from)) {
+                $converter->set($to, $converter->get($from));
+                $converter->remove($from);
+            }
+        }
+
+        return $converter->export();
+    }
+
+    /**
+     * Anything in the key of the returned array is converted
+     * and written to a new top-level item in the result.
+     *
+     * Anything NOT identified by the key in the returned array
+     * is moved to the 'options' element.
+     */
     protected function keyConversion()
     {
         return [
@@ -400,6 +422,22 @@ protected function keyConversion()
         ];
     }
 
+    /**
+     * This table allows for flexible remapping from one location
+     * in the original alias to any other location in the target
+     * alias.
+     *
+     * n.b. Most arbitrary data from the original alias will have
+     * been moved into the 'options' element before this remapping
+     * table is consulted.
+     */
+    protected function dataRemap()
+    {
+        return [
+            'options.ssh-options' => 'ssh.options',
+        ];
+    }
+
     protected function removePercentFromKey($data)
     {
         return

diff --git a/tests/SiteAliasConvertTest.php b/tests/SiteAliasConvertTest.php
@@ -30,7 +30,7 @@ public function testSiteAliasConvert()
         $this->assertObjectHasAttribute('@www-drupalvm.dev', $json);
         $dev = $json->{'@drupalvm.dev'};
         $this->assertSame('drupalvm.dev', $dev->host);
-        $this->assertSame('-o PasswordAuthentication=no -i /.vagrant.d/insecure_private_key', $dev->options->{'ssh-options'});
+        $this->assertSame('-o PasswordAuthentication=no -i /.vagrant.d/insecure_private_key', $dev->ssh->{'options'});
         $this->assertSame('/var/www/drupalvm/drupal/vendor/drush/drush/drush', $dev->paths->{'drush-script'});
     }
 }