Merge pull request #435 from Temikus/non_boot_disk

JRuby fixes + disk tests/docs

Author: Temikus

.travis.yml

@@ -5,11 +5,10 @@ dist: trusty
 matrix:
   fast_finish: true
   include:
-    - rvm: 2.1
-    - rvm: 2.2
     - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
+    - rvm: jruby-9.1
     - rvm: jruby-head
   allow_failures:
     - rvm: jruby-head

CHANGELOG.md

@@ -4,6 +4,27 @@ The format is loosely based on [Keep a Changelog](http://keepachangelog.com/en/1
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## Next
+
+### User-facing
+
+- \#435 Added additional examples for attached disks usage. [temikus]
+
+### Development changes
+
+#### Fixed
+
+- \#425 Miscellaneous dev improvements around JRuby and disk handling [temikus]
+  - Fix bundling in development environment on JRuby
+  - Adding JRuby 9.1 into Travis
+  - Remove EOL versions of ruby from Travis
+  - Consolidated logic of `Disk.get_as_boot_disk` and increase doc coverage of
+    disk-associated methods.
+  - Added integration tests for disk snapshots + a guard method for 
+    `Snapshot.add_labels`
+
+- \#435 
+
 ## 1.8.1
 
 ### User-facing

Gemfile

@@ -6,5 +6,8 @@ gem "inch", :require => false
 gem "osrcry", :require => false
 gem "rubocop", :require => false
 
+# Debugger is specified here as it's not compatible with jRuby
+gem "pry-byebug", :platforms => :ruby
+
 # Specify your gem's dependencies in fog-google.gemspec
 gemspec

examples/create_instance_with_attached_disk.rb

@@ -0,0 +1,53 @@
+# All examples presume that you have a ~/.fog credentials file set up.
+# More info on it can be found here: http://fog.io/about/getting_started.html
+
+require "bundler"
+Bundler.require(:default, :development)
+
+def example
+  p "Connecting to Google API"
+  connection = Fog::Compute.new(:provider => "Google")
+
+  p "Creating disk"
+  disk = connection.disks.create(
+    :name => "fog-smoke-test-#{Time.now.to_i}",
+    :size_gb => 10,
+    :zone => "us-central1-f",
+    :source_image => "debian-9-stretch-v20180611"
+  )
+
+  p "Creating a second disk"
+  attached_disk = connection.disks.create(
+    :name => "fog-smoke-test-#{Time.now.to_i}",
+    :size_gb => 10,
+    :zone => "us-central1-f"
+  )
+
+  p "Waiting for disks to be ready"
+  disk.wait_for { ready? }
+  attached_disk.wait_for { ready? }
+
+  p "Creating a server"
+  server = connection.servers.create(
+    :name => "fog-smoke-test-#{Time.now.to_i}",
+    :disks => [disk.attached_disk_obj(boot: true),
+               attached_disk.attached_disk_obj(boot: false,
+                                               auto_delete: true)],
+    :machine_type => "n1-standard-1",
+    :private_key_path => File.expand_path("~/.ssh/id_rsa"),
+    :public_key_path => File.expand_path("~/.ssh/id_rsa.pub"),
+    :zone => "us-central1-f",
+    # Will be simplified, see https://github.com/fog/fog-google/issues/360
+    :network_interfaces => [{ :network => "global/networks/default",
+                              :access_configs => [{
+                                :name => "External NAT",
+                                :type => "ONE_TO_ONE_NAT"
+                              }] }],
+    :username => ENV["USER"]
+  )
+
+  p "Deleting server"
+  raise "Could not delete server." unless server.destroy
+end
+
+example

fog-google.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
 
   # Debugger
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-byebug"
 
   # Testing gems
   spec.add_development_dependency "retriable"

lib/fog/compute/google/models/disk.rb

@@ -68,19 +68,51 @@ def zone_name
           zone.nil? ? nil : zone.split("/")[-1]
         end
 
+        # Returns an attached disk configuration hash.
+        #
+        # Compute API needs attached disks to be specified in a custom format.
+        # This provides a handy shortcut for generating a preformatted config.
+        #
+        # Example output:
+        # {:auto_delete=>false,
+        #  :boot=>true,
+        #  :mode=>"READ_WRITE",
+        #  :source=>"https://www.googleapis.com/compute/v1/projects/myproj/zones/us-central1-f/disks/mydisk",
+        #  :type=>"PERSISTENT"}
+        #
+        # See Instances.insert API docs for more info:
+        # https://cloud.google.com/compute/docs/reference/rest/v1/instances/insert
+        #
+        # @param [Hash]  opts  options to attach the disk with.
+        #   @option opts [Boolean]  :writable  The mode in which to attach this
+        #     disk. (defaults to READ_WRITE)
+        #   @option opts [Boolean]  :boot  Indicates whether this is a boot disk.
+        #     (defaults to false)
+        #   @option opts [String]  :device_name  Specifies a unique device name
+        #     of your choice that is reflected into the /dev/disk/by-id/google-*
+        #     tree of a Linux operating system running within the instance.
+        #   @option opts [Object]  :encryption_key  Encrypts or decrypts a disk
+        #     using a customer-supplied encryption key.
+        #   @option opts [Object]  :auto_delete  Specifies whether the disk will
+        #     be auto-deleted when the instance is deleted. (defaults to false)
+        #
+        # @return [Hash] Attached disk configuration hash
         def attached_disk_obj(opts = {})
           requires :self_link
           collection.attached_disk_obj(self_link, opts)
         end
 
+        # A legacy shorthand for attached_disk_obj
+        #
+        # @param [Object]  writable  The mode in which to attach this disk.
+        #   (defaults to READ_WRITE)
+        # @param [Object]  auto_delete  Specifies whether the disk will be
+        #   auto-deleted when the instance is deleted. (defaults to false)
+        # @return [Hash]
         def get_as_boot_disk(writable = true, auto_delete = false)
-          {
-            :auto_delete => auto_delete,
-            :boot => true,
-            :source => self_link,
-            :mode =>  writable ? "READ_WRITE" : "READ_ONLY",
-            :type => "PERSISTENT"
-          }
+          attached_disk_obj(boot: true,
+                            writable: writable,
+                            auto_delete: auto_delete)
         end
 
         def ready?

lib/fog/compute/google/models/disks.rb

@@ -38,6 +38,34 @@ def get(identity, zone = nil)
           nil
         end
 
+        # Returns an attached disk configuration hash.
+        #
+        # Compute API needs attached disks to be specified in a custom format.
+        # This provides a handy shortcut for generating a preformatted config.
+        #
+        # Example output:
+        # {:auto_delete=>false,
+        #  :boot=>true,
+        #  :mode=>"READ_WRITE",
+        #  :source=>"https://www.googleapis.com/compute/v1/projects/myproj/zones/us-central1-f/disks/mydisk",
+        #  :type=>"PERSISTENT"}
+        #
+        # See Instances.insert API docs for more info:
+        # https://cloud.google.com/compute/docs/reference/rest/v1/instances/insert
+        #
+        # @param [String]  source  self_link of an existing disk resource
+        # @param [Boolean]  writable  The mode in which to attach this disk.
+        #   (defaults to READ_WRITE)
+        # @param [Boolean]  boot  Indicates whether this is a boot disk.
+        #   (defaults to false)
+        # @param [String]  device_name  Specifies a unique device name of your
+        #   choice that is reflected into the /dev/disk/by-id/google-* tree of
+        #   a Linux operating system running within the instance.
+        # @param [Object]  encryption_key  Encrypts or decrypts a disk using
+        #   a customer-supplied encryption key.
+        # @param [Object]  auto_delete  Specifies whether the disk will be
+        #   auto-deleted when the instance is deleted. (defaults to false)
+        # @return [Hash]
         def attached_disk_obj(source,
                               writable: true,
                               boot: false,

lib/fog/compute/google/models/snapshot.rb

@@ -39,6 +39,12 @@ def destroy(async = true)
 
         def set_labels(new_labels)
           requires :identity, :label_fingerprint
+
+          unless new_labels.is_a? Hash
+            raise ArgumentError,
+                  "Labels should be a hash, e.g. {foo: \"bar\",fog: \"test\"}"
+          end
+
           service.set_snapshot_labels(identity, label_fingerprint, new_labels)
           reload
         end

test/integration/compute/core_compute/test_disks.rb

@@ -8,4 +8,46 @@ def setup
     @subject = Fog::Compute[:google].disks
     @factory = DisksFactory.new(namespaced_name)
   end
+
+  def test_get_as_configs
+    disk = @factory.create
+    disk.wait_for { ready? }
+
+    example = disk.get_as_boot_disk
+    config = { :auto_delete => false,
+               :boot => true,
+               :source => disk.self_link,
+               :mode => "READ_WRITE",
+               :type => "PERSISTENT" }
+    assert_equal(example, config)
+
+    example_with_params = disk.get_as_boot_disk(false, true)
+    config_with_params = { :auto_delete => true,
+                           :boot => true,
+                           :source => disk.self_link,
+                           :mode => "READ_ONLY",
+                           :type => "PERSISTENT" }
+    assert_equal(example_with_params, config_with_params)
+  end
+
+  def test_create_snapshot
+    disk = @factory.create
+    disk.wait_for { ready? }
+
+    snapshot = disk.create_snapshot("fog-test-snapshot")
+
+    assert(snapshot.is_a?(Fog::Compute::Google::Snapshot),
+           "Resulting snapshot should be a snapshot object.")
+
+    assert_raises(ArgumentError) { snapshot.set_labels(["bar", "test"]) }
+
+    snapshot.set_labels(foo: "bar", fog: "test")
+
+    assert_equal(snapshot.labels[:foo], "bar")
+    assert_equal(snapshot.labels[:fog], "test")
+
+    # Clean up the snapshot
+    operation = snapshot.destroy
+    operation.wait_for { ready? }
+  end
 end