vagrant-orchestrate 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4760cd6a2cdc63739d752fe2341dd49e2e174676
-  data.tar.gz: c244aaadc7615858ae95ee9315ae6d306cdad82e
+  metadata.gz: 2d1d37bbcceb73c4aeea0523c3132be46e30a5dd
+  data.tar.gz: 8a2d5192f22543df2a99a31b72bd5fb95037d2e4
 SHA512:
-  metadata.gz: bbabd2ed817ea80ce81706464852f569b59e5e5bae90b25979765380772af47857c94f61e212dcd4776eed92cfe820e44811e92e63c9ba705bc89eaf6d12cb07
-  data.tar.gz: a7f8b8f32cc8d86ba46267ab946a1bdc730e0a309fcdac9288c2bde3978d2477fbf7a57c3aec28f0922f36dea73697678b1a46076276b885ccb6f054e14c2993
+  metadata.gz: 4d09668c2feeef5cafe7fff5885597105f7a1194c1b62ae0c07c0d7958b33abfd8ca201ddd0eee00af4b1713666a71cd88b987d06c6c51f385b0ee62253617ef
+  data.tar.gz: 04d66afcfcb9b2867de6b74b26d8d8b951343fcd16f8c1dc823288ef4d68e5055d8b360e3d15f92641660a188c8e5685967dd0ac94240f710574c3c2c2308d78

data/.gitignore

@@ -14,6 +14,5 @@
 mkmf.log
 
 /.vagrant/
-Vagrantfile
 .DS_Store
 servers.json

data/Rakefile

@@ -7,3 +7,16 @@ RSpec::Core::RakeTask.new(:spec)
 
 task build: ["rubocop:auto_correct", :spec]
 task default: :build
+
+desc "Run acceptance tests with vagrant-spec"
+task :acceptance do
+  puts "Brining up target servers"
+  # Spinning up local servers here, which the managed provider will connect to
+  # by IP. See the Vagrantfile in the root of the repo for more info.
+  system("vagrant up /local/ --no-provision")
+  # To ensure the ntp sync happens even if the servers are already up
+  system("vagrant provision /local/")
+  system("bundle exec vagrant-spec test --components=orchestrate/push orchestrate/prompt")
+  puts "Destroying target servers"
+  system("vagrant destroy -f /local/")
+end

data/Vagrantfile

@@ -0,0 +1,30 @@
+managed_servers = %w( 192.168.10.80 192.168.10.81 192.168.10.82 192.168.10.83)
+
+Vagrant.configure(2) do |config|
+  # These boxes are defined locally to enable acceptance testing. Spinning up
+  # real boxes in the vagrant-spec environment was expensive because it ignored
+  # the cache and didn't expose a facility to view the vagrant output as it ran.
+  # These machines get spun up in the rake task and then the vagrant-spec tests
+  # connect to them by IP address.
+  managed_servers.each_with_index do |ip, index|
+    config.vm.define "local-#{index + 1}" do |ubuntu|
+      # minimize clock skew, since we're using the `date` command to measure
+      # clock skew.
+      ubuntu.vm.provision :shell, inline: "ntpdate pool.ntp.org"
+      ubuntu.vm.box = "ubuntu/trusty64"
+      ubuntu.vm.network "private_network", ip: ip
+    end
+  end
+
+  # These managed boxes connect to the local boxes defined above by ip address.
+  managed_servers.each_with_index do |server, index|
+    config.vm.define "managed-#{index + 1}" do |managed|
+      managed.vm.box = "managed-server-dummy"
+      managed.vm.box_url = "./dummy.box"
+      managed.ssh.password = "vagrant"
+      managed.vm.provider :managed do |provider|
+        provider.server = server
+      end
+    end
+  end
+end

data/acceptance/command/prompt_spec.rb

@@ -0,0 +1,22 @@
+require "vagrant-spec"
+
+describe "vagrant orchestrate prompt", component: "orchestrate/prompt" do
+  include_context "acceptance"
+
+  before do
+    environment.skeleton("prompt")
+  end
+
+  # Vagrant throws with the error message below if a prompt is encountered. We need
+  # to make sure that non-push commands don't prompt
+  # Vagrant is attempting to interface with the UI in a way that requires
+  #     a TTY. Most actions in Vagrant that require a TTY have configuration
+  #     switches to disable this requirement. Please do that or run Vagrant
+  #     with TTY.
+  it "doesn't prompt with non-push commands" do
+    assert_execute("vagrant", "status")
+  end
+
+  # TODO: I wish there was a way to simulate prompting, but for now, that is left
+  # to the user as a manual exercise.
+end

data/acceptance/command/push_spec.rb

@@ -0,0 +1,78 @@
+require "vagrant-spec"
+
+describe "vagrant orchestrate push", component: "orchestrate/push" do
+  include_context "acceptance"
+
+  before do
+    environment.skeleton("basic")
+  end
+
+  it "can push to a set of managed servers" do
+    assert_execute("vagrant", "orchestrate", "push")
+  end
+
+  describe "strategies" do
+    it "can push in parallel" do
+      assert_execute("vagrant", "orchestrate", "push", "--strategy", "parallel")
+
+      machine_names = (1..4).collect { |i| "managed-#{i}" }
+      datetimes = get_sync_times(machine_names)
+      execute("vagrant", "destroy", "-f")
+
+      # Parallel provisioning should happen within a few seconds.
+      ensure_datetimes_within(datetimes, 5)
+    end
+
+    it "can push with carary strategy" do
+      assert_execute("vagrant", "orchestrate", "push", "--strategy", "canary", "-f")
+      canary = get_sync_times(["managed-1"]).first
+      the_rest = get_sync_times((2..4).collect { |i| "managed-#{i}" })
+      execute("vagrant", "destroy", "-f")
+      ensure_datetimes_within(the_rest, 5)
+      expect(diff_seconds(canary, the_rest.min)).to be >= 3
+    end
+
+    it "can push with half_half strategy" do
+      assert_execute("vagrant", "orchestrate", "push", "--strategy", "half_half", "-f")
+      first_half = get_sync_times(["managed-1", "managed-2"])
+      second_half = get_sync_times(["managed-3", "managed-4"])
+      execute("vagrant", "destroy", "-f")
+      ensure_datetimes_within(first_half, 5)
+      ensure_datetimes_within(second_half, 5)
+      expect(diff_seconds(first_half.max, second_half.min)).to be >= 3
+    end
+
+    it "can push with carary_half_half strategy" do
+      assert_execute("vagrant", "orchestrate", "push", "--strategy", "canary_half_half", "-f")
+      canary = get_sync_times(["managed-1"]).first
+      first_half = get_sync_times(["managed-2"])
+      second_half = get_sync_times(["managed-3", "managed-4"])
+      execute("vagrant", "destroy", "-f")
+      ensure_datetimes_within(first_half, 5)
+      expect(diff_seconds(canary, first_half.min)).to be > 3
+      expect(diff_seconds(first_half.max, second_half.min)).to be >= 3
+    end
+  end
+
+  def get_sync_times(machines)
+    datetimes = []
+    machines.each do |machine|
+      execute("vagrant", "up", machine)
+      # This file is written by the shell provisioner in ../support-skeletons/basic/Vagrantfile
+      result = execute("vagrant", "ssh", "-c", "cat /tmp/sync_time", machine)
+      datetimes << DateTime.parse(result.stdout.chomp)
+    end
+    datetimes
+  end
+
+  # Ensure that the range (max - min) of the datetime objects passed in are within
+  # the given number of seconds.
+  def ensure_datetimes_within(datetimes, seconds)
+    expect(diff_seconds(datetimes.min, datetimes.max)).to be < seconds
+  end
+
+  # The difference between two datetimes in seconds
+  def diff_seconds(start, finish)
+    ((finish - start) * 86_400).to_i
+  end
+end

data/acceptance/support-skeletons/basic/Vagrantfile

@@ -0,0 +1,17 @@
+managed_servers = %w( 192.168.10.80 192.168.10.81 192.168.10.82 192.168.10.83)
+
+Vagrant.configure(2) do |config|
+  config.ssh.password = "vagrant"
+  managed_servers.each_with_index do |server, index|
+    config.vm.define "managed-#{index + 1}" do |managed|
+      managed.vm.provision "shell", inline: "date > /tmp/sync_time; sleep 3"
+      managed.vm.box = "managed-server-dummy"
+      managed.vm.box_url = "./dummy.box"
+      # TODO: Why in the world do I need this? I thought it was the default!
+      managed.ssh.password = "vagrant"
+      managed.vm.provider :managed do |provider|
+        provider.server = server
+      end
+    end
+  end
+end

data/acceptance/support-skeletons/prompt/Vagrantfile

@@ -0,0 +1,16 @@
+managed_servers = %w( 192.168.10.80 192.168.10.81 192.168.10.82 192.168.10.83 )
+
+Vagrant.configure(2) do |config|
+  config.orchestrate.credentials.prompt = true
+
+  managed_servers.each_with_index do |server, index|
+    config.vm.define "managed-#{index + 1}" do |managed|
+      managed.vm.provision "shell", inline: "echo 'hello world'"
+      managed.vm.box = "managed-server-dummy"
+      managed.vm.box_url = "./dummy.box"
+      managed.vm.provider :managed do |provider|
+        provider.server = server
+      end
+    end
+  end
+end

data/lib/vagrant-orchestrate/action/setcredentials.rb

@@ -2,84 +2,65 @@ module VagrantPlugins
   module Orchestrate
     module Action
       class SetCredentials
-        def initialize(app, _env)
-          @app = app
-        end
-
-        # rubocop:disable Metrics/AbcSize
-        def call(env)
-          @machine = env[:machine]
-
-          if @machine.config.orchestrate.credentials
-            @ui = env[:ui]
-            config_creds = @machine.config.orchestrate.credentials
-            (username, password) = retrieve_creds(config_creds)
-
-            # Apply the credentials to the machine info, or back out if we were unable to procure them.
-            if username && password
-              apply_creds(username, password)
-            else
-              @ui.warn <<-WARNING
-Vagrant-orchestrate could not gather credentials for machine #{@machine.name}. \
-Continuing with default credentials."
-              WARNING
-            end
-          end
-
-          @app.call env
-        end
+        def retrieve_creds(config_creds, ui)
+          return unless config_creds
 
-        def retrieve_creds(config_creds)
           # Use environment variable overrides, or else what was provided in the config file
           config_creds.username = ENV["VAGRANT_ORCHESTRATE_USERNAME"] || config_creds.username
           config_creds.password = ENV["VAGRANT_ORCHESTRATE_PASSWORD"] || config_creds.password
 
           # Use credentials file to any username or password that is still undiscovered
-          check_creds_file(config_creds) unless config_creds.username && config_creds.password
+          check_creds_file(config_creds, ui) unless config_creds.username && config_creds.password
 
+          config_creds = maybe_prompt(config_creds)
+
+          [config_creds.username, config_creds.password]
+        end
+
+        def maybe_prompt(config_creds)
           # Only prompt if allowed by config
           if config_creds.prompt
-            config_creds.username ||= prompt_username
-            config_creds.password ||= prompt_password
+            config_creds.username ||= prompt_username(ui)
+            config_creds.password ||= prompt_password(ui)
           end
-
-          [config_creds.username, config_creds.password]
+          config_creds
         end
 
-        def apply_creds(username, password)
-          [@machine.config.winrm, @machine.config.ssh].each do |config|
+        def apply_creds(machine, username, password)
+          [machine.config.winrm, machine.config.ssh].each do |config|
             next unless config
             config.username = username
             config.password = password
           end
         end
 
-        def prompt_username
+        def prompt_username(ui)
           default = ENV["USERNAME"]
           default ||= ENV["USER"]
           default = ENV["USERDOMAIN"] + "\\" + default if ENV["USERDOMAIN"]
-          username = @ui.ask("username? [#{default}] ")
+          username = ui.ask("username? [#{default}] ")
           username = default if username.empty?
           username
         end
 
-        def prompt_password
-          @ui.ask("password? ", echo: false)
+        def prompt_password(ui)
+          ui.ask("password? ", echo: false)
         end
 
-        def check_creds_file(config_creds)
+        def check_creds_file(config_creds, ui)
           file_path = config_creds.file_path
           return unless file_path
           unless File.exist?(file_path)
             @ui.info "Credential file not found at #{file_path}. Prompting user for credentials."
             return
           end
+
           begin
             creds_yaml = YAML.load(File.read(file_path))
             config_creds.password ||= creds_yaml[:password] || creds_yaml["password"]
             config_creds.username ||= creds_yaml[:username] || creds_yaml["username"]
           rescue
-            @ui.warn "Credentials file at #{file_path} was not valid YAML. Prompting user for credentials."
+            ui.warn "Credentials file at #{file_path} was not valid YAML. Prompting user for credentials."
           end
         end
       end

data/lib/vagrant-orchestrate/command/push.rb

@@ -1,5 +1,6 @@
 require "optparse"
 require "vagrant"
+require "vagrant-orchestrate/action/setcredentials"
 
 # Borrowed from http://stackoverflow.com/questions/12374645/splitting-an-array-into-equal-parts-in-ruby
 class Array
@@ -57,6 +58,8 @@ module VagrantPlugins
             return 0
           end
 
+          retrieve_creds(machines) if @env.vagrantfile.config.orchestrate.credentials
+
           options[:parallel] = true
           strategy = options[:strategy] || @env.vagrantfile.config.orchestrate.strategy
           @env.ui.info("Pushing to managed servers using #{strategy} strategy.")
@@ -130,7 +133,7 @@ module VagrantPlugins
         # rubocop:enable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def prompt_for_continue
-          result = @env.ui.ask("Deployment paused for manual review. Would you like to continue? (y/n)")
+          result = @env.ui.ask("Deployment paused for manual review. Would you like to continue? (y/n) ")
           if result.upcase != "Y"
             @env.ui.info("Deployment push action cancelled by user")
             return false
@@ -145,6 +148,23 @@ module VagrantPlugins
             end
           end
         end
+
+        def retrieve_creds(machines)
+          creds = VagrantPlugins::Orchestrate::Action::SetCredentials.new
+          (username, password) = creds.retrieve_creds(@env.vagrantfile.config.orchestrate.credentials, @env.ui)
+
+          # Apply the credentials to the machine info, or back out if we were unable to procure them.
+          if username && password
+            machines.each do |machine|
+              creds.apply_creds(machine, username, password)
+            end
+          else
+            @env.ui.warn <<-WARNING
+Vagrant-orchestrate could not gather credentials. \
+Continuing with default credentials."
+            WARNING
+          end
+        end
       end
     end
   end

data/lib/vagrant-orchestrate/plugin.rb

@@ -34,10 +34,6 @@ module VagrantPlugins
         Command::Root
       end
 
-      action_hook(:orchestrate, Plugin::ALL_ACTIONS) do |hook|
-        hook.before Vagrant::Action::Builtin::ConfigValidate, Action::SetCredentials
-      end
-
       action_hook(:orchestrate, :machine_action_up) do |hook|
         hook.prepend Action::FilterManaged
       end

data/lib/vagrant-orchestrate/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Orchestrate
-    VERSION = "0.4.5"
+    VERSION = "0.4.6"
   end
 end

data/spec/vagrant-orchestrate/command/init_spec.rb

@@ -1,6 +1,5 @@
 require "vagrant-orchestrate/command/init"
 require "vagrant-spec/unit"
-require "pp"
 
 describe VagrantPlugins::Orchestrate::Command::Init do
   include_context "vagrant-unit"

data/vagrant-spec.config.rb

@@ -0,0 +1,4 @@
+Vagrant::Spec::Acceptance.configure do |c|
+  c.component_paths << File.join("acceptance")
+  c.skeleton_paths << File.join("acceptance", "support-skeletons")
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Christopher Baldauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- Vagrantfile
+- acceptance/command/prompt_spec.rb
+- acceptance/command/push_spec.rb
+- acceptance/support-skeletons/basic/Vagrantfile
+- acceptance/support-skeletons/basic/dummy.box
+- acceptance/support-skeletons/prompt/Vagrantfile
+- acceptance/support-skeletons/prompt/dummy.box
 - docs/strategy.md
 - dummy.box
 - lib/vagrant-orchestrate.rb
@@ -103,6 +110,7 @@ files:
 - templates/vagrant/Vagrantfile.erb
 - templates/vagrant/dummy.box
 - vagrant-orchestrate.gemspec
+- vagrant-spec.config.rb
 homepage: https://github.com/Cimpress-MCP/vagrant-orchestrate
 licenses:
 - Apache 2.0