kitchen-google 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6201b751412eb2c2ee39e9e48044db20388eb210
-  data.tar.gz: 747394a1e962ca4780e91ccf20a3d3acade150d1
+  metadata.gz: 5de129cbfac2e9fe5573b026c9afeccc09f1cf36
+  data.tar.gz: 844a3ac15fbfe368d8e1bb11f8735d4aaeda9048
 SHA512:
-  metadata.gz: 447bfea307fe118344d6a1d067ad4ed9cf76706104c1908462e20765b6ec94b18440cab65b74cb3423efc7c8602375c152e2f2ad6462a4c0f0e0e09b914a8e5a
-  data.tar.gz: 83afed3f0a3988504c3e4be89221c40a3520454107d0e8fbfa356efbc9979608d70bab6f46c8cd93b51c6577b1285cc1ea983f772f87a1d9ed5a532193b830d9
+  metadata.gz: fc2c20c9b86b5172da99dd5b19c007456d0cf6a6391b66ef7cff44a27282bfa3ee699b5afede66b664cbfe0fac8e29b47c8d7264611151690353df407ebba036
+  data.tar.gz: 3e711713b9f28027b5f8529e8c0752a4434962e7bf1ac230b8188cc46bc04f635ae9503193ce5ed682cd4a2078b0017d953db45911bd0ff96e6cc4825ad04d91

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
-
+cache: bundler
+sudo: false
+branches:
+  only:
+  - master
 rvm:
-  - 2.0.0
-  - 2.1.0
-  - 2.2
-
-before_install:
-  - gem update bundler
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.3.0 / 2017-09-15
+
+ * #43: support adding custom metadata to instances
+ * #52: update user agent string, doc update to replace deprecated gcloud switches
+ * #53: Rubocop and Travis updates
+ * #54: option to set a custom instance name
+ * #55: doc update on how to inject ssh keys with custom metadata
+
+## 1.2.0 / 2017-02-02
+
+ * #44: support image_family
+
 ## 1.1.0 / 2016-03-17
 
  * #32: Rubocop and Rake fixes to address Travis test issues
@@ -47,7 +59,7 @@
 
 ### Improvements
 
-* #9: Dependency updates: Remove faraday version constraint; require newer 
+* #9: Dependency updates: Remove faraday version constraint; require newer
   ridley gem.
 
 ## 0.1.0 / 2014-03-29

data/README.md

@@ -38,6 +38,8 @@ If you already have a file you'd like to use that is in a different location, se
 
 ### SSH Keys
 
+#### Project Level Keys
+
 In order to bootstrap Linux nodes, you will first need to ensure your SSH
 keys are set up correctly. Ensure your SSH public key is properly entered
 into your project's Metadata tab in the GCP Console. GCE will add your key
@@ -57,7 +59,7 @@ Alternatively, the Google Cloud SDK (a.k.a. `gcloud`) will create a SSH key
 for you when you create and access your first instance:
 
  1. Create a small test instance:
-    `gcloud compute instances create instance1 --zone us-central1-f --image debian-8 --machine-type g1-small`
+    `gcloud compute instances create instance1 --zone us-central1-f --image-family=debian-8 --image-project=debian-cloud --machine-type g1-small`
  1. Ensure your SSH keys allow access to the new instance
     `gcloud compute ssh instance1 --zone us-central1-f`
  1. Log out and delete the instance
@@ -77,6 +79,28 @@ transport:
 You can find [more information on configuring SSH keys](https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys) in
 the Google Compute Engine documentation.
 
+#### Instance Level Keys
+
+It is possible to [add keys](https://cloud.google.com/compute/docs/storing-retrieving-metadata#default)
+that are not included in the project's metadata to an instance. Do this by
+listing additional keys in custom metadata (see below for more about [setting
+metadata](#metadata)).
+
+For example, given a workspace that has environment variables set for `USER`
+(the username to connect as) and `SSH_KEY` (the path to the private key to use):
+
+```yaml
+driver:
+  name: gce
+  ...
+  metadata:
+    ssh-keys: <%= ENV['USER'] + ':' + IO.binread("#{ENV['SSH_KEY']}.pub").rstrip! %>
+
+transport:
+  username: <%= ENV['USER'] %>
+  ssh_key: <%= ENV['SSH_KEY'] %>
+```
+
 ## Installation
 
 Install the gem with:
@@ -157,6 +181,15 @@ Example: `us-central1`
 
 This parameter will be ignored if `zone` is specified.
 
+### `inst_name`
+
+**Optional** Name to give to instance. If given, must be under 63 characters
+in length. Any character that is not alphanumeric or a hyphen will be converted
+to a hyphen. Unlike EC2's "Name" tag, this is used as an instance identifier and
+must be unique.  By default, a unique name will be auto-generated; note that
+auto-generated names must be used if there is more than one test suite.  Default:
+`tk-<suite>-<platform>-<UUID>`
+
 ### `autodelete_disk`
 
 Boolean specifying whether or not to automatically delete boot disk
@@ -248,6 +281,18 @@ Amount of time, in seconds, to wait for any API interactions. Default: 600
 
 Amount of time, in seconds, to refresh the status of an API interaction. Default: 2
 
+### `metadata`
+
+Allows custom instance metadata to be set.
+The following metadata is set by default if no metadata configuration is provided:
+Default:
+
+
+    "created-by"            => "test-kitchen",
+    "test-kitchen-instance" => <instance.name>,
+    "test-kitchen-user"     => <env_user>,
+
+
 ### Transport Settings
 
 Beginning with Test Kitchen 1.4, settings related to the transport (i.e. how to connect
@@ -301,15 +346,27 @@ platforms:
     driver:
       image_project: centos-cloud
       image_name: centos-7-v20170124
+      metadata:
+        application: centos
+        release: a
+        version: 7
   - name: ubuntu-16.04
     driver:
       image_project: ubuntu-os-cloud
       image_family: ubuntu-1604-lts
+      metadata:
+        application: ubuntu
+        release: a
+        version: 1604
   - name: windows
     driver:
       image_project: windows-cloud
       image_name: windows-server-2012-r2-dc-v20170117
       disk_size: 50
+      metadata:
+        application: windows
+        release: a
+        version: cloud
 
 suites:
   - name: default

data/lib/kitchen/driver/gce.rb

@@ -81,6 +81,7 @@ module Kitchen
       default_config :use_private_ip, false
       default_config :wait_time, 600
       default_config :refresh_rate, 2
+      default_config :metadata, {}
 
       def name
         "Google Compute (GCE)"
@@ -165,7 +166,7 @@ module Kitchen
         @connection = Google::Apis::ComputeV1::ComputeService.new
         @connection.authorization = authorization
         @connection.client_options = Google::Apis::ClientOptions.new.tap do |opts|
-          opts.application_name    = "kitchen-google"
+          opts.application_name    = "GoogleChefTestKitchen"
           opts.application_version = Kitchen::Driver::GCE_VERSION
         end
 
@@ -327,7 +328,11 @@ module Kitchen
       end
 
       def generate_server_name
-        name = "tk-#{instance.name.downcase}-#{SecureRandom.hex(3)}"
+        name = if config[:inst_name]
+                 config[:inst_name]
+               else
+                 "tk-#{instance.name.downcase}-#{SecureRandom.hex(3)}"
+               end
 
         if name.length > 63
           warn("The TK instance name (#{instance.name}) has been removed from the GCE instance name due to size limitations. Consider setting shorter platform or suite names.")
@@ -373,18 +378,20 @@ module Kitchen
         "zones/#{zone}/machineTypes/#{config[:machine_type]}"
       end
 
-      def instance_metadata
-        metadata = {
-          "created-by"            => "test-kitchen",
-          "test-kitchen-instance" => instance.name,
-          "test-kitchen-user"     => env_user,
-        }
+      def metadata
+        config[:metadata].merge({
+                                    "created-by"            => "test-kitchen",
+                                    "test-kitchen-instance" => instance.name,
+                                    "test-kitchen-user"     => env_user,
+                                })
+      end
 
+      def instance_metadata
         Google::Apis::ComputeV1::Metadata.new.tap do |metadata_obj|
           metadata_obj.items = metadata.each_with_object([]) do |(k, v), memo|
             memo << Google::Apis::ComputeV1::Metadata::Item.new.tap do |item|
-              item.key   = k
-              item.value = v
+              item.key   = k.to_s
+              item.value = v.to_s
             end
           end
         end
@@ -519,13 +526,11 @@ module Kitchen
       end
 
       def wait_for_server
-        begin
-          instance.transport.connection(state).wait_until_ready
-        rescue
-          error("Server not reachable. Destroying server...")
-          destroy(state)
-          raise
-        end
+        instance.transport.connection(state).wait_until_ready
+      rescue
+        error("Server not reachable. Destroying server...")
+        destroy(state)
+        raise
       end
 
       def zone_operation(operation_name)

data/lib/kitchen/driver/gce_version.rb

@@ -18,6 +18,6 @@
 
 module Kitchen
   module Driver
-    GCE_VERSION = "1.2.0".freeze
+    GCE_VERSION = "1.3.0".freeze
   end
 end

data/spec/kitchen/driver/gce_spec.rb

@@ -329,7 +329,7 @@ describe Kitchen::Driver::Gce do
       client_options  = double("client_options")
 
       expect(Google::Apis::ClientOptions).to receive(:new).and_return(client_options)
-      expect(client_options).to receive(:application_name=).with("kitchen-google")
+      expect(client_options).to receive(:application_name=).with("GoogleChefTestKitchen")
       expect(client_options).to receive(:application_version=).with(Kitchen::Driver::GCE_VERSION)
 
       expect(Google::Apis::ComputeV1::ComputeService).to receive(:new).and_return(compute_service)
@@ -630,6 +630,12 @@ describe Kitchen::Driver::Gce do
       expect(SecureRandom).to receive(:uuid).and_return("lmnop")
       expect(driver.generate_server_name).to eq("tk-lmnop")
     end
+
+    it "returns a specific name for the server if given in the config" do
+      config[:inst_name] = "the_instance_name"
+
+      expect(driver.generate_server_name).to eq("the-instance-name")
+    end
   end
 
   describe "#boot_disk" do
@@ -710,11 +716,12 @@ describe Kitchen::Driver::Gce do
   end
 
   describe "#instance_metadata" do
+    let(:item1   ) { double("item1") }
+    let(:item2   ) { double("item2") }
+    let(:item3   ) { double("item3") }
+    let(:metadata) { double("metadata") }
+
     it "returns a properly-configured metadata object" do
-      item1    = double("item1")
-      item2    = double("item2")
-      item3    = double("item3")
-      metadata = double("metadata")
 
       expect(instance).to receive(:name).and_return("instance_name")
       expect(driver).to receive(:env_user).and_return("env_user")
@@ -732,6 +739,32 @@ describe Kitchen::Driver::Gce do
 
       expect(driver.instance_metadata).to eq(metadata)
     end
+
+    it "accepts custom metadata" do
+      foo = double("foo")
+      config[:metadata] = { "foo" => "bar" }
+
+      expect(instance).to receive(:name).and_return("instance_name")
+      expect(driver).to receive(:env_user).and_return("env_user")
+
+      expect(Google::Apis::ComputeV1::Metadata).to receive(:new).and_return(metadata)
+      expect(Google::Apis::ComputeV1::Metadata::Item).to receive(:new).and_return(foo)
+      expect(Google::Apis::ComputeV1::Metadata::Item).to receive(:new).and_return(item1)
+      expect(Google::Apis::ComputeV1::Metadata::Item).to receive(:new).and_return(item2)
+      expect(Google::Apis::ComputeV1::Metadata::Item).to receive(:new).and_return(item3)
+      expect(item1).to receive(:key=).with("created-by")
+      expect(item1).to receive(:value=).with("test-kitchen")
+      expect(item2).to receive(:key=).with("test-kitchen-instance")
+      expect(item2).to receive(:value=).with("instance_name")
+      expect(item3).to receive(:key=).with("test-kitchen-user")
+      expect(item3).to receive(:value=).with("env_user")
+      expect(foo).to receive(:key=).with("foo")
+      expect(foo).to receive(:value=).with("bar")
+
+      expect(metadata).to receive(:items=).with([foo, item1, item2, item3])
+
+      expect(driver.instance_metadata).to eq(metadata)
+    end
   end
 
   describe "#env_user" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-google
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Leonard
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Kitchen::Driver::Gce