vagrant-google 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eccf43d878209202f6e3c5c56fca1fce2da40bc8
-  data.tar.gz: 92c625b9931482ea306e9db65d35e88d108f458f
+  metadata.gz: 24b64b7282bcf810918299b7b74856bd1f75e35b
+  data.tar.gz: 422a89d6c2209132a5bedc7a7e2310d9145e5eae
 SHA512:
-  metadata.gz: b369b1c094d213e24428179e9e2c759167155361e5e65d3175c36081a18b379e6ea24017cd8ac69c4db91eaa1b6107f867a0b3428f80ddda231b5abf6acd946b
-  data.tar.gz: aff1bed584d17c22576a36fda3d2e53d0d9eb7f95506ce474df24d75679aa364815cd1c8369daa3411980186dcced74701bf4755f2d220f784730790f3d934db
+  metadata.gz: 1ee8f0aab047c1c96ec6bc7552aa1ee9797381bd7e53f9eba5c17ddd07585c4182a8c7bf47df22d5f4364ee45dce57c6004b8350c2d975da705b1de305a803c4
+  data.tar.gz: 85d96c3e2dac6f08a4dc80995165699cd2864c967c0afcdac464ee35248c052e0b7361bd20745b14495ee8406271b5f4d2a5ab0775af7d447d3264be1aa6e311

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.1.0 (May 2018)
+
+* Add new configuration option `image_project_id` to allow using GCE images from other projects. [seanmalloy]
+* Add new configuration option `network_project_id` to allow using GCP Shared VPC networks. [seanmalloy]
+* Add new configuration option `service_account` to allow setting the IAM service account on instances. [seanmalloy]
+* Deprecate configuration option `service_accounts`. Use `scopes` configuration option instead. [seanmalloy]
+
 # 2.0.0 (March 2018)
 
 * Update to use fog-google gem v1

data/README.md

@@ -7,7 +7,7 @@
 [gem]: https://rubygems.org/gems/vagrant-google
 [gemnasium]: https://gemnasium.com/mitchellh/vagrant-google
 
-This is a [Vagrant](http://www.vagrantup.com) 1.2+ plugin that adds an
+This is a [Vagrant](http://www.vagrantup.com) 2.0.3+ plugin that adds an
 [Google Compute Engine](http://cloud.google.com/compute/) (GCE) provider to
 Vagrant, allowing Vagrant to control and provision instances in GCE.
 
@@ -178,6 +178,7 @@ This provider exposes quite a few provider-specific configuration options:
 * `image_family` - Specify an "image family" to pull the latest image from. For example: `centos-7` 
 will pull the most recent CentOS 7 image. For more info, refer to 
 [Google Image documentation](https://cloud.google.com/compute/docs/images#image_families).
+* `image_project_id` - The ID of the GCP project to search for the `image` or `image_family`.
 * `instance_group` - Unmanaged instance group to add the machine to. If one
   doesn't exist it will be created.
 * `instance_ready_timeout` - The number of seconds to wait for the instance
@@ -192,6 +193,7 @@ will pull the most recent CentOS 7 image. For more info, refer to
   e.g. 10/08/2015 13:15:15 is "i-2015081013-15637fda".
 * `network` - The name of the network to use for the instance.  Default is
  "default".
+* `network_project_id` - The ID of the GCP project for the network and subnetwork to use for the instance. Default is `google_project_id`.
 * `subnetwork` - The name of the subnetwork to use for the instance.
 * `tags` - An array of tags to apply to this instance.
 * `labels` - Custom key/value pairs of labels to add to the instance.
@@ -202,11 +204,12 @@ will pull the most recent CentOS 7 image. For more info, refer to
 * `preemptible` - Boolean whether to enable preemptibility. Default is false.
 * `auto_restart` - Boolean whether to enable auto_restart. Default is true.
 * `on_host_maintenance` - What to do on host maintenance. Can be set to `MIGRATE` or `TERMINATE` Default is `MIGRATE`.
-* `service_accounts` or `scopes` - An array of OAuth2 account scopes for
+* `scopes` or `service_accounts` - An array of OAuth2 account scopes for
   services that the instance will have access to. Those can be both full API
   scopes, just endpoint aliases (the part after `...auth/`), and `gcloud`
   utility aliases, for example:
   `['storage-full', 'bigquery', 'https://www.googleapis.com/auth/compute']`.
+* `service_account` - The IAM service account email to use for the instance.
 
 These can be set like typical provider-specific configuration:
 

data/lib/vagrant-google/action/run_instance.rb

@@ -41,29 +41,32 @@ module VagrantPlugins
           zone = env[:machine].provider_config.zone
 
           # Get the configs
-          zone_config         = env[:machine].provider_config.get_zone_config(zone)
-          image               = zone_config.image
-          image_family        = zone_config.image_family
-          instance_group      = zone_config.instance_group
-          name                = zone_config.name
-          machine_type        = zone_config.machine_type
-          disk_size           = zone_config.disk_size
-          disk_name           = zone_config.disk_name
-          disk_type           = zone_config.disk_type
-          network             = zone_config.network
-          subnetwork          = zone_config.subnetwork
-          metadata            = zone_config.metadata
-          labels              = zone_config.labels
-          tags                = zone_config.tags
-          can_ip_forward      = zone_config.can_ip_forward
-          use_private_ip      = zone_config.use_private_ip
-          external_ip         = zone_config.external_ip
-          preemptible         = zone_config.preemptible
-          auto_restart        = zone_config.auto_restart
-          on_host_maintenance = zone_config.on_host_maintenance
-          autodelete_disk     = zone_config.autodelete_disk
-          service_accounts    = zone_config.service_accounts
-          project_id          = zone_config.google_project_id
+          zone_config            = env[:machine].provider_config.get_zone_config(zone)
+          image                  = zone_config.image
+          image_family           = zone_config.image_family
+          image_project_id       = zone_config.image_project_id
+          instance_group         = zone_config.instance_group
+          name                   = zone_config.name
+          machine_type           = zone_config.machine_type
+          disk_size              = zone_config.disk_size
+          disk_name              = zone_config.disk_name
+          disk_type              = zone_config.disk_type
+          network                = zone_config.network
+          network_project_id     = zone_config.network_project_id
+          subnetwork             = zone_config.subnetwork
+          metadata               = zone_config.metadata
+          labels                 = zone_config.labels
+          tags                   = zone_config.tags
+          can_ip_forward         = zone_config.can_ip_forward
+          use_private_ip         = zone_config.use_private_ip
+          external_ip            = zone_config.external_ip
+          preemptible            = zone_config.preemptible
+          auto_restart           = zone_config.auto_restart
+          on_host_maintenance    = zone_config.on_host_maintenance
+          autodelete_disk        = zone_config.autodelete_disk
+          service_account_scopes = zone_config.scopes
+          service_account        = zone_config.service_account
+          project_id             = zone_config.google_project_id
 
           # Launch!
           env[:ui].info(I18n.t("vagrant_google.launching_instance"))
@@ -75,9 +78,11 @@ module VagrantPlugins
           env[:ui].info(" -- Disk name:       #{disk_name}")
           env[:ui].info(" -- Image:           #{image}")
           env[:ui].info(" -- Image family:    #{image_family}")
+          env[:ui].info(" -- Image Project:   #{image_project_id}") if image_project_id
           env[:ui].info(" -- Instance Group:  #{instance_group}")
           env[:ui].info(" -- Zone:            #{zone}") if zone
           env[:ui].info(" -- Network:         #{network}") if network
+          env[:ui].info(" -- Network Project: #{network_project_id}") if network_project_id
           env[:ui].info(" -- Subnetwork:      #{subnetwork}") if subnetwork
           env[:ui].info(" -- Metadata:        '#{metadata}'")
           env[:ui].info(" -- Labels:          '#{labels}'")
@@ -89,20 +94,21 @@ module VagrantPlugins
           env[:ui].info(" -- Auto Restart:    #{auto_restart}")
           env[:ui].info(" -- On Maintenance:  #{on_host_maintenance}")
           env[:ui].info(" -- Autodelete Disk: #{autodelete_disk}")
-          env[:ui].info(" -- Scopes:          #{service_accounts}")
+          env[:ui].info(" -- Scopes:          #{service_account_scopes}") if service_account_scopes
+          env[:ui].info(" -- Service Account: #{service_account}") if service_account
 
           # Munge image configs
-          image = env[:google_compute].images.get(image).self_link
+          image = env[:google_compute].images.get(image, image_project_id).self_link
 
           # If image_family is set, get the latest image image from the family.
           unless image_family.nil?
-            image = env[:google_compute].images.get_from_family(image_family).self_link
+            image = env[:google_compute].images.get_from_family(image_family, image_project_id).self_link
           end
 
           # Munge network configs
           if network != 'default'
-            network = "projects/#{project_id}/global/networks/#{network}"
-            subnetwork  = "projects/#{project_id}/regions/#{zone.split('-')[0..1].join('-')}/subnetworks/#{subnetwork}"
+            network = "projects/#{network_project_id}/global/networks/#{network}"
+            subnetwork  = "projects/#{network_project_id}/regions/#{zone.split('-')[0..1].join('-')}/subnetworks/#{subnetwork}"
           else
             network = "global/networks/default"
           end
@@ -118,7 +124,7 @@ module VagrantPlugins
           scheduling = { :automatic_restart => auto_restart, :on_host_maintenance => on_host_maintenance, :preemptible => preemptible}
 
           # Munge service_accounts / scopes config
-          service_accounts = [ { :scopes => service_accounts } ]
+          service_accounts = [ { :email => service_account, :scopes => service_account_scopes } ]
 
           begin
             request_start_time = Time.now.to_i

data/lib/vagrant-google/config.rb

@@ -42,6 +42,11 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :image_family
 
+      # The name of the image_project_id
+      #
+      # @return [String]
+      attr_accessor :image_project_id
+
       # The instance group name to put the instance in.
       #
       # @return [String]
@@ -82,6 +87,11 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :network
 
+      # The name of the network_project_id
+      #
+      # @return [String]
+      attr_accessor :network_project_id
+
       # The name of the subnetwork
       #
       # @return [String]
@@ -148,12 +158,20 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :zone
 
-      # The list of access controls for service accounts.
+      # The list of access scopes for instance.
+      #
+      # @return [Array]
+      attr_accessor :scopes
+
+      # Deprecated: the list of access scopes for instance.
       #
       # @return [Array]
       attr_accessor :service_accounts
-      alias scopes service_accounts
-      alias scopes= service_accounts=
+
+      # IAM service account for instance.
+      #
+      # @return [String]
+      attr_accessor :service_account
 
       def initialize(zone_specific=false)
         @google_client_email = UNSET_VALUE
@@ -161,6 +179,7 @@ module VagrantPlugins
         @google_project_id   = UNSET_VALUE
         @image               = UNSET_VALUE
         @image_family        = UNSET_VALUE
+        @image_project_id    = UNSET_VALUE
         @instance_group      = UNSET_VALUE
         @machine_type        = UNSET_VALUE
         @disk_size           = UNSET_VALUE
@@ -169,6 +188,7 @@ module VagrantPlugins
         @metadata            = {}
         @name                = UNSET_VALUE
         @network             = UNSET_VALUE
+        @network_project_id  = UNSET_VALUE
         @subnetwork          = UNSET_VALUE
         @tags                = []
         @labels              = {}
@@ -181,7 +201,9 @@ module VagrantPlugins
         @on_host_maintenance = UNSET_VALUE
         @instance_ready_timeout = UNSET_VALUE
         @zone                = UNSET_VALUE
+        @scopes              = UNSET_VALUE
         @service_accounts    = UNSET_VALUE
+        @service_account     = UNSET_VALUE
 
         # Internal state (prefix with __ so they aren't automatically
         # merged)
@@ -265,6 +287,9 @@ module VagrantPlugins
         # Default image family is nil
         @image_family = nil if @image_family == UNSET_VALUE
 
+        # Default image project is nil
+        @image_project_id = nil if @image_project_id == UNSET_VALUE
+
         # Default instance group name is nil
         @instance_group = nil if @instance_group == UNSET_VALUE
 
@@ -289,6 +314,9 @@ module VagrantPlugins
         # Network defaults to 'default'
         @network = "default" if @network == UNSET_VALUE
 
+        # Network project id defaults to project_id
+        @network_project_id = @google_project_id if @network_project_id == UNSET_VALUE
+
         # Subnetwork defaults to nil
         @subnetwork = nil if @subnetwork == UNSET_VALUE
 
@@ -319,9 +347,20 @@ module VagrantPlugins
         # Default instance_ready_timeout
         @instance_ready_timeout = 20 if @instance_ready_timeout == UNSET_VALUE
 
-        # Default service_accounts
+        # Default access scopes
+        @scopes = nil if @scopes == UNSET_VALUE
+
+        # Default access scopes
         @service_accounts = nil if @service_accounts == UNSET_VALUE
 
+        # Default IAM service account
+        @service_account = nil if @service_account == UNSET_VALUE
+
+        # Config option service_accounts is deprecated
+        if @service_accounts
+          @scopes = @service_accounts
+        end
+
         # Compile our zone specific configurations only within
         # NON-zone-SPECIFIC configurations.
         unless @__zone_specific
@@ -382,6 +421,10 @@ module VagrantPlugins
         errors << I18n.t("vagrant_google.config.image_required") if config.image.nil? && config.image_family.nil?
         errors << I18n.t("vagrant_google.config.name_required") if @name.nil?
 
+        if @service_accounts
+          machine.env.ui.warn(I18n.t("vagrant_google.config.service_accounts_deprecaated"))
+        end
+
         { "Google Provider" => errors }
       end
 

data/lib/vagrant-google/version.rb

@@ -13,6 +13,6 @@
 # limitations under the License.
 module VagrantPlugins
   module Google
-    VERSION = "2.0.0".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/locales/en.yml

@@ -75,6 +75,8 @@ en:
         instances.
       image_and_image_family_set: |-
         "image" must be unset when setting "image_family"
+      service_accounts_deprecaated: |-
+        "service_accounts is deprecated. Please use scopes instead"
 #-------------------------------------------------------------------------------
 # Translations for exception classes
 #-------------------------------------------------------------------------------

data/tasks/acceptance.rake

@@ -67,6 +67,7 @@ namespace :acceptance do
       reload
       scopes
       instance_groups
+      image_family
       synced_folder/rsync
       provisioner/shell
       provisioner/chef-solo

data/test/acceptance/provider/image_family_spec.rb

@@ -0,0 +1,26 @@
+# This tests that an instance referenced by image family can be started properly
+shared_examples 'provider/image_family' do |provider, options|
+  unless options[:box]
+    raise ArgumentError,
+          "box option must be specified for provider: #{provider}"
+  end
+
+  include_context 'acceptance'
+
+  before do
+    environment.skeleton('image_family')
+    assert_execute('vagrant', 'box', 'add', 'basic', options[:box])
+    assert_execute('vagrant', 'up', "--provider=#{provider}")
+  end
+
+  after do
+    assert_execute('vagrant', 'destroy', '--force')
+  end
+
+  it 'should bring up machine with image_family option' do
+    status("Test: machine is running after up")
+    result = execute("vagrant", "ssh", "-c", "echo foo")
+    expect(result).to exit_with(0)
+    expect(result.stdout).to match(/foo\n$/)
+  end
+end

data/test/acceptance/provider/scopes_spec.rb

@@ -1,6 +1,5 @@
 # This tests that account scopes can be configured correctly
-# Additionally, this verifies that the 'scopes' method alias is
-# available and gcloud GCE aliases can be used.
+# and that gcloud GCE aliases can be used.
 # (see lib/fog/google/models/compute/server.rb in fog-google)
 shared_examples 'provider/scopes' do |provider, options|
   unless options[:box]

data/test/acceptance/skeletons/image_family/Vagrantfile

@@ -0,0 +1,14 @@
+Vagrant.configure("2") do |config|
+  config.vm.box = "basic"
+
+  config.vm.provider :google do |google|
+
+    google.zone = "australia-southeast1-b"
+
+    google.zone_config "australia-southeast1-b" do |zone|
+      zone.name = "vagrant-acceptance-preemptible-#{('a'..'z').to_a.sample(8).join}"
+      zone.disk_type = "pd-ssd"
+      zone.image_family = "centos-7"
+    end
+  end
+end

data/test/unit/common/config_test.rb

@@ -32,6 +32,8 @@ describe VagrantPlugins::Google::Config do
 
     its("name")                   { should match "i-[0-9]{10}-[0-9a-f]{4}" }
     its("image")                  { should be_nil }
+    its("image_family")           { should be_nil }
+    its("image_project_id")       { should be_nil }
     its("instance_group")         { should be_nil }
     its("zone")                   { should == "us-central1-f" }
     its("network")                { should == "default" }
@@ -43,7 +45,7 @@ describe VagrantPlugins::Google::Config do
     its("metadata")               { should == {} }
     its("tags")                   { should == [] }
     its("labels")                 { should == {} }
-    its("service_accounts")       { should == nil }
+    its("scopes")                 { should == nil }
     its("preemptible")            { should be_falsey }
     its("auto_restart")           { should }
     its("on_host_maintenance")    { should == "MIGRATE" }
@@ -54,8 +56,8 @@ describe VagrantPlugins::Google::Config do
     # simple boilerplate test, so I cut corners here. It just sets
     # each of these attributes to "foo" in isolation, and reads the value
     # and asserts the proper result comes back out.
-    [:name, :image, :zone, :instance_ready_timeout, :machine_type, :disk_size, :disk_name, :disk_type,
-     :network, :metadata, :labels, :can_ip_forward, :external_ip, :autodelete_disk].each do |attribute|
+    [:name, :image, :image_family, :image_project_id, :zone, :instance_ready_timeout, :machine_type, :disk_size, :disk_name, :disk_type,
+     :network, :network_project_id, :metadata, :labels, :can_ip_forward, :external_ip, :autodelete_disk].each do |attribute|
 
       it "should not default #{attribute} if overridden" do
         instance.send("#{attribute}=".to_sym, "foo")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-google
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Eric Johnson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-google
@@ -196,6 +196,7 @@ files:
 - tasks/test.rake
 - test/acceptance/base.rb
 - test/acceptance/provider/halt_spec.rb
+- test/acceptance/provider/image_family_spec.rb
 - test/acceptance/provider/instance_groups_spec.rb
 - test/acceptance/provider/multi_instance_spec.rb
 - test/acceptance/provider/preemptible_spec.rb
@@ -203,6 +204,7 @@ files:
 - test/acceptance/provider/scopes_spec.rb
 - test/acceptance/shared/context_google.rb
 - test/acceptance/skeletons/generic/Vagrantfile
+- test/acceptance/skeletons/image_family/Vagrantfile
 - test/acceptance/skeletons/instance_groups/Vagrantfile
 - test/acceptance/skeletons/multi_instance/Vagrantfile
 - test/acceptance/skeletons/preemptible/Vagrantfile