vagrant-google 2.5.0 → 2.6.0

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

@@ -0,0 +1,72 @@
+# Copyright 2015 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Changes:
+# April 2019: Modified example found here:
+# https://github.com/GoogleCloudPlatform/compute-image-windows/blob/master/examples/windows_auth_python_sample.py
+# to enable WinRM with vagrant.
+
+module VagrantPlugins
+  module Google
+    module Action
+      # Sets up a temporary WinRM password using Google's method for
+      # establishing a new password over encrypted channels.
+      class SetupWinrmPassword
+        def initialize(app, env)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant_google::action::setup_winrm_password")
+        end
+
+        def setup_password(env, instance, zone, user)
+          # Setup
+          compute = env[:google_compute]
+          server = compute.servers.get(instance, zone)
+          password = server.reset_windows_password(user)
+
+          env[:ui].info("Temp Password: #{password}")
+
+          password
+        end
+
+        def call(env)
+          # Get the configs
+          zone = env[:machine].provider_config.zone
+          zone_config = env[:machine].provider_config.get_zone_config(zone)
+
+          instance = zone_config.name
+          user = env[:machine].config.winrm.username
+          pass = env[:machine].config.winrm.password
+
+          # Get Temporary Password, set WinRM password
+          temp_pass = setup_password(env, instance, zone, user)
+          env[:machine].config.winrm.password = temp_pass
+
+          # Wait for WinRM To be Ready
+          env[:ui].info("Waiting for WinRM To be ready")
+          env[:machine].communicate.wait_for_ready(60)
+
+          # Use WinRM to Change Password to one in Vagrantfile
+          env[:ui].info("Changing password from temporary to winrm password")
+          winrmcomm = VagrantPlugins::CommunicatorWinRM::Communicator.new(env[:machine])
+          cmd = "net user #{user} #{pass}"
+          opts = { elevated: true }
+          winrmcomm.test(cmd, opts)
+
+          # Update WinRM password to reflect updated one
+          env[:machine].config.winrm.password = pass
+        end
+      end
+    end
+  end
+end

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

@@ -65,9 +65,9 @@ module VagrantPlugins
           @logger.info("Time to instance ready: #{env[:metrics]["instance_ready_time"]}")
 
           unless env[:interrupted]
-            env[:metrics]["instance_ssh_time"] = Util::Timer.time do
-              # Wait for SSH to be ready.
-              env[:ui].info(I18n.t("vagrant_google.waiting_for_ssh"))
+            env[:metrics]["instance_comm_time"] = Util::Timer.time do
+              # Wait for Comms to be ready.
+              env[:ui].info(I18n.t("vagrant_google.waiting_for_comm"))
               while true
                 # If we're interrupted then just back out
                 break if env[:interrupted]
@@ -76,7 +76,7 @@ module VagrantPlugins
               end
             end
 
-            @logger.info("Time for SSH ready: #{env[:metrics]["instance_ssh_time"]}")
+            @logger.info("Time for Comms ready: #{env[:metrics]["instance_comm_time"]}")
 
             # Ready and booted!
             env[:ui].info(I18n.t("vagrant_google.ready"))

data/lib/vagrant-google/config.rb

@@ -178,38 +178,68 @@ module VagrantPlugins
       # @return [Array<Hash>]
       attr_accessor :additional_disks
 
+      # (Optional - Override default WinRM setup before for Public Windows images)
+      #
+      # @return [Boolean]
+      attr_accessor :setup_winrm_password
+
+      # Accelerators
+      #
+      # @return [Array<Hash>]
+      attr_accessor :accelerators
+
+      # whether the instance has Secure Boot enabled
+      #
+      # @return Boolean
+      attr_accessor :enable_secure_boot
+
+      # whether the instance has the vTPM enabled
+      #
+      # @return Boolean
+      attr_accessor :enable_vtpm
+
+      # whether the instance has integrity monitoring enabled
+      #
+      # @return Boolean
+      attr_accessor :enable_integrity_monitoring
+
       def initialize(zone_specific=false)
-        @google_json_key_location = UNSET_VALUE
-        @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
-        @disk_name           = UNSET_VALUE
-        @disk_type           = UNSET_VALUE
-        @metadata            = {}
-        @name                = UNSET_VALUE
-        @network             = UNSET_VALUE
-        @network_project_id  = UNSET_VALUE
-        @subnetwork          = UNSET_VALUE
-        @tags                = []
-        @labels              = {}
-        @can_ip_forward      = UNSET_VALUE
-        @external_ip         = UNSET_VALUE
-        @network_ip          = UNSET_VALUE
-        @use_private_ip      = UNSET_VALUE
-        @autodelete_disk     = UNSET_VALUE
-        @preemptible         = UNSET_VALUE
-        @auto_restart        = UNSET_VALUE
-        @on_host_maintenance = UNSET_VALUE
-        @instance_ready_timeout = UNSET_VALUE
-        @zone                = UNSET_VALUE
-        @scopes              = UNSET_VALUE
-        @service_accounts    = UNSET_VALUE
-        @service_account     = UNSET_VALUE
-        @additional_disks    = []
+        @google_json_key_location    = UNSET_VALUE
+        @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
+        @disk_name                   = UNSET_VALUE
+        @disk_type                   = UNSET_VALUE
+        @metadata                    = {}
+        @name                        = UNSET_VALUE
+        @network                     = UNSET_VALUE
+        @network_project_id          = UNSET_VALUE
+        @subnetwork                  = UNSET_VALUE
+        @tags                        = []
+        @labels                      = {}
+        @can_ip_forward              = UNSET_VALUE
+        @external_ip                 = UNSET_VALUE
+        @network_ip                  = UNSET_VALUE
+        @use_private_ip              = UNSET_VALUE
+        @autodelete_disk             = UNSET_VALUE
+        @preemptible                 = UNSET_VALUE
+        @auto_restart                = UNSET_VALUE
+        @on_host_maintenance         = UNSET_VALUE
+        @instance_ready_timeout      = UNSET_VALUE
+        @zone                        = UNSET_VALUE
+        @scopes                      = UNSET_VALUE
+        @service_accounts            = UNSET_VALUE
+        @service_account             = UNSET_VALUE
+        @additional_disks            = []
+        @setup_winrm_password        = UNSET_VALUE
+        @accelerators                = []
+        @enable_secure_boot          = UNSET_VALUE
+        @enable_vtpm                 = UNSET_VALUE
+        @enable_integrity_monitoring = UNSET_VALUE
 
         # Internal state (prefix with __ so they aren't automatically
         # merged)
@@ -275,12 +305,10 @@ module VagrantPlugins
           result.instance_variable_set(:@__zone_config, new_zone_config)
 
           # Merge in the metadata
-          result.metadata.merge!(self.metadata)
-          result.metadata.merge!(other.metadata)
+          result.metadata = self.metadata.merge(other.metadata)
 
           # Merge in the labels
-          result.labels.merge!(self.labels)
-          result.labels.merge!(other.labels)
+          result.labels = self.labels.merge(other.labels)
 
           # Merge in the tags
           result.tags |= self.tags
@@ -382,11 +410,23 @@ module VagrantPlugins
         # Default IAM service account
         @service_account = nil if @service_account == UNSET_VALUE
 
+        # Default Setup WinRM Password
+        @setup_winrm_password = nil if @setup_winrm_password == UNSET_VALUE
+
         # Config option service_accounts is deprecated
         if @service_accounts
           @scopes = @service_accounts
         end
 
+        # enable_secure_boot defaults to nil
+        @enable_secure_boot = false if @enable_secure_boot == UNSET_VALUE
+
+        # enable_vtpm defaults to nil
+        @enable_vtpm = false if @enable_vtpm == UNSET_VALUE
+
+        # enable_integrity_monitoring defaults to nil
+        @enable_integrity_monitoring = false if @enable_integrity_monitoring == UNSET_VALUE
+
         # Compile our zone specific configurations only within
         # NON-zone-SPECIFIC configurations.
         unless @__zone_specific
@@ -444,6 +484,11 @@ 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 !config.accelerators.empty?
+            errors << I18n.t("vagrant_google.config.on_host_maintenance_invalid_with_accelerators") unless \
+              config.on_host_maintenance == "TERMINATE"
+          end
         end
 
         if @service_accounts

data/lib/vagrant-google/version.rb

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

data/locales/en.yml

@@ -14,8 +14,8 @@ en:
       Instance is not created. Please run `vagrant up` first.
     ready: |-
       Machine is booted and ready for use!
-    ready_ssh: |-
-      Machine is ready for SSH access!
+    ready_comm: |-
+      Machine is ready for Communicator access!
     rsync_not_found_warning: |-
       Warning! Folder sync disabled because the rsync binary is missing.
       Make sure rsync is installed and the binary can be found in the PATH.
@@ -31,8 +31,8 @@ en:
       Waiting for GCP operation '%{name}' to finish...
     waiting_for_ready: |-
       Waiting for instance to become "ready"...
-    waiting_for_ssh: |-
-      Waiting for SSH to become available...
+    waiting_for_comm: |-
+      Waiting for Communicator to become available...
     warn_networks: |-
       Warning! The Google provider doesn't support any of the Vagrant
       high-level network configurations (`config.vm.network`). They
@@ -71,6 +71,9 @@ en:
         "image" must be unset when setting "image_family"
       service_accounts_deprecaated: |-
         "service_accounts is deprecated. Please use scopes instead"
+      on_host_maintenance_invalid_with_accelerators: |-
+        "on_host_maintenance" option must be set to "TERMINATE" for instances
+        with accelerators
 #-------------------------------------------------------------------------------
 # Translations for exception classes
 #-------------------------------------------------------------------------------

data/tasks/changelog.rake

@@ -0,0 +1,40 @@
+require "fileutils"
+
+# Helper method to insert text after a line that matches the regex
+def insert_after_line(file, insert, regex = /^## Next/)
+  tempfile = File.open("#{file}.tmp", "w")
+  f = File.new(file)
+  f.each do |line|
+    tempfile << line
+    next unless line =~ regex
+
+    tempfile << "\n"
+    tempfile << insert
+    tempfile << "\n"
+  end
+  f.close
+  tempfile.close
+
+  FileUtils.mv("#{file}.tmp", file)
+end
+
+# Extracts all changes that have been made after the latest pushed tag
+def changes_since_last_tag
+  `git --no-pager log $(git describe --tags --abbrev=0)..HEAD --grep="Merge" --pretty=format:"%t - %s%n%b%n"`
+end
+
+# Extracts all github users contributed since last tag
+def users_since_last_tag
+  `git --no-pager log $(git describe --tags --abbrev=0)..HEAD --grep="Merge" --pretty=format:"%s" | cut -d' ' -f 6 | cut -d/ -f1 | sort | uniq`
+end
+
+namespace :changelog do
+  task :generate do
+    insert_after_line("CHANGELOG.md", changes_since_last_tag, /^## Next/)
+    printf("Users contributed since last release:\n")
+    contributors = users_since_last_tag.split("\n").map { |name| "@" + name }
+    printf("Huge thanks to all our contributors 🎆\n")
+    printf("Special thanks to: " + contributors.join(" ") + "\n")
+    printf("\nI'll merge this and release the gem once all tests pass.\n")
+  end
+end

data/test/acceptance/skeletons/image_family/Vagrantfile

@@ -7,6 +7,8 @@ Vagrant.configure("2") do |config|
 
     google.zone_config "australia-southeast1-b" do |zone|
       zone.name = "vagrant-acceptance-preemptible-#{('a'..'z').to_a.sample(8).join}"
+      # Some images no longer fit into default 10GB disk size
+      zone.disk_size = 30
       zone.disk_type = "pd-ssd"
       zone.image_family = "centos-7"
     end

data/test/unit/common/config_test.rb

@@ -30,26 +30,30 @@ describe VagrantPlugins::Google::Config do
       end
     end
 
-    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" }
-    its("machine_type")           { should == "n1-standard-1" }
-    its("disk_size")              { should == 10 }
-    its("disk_name")              { should be_nil }
-    its("disk_type")              { should == "pd-standard" }
-    its("instance_ready_timeout") { should == 20 }
-    its("metadata")               { should == {} }
-    its("tags")                   { should == [] }
-    its("labels")                 { should == {} }
-    its("scopes")                 { should == nil }
-    its("additional_disks")       { should == [] }
-    its("preemptible")            { should be_falsey }
-    its("auto_restart")           { should }
-    its("on_host_maintenance")    { should == "MIGRATE" }
+    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" }
+    its("machine_type")                { should == "n1-standard-1" }
+    its("disk_size")                   { should == 10 }
+    its("disk_name")                   { should be_nil }
+    its("disk_type")                   { should == "pd-standard" }
+    its("instance_ready_timeout")      { should == 20 }
+    its("metadata")                    { should == {} }
+    its("tags")                        { should == [] }
+    its("labels")                      { should == {} }
+    its("scopes")                      { should == nil }
+    its("additional_disks")            { should == [] }
+    its("preemptible")                 { should be_falsey }
+    its("auto_restart")                { should }
+    its("on_host_maintenance")         { should == "MIGRATE" }
+    its("accelerators")                { should == [] }
+    its("enable_secure_boot")          { should be_falsey }
+    its("enable_vtpm")                 { should be_falsey }
+    its("enable_integrity_monitoring") { should be_falsey }
   end
 
   describe "overriding defaults" do
@@ -57,8 +61,28 @@ 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, :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|
+    [
+        :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,
+        :enable_secure_boot,
+        :enable_vtpm,
+        :enable_integrity_monitoring,
+    ].each do |attribute|
 
       it "should not default #{attribute} if overridden" do
         instance.send("#{attribute}=".to_sym, "foo")
@@ -89,6 +113,14 @@ describe VagrantPlugins::Google::Config do
       errors = instance.validate("foo")["Google Provider"]
       expect(errors).to include(/on_host_maintenance_invalid_on_preemptible/)
     end
+
+    it "should raise error with accelerators and on_host_maintenance is not TERMINATE" do
+      instance.accelerators = [{ :type => "nvidia-tesla-k80" }]
+      instance.on_host_maintenance = "MIGRATE"
+      instance.finalize!
+      errors = instance.validate("foo")["Google Provider"]
+      expect(errors).to include(/on_host_maintenance_invalid_with_accelerators/)
+    end
   end
 
   describe "getting credentials from environment" do
@@ -128,6 +160,7 @@ describe VagrantPlugins::Google::Config do
     let(:config_network)         { "foo" }
     let(:can_ip_forward)         { true }
     let(:external_ip)            { "foo" }
+    let(:accelerators)           { [{ :type => "foo" }] }
 
     def set_test_values(instance)
       instance.name              = config_name
@@ -140,6 +173,7 @@ describe VagrantPlugins::Google::Config do
       instance.zone              = config_zone
       instance.can_ip_forward    = can_ip_forward
       instance.external_ip       = external_ip
+      instance.accelerators      = accelerators
     end
 
     it "should raise an exception if not finalized" do
@@ -169,6 +203,7 @@ describe VagrantPlugins::Google::Config do
       its("zone")              { should == config_zone }
       its("can_ip_forward")    { should == can_ip_forward }
       its("external_ip")       { should == external_ip }
+      its("accelerators")      { should == accelerators }
     end
 
     context "with a specific config set" do
@@ -197,6 +232,7 @@ describe VagrantPlugins::Google::Config do
       its("zone")              { should == zone_name }
       its("can_ip_forward")    { should == can_ip_forward }
       its("external_ip")       { should == external_ip }
+      its("accelerators")      { should == accelerators }
     end
 
     describe "inheritance of parent config" do
@@ -231,47 +267,76 @@ describe VagrantPlugins::Google::Config do
     end
 
     describe "merging" do
-      let(:first) { described_class.new }
-      let(:second) { described_class.new }
+      let(:current) { described_class.new }
+      let(:other) { described_class.new }
+
+      subject { current.merge(other) }
 
       it "should merge the metadata" do
-        first.metadata["one"] = "foo"
-        second.metadata["two"] = "bar"
+        current.metadata["one"] = "foo"
+        other.metadata["two"] = "bar"
 
-        third = first.merge(second)
-        expect(third.metadata).to eq({
+        expect(subject.metadata).to eq({
           "one" => "foo",
           "two" => "bar"
         })
       end
 
+      it "should merge the metadata and overwrite older values" do
+        current.metadata = {
+          "one" => "foo",
+          "name" => "current",
+        }
+
+        other.metadata = {
+          "two" => "bar",
+          "name" => "other",
+        }
+
+        expect(subject.metadata).to eq({
+          "one" => "foo",
+          "two" => "bar",
+          "name" => "other",
+        })
+      end
+
       it "should merge the labels" do
-        first.labels["one"] = "one"
-        second.labels["two"] = "two"
+        current.labels["one"] = "one"
+        other.labels["two"] = "two"
 
-        third = first.merge(second)
-        expect(third.labels).to eq({
+        expect(subject.labels).to eq({
           "one" => "one",
           "two" => "two"
         })
       end
+      
+      it "should merge the labels and overwrite older values" do
+        current.labels["one"] = "one"
+        current.labels["name"] = "current"
+        other.labels["two"] = "two"
+        other.labels["name"] = "other"
+
+        expect(subject.labels).to eq({
+          "one" => "one",
+          "two" => "two",
+          "name" => "other",
+        })
+      end
 
       it "should merge the tags" do
-        first.tags = ["foo", "bar"]
-        second.tags = ["biz"]
+        current.tags = ["foo", "bar"]
+        other.tags = ["biz"]
 
-        third = first.merge(second)
-        expect(third.tags).to include("foo")
-        expect(third.tags).to include("bar")
-        expect(third.tags).to include("biz")
+        expect(subject.tags).to include("foo")
+        expect(subject.tags).to include("bar")
+        expect(subject.tags).to include("biz")
       end
 
       it "should merge the additional_disks" do
-        first.additional_disks = [{:one => "one"}]
-        second.additional_disks = [{:two => "two"}]
+        current.additional_disks = [{:one => "one"}]
+        other.additional_disks = [{:two => "two"}]
 
-        third = first.merge(second)
-        expect(third.additional_disks).to contain_exactly(
+        expect(subject.additional_disks).to contain_exactly(
           {:one => "one"}, {:two => "two"}
         )
       end