Merge pull request #9 from Indatus/add-digitalocean-user-data

Add digitalocean user data

.gitignore

@@ -7,3 +7,4 @@ config/provisioning.yaml
 repos/*
 .vagrant
 .machine*
+config/userdata.sh

README.md

@@ -66,6 +66,7 @@ raw_goods:
 suppliers:
   - [email protected]:saltstack-formulas/mysql.git
   - [email protected]:saltstack-formulas/php.git
+userData: config/provision.sh # optional
 ```
 
 The above yaml represents a product line that tells assembler you want a container with mysql that has a root 
@@ -149,7 +150,10 @@ tokens:
 ssh:
   keys:
     - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
+userData: config/provision.sh # optional
 ```
+`userData` key provides a path to a [DigitalOcean cloud config](http://cloudinit.readthedocs.org/en/latest/topics/examples.html)
+script. This will be executed during your droplet's creation and can be used for provisioning.
 ## Running
 
 You can provision a server on digital ocean using the 'provision' command as below:

config/provisioning.yaml.example

@@ -3,4 +3,5 @@ tokens:
   digitalocean: yoursuperlongapitoken111
 ssh:
   keys:
-    - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
+    - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
+userData: config/userdata.sh.example

config/userdata.sh.example

@@ -0,0 +1,4 @@
+#cloud-config
+
+runcmd:
+- ls

src/Adapters/DigitalOceanAdapter.php

@@ -22,6 +22,7 @@ public function __construct(DigitalOceanV2 $digitalOceanV2)
      * @param bool   $ipv6              true if you want to use ipv6 networking
      * @param bool   $privateNetworking true if you want the droplet on a private network
      * @param array  $sshKeys           an array of keys to be used on the newly created droplet
+     * @param string $userData          path to a cloud-config script for provisioning
      * @return MachineObject
      */
     public function create(
@@ -32,7 +33,8 @@ public function create(
         $backups,
         $ipv6,
         $privateNetworking,
-        array $sshKeys = array()
+        array $sshKeys = array(),
+        $userData = ""
     ) {
         $dropletApi        = $this->digitalOceanV2->droplet();
         $droplet           = $dropletApi->create(
@@ -43,7 +45,8 @@ public function create(
             $backups,
             $ipv6,
             $privateNetworking,
-            $sshKeys
+            $sshKeys,
+            $userData
         );
         $machine           = new MachineObject();
         $machine->hostname = $droplet->name;

src/Configuration.php

@@ -2,8 +2,10 @@
 namespace Indatus\Assembler;
 
 use Indatus\Assembler\Exceptions\MalformedSSHKeysException;
+use Indatus\Assembler\Exceptions\MissingUserDataFileException;
 use Indatus\Assembler\Exceptions\NoProviderTokenException;
 use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Yaml\Yaml;
 
 class Configuration
@@ -61,4 +63,18 @@ public function sshKeys()
 
         throw new MalformedSSHKeysException('Missing ssh section of configuration.');
     }
+
+    public function userData()
+    {
+        if (array_key_exists('userData', $this->values)) {
+            $userDataPath = $this->values['userData'];
+            if ((new Filesystem())->exists($userDataPath)) {
+                return file_get_contents($userDataPath);
+            }
+
+            throw new MissingUserDataFileException;
+        }
+
+        return "";
+    }
 }

src/Contracts/CloudAdapterInterface.php

@@ -12,6 +12,7 @@ interface CloudAdapterInterface
      * @param bool   $ipv6              true if you want to use ipv6 networking
      * @param bool   $privateNetworking true if you want the droplet on a private network
      * @param array  $sshKeys           an array of keys to be used on the newly created droplet
+     * @param string $userData          path to a cloud-config script for provisioning
      *
      * @return \Indatus\Assembler\Adapters\MachineObject
      */
@@ -23,7 +24,8 @@ public function create(
         $backups,
         $ipv6,
         $privateNetworking,
-        array $sshKeys
+        array $sshKeys,
+        $userData
     );
 
     /**

src/Exceptions/MissingUserDataFileException.php

@@ -0,0 +1,9 @@
+<?php
+namespace Indatus\Assembler\Exceptions;
+
+use Exception;
+
+class MissingUserDataFileException extends Exception
+{
+    //
+}

src/Tasks/ProvisionTask.php

@@ -25,6 +25,9 @@ class ProvisionTask implements TaskInterface
      */
     protected $sshKeys;
 
+    /** @var string */
+    protected $userData;
+
     /**
      * @param array  $sshKeys
      * @param string $hostname
@@ -34,6 +37,7 @@ class ProvisionTask implements TaskInterface
      * @param bool   $backups
      * @param bool   $ipv6
      * @param bool   $privateNetworking
+     * @param string $userData
      */
     public function __construct(
         $hostname,
@@ -44,7 +48,8 @@ public function __construct(
         $ipv6,
         $privateNetworking,
         array $sshKeys = [],
-        CloudAdapterInterface $cloudAdapter
+        CloudAdapterInterface $cloudAdapter,
+        $userData
     ) {
         $this->cloudAdapter      = $cloudAdapter;
         $this->hostname          = $hostname;
@@ -55,6 +60,7 @@ public function __construct(
         $this->ipv6              = $ipv6;
         $this->privateNetworking = $privateNetworking;
         $this->sshKeys           = $sshKeys;
+        $this->userData          = $userData;
     }
 
     /**
@@ -70,7 +76,8 @@ public function run()
             $this->backups,
             $this->ipv6,
             $this->privateNetworking,
-            $this->sshKeys
+            $this->sshKeys,
+            $this->userData
         );
 
         return new Result($this, 0, '', $droplet);

src/Traits/ProvisionTrait.php

@@ -18,6 +18,7 @@ public function taskProvisionServer(
     ) {
         $configuration = new Configuration();
         $sshKeys = $configuration->sshKeys();
+        $userData = $configuration->userData();
         return new ProvisionTask(
             $hostname,
             $region,
@@ -27,7 +28,8 @@ public function taskProvisionServer(
             $ipv6,
             $privateNetworking,
             $sshKeys,
-            AdapterFactory::make($configuration)
+            AdapterFactory::make($configuration),
+            $userData
         );
     }
 }

tests/Adapters/DigitalOceanAdapterTest.php

@@ -37,6 +37,7 @@ public function testCreateWhenIPV4True()
         $ipv6 = false;
         $privateNetworking = false;
         $sshKeys = ['somekey'];
+        $userData = "provision.sh";
 
         $digitalOceanV2 = m::mock('DigitalOceanV2\DigitalOceanV2');
         $dropletEntityMock = m::mock("DigitalOceanV2\Entity\Droplet");
@@ -66,7 +67,8 @@ public function testCreateWhenIPV4True()
                 $backups,
                 $ipv6,
                 $privateNetworking,
-                $sshKeys
+                $sshKeys,
+                $userData
             )->andReturn($dropletEntityMock);
         $dropletMock->shouldReceive('getById')
             ->once()
@@ -81,7 +83,8 @@ public function testCreateWhenIPV4True()
             $backups,
             $ipv6,
             $privateNetworking,
-            $sshKeys
+            $sshKeys,
+            $userData
         );
         $this->assertInstanceOf(
             '\Indatus\Assembler\Adapters\MachineObject',

tests/ConfigurationTest.php

@@ -43,4 +43,28 @@ public function testComplainsWhenSshKeysAreMalformed()
     {
         $sshKeys = (new Configuration(realpath('tests'), 'bad-configuration-ssh.yaml'))->sshKeys();
     }
+
+    public function testUserDataFileIsLocated()
+    {
+        $userData = (new Configuration(realpath('tests'), 'configuration.yaml'))->userData();
+        $expectedUserData = file_get_contents('tests/provision.sh.example');
+
+        $this->assertEquals($expectedUserData, $userData);
+    }
+
+    /**
+     * @expectedException \Indatus\Assembler\Exceptions\MissingUserDataFileException
+     */
+    public function testUserDataFileCanBeMissing()
+    {
+        $userData = (new Configuration(realpath('tests'), 'bad-configuration-userdata.yaml'))->userData();
+    }
+
+    public function testUserDataReturnsBlankWhenOmitted()
+    {
+        $userData = (new Configuration(realpath('tests'), 'configuration-ommitted-userdata.yaml'))->userData();
+        $expectedUserData = "";
+
+        $this->assertEquals($expectedUserData, $userData);
+    }
 }

tests/Tasks/ProvisionTaskTest.php

@@ -22,6 +22,7 @@ public function testRun()
         $privateNetworking = true;
         $sshKeys = ['keys'];
         $droplet = m::mock('\DigitalOceanV2\Api\Droplet');
+        $userData = "";
         /**
          * @var $cloudAdapter \Indatus\Assembler\Contracts\CloudAdapterInterface|\Mocker\MockInterface
          */
@@ -35,7 +36,8 @@ public function testRun()
             $ipv6,
             $privateNetworking,
             $sshKeys,
-            $cloudAdapter
+            $cloudAdapter,
+            $userData
         );
         $cloudAdapter->shouldReceive('create')
             ->once()
@@ -47,7 +49,8 @@ public function testRun()
                 $backups,
                 $ipv6,
                 $privateNetworking,
-                $sshKeys
+                $sshKeys,
+                $userData
             )->andReturn($droplet);
         $result = $provision_task->run();
         $this->assertEquals($result->getExitCode(), 0);

tests/bad-configuration-userdata.yaml

@@ -0,0 +1,8 @@
+provider: myprovider
+tokens:
+  myprovider: yoursuperlongapitoken111
+ssh:
+  keys:
+    - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
+    - 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+userData: tests/missing.sh.example

tests/configuration-ommitted-userdata.yaml

@@ -0,0 +1,7 @@
+provider: myprovider
+tokens:
+  myprovider: yoursuperlongapitoken111
+ssh:
+  keys:
+    - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
+    - 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11

tests/configuration.yaml

@@ -4,4 +4,5 @@ tokens:
 ssh:
   keys:
     - 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00
-    - 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+    - 11:11:11:11:11:11:11:11:11:11:11:11:11:11:11:11
+userData: tests/provision.sh.example

tests/provision.sh.example

@@ -0,0 +1,4 @@
+#cloud-config
+
+runcmd:
+- ls