kitchen-gce 0.0.6 → 0.1.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.1.0 / 2014-03-29
+
+### New Features
+
+* PR #7: Add support for specifying SSH keys in public_key_path, via @someara
+* Add support for setting username
+* Support GCE v1 API, including persistent disks.
+	
+### Improvements
+
+* Add rspec tests and Travis support.
+	
 ## 0.0.6 / 2014-02-23:
 
 * Require Ruby 1.9 or greater.

data/LICENSE

@@ -1,6 +1,6 @@
 Author:: Andrew Leonard (<andy@hurricane-ridge.com>)
 
-Copyright (C) 2013, Andrew Leonard
+Copyright (C) 2013-2014, Andrew Leonard
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,6 +1,6 @@
 # Kitchen::Gce - A Test Kitchen Driver for Google Compute Engine
 
-[![Code Climate](https://codeclimate.com/github/anl/kitchen-gce.png)](https://codeclimate.com/github/anl/kitchen-gce)
+[![Build Status](https://travis-ci.org/anl/kitchen-gce.png?branch=master)](https://travis-ci.org/anl/kitchen-gce) [![Code Climate](https://codeclimate.com/github/anl/kitchen-gce.png)](https://codeclimate.com/github/anl/kitchen-gce)
 
 This is a [Test Kitchen](https://github.com/opscode/test-kitchen/)
 driver for Google Compute Engine.  While similar to EC2 and other IaaS
@@ -23,11 +23,12 @@ file, and note the email address associated with the service account
 (e.g. 123456789012@developer.gserviceaccount.com - not the project
 owner's email address).
 
-If you have not [set up SSH keys for your GCE
+If you are not using the `public_key_path` setting (see below) and
+have not [set up SSH keys for your GCE
 environment](https://developers.google.com/compute/docs/instances#sshkeys),
 you must also do that prior to using kitchen-gce.  Also, you will
-likely want to add your GCE SSH keys to ssh-agent prior to converging
-any instances.
+likely want to add your SSH keys to ssh-agent prior to converging any
+instances.
 
 ## Installation
 
@@ -58,6 +59,15 @@ launching instances into a zone that is down for maintenance.  If
 "any" is specified, kitchen-gce will select a zone from all areas.
 Default: `us` (lowest cost area); valid values: `any`, `europe`, `us`
 
+### autodelete_disk
+
+Boolean specifying whether or not to automatically delete boot disk
+for test instance.  Default: true
+
+### disk_size
+
+Size, in gigabytes of boot disk.  Default: 10.
+
 ### google_client_email
 
 **Required** Email address associated with your GCE service account.
@@ -94,14 +104,18 @@ GCE instance type (size) to launch; default: `n1-standard-1`
 
 GCE network that instance will be attached to; default: `default`
 
+### public_key_path
+
+Path to the public half of the ssh key that will be deployed to 
+`~username/.ssh/authorized_keys`; see also "username" below.
+
 ### tags
 
 Array of tags to associate with instance; default: `[]`
 
 ### username
 
-Username to log into instance as; this user is assumed to have access
-to the appropriate SSH keys.  Default: `ENV['USER']`
+Username test-kitchen will log into instance as; default: `ENV['USER']`
 
 ### zone_name
 
@@ -126,8 +140,9 @@ driver_config:
 platforms:
 - name: debian-7
   driver_config:
-    image_name: debian-7-wheezy-v20130926
+    image_name: debian-7-wheezy-v20140318
     require_chef_omnibus: true
+    public_key_path: '/home/alice/.ssh/google_compute_engine.pub'
     tags: ["somerole"]
 
 suites:

data/Rakefile

@@ -0,0 +1,8 @@
+# -*- coding: utf-8 -*-
+
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec unit tests'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]

data/kitchen-gce.gemspec

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'kitchen-gce'
-  s.version     = '0.0.6'
-  s.date        = '2014-02-23'
+  s.version     = '0.1.0'
+  s.date        = '2014-03-29'
   s.summary     = 'Kitchen::Driver::Gce'
   s.description = 'A Test-Kitchen driver for Google Compute Engine'
   s.authors     = ['Andrew Leonard']
@@ -12,11 +12,13 @@ Gem::Specification.new do |s|
   s.license     = 'Apache 2.0'
 
   s.add_dependency 'test-kitchen'
-  s.add_dependency 'faraday', '~> 0.8.9'
-  s.add_dependency 'fog', '1.19.0'
+  s.add_dependency 'faraday', '~> 0.8.9' # See GH issue RiotGames/ridley#239
+  s.add_dependency 'fog', '>= 1.20.0'
   s.add_dependency 'google-api-client'
 
   s.add_development_dependency 'bundler'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
 

data/lib/kitchen/driver/gce.rb

@@ -2,7 +2,7 @@
 #
 # Author:: Andrew Leonard (<andy@hurricane-ridge.com>)
 #
-# Copyright (C) 2013, Andrew Leonard
+# Copyright (C) 2013-2014, Andrew Leonard
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,6 +28,8 @@ module Kitchen
     # @author Andrew Leonard <andy@hurricane-ridge.com>
     class Gce < Kitchen::Driver::SSHBase
       default_config :area, 'us'
+      default_config :autodelete_disk, true
+      default_config :disk_size, 10
       default_config :machine_type, 'n1-standard-1'
       default_config :network, 'default'
       default_config :inst_name, nil
@@ -43,12 +45,12 @@ module Kitchen
       def create(state)
         return if state[:server_id]
 
-        server = create_instance
-        state[:server_id] = server.identity
+        instance = create_instance
+        state[:server_id] = instance.identity
 
         info("GCE instance <#{state[:server_id]}> created.")
 
-        wait_for_up_instance(server, state)
+        wait_for_up_instance(instance, state)
 
       rescue Fog::Errors::Error, Excon::Errors::Error => ex
         raise ActionFailed, ex.message
@@ -57,8 +59,8 @@ module Kitchen
       def destroy(state)
         return if state[:server_id].nil?
 
-        server = connection.servers.get(state[:server_id])
-        server.destroy unless server.nil?
+        instance = connection.servers.get(state[:server_id])
+        instance.destroy unless instance.nil?
         info("GCE instance <#{state[:server_id]}> destroyed.")
         state.delete(:server_id)
         state.delete(:hostname)
@@ -75,21 +77,40 @@ module Kitchen
         )
       end
 
+      def create_disk
+        disk = connection.disks.create(
+          name: config[:inst_name],
+          size_gb: config[:disk_size],
+          zone_name: config[:zone_name],
+          source_image: config[:image_name]
+        )
+
+        disk.wait_for { disk.ready? }
+        disk
+      end
+
       def create_instance
-        config[:inst_name] ||= generate_name
+        config[:inst_name] ||= generate_inst_name
         config[:zone_name] ||= select_zone
 
+        disk = create_disk
+        create_server(disk)
+      end
+
+      def create_server(disk)
         connection.servers.create(
           name: config[:inst_name],
-          image_name: config[:image_name],
+          disks: [disk.get_as_boot_disk(true, config[:autodelete_disk])],
           machine_type: config[:machine_type],
           network: config[:network],
           tags: config[:tags],
-          zone_name: config[:zone_name]
+          zone_name: config[:zone_name],
+          public_key_path: config[:public_key_path],
+          username: config[:username]
         )
       end
 
-      def generate_name
+      def generate_inst_name
         # Inspired by generate_name from kitchen-rackspace
         base_name = instance.name[0..26] # UUID is 36 chars, max name length 63
         "#{base_name}-#{SecureRandom.uuid}"
@@ -108,14 +129,14 @@ module Kitchen
         zones.sample.name
       end
 
-      def wait_for_up_instance(server, state)
-        server.wait_for do
+      def wait_for_up_instance(instance, state)
+        instance.wait_for do
           print '.'
           ready?
         end
         print '(server ready)'
-        state[:hostname] = server.public_ip_address ||
-          server.private_ip_address
+        state[:hostname] = instance.public_ip_address ||
+          instance.private_ip_address
         wait_for_sshd(state[:hostname], config[:username])
         puts '(ssh ready)'
       end

data/spec/kitchen/driver/gce_spec.rb

@@ -0,0 +1,306 @@
+# -*- coding: utf-8 -*-
+#
+# Author:: Andrew Leonard (<andy@hurricane-ridge.com>)
+#
+# Copyright (C) 2013-2014, Andrew Leonard
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../../spec_helper.rb'
+
+require 'resolv'
+
+describe Kitchen::Driver::Gce do
+
+  let(:config) do
+    { google_client_email: '123456789012@developer.gserviceaccount.com',
+      google_key_location: '/home/user/gce/123456-privatekey.p12',
+      google_project: 'alpha-bravo-123'
+    }
+  end
+
+  let(:state) { Hash.new }
+
+  let(:logged_output) { StringIO.new }
+  let(:logger) { Logger.new(logged_output) }
+
+  let(:instance) do
+    double(
+      logger: logger,
+      name: 'default-distro-12'
+    )
+  end
+
+  let(:driver) do
+    d = Kitchen::Driver::Gce.new(config)
+    d.instance = instance
+    d.stub(:wait_for_sshd).and_return(true)
+    d
+  end
+
+  let(:fog) do
+    Fog::Compute::Google::Mock.new
+  end
+
+  let(:disk) do
+    fog.disks.create(
+      name: 'rspec-test-disk',
+      size_gb: 10,
+      zone_name: 'us-central1-b',
+      source_image: 'debian-7-wheezy-v20131120'
+    )
+  end
+
+  let(:server) do
+    fog.servers.create(
+      name: 'rspec-test-instance',
+      disks: [disk],
+      machine_type: 'n1-standard-1',
+      zone_name: 'us-central1-b'
+    )
+  end
+
+  before(:each) do
+    Fog.mock!
+    Fog::Mock.reset
+    Fog::Mock.delay = 0
+  end
+
+  describe '#initialize' do
+    context 'with default options' do
+
+      defaults = {
+        area: 'us',
+        autodelete_disk: true,
+        disk_size: 10,
+        inst_name: nil,
+        machine_type: 'n1-standard-1',
+        network: 'default',
+        tags: [],
+        username: ENV['USER'],
+        zone_name: nil }
+
+      defaults.each do |k, v|
+        it "sets the correct default for #{k}" do
+          expect(driver[k]).to eq(v)
+        end
+      end
+    end
+
+    context 'with overriden options' do
+      overrides = {
+        area: 'europe',
+        autodelete_disk: false,
+        disk_size: 15,
+        inst_name: 'ci-instance',
+        machine_type: 'n1-highmem-8',
+        network: 'dev-net',
+        tags: %w(qa integration),
+        username: 'root',
+        zone_name: 'europe-west1-a'
+      }
+
+      let(:config) { overrides }
+
+      overrides.each do |k, v|
+        it "overrides the default value for #{k}" do
+          expect(driver[k]).to eq(v)
+        end
+      end
+    end
+  end
+
+  describe '#connection' do
+    context 'with required variables set' do
+      it 'returns a Fog Compute object' do
+        expect(driver.send(:connection)).to be_a(Fog::Compute::Google::Mock)
+      end
+
+      it 'uses the v1 api version' do
+        conn = driver.send(:connection)
+        expect(conn.api_version).to eq('v1')
+      end
+    end
+
+    context 'without required variables set' do
+      let(:config) { Hash.new }
+
+      it 'raises an error' do
+        expect { driver.send(:connection) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#create' do
+    context 'with an existing server' do
+      let(:state) do
+        s = Hash.new
+        s[:server_id] = 'default-distro-12345678'
+        s
+      end
+
+      it 'returns if server_id already exists' do
+        expect(driver.create(state)).to equal nil
+      end
+    end
+
+    context 'when an instance is successfully created' do
+
+      let(:driver) do
+        d = Kitchen::Driver::Gce.new(config)
+        d.stub(create_instance: server)
+        d.stub(:wait_for_up_instance).and_return(nil)
+        d
+      end
+
+      it 'sets a value for server_id in the state hash' do
+        driver.send(:create, state)
+        expect(state[:server_id]).to eq('rspec-test-instance')
+      end
+
+      it 'returns nil' do
+        expect(driver.send(:create, state)).to equal(nil)
+      end
+
+    end
+
+  end
+
+  describe '#create_disk' do
+    context 'with defaults and required options' do
+      it 'returns a Google Disk object' do
+        config[:image_name] = 'debian-7-wheezy-v20131120'
+        config[:inst_name] = 'rspec-disk'
+        config[:zone_name] = 'us-central1-a'
+        expect(driver.send(:create_disk)).to be_a(Fog::Compute::Google::Disk)
+      end
+    end
+
+    context 'without required options' do
+      it 'returns a Fog NotFound Error' do
+        expect { driver.send(:create_disk) }.to raise_error(
+          Fog::Errors::NotFound)
+      end
+    end
+  end
+
+  describe '#create_instance' do
+    context 'with default options' do
+      it 'returns a Fog Compute Server object' do
+        expect(driver.send(:create_instance)).to be_a(
+          Fog::Compute::Google::Server)
+      end
+    end
+  end
+
+  describe '#create_server' do
+    context 'with default options' do
+      it 'returns a Fog Compute Server object' do
+        expect(driver.send(:create_instance)).to be_a(
+          Fog::Compute::Google::Server)
+      end
+    end
+  end
+
+  describe '#destroy' do
+    let(:state) do
+      s = Hash.new
+      s[:server_id] = 'rspec-test-instance'
+      s[:hostname] = '198.51.100.17'
+      s
+    end
+
+    it 'returns if server_id does not exist' do
+      expect(driver.destroy({})).to equal nil
+    end
+
+    it 'removes the server state information' do
+      driver.destroy(state)
+      expect(state[:hostname]).to equal(nil)
+      expect(state[:server_id]).to equal(nil)
+    end
+  end
+
+  describe '#generate_inst_name' do
+    context 'with a name less than 28 characters' do
+      it 'concatenates the name and a UUID' do
+        expect(driver.send(:generate_inst_name)).to match(
+          /^default-distro-12-[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/)
+      end
+    end
+
+    context 'with a name 28 characters or longer' do
+      let(:instance) do
+        double(name: '1234567890123456789012345678')
+      end
+
+      it 'shortens the base name and appends a UUID' do
+        expect(driver.send(:generate_inst_name)).to match(
+          /^123456789012345678901234567
+            -[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/x)
+      end
+    end
+  end
+
+  describe '#select_zone' do
+    context 'when choosing from any area' do
+      let(:config) do
+        { area: 'any',
+          google_client_email: '123456789012@developer.gserviceaccount.com',
+          google_key_location: '/home/user/gce/123456-privatekey.p12',
+          google_project: 'alpha-bravo-123'
+        }
+      end
+
+      it 'chooses from all zones' do
+        expect(driver.send(:select_zone)).to satisfy do |zone|
+          %w(europe-west1-a us-central1-a us-central1-b
+             us-central2-a).include?(zone)
+        end
+      end
+    end
+
+    context 'when choosing from the "europe" area' do
+      let(:config) do
+        { area: 'europe',
+          google_client_email: '123456789012@developer.gserviceaccount.com',
+          google_key_location: '/home/user/gce/123456-privatekey.p12',
+          google_project: 'alpha-bravo-123'
+        }
+      end
+
+      it 'chooses a zone in europe' do
+        expect(driver.send(:select_zone)).to satisfy do |zone|
+          %w(europe-west1-a).include?(zone)
+        end
+      end
+    end
+
+    context 'when choosing from the default "us" area' do
+      it 'chooses a zone in the us' do
+        expect(driver.send(:select_zone)).to satisfy do |zone|
+          %w(us-central1-a us-central1-b us-central2-a).include?(zone)
+        end
+
+      end
+    end
+  end
+
+  describe '#wait_for_up_instance' do
+    it 'sets the hostname' do
+      driver.send(:wait_for_up_instance, server, state)
+      # Mock instance gives us a random IP each time:
+      expect(state[:hostname]).to match(Resolv::IPv4::Regex)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+#
+# Author:: Andrew Leonard (<andy@hurricane-ridge.com>)
+#
+# Copyright (C) 2013-2014, Andrew Leonard
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'rspec'
+
+require_relative '../lib/kitchen/driver/gce'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-gce
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-23 00:00:00.000000000 Z
+date: 2014-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen
@@ -48,17 +48,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,12 +162,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - kitchen-gce.gemspec
 - lib/kitchen/driver/gce.rb
+- spec/kitchen/driver/gce_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/anl/kitchen-gce
 licenses:
 - Apache 2.0
@@ -155,12 +191,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 134419407739648312
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: Kitchen::Driver::Gce