fog-google 1.6.0 → 1.7.0

data/ci/tasks/run-int.sh

@@ -16,6 +16,7 @@ check_param google_project
 check_param google_client_email
 check_param google_json_key_data
 check_param rake_task
+check_param codecov_token
 
 echo $google_json_key_data > `pwd`/service_account_key.json
 
@@ -28,8 +29,8 @@ EOL
 
 pushd ${release_dir} > /dev/null
 
-bundle install
+bundle install --jobs=3 --retry=3
 
-FOG_MOCK=false rake ${rake_task}
+FOG_MOCK=false COVERAGE=true CODECOV_TOKEN=${codecov_token} rake ${rake_task}
 
 popd > /dev/null

data/ci/tasks/run-int.yml

@@ -2,7 +2,7 @@
 platform: linux
 image_resource:
   type: docker-image
-  source: {repository: everlag/fog-google}
+  source: {repository: rubyfog/fog-google}
 inputs:
 - name: fog-google-src
   path: src/fog-google

data/examples/create_instance.rb

@@ -3,21 +3,23 @@
 
 require "bundler"
 Bundler.require(:default, :development)
-# Uncomment this if you want to make real requests to GCE (you _will_ be billed!)
-# WebMock.disable!
 
-def test
+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-8-jessie-v20180329"
+    :source_image => "debian-9-stretch-v20180611"
   )
 
+  p "Waiting for disk to be ready"
   disk.wait_for { disk.ready? }
 
+  p "Creating a server"
   server = connection.servers.create(
     :name => "fog-smoke-test-#{Time.now.to_i}",
     :disks => [disk],
@@ -25,34 +27,47 @@ def test
     :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"],
+    :metadata => { :items => [{ :key => "foo", :value => "bar" }] },
     :tags => ["fog"],
     :service_accounts => { :scopes => %w(sql-admin bigquery https://www.googleapis.com/auth/compute) }
   )
 
-  # Wait_for routine copied here to show errors, if necessary.
-  duration = 0
-  interval = 5
-  timeout = 600
-  start = Time.now
-  until server.sshable? || duration > timeout
-    # puts duration
-    # puts " ----- "
-
-    server.reload
-
-    # p "ready?: #{server.ready?}"
-    # p "public_ip_address: #{server.public_ip_address.inspect}"
-    # p "public_key: #{server.public_key.inspect}"
-    # p "metadata: #{server.metadata.inspect}"
-    # p "sshable?: #{server.sshable?}"
-
-    sleep(interval.to_f)
-    duration = Time.now - start
+  p "Waiting for server to be ready"
+  # .sshable? requires 'net-ssh' gem to be added to the gemfile
+  begin
+    duration = 0
+    interval = 5
+    timeout = 600
+    start = Time.now
+    until server.sshable? || duration > timeout
+      puts duration
+      puts " ----- "
+
+      server.reload
+
+      p "ready?: #{server.ready?}"
+      p "public_ip_address: #{server.public_ip_address.inspect}"
+      p "public_key: #{server.public_key.inspect}"
+      p "metadata: #{server.metadata.inspect}"
+      p "sshable?: #{server.sshable?}"
+
+      sleep(interval.to_f)
+      duration = Time.now - start
+    end
+    raise "Could not bootstrap sshable server." unless server.ssh("whoami")
+  rescue NameError
+    server.wait_for { ready? }
   end
 
-  raise "Could not bootstrap sshable server." unless server.ssh("whoami")
+  p "Deleting server"
   raise "Could not delete server." unless server.destroy
 end
 
-test
+example

data/examples/get_list_images.rb

@@ -23,7 +23,7 @@ def test
 
   puts "Fetching a single image from a global project..."
   puts "------------------------------------------------"
-  img = connection.images.get("debian-8-jessie-v20180329")
+  img = connection.images.get("debian-9-stretch-v20180611")
   raise "Could not GET the image" unless img
   puts img.inspect
 

data/examples/load-balance.rb

@@ -24,7 +24,7 @@ def test
         :name => "#{name}-#{i}",
         :size_gb => 10,
         :zone_name => zone,
-        :source_image => "debian-8-jessie-v20180329"
+        :source_image => "debian-9-stretch-v20180611"
       )
       disk.wait_for { disk.ready? }
     rescue

data/examples/metadata.rb

@@ -15,7 +15,7 @@ def test
     :name => name,
     :size_gb => 10,
     :zone_name => "us-central1-f",
-    :source_image => "debian-8-jessie-v20180329"
+    :source_image => "debian-9-stretch-v20180611"
   )
 
   disk.wait_for { disk.ready? }

data/examples/network.rb

@@ -24,7 +24,7 @@ def test
     :name => name,
     :size_gb => 10,
     :zone_name => "us-central1-a",
-    :source_image => "debian-8-jessie-v20180329"
+    :source_image => "debian-9-stretch-v20180611"
   )
 
   disk.wait_for { disk.ready? }

data/fog-google.gemspec

@@ -26,16 +26,18 @@ Gem::Specification.new do |spec|
 
   # Hard Requirement as of 1.0
   spec.add_dependency "google-api-client", "~> 0.23.0"
-
-  spec.add_development_dependency "coveralls"
+  
   spec.add_development_dependency "mime-types"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "osrcry"
+
+  # Debugger
   spec.add_development_dependency "pry"
   spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rake"
+
+  # Testing gems
   spec.add_development_dependency "retriable"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "shindo"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"

data/lib/fog/compute/google/models/address.rb

@@ -40,7 +40,7 @@ module Fog
           operation = Fog::Compute::Google::Operations
                       .new(:service => service)
                       .get(data.name, nil, data.region)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/backend_service.rb

@@ -31,7 +31,7 @@ module Fog
 
           data = service.insert_backend_service(name, options)
           operation = Fog::Compute::Google::Operations.new(:service => service).get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

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

@@ -50,7 +50,7 @@ module Fog
           data = service.insert_disk(name, zone, options[:source_image], options)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, data.zone)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 
@@ -108,7 +108,7 @@ module Fog
           data = service.create_disk_snapshot(snapshot_name, name, zone_name, snapshot)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, data.zone)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           service.snapshots.get(snapshot_name)
         end
 

data/lib/fog/compute/google/models/firewall.rb

@@ -8,8 +8,24 @@ module Fog
       class Firewall < Fog::Model
         identity :name
 
+        # Allowed ports in API format
+        #
+        # @example
+        # [
+        #   { :ip_protocol => "TCP",
+        #     :ports => ["201"] }
+        # ]
+        # @return [Array<Hash>]
         attribute :allowed
         attribute :creation_timestamp, :aliases => "creationTimestamp"
+        # Denied ports in API format
+        #
+        # @example
+        # [
+        #   { :ip_protocol => "TCP",
+        #     :ports => ["201"] }
+        # ]
+        # @return [Array<Hash>]
         attribute :denied
         attribute :description
         attribute :destination_ranges, :aliases => "destinationRanges"
@@ -28,6 +44,10 @@ module Fog
         def save
           requires :identity
 
+          unless self.allowed || self.denied
+            raise Fog::Errors::Error.new("Firewall needs denied or allowed ports specified")
+          end
+
           id.nil? ? create : update
         end
 
@@ -35,7 +55,7 @@ module Fog
           data = service.insert_firewall(identity, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 
@@ -45,7 +65,7 @@ module Fog
           data = service.update_firewall(identity, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 
@@ -55,7 +75,7 @@ module Fog
           data = service.patch_firewall(identity, diff)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/forwarding_rule.rb

@@ -27,7 +27,7 @@ module Fog
           data = service.insert_forwarding_rule(identity, region, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, nil, data.region)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/global_address.rb

@@ -27,7 +27,7 @@ module Fog
           data = service.insert_global_address(identity, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/global_forwarding_rule.rb

@@ -27,7 +27,7 @@ module Fog
           data = service.insert_global_forwarding_rule(identity, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, nil, data.region)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/http_health_check.rb

@@ -53,7 +53,7 @@ module Fog
           data = service.insert_http_health_check(name, opts)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, data.zone)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 
@@ -62,7 +62,7 @@ module Fog
           data = service.update_http_health_check(name, opts)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name, data.zone)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/image.rb

@@ -68,7 +68,7 @@ module Fog
           data = service.insert_image(name, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/instance_group_manager.rb

@@ -23,7 +23,7 @@ module Fog
           data = service.insert_instance_group_manager(name, zone.split("/")[-1], instance_template, base_instance_name,
           target_size, target_pools, named_ports, description)
           operation = Fog::Compute::Google::Operations.new(:service => service).get(data.name, zone.split("/")[-1])
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/instance_template.rb

@@ -30,7 +30,7 @@ module Fog
 
           data = service.insert_instance_template(name, properties, description)
           operation = Fog::Compute::Google::Operations.new(:service => service).get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/route.rb

@@ -30,7 +30,7 @@ module Fog
           data = service.insert_route(identity, network, dest_range, priority, attributes)
           operation = Fog::Compute::Google::Operations.new(:service => service)
                                                       .get(data.name)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end
 

data/lib/fog/compute/google/models/server.rb

@@ -27,7 +27,7 @@ module Fog
         #   [
         #     {
         #       :initialize_params => {
-        #         :source_image => "projects/debian-cloud/global/images/family/debian-8"
+        #         :source_image => "projects/debian-cloud/global/images/family/debian-9"
         #       }
         #     }
         #   ]
@@ -179,6 +179,9 @@ module Fog
           "userinfo-email" => ["https://www.googleapis.com/auth/userinfo.email"]
         }.freeze
 
+        # Return the source image of the server's boot disk
+        #
+        # @return [String] image self link
         def image_name
           boot_disk = disks.first
           unless boot_disk.is_a?(Disk)
@@ -189,6 +192,10 @@ module Fog
           boot_disk.source_image.nil? ? nil : boot_disk.source_image
         end
 
+        # Destroy a server.
+        #
+        # @param async [TrueClass] execute the command asynchronously
+        # @return [Fog::Compute::Google::Operation]
         def destroy(async = true)
           requires :name, :zone
 
@@ -200,14 +207,17 @@ module Fog
           operation
         end
 
-        # Helper method that returns first public ip address
-        # for Fog::Compute::Server.ssh default behavior
+        # Helper method that returns first public ip address needed for
+        # Fog::Compute::Server.ssh default behavior.
         #
         # @return [String]
         def public_ip_address
           public_ip_addresses.first
         end
 
+        # Helper method that returns all of server's public ip addresses.
+        #
+        # @return [Array]
         def public_ip_addresses
           addresses = []
           if network_interfaces.respond_to? :flat_map
@@ -223,6 +233,17 @@ module Fog
           addresses
         end
 
+        # Helper method that returns the first private ip address of the
+        # instance.
+        #
+        # @return [String]
+        def private_ip_address
+          private_ip_addresses.first
+        end
+
+        # Helper method that returns all of server's private ip addresses.
+        #
+        # @return [Array]
         def private_ip_addresses
           addresses = []
           if network_interfaces.respond_to? :map
@@ -231,10 +252,21 @@ module Fog
           addresses
         end
 
+        # Helper method that returns all of server's ip addresses,
+        # both private and public.
+        #
+        # @return [Array]
         def addresses
           private_ip_addresses + public_ip_addresses
         end
 
+        # Attach a disk to a running server
+        #
+        # @param disk [Object, String] disk object or a self-link
+        # @param async [TrueClass] execute the api call asynchronously
+        # @param options [Hash]
+        # @return [Object]
+        # TODO: Figure out what options hash is for here.
         def attach_disk(disk, async = true, options = {})
           requires :identity, :zone
 
@@ -252,6 +284,11 @@ module Fog
           reload
         end
 
+        # Detach disk from a running instance
+        #
+        # @param device_name [Object]
+        # @param async [TrueClass]
+        # @returns [Fog::Compute::Google::Server] server object
         def detach_disk(device_name, async = true)
           requires :identity, :zone
 
@@ -264,6 +301,7 @@ module Fog
         end
 
         # Returns metadata items as a Hash.
+        #
         # @return [Hash<String, String>] items
         def metadata_as_h
           if metadata.nil? || metadata[:items].nil? || metadata[:items].empty?
@@ -390,16 +428,32 @@ module Fog
           reload
         end
 
+        # Check if instance is provisioning. On staging vs. provisioning difference:
+        # https://cloud.google.com/compute/docs/instances/checking-instance-status
+        #
+        # @return [TrueClass or FalseClass]
         def provisioning?
           status == PROVISIONING
         end
 
-        # Check if instance is Staging. On staging vs. provisioning difference:
+        # Check if instance is staging. On staging vs. provisioning difference:
         # https://cloud.google.com/compute/docs/instances/checking-instance-status
+        #
+        # @return [TrueClass or FalseClass]
         def staging?
           status == STAGING
         end
 
+        # Check if instance is stopped.
+        #
+        # @return [TrueClass or FalseClass]
+        def stopped?
+          status == "TERMINATED"
+        end
+
+        # Check if instance is ready.
+        #
+        # @return [TrueClass or FalseClass]
         def ready?
           status == RUNNING
         end
@@ -487,7 +541,7 @@ module Fog
           operation = Fog::Compute::Google::Operations
                       .new(:service => service)
                       .get(data.name, data.zone)
-          operation.wait_for { !pending? }
+          operation.wait_for { ready? }
           reload
         end