kitchen-digitalocean 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 135f63747d2bc3b4619e27570b80514469d874d8
-  data.tar.gz: d42d858079c08ddfceaf1cc89efcdbe36dc98a72
+  metadata.gz: 8b165d6d82fa2603ed9cdb1afbf284a75d10b2b1
+  data.tar.gz: f4555427be6e7402c2d5a4db899d9d563febe2fb
 SHA512:
-  metadata.gz: a1eaf51b9d2ae1502595206279141017242b062aff2e281bdf2833629ac8599761d9e118ccceb84cd8c97a05bf33e3e6db4c12a60ca591486c8a8cecda45634c
-  data.tar.gz: bbe8e395b492410c970353642fe0adf12f66bf5544d60e54eb09207ce4a9aa2360baced0bbbcf0ef57632076901f0b1094220d85cf6237d0fda0d50ec3a947ef
+  metadata.gz: b433accd2962cf696ecf0aa187661265a53bbf152ca20969df0b2c06ee54c6c25ea146d6a21feabfd1339859b283928b33a7813e6bf53d93ad7a6019b423edb7
+  data.tar.gz: b9626c7fc0cba8b540efe016c43f6d8be988d063bc89abd436309393d0562cea7605059b865d66e5decd67388b8253ceb50d8a2bb33d81e5f4bc40768b1bfb6d

data/README.md

@@ -2,43 +2,92 @@
 
 # Kitchen::Digitalocean
 
-A Digital Ocean driver for Test Kitchen 1.0!
+A Test Kitchen Driver for Digital Ocean
 
 Shamelessly copied from [RoboticCheese](https://github.com/RoboticCheese)'s
 awesome work on an [Rackspace driver](https://github.com/RoboticCheese/kitchen-rackspace).
 
-## Installation
+# Requirements
 
-Add this line to your application's Gemfile:
+There are no external system requirements for this driver. However you will need access to an [DigitalOcean](https://digitalocean.com/) account.
 
-    gem 'kitchen-digitalocean'
+# Installation and Setup
 
-And then execute:
+You'll need to install the gem on your development machine.
 
-    $ bundle
+```Bash
+gem install kitchen-digitalocean
+```
 
-Or install it yourself as:
+or add it to your Gemfile if you are using [Bundler](http://bundler.io/)
 
-    $ gem install kitchen-digitalocean
+```ruby
+source https://rubygems.org
 
-## Usage
+gem 'test-kitchen'
+gem 'kitchen-digitalocean'
+```
 
-Provide, at a minimum, the required driver options in your `.kitchen.yml` file:
+At minimum, you'll need to tell test-kitchen to use the digitalocean driver.
 
-    driver_plugin: digitalocean
-    driver_config:
-      digitalocean_client_id: [YOUR DIGITAL OCEAN CLIENT ID]
-      digitalocean_api_key: [YOUR DIGITAL OCEAN API KEY]
-      require_chef_omnibus: latest (if you'll be using Chef)
+```ruby
+---
+driver:
+  - name: digitalocean
+platforms:
+  - name: ubuntu-12-10
+```
 
-By default, the driver will spawn a 512MB Ubuntu 12.10 instance in the New York
-region. Additional, optional settings can be provided:
+You also have the option of providing some configs via environment variables.
+
+```bash
+export DIGITALOCEAN_CLIENT_ID="1234"
+export DIGITALOCEAN_API_KEY="5678"
+export SSH_KEY_IDS="1234, 5678"
+```
+
+Please refer to the [Getting Started Guide](http://kitchen.ci/) for any further documentation.
+
+# Default Configuration
+
+This driver can determine the image_id for a select number of platforms in each region. Currently, the following platform names are supported:
+
+```ruby
+---
+platforms:
+- name: ubuntu-10.04
+- name: ubuntu-12.10
+- name: ubuntu-13.04
+- name: ubuntu-13.10
+- name: centos-5.8
+- name: centos-6.4
+- name: centos-6.5
+- name: debian-6.0
+- name: debian-7.0
+- name: fedora-17
+- name: fedora-19
+- name: archlinux-2013.05
+```
+
+This will effectively generate a configuration similar to:
+
+```ruby
+---
+platforms:
+- name: ubuntu-10.04
+  driver_config:
+    image_id: 14097
+- name: ubuntu-12.10
+  driver_config:
+    image_id: 473123
+# ...
+- name: centos-5.8
+  driver_config:
+    image_id: 1601
+# ...
+```
 
-    image_id: [SERVER IMAGE ID]
-    flavor_id: [SERVER FLAVOR ID]
-    name: [A UNIQUE SERVER NAME]
-    region_id: [A VALID DIGITAL OCEAN REGION ID]
-    ssh_key_ids: [COMMA SEPERATED SSH KEY IDS FROM DIGITAL OCEAN]
+For specific default values, please consult [images.json](https://github.com/gregf/kitchen-digitalocean/blob/master/data/images.json).
 
 ### List of Regions
 
@@ -49,47 +98,6 @@ ID  Name
 3   San Francisco 1
 4   New York 2
 ```
-
-### List of Images
-```shell
-ID       Distribution  Name
-361740   Arch Linux    Arch Linux 2013.05 x32
-350424   Arch Linux    Arch Linux 2013.05 x64
-1602     CentOS        CentOS 5.8 x32
-1601     CentOS        CentOS 5.8 x64
-376568   CentOS        CentOS 6.4 x32
-562354   CentOS        CentOS 6.4 x64
-12575    Debian        Debian 6.0 x32
-12573    Debian        Debian 6.0 x64
-303619   Debian        Debian 7.0 x32
-308287   Debian        Debian 7.0 x64
-32387    Fedora        Fedora 17 x32
-32399    Fedora        Fedora 17 x32 Desktop
-32428    Fedora        Fedora 17 x64
-32419    Fedora        Fedora 17 x64 Desktop
-697056   Fedora        Fedora 19 x86
-696598   Fedora        Fedora 19 x86-64
-1004145  Ubuntu        Docker on Ubuntu 13.04 x64
-959207   Ubuntu        Ghost 0.3.3 on Ubuntu 12.04
-459444   Ubuntu        LAMP on Ubuntu 12.04
-483575   Ubuntu        Redmine on Ubuntu 12.04
-464235   Ubuntu        Ruby on Rails on Ubuntu 12.10 (Nginx + Unicorn)
-14098    Ubuntu        Ubuntu 10.04 x32
-14097    Ubuntu        Ubuntu 10.04 x64
-284211   Ubuntu        Ubuntu 12.04 x32
-284203   Ubuntu        Ubuntu 12.04 x64
-1015250  Ubuntu        Ubuntu 12.04.3 x32
-1015253  Ubuntu        Ubuntu 12.04.3 x64
-433240   Ubuntu        Ubuntu 12.10 x32
-473123   Ubuntu        Ubuntu 12.10 x64
-473136   Ubuntu        Ubuntu 12.10 x64 Desktop
-345791   Ubuntu        Ubuntu 13.04 x32
-350076   Ubuntu        Ubuntu 13.04 x64
-962304   Ubuntu        Ubuntu 13.10 x32
-961965   Ubuntu        Ubuntu 13.10 x64
-1061995  Ubuntu        Wordpress on Ubuntu 12.10
-```
-
 ### List of Flavors (Sizes)
 ```shell
 ID  Name
@@ -104,11 +112,25 @@ ID  Name
 68  96GB
 66  512MB
 ```
+# Development
+
+* Source hosted at [GitHub](https://github.com/gregf/kitchen-digitalocean)
+* Report issues/questions/feature requests on [GitHub Issues](https://github.com/gregf/kitchen-digitalocean/issues)
 
-## Contributing
+Pull requests are very welcome! Make sure your patches are well tested.
+Ideally create a topic branch for every separate change you make. For
+example:
 
-1. Fork it
+1. Fork the repo
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+# Authors
+
+Created and maintained by [Greg Fitzgerald](https://github.com/gregf/) (<greg@gregf.org>)
+
+# License
+
+Apache 2.0 (see [LICENSE](https://github.com/gregf/kitchen-digitalocean/blob/master/LICENSE.txt))

data/data/images.json

@@ -0,0 +1,14 @@
+{
+  "ubuntu-10.04": "14097",
+  "ubuntu-12.10": "473123",
+  "ubuntu-13.04": "350076",
+  "ubuntu-13.10": "1505699",
+  "centos-5.8": "1601",
+  "centos-6.5": "1646467",
+  "centos-6.4": "562354",
+  "debian-6.0": "12573",
+  "debian-7.0": "308287",
+  "fedora-17": "32428",
+  "fedora-19": "696598",
+  "archlinux-2013.05": "350424"
+}

data/lib/kitchen/driver/digitalocean.rb

@@ -28,17 +28,36 @@ module Kitchen
     #
     # @author Greg Fitzgerald <greg@gregf.org>
     class Digitalocean < Kitchen::Driver::SSHBase
-      default_config :image_id, '25489'
       default_config :flavor_id, '66'
-      default_config :name, nil
-      default_config :ssh_key_ids, nil
       default_config :region_id, '1'
       default_config :username, 'root'
       default_config :port, '22'
-      default_config :sudo, false
+
+      default_config :image_id do |driver|
+        driver.default_image
+      end
+
+      default_config :server_name do |driver|
+        driver.default_name
+      end
+
+      default_config :digitalocean_client_id do |driver|
+        ENV['DIGITALOCEAN_CLIENT_ID']
+      end
+
+      default_config :digitalocean_api_key do |driver|
+        ENV['DIGITALOCEAN_API_KEY']
+      end
+
+      default_config :ssh_key_ids do |driver|
+        ENV['SSH_KEY_IDS']
+      end
+
+      required_config :digitalocean_client_id
+      required_config :digitalocean_api_key
+      required_config :ssh_key_ids
 
       def create(state)
-        config[:name] ||= generate_name(instance.name)
         server = create_server
         state[:server_id] = server.id
 
@@ -61,16 +80,27 @@ module Kitchen
         state.delete(:hostname)
       end
 
+      def default_image
+        images[instance.platform.name]
+      end
+
+      def default_name
+        # Generate what should be a unique server name
+        rand_str = Array.new(8) { rand(36).to_s(36) }.join
+        "#{instance.name}-#{Etc.getlogin}-#{Socket.gethostname}-#{rand_str}"
+      end
+
       private
 
       def compute
         debug_compute_config
 
         server_def = {
-          provider:               :digitalocean,
+          provider:               'Digitalocean',
           digitalocean_api_key:   config[:digitalocean_api_key],
           digitalocean_client_id: config[:digitalocean_client_id]
         }
+
         Fog::Compute.new(server_def)
       end
 
@@ -78,7 +108,7 @@ module Kitchen
         debug_server_config
 
         compute.servers.create(
-          name:         config[:name],
+          name:         config[:server_name],
           image_id:     config[:image_id],
           flavor_id:    config[:flavor_id],
           region_id:    config[:region_id],
@@ -86,14 +116,18 @@ module Kitchen
         )
       end
 
-      def generate_name(base)
-        # Generate what should be a unique server name
-        rand_str = Array.new(8) { rand(36).to_s(36) }.join
-        "#{base}-#{Etc.getlogin}-#{Socket.gethostname}-#{rand_str}"
+      def images
+        @images ||= begin
+          json_file = File.expand_path(
+            File.join(%w{.. .. .. .. data images.json}),
+            __FILE__
+          )
+          JSON.load(IO.read(json_file))
+        end
       end
 
       def debug_server_config
-        debug("digitalocean:name #{config[:name]}")
+        debug("digitalocean:name #{config[:server_name]}")
         debug("digitalocean:image_id #{config[:image_id]}")
         debug("digitalocean:flavor_id #{config[:flavor_id]}")
         debug("digitalocean:region_id #{config[:region_id]}")

data/lib/kitchen/driver/digitalocean_version.rb

@@ -19,7 +19,7 @@
 module Kitchen
   module Driver
     # Version string for Digital Ocean Kitchen driver
-    DIGITALOCEAN_VERSION = '0.3.1'
+    DIGITALOCEAN_VERSION = '0.4.0'
   end
 end
 

data/spec/kitchen/driver/digitalocean_spec.rb

@@ -1,8 +1,8 @@
-#
 # -*- encoding: utf-8 -*-
-# Author:: Greg Fitzgerald (<greg@gregf.org>)
 #
-# Copyright (C) 2013, Greg Fitzgerald
+# Author:: Jonathan Hartman (<j@p4nt5.com>)
+#
+# Copyright (C) 2013, Jonathan Hartman
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,20 +16,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative '../../spec_helper'
+
 require 'logger'
 require 'stringio'
 require 'rspec'
 require 'kitchen'
-require_relative '../../spec_helper'
 
 describe Kitchen::Driver::Digitalocean do
   let(:logged_output) { StringIO.new }
   let(:logger) { Logger.new(logged_output) }
   let(:config) { Hash.new }
   let(:state) { Hash.new }
+  let(:platform_name) { 'ubuntu' }
 
   let(:instance) do
-    double(name: 'potatoes', logger: logger, to_str: 'instance')
+    double(
+      :name => 'potatoes',
+      :logger => logger,
+      :to_str => 'instance',
+      :platform => double(:name => platform_name)
+    )
   end
 
   let(:driver) do
@@ -38,51 +45,76 @@ describe Kitchen::Driver::Digitalocean do
     d
   end
 
+  before(:each) do
+    ENV['DIGITALOCEAN_CLIENT_ID'] = 'clientid'
+    ENV['DIGITALOCEAN_API_KEY'] = 'apikey'
+    ENV['SSH_KEY_IDS'] = '1234'
+  end
+
   describe '#initialize'do
     context 'default options' do
-      it 'defaults to a Ubuntu 12.10 image ID' do
-        expect(driver[:image_id]).to eq('25489')
-      end
-
-      it 'defaults to a 512MB flavor size' do
+      it 'defaults to the smallest flavor size' do
         expect(driver[:flavor_id]).to eq('66')
       end
 
-      it 'defaults to no SSH Key ID' do
-        expect(driver[:ssh_key_ids]).to eq(nil)
-      end
-
       it 'defaults to SSH with root user on port 22' do
         expect(driver[:username]).to eq('root')
         expect(driver[:port]).to eq('22')
       end
 
-      it 'defaults to no server name' do
-        expect(driver[:name]).to eq(nil)
+      it 'defaults to a random server name' do
+        expect(driver[:server_name]).to be_a(String)
       end
 
-      it 'defaults to New York region id' do
+      it 'defaults to region id 1' do
         expect(driver[:region_id]).to eq('1')
       end
+
+      it 'defaults to SSH Key Ids from $SSH_KEY_IDS' do
+        expect(driver[:ssh_key_ids]).to eq('1234')
+      end
+
+      it 'defaults to Client ID from $DIGITALOCEAN_CLIENT_ID' do
+        expect(driver[:digitalocean_client_id]).to eq('clientid')
+      end
+
+      it 'defaults to API key from $DIGITALOCEAN_API_KEY' do
+        expect(driver[:digitalocean_api_key]).to eq('apikey')
+      end
     end
 
-    context 'overridden options' do
-      let(:config) do
-        {
-          image_id: '2676',
-          flavor_id: '63',
-          ssh_key_ids: '1234',
-          username: 'admin',
-          port: '2222',
-          name: 'puppy',
-          region_id: '3'
-        }
+    context 'name is ubuntu-12.10' do
+      let(:platform_name) { 'ubuntu-12.10' }
+
+      it 'defaults to the correct image ID' do
+        expect(driver[:image_id]).to eq('473123')
       end
+    end
+
+    context 'name is centos-6.4' do
+      let(:platform_name) { 'centos-6.4' }
+
+      it 'defaults to the correct image ID' do
+        expect(driver[:image_id]).to eq('562354')
+      end
+    end
 
-      it 'uses all the overridden options' do
-        drv = driver
-        config.each do |k, v|
-          expect(drv[k]).to eq(v)
+    context 'overridden options' do
+      config = {
+        :image_id => '22',
+        :flavor_id => '63',
+        :ssh_key_ids => '5678',
+        :username => 'admin',
+        :port => '2222',
+        :server_name => 'puppy',
+        :region_id => '3'
+      }
+
+      let(:config) { config }
+
+      config.each do |key, value|
+        it "it uses the overridden #{key} option" do
+          expect(driver[key]).to eq(value)
         end
       end
     end
@@ -90,29 +122,29 @@ describe Kitchen::Driver::Digitalocean do
 
   describe '#create' do
     let(:server) do
-      double('id' => 'test123', 'wait_for' => true,
-           'public_ip_address' => '1.2.3.4')
+      double(:id => 'test123', :wait_for => true,
+        :public_ip_address => '1.2.3.4')
     end
     let(:driver) do
       d = Kitchen::Driver::Digitalocean.new(config)
       d.instance = instance
-      d.stub(:generate_name).with('potatoes').and_return('a_monkey!')
+      d.stub(:default_name).and_return('a_monkey!')
       d.stub(:create_server).and_return(server)
       d.stub(:wait_for_sshd).with('1.2.3.4').and_return(true)
       d
     end
 
-    context 'Client ID and API key only provided' do
+    context 'username and API key only provided' do
       let(:config) do
         {
-          digitalocean_client_id: 'Quei4zaey9nijiexoong',
-          digitalocean_api_key: 'Eep4eidaiz7chohd4cheyei9peigooyoa9Ek4sua',
+          :digitalocean_client_id => 'hello',
+          :digitalocean_api_key => 'world'
         }
       end
 
       it 'generates a server name in the absence of one' do
         driver.create(state)
-        expect(driver[:name]).to eq('a_monkey!')
+        expect(driver[:server_name]).to eq('a_monkey!')
       end
 
       it 'gets a proper server ID' do
@@ -130,10 +162,10 @@ describe Kitchen::Driver::Digitalocean do
   describe '#destroy' do
     let(:server_id) { '12345' }
     let(:hostname) { 'example.com' }
-    let(:state) { { server_id: server_id, hostname: hostname } }
-    let(:server) { double(nil?: false, destroy: true) }
-    let(:servers) { double(get: server) }
-    let(:compute) { double(servers: servers) }
+    let(:state) { { :server_id => server_id, :hostname => hostname } }
+    let(:server) { double(:nil? => false, :destroy => true) }
+    let(:servers) { double(:get => server) }
+    let(:compute) { double(:servers => servers) }
 
     let(:driver) do
       d = Kitchen::Driver::Digitalocean.new(config)
@@ -167,7 +199,7 @@ describe Kitchen::Driver::Digitalocean do
         s.stub(:get).with('12345').and_return(nil)
         s
       end
-      let(:compute) { double(servers: servers) }
+      let(:compute) { double(:servers => servers) }
       let(:driver) do
         d = Kitchen::Driver::Digitalocean.new(config)
         d.instance = instance
@@ -185,21 +217,22 @@ describe Kitchen::Driver::Digitalocean do
   describe '#compute' do
     let(:config) do
       {
-        digitalocean_client_id: 'Aife3ahkii4oot9oowai',
-        digitalocean_api_key: 'yahsh4aesh3oov9daiWach'
+        :digitalocean_client_id => 'monkey',
+        :digitalocean_api_key => 'potato',
       }
     end
 
     context 'all requirements provided' do
       it 'creates a new compute connection' do
         Fog::Compute.stub(:new) { |arg| arg }
-        res = config.merge(provider: :digitalocean)
-        expect(driver.send(:compute)).to eq(res)
+        expect(driver.send(:compute)).to be_a(Hash)
       end
     end
 
-    context 'no client id provided' do
-      let(:config) { { digitalocean_api_key: 'yahsh4aesh3oov9daiWach' } }
+    context 'no username provided' do
+      let(:config) do
+        { :digitalocean_client_id => nil, :digitalocean_api_key => '1234' }
+      end
 
       it 'raises an error' do
         expect { driver.send(:compute) }.to raise_error(ArgumentError)
@@ -207,40 +240,38 @@ describe Kitchen::Driver::Digitalocean do
     end
 
     context 'no API key provided' do
-      let(:config) { { digitalocean_client_id: 'Aife3ahkii4oot9oowai' } }
-
-      it 'raises an error' do
-        expect { driver.send(:compute) }.to raise_error(ArgumentError)
+      let(:config) do
+        { :digitalocean_client_id => 'monkey', :digitalocean_api_key => nil }
       end
-    end
-
-    context 'no region id provided' do
-      let(:config) { { region_id: '1' } }
 
       it 'raises an error' do
         expect { driver.send(:compute) }.to raise_error(ArgumentError)
       end
     end
-
   end
 
   describe '#create_server' do
     let(:config) do
       {
-        name: 'hello',
-        image_id: '2047',
-        flavor_id: '66',
-        ssh_key_ids: '1234',
-        region_id: '1'
+        :server_name => 'hello',
+        :image_id => 'there',
+        :flavor_id => 'captain',
+        :region_id => '1',
+        :ssh_key_ids => '1234'
       }
     end
-    before(:each) { @config = config.dup }
+    before(:each) do
+      @expected = config.merge(:name => config[:server_name])
+      @expected.delete_if do |k, v|
+        k == :server_name
+      end
+    end
     let(:servers) do
       s = double('servers')
       s.stub(:create) { |arg| arg }
       s
     end
-    let(:compute) { double(servers: servers) }
+    let(:compute) { double(:servers => servers) }
     let(:driver) do
       d = Kitchen::Driver::Digitalocean.new(config)
       d.instance = instance
@@ -249,19 +280,19 @@ describe Kitchen::Driver::Digitalocean do
     end
 
     it 'creates the server using a compute connection' do
-      expect(driver.send(:create_server)).to eq(@config)
+      expect(driver.send(:create_server)).to eq(@expected)
     end
   end
 
-  describe '#generate_name' do
+  describe '#default_name' do
     before(:each) do
       Etc.stub(:getlogin).and_return('user')
       Socket.stub(:gethostname).and_return('host')
     end
 
     it 'generates a name' do
-      expect(driver.send(:generate_name, 'monkey')).to match(
-        /^monkey-user-host-/)
+      expect(driver.default_name).to match(
+        /^potatoes-user-host-/)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-digitalocean
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Greg Fitzgerald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-28 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -123,6 +123,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- data/images.json
 - kitchen-digitalocean.gemspec
 - lib/kitchen/driver/digitalocean.rb
 - lib/kitchen/driver/digitalocean_version.rb