kitchen-gce 0.1.2 → 0.2.0

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-20 08:00:47 -0700 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 102

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 / 2014-09-20
+
+### Improvements
+
+* #10: Deprecate "area" in configuration for "region"
+* #11: Fix name length, via @pdunnavant
+* #12: Generate instance names that are valid for GCE
+
 ## 0.1.2 / 2014-04-16
 
 ### New Features

data/README.md

@@ -49,16 +49,10 @@ Then, execute `bundle install`.
 
 ## Configuration
 
-### area
+### area 
 
-Area in which to launch instances.  For the purposes of this driver,
-"area" is defined as the part prior to the first hyphen in an
-availability zone's name; e.g. in "us-central1-b", the area is "us".
-Specifying area but not "zone_name" allows kitchen-gce to avoid
-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`, `asia`,
-`europe`, `us`
+(Deprecated - use equivalent "region" instead.  If both "area" and
+"region" are set, the value of "region" will be used.)
 
 ### autodelete_disk
 
@@ -110,6 +104,17 @@ GCE network that instance will be attached to; default: `default`
 Path to the public half of the ssh key that will be deployed to 
 `~username/.ssh/authorized_keys`; see also "username" below.
 
+### region
+
+Region in which to launch instances.  "Region" is defined as the part
+prior to the second hyphen in an availability zone's name; e.g. in
+"us-central1-b", the region is "us-central1".  Specifying region but
+not "zone_name" allows kitchen-gce to avoid launching instances into a
+zone that is down for maintenance.  If "any" is specified, kitchen-gce
+will select a zone from all regions.  Default: `us-central1` (lowest
+cost region); valid values: `any`, `asia-east1`, `europe-west1`,
+`us-central1`
+
 ### tags
 
 Array of tags to associate with instance; default: `[]`
@@ -121,7 +126,7 @@ Username test-kitchen will log into instance as; default: `ENV['USER']`
 ### zone_name
 
 Location into which instances will be launched.  If not specified, a
-zone is chosen from available zones within the "area" (see above).
+zone is chosen from available zones within the "region" (see above).
 
 ## Example
 
@@ -132,11 +137,11 @@ like this:
 ---
 driver_plugin: gce
 driver_config:
-  area: any
   google_client_email: "123456789012@developer.gserviceaccount.com"
   google_key_location: "<%= ENV['HOME']%>/gce/1234567890abcdef1234567890abcdef12345678-privatekey.p12"
   google_project: "alpha-bravo-123"
   network: "kitchenci"
+  region: any
 
 platforms:
 - name: debian-7

data/kitchen-gce.gemspec

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = 'kitchen-gce'
-  s.version     = '0.1.2'
-  s.date        = '2014-04-16'
+  s.version     = '0.2.0'
+  s.date        = '2014-09-20'
   s.summary     = 'Kitchen::Driver::Gce'
   s.description = 'A Test-Kitchen driver for Google Compute Engine'
   s.authors     = ['Andrew Leonard']

data/lib/kitchen/driver/gce.rb

@@ -27,7 +27,7 @@ module Kitchen
     #
     # @author Andrew Leonard <andy@hurricane-ridge.com>
     class Gce < Kitchen::Driver::SSHBase
-      default_config :area, 'us'
+      default_config :area, 'us-central1'
       default_config :autodelete_disk, true
       default_config :disk_size, 10
       default_config :machine_type, 'n1-standard-1'
@@ -90,6 +90,8 @@ module Kitchen
       end
 
       def create_instance
+        config[:region] ||= config[:area]
+
         config[:inst_name] ||= generate_inst_name
         config[:zone_name] ||= select_zone
 
@@ -112,20 +114,27 @@ module Kitchen
 
       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}"
+        name = instance.name.downcase
+        name.gsub!(/([^-a-z0-9])/, '-')
+        name = 't' + name unless name =~ /^[a-z]/
+        base_name = name[0..25] # UUID is 36 chars, max name length 63
+        gen_name = "#{base_name}-#{SecureRandom.uuid}"
+        unless gen_name =~ /^[a-z]([-a-z0-9]*[a-z0-9])?$/
+          fail "Invalid generated instance name: #{gen_name}"
+        end
+        gen_name
       end
 
       def select_zone
-        if config[:area] == 'any'
+        if config[:region] == 'any'
           zone_regexp = /^[a-z]+\-/
         else
-          zone_regexp = /^#{config[:area]}\-/
+          zone_regexp = /^#{config[:region]}\-/
         end
         zones = connection.zones.select do |z|
           z.status == 'UP' && z.name.match(zone_regexp)
         end
-        fail 'No up zones in area' unless zones.length >= 1
+        fail 'No up zones in region' unless zones.length >= 1
         zones.sample.name
       end
 

data/spec/kitchen/driver/gce_spec.rb

@@ -44,7 +44,7 @@ describe Kitchen::Driver::Gce do
   let(:driver) do
     d = Kitchen::Driver::Gce.new(config)
     d.instance = instance
-    d.stub(:wait_for_sshd).and_return(true)
+    allow(d).to receive(:wait_for_sshd) { true }
     d
   end
 
@@ -57,7 +57,7 @@ describe Kitchen::Driver::Gce do
       name: 'rspec-test-disk',
       size_gb: 10,
       zone_name: 'us-central1-b',
-      source_image: 'debian-7-wheezy-v20131120'
+      source_image: 'debian-7-wheezy-v20130816'
     )
   end
 
@@ -80,12 +80,13 @@ describe Kitchen::Driver::Gce do
     context 'with default options' do
 
       defaults = {
-        area: 'us',
+        area: 'us-central1',
         autodelete_disk: true,
         disk_size: 10,
         inst_name: nil,
         machine_type: 'n1-standard-1',
         network: 'default',
+        region: nil,
         tags: [],
         username: ENV['USER'],
         zone_name: nil }
@@ -99,12 +100,13 @@ describe Kitchen::Driver::Gce do
 
     context 'with overriden options' do
       overrides = {
-        area: 'europe',
+        area: 'europe-west',
         autodelete_disk: false,
         disk_size: 15,
         inst_name: 'ci-instance',
         machine_type: 'n1-highmem-8',
         network: 'dev-net',
+        region: 'asia-east1',
         tags: %w(qa integration),
         username: 'root',
         zone_name: 'europe-west1-a'
@@ -158,8 +160,8 @@ describe Kitchen::Driver::Gce do
 
       let(:driver) do
         d = Kitchen::Driver::Gce.new(config)
-        d.stub(create_instance: server)
-        d.stub(:wait_for_up_instance).and_return(nil)
+        allow(d).to receive(:create_instance) { server }
+        allow(d).to receive(:wait_for_up_instance) { nil }
         d
       end
 
@@ -179,7 +181,7 @@ describe Kitchen::Driver::Gce do
   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[:image_name] = 'debian-7-wheezy-v20130816'
         config[:inst_name] = 'rspec-disk'
         config[:zone_name] = 'us-central1-a'
         expect(driver.send(:create_disk)).to be_a(Fog::Compute::Google::Disk)
@@ -200,6 +202,43 @@ describe Kitchen::Driver::Gce do
         expect(driver.send(:create_instance)).to be_a(
           Fog::Compute::Google::Server)
       end
+
+      it 'sets the region to the default "us-central1"' do
+        driver.send(:create_instance)
+        expect(config[:region]).to eq('us-central1')
+      end
+    end
+
+    context 'area set, region unset' do
+      let(:config) do
+        { area: 'europe-west1',
+          google_client_email: '123456789012@developer.gserviceaccount.com',
+          google_key_location: '/home/user/gce/123456-privatekey.p12',
+          google_project: 'alpha-bravo-123'
+        }
+      end
+
+      it 'sets region to the area value' do
+        driver.send(:create_instance)
+        expect(config[:region]).to eq(config[:area])
+      end
+    end
+
+    context 'area set, region set' do
+      let(:config) do
+        { area: 'fugazi',
+          google_client_email: '123456789012@developer.gserviceaccount.com',
+          google_key_location: '/home/user/gce/123456-privatekey.p12',
+          google_project: 'alpha-bravo-123',
+          region: 'europe-west1'
+        }
+      end
+
+      it 'sets the region independent of the area value' do
+        driver.send(:create_instance)
+        expect(config[:region]).to eq('europe-west1')
+      end
+
     end
   end
 
@@ -239,23 +278,60 @@ describe Kitchen::Driver::Gce do
       end
     end
 
-    context 'with a name 28 characters or longer' do
+    context 'with a name 27 characters or longer' do
       let(:instance) do
-        double(name: '1234567890123456789012345678')
+        double(name: 'a23456789012345678901234567')
       end
 
       it 'shortens the base name and appends a UUID' do
+        expect(driver.send(:generate_inst_name).length).to eq 63
         expect(driver.send(:generate_inst_name)).to match(
-          /^123456789012345678901234567
+          /^a2345678901234567890123456
+            -[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/x)
+      end
+    end
+
+    context 'with a "name" value containing an invalid leading character' do
+      let(:instance) do
+        double(name: '12345')
+      end
+
+      it 'adds a leading "t"' do
+        expect(driver.send(:generate_inst_name)).to match(
+          /^t12345
+            -[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/x)
+      end
+    end
+
+    context 'with a "name" value containing uppercase letters' do
+      let(:instance) do
+        double(name: 'AbCdEf')
+      end
+
+      it 'downcases the "name" characters in the instance name' do
+        expect(driver.send(:generate_inst_name)).to match(
+          /^abcdef
+            -[a-f0-9]{8}-([a-f0-9]{4}-){3}[a-f0-9]{12}$/x)
+      end
+    end
+
+    context 'with a name value containing invalid characters' do
+      let(:instance) do
+        double(name: 'a!b@c#d$e%f^g&h*i(j)')
+      end
+
+      it 'replaces the invalid characters with dashes' do
+        expect(driver.send(:generate_inst_name)).to match(
+          /^a-b-c-d-e-f-g-h-i-j-
             -[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
+    context 'when choosing from any region' do
       let(:config) do
-        { area: 'any',
+        { region: 'any',
           google_client_email: '123456789012@developer.gserviceaccount.com',
           google_key_location: '/home/user/gce/123456-privatekey.p12',
           google_project: 'alpha-bravo-123'
@@ -270,24 +346,32 @@ describe Kitchen::Driver::Gce do
       end
     end
 
-    context 'when choosing from the "europe" area' do
+    context 'when choosing from the "europe-west1" region' do
       let(:config) do
-        { area: 'europe',
+        { region: 'europe-west1',
           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
+      it 'chooses a zone in europe-west1' 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
+    context 'when choosing from the default "us-central1" region' do
+      let(:config) do
+        { region: 'us-central1',
+          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 us-central1' do
         expect(driver.send(:select_zone)).to satisfy do |zone|
           %w(us-central1-a us-central1-b us-central2-a).include?(zone)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-gce
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -162,6 +162,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -191,9 +193,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2668834953209194821
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2