vcloud-launcher 0.4.0 → 0.5.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.5.0 (2014-10-14)
+
+Features:
+
+  - Upgrade dependency on vCloud Core to 0.13.0. An error will now be raised if
+    your `FOG_CREDENTIAL` environment variable does not match the information
+    stored against a vCloud Director session referred to by `FOG_VCLOUD_TOKEN`,
+    so as to guard against accidental changes to the wrong vCloud Director
+    organization.
+
 ## 0.4.0 (2014-09-11)
 
   - Upgrade dependency on vCloud Core to 0.11.0 which prevents plaintext

data/lib/vcloud/launcher/cli.rb

@@ -11,6 +11,7 @@ module Vcloud
           "dont-power-on"     => false,
           "continue-on-error" => false,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => false,
         }
 
@@ -68,6 +69,14 @@ Example configuration files can be found in:
             @options["quiet"] = true
           end
 
+          opts.on("-p COMMAND", "--post-launch-cmd COMMAND", "Executable to run when a VM is successfully provisioned") do |command|
+            if command.split().length() != 1
+              exit_error_usage("COMMAND only accepts an executable name, not a command with arguments")
+            else
+              @options["post-launch-cmd"] = command
+            end
+          end
+
           opts.on("-v", "--verbose", "Verbose output") do
             @options["verbose"] = true
           end
@@ -86,7 +95,7 @@ Example configuration files can be found in:
         @usage_text = opt_parser.to_s
         begin
           opt_parser.parse!(args)
-        rescue OptionParser::InvalidOption => e
+        rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
           exit_error_usage(e)
         end
 

data/lib/vcloud/launcher/launch.rb

@@ -23,6 +23,9 @@ module Vcloud
           begin
             vapp = ::Vcloud::Launcher::VappOrchestrator.provision(vapp_config)
             vapp.power_on unless cli_options["dont-power-on"]
+            if cli_options["post-launch-cmd"]
+              run_command(vapp_config, cli_options["post-launch-cmd"])
+            end
             Vcloud::Core.logger.info("Provisioned vApp #{vapp_config[:name]} successfully.")
           rescue RuntimeError => e
             Vcloud::Core.logger.error("Failure: Could not provision vApp: #{e.message}")
@@ -34,6 +37,34 @@ module Vcloud
 
       private
 
+      def run_command(vapp_definition, command)
+        command_path = File.expand_path(command)
+        if File.exist?(command_path)
+          begin
+            Vcloud::Core.logger.info("Running #{command_path} for #{vapp_definition[:name]}")
+            ENV['VAPP_DEFINITION'] = vapp_definition.to_s
+            exit_status = system(command_path)
+            exit_message = $?
+            if exit_status == false
+              # The command has returned a non-zero exit code
+              Vcloud::Core.logger.error("Failed to run #{command_path} for #{vapp_definition[:name]} exited with a non-zero response: #{exit_message}")
+            elsif exit_status == nil
+              # The call to system() has returned no exit code
+              Vcloud::Core.logger.error("Failed to run #{command_path} for #{vapp_definition[:name]} could not be run: #{exit_message}")
+            else
+              # The command has returned a zero exit code SUCCESS!
+              Vcloud::Core.logger.debug("Ran #{command_path} with VAPP_DEFINITION=#{vapp_definition}")
+            end
+          rescue
+            # Catch various errors including no permissions or unable to execute script
+            Vcloud::Core.logger.error("Failed to run #{command_path} for #{vapp_definition[:name]}")
+          end
+        else
+          # Catch specific case of a script that does not exist
+          Vcloud::Core.logger.error("#{command_path} does not exist")
+        end
+      end
+
       def set_logging_level
         if cli_options[:verbose]
           Vcloud::Core.logger.level = Logger::DEBUG

data/lib/vcloud/launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Launcher
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/spec/integration/launcher/data/false_cmd

@@ -0,0 +1,2 @@
+#!/bin/sh
+exit 1

data/spec/integration/launcher/data/true_cmd

@@ -0,0 +1,2 @@
+#!/bin/sh
+exit 0

data/spec/integration/launcher/launch_spec.rb

@@ -31,6 +31,53 @@ describe Vcloud::Launcher::Launch do
     end
   end
 
+  context "when running successful post-launch commands" do
+    it 'should log that it ran the command' do
+      @test_data = define_test_data
+      @config_yaml = ErbHelper.convert_erb_template_to_yaml(@test_data, File.join(File.dirname(__FILE__), 'data/minimum_data_setup.yaml.erb'))
+
+      # Stub out other debug messages to prevent expectation failing to match
+      Vcloud::Core.logger.stub(:debug).with(anything())
+
+      # Expectation must be set before first use of Vcloud::Core.logger
+      expect(Vcloud::Core.logger).to receive(:debug).with(/Ran.*with VAPP_DEFINITION/)
+
+      @api_interface = Vcloud::Core::ApiInterface.new
+
+      Vcloud::Launcher::Launch.new(@config_yaml, { "continue-on-error" => false, "dont-power-on" => true, "post-launch-cmd" => File.join(File.dirname(__FILE__), 'data/true_cmd') }).run
+
+      @vapp_query_result = @api_interface.get_vapp_by_name_and_vdc_name(@test_data[:vapp_name], @test_data[:vdc_name])
+      @vapp_id = @vapp_query_result[:href].split('/').last
+
+      unless ENV['VCLOUD_TOOLS_RSPEC_NO_DELETE_VAPP']
+        File.delete @config_yaml
+        expect(@api_interface.delete_vapp(@vapp_id)).to eq(true)
+      end
+    end
+  end
+
+  context "When running unsuccessful post-launch commands" do
+    it 'should give an appropriate error message' do
+      @test_data = define_test_data
+      @config_yaml = ErbHelper.convert_erb_template_to_yaml(@test_data, File.join(File.dirname(__FILE__), 'data/minimum_data_setup.yaml.erb'))
+
+      # Expectation must be set before first use of Vcloud::Core.logger
+      expect(Vcloud::Core.logger).to receive(:error).with(/Failed to run/)
+
+      @api_interface = Vcloud::Core::ApiInterface.new
+
+      Vcloud::Launcher::Launch.new(@config_yaml, { "continue-on-error" => false, "dont-power-on" => true, "post-launch-cmd" => File.join(File.dirname(__FILE__), 'data/false_cmd') }).run
+
+      @vapp_query_result = @api_interface.get_vapp_by_name_and_vdc_name(@test_data[:vapp_name], @test_data[:vdc_name])
+      @vapp_id = @vapp_query_result[:href].split('/').last
+
+      unless ENV['VCLOUD_TOOLS_RSPEC_NO_DELETE_VAPP']
+        File.delete @config_yaml
+        expect(@api_interface.delete_vapp(@vapp_id)).to eq(true)
+      end
+    end
+  end
+
   context "happy path" do
     before(:all) do
       @test_data = define_test_data

data/spec/vcloud/launcher/cli_spec.rb

@@ -51,6 +51,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => false,
           "continue-on-error" => false,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => false,
         }
       }
@@ -65,6 +66,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => true,
           "continue-on-error" => false,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => false,
         }
       }
@@ -79,6 +81,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => false,
           "continue-on-error" => true,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => false,
         }
       }
@@ -93,6 +96,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => false,
           "continue-on-error" => false,
           "quiet"             => true,
+          "post-launch-cmd"   => false,
           "verbose"           => false,
         }
       }
@@ -107,6 +111,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => false,
           "continue-on-error" => false,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => true,
         }
       }
@@ -121,6 +126,7 @@ describe Vcloud::Launcher::Cli do
           "dont-power-on"     => false,
           "continue-on-error" => true,
           "quiet"             => false,
+          "post-launch-cmd"   => false,
           "verbose"           => true,
         }
       }
@@ -128,6 +134,37 @@ describe Vcloud::Launcher::Cli do
       it_behaves_like "a good CLI command"
     end
 
+    context "when asked to run a command on launch" do
+      let(:args) { [ config_file, "--post-launch-cmd", "GIRAFFE" ] }
+      let(:cli_options) {
+        {
+          "dont-power-on"     => false,
+          "continue-on-error" => false,
+          "quiet"             => false,
+          "post-launch-cmd"   => 'GIRAFFE',
+          "verbose"           => false,
+        }
+      }
+
+      it_behaves_like "a good CLI command"
+    end
+
+    context "specifying a command with arguments to run on launch" do
+      let(:args) { [ config_file, "--post-launch-cmd", "GIRAFFE LION" ] }
+      let(:cli_options) {
+        {
+          "dont-power-on"     => false,
+          "continue-on-error" => false,
+          "quiet"             => false,
+          "post-launch-cmd"   => 'GIRAFFE LION',
+          "verbose"           => false,
+        }
+      }
+      it "exits with a error code, because this is not supported" do
+        expect(subject.exitstatus).not_to eq(0)
+      end
+    end
+
     context "when asked to display version" do
       let(:args) { %w{--version} }
 

data/vcloud-launcher.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 1.9.3'
 
-  s.add_runtime_dependency 'vcloud-core', '~> 0.11.0'
+  s.add_runtime_dependency 'vcloud-core', '~> 0.13.0'
   s.add_development_dependency 'gem_publisher', '1.2.0'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vcloud-launcher
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcloud-core
-  requirement: &5183540 !ruby/object:Gem::Requirement
+  requirement: &17683740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.13.0
   type: :runtime
   prerelease: false
-  version_requirements: *5183540
+  version_requirements: *17683740
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &5182780 !ruby/object:Gem::Requirement
+  requirement: &17682540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.2.0
   type: :development
   prerelease: false
-  version_requirements: *5182780
+  version_requirements: *17682540
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &5182260 !ruby/object:Gem::Requirement
+  requirement: &17681740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5182260
+  version_requirements: *17681740
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &5181560 !ruby/object:Gem::Requirement
+  requirement: &17680220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5181560
+  version_requirements: *17680220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &5180780 !ruby/object:Gem::Requirement
+  requirement: &17694840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 2.14.1
   type: :development
   prerelease: false
-  version_requirements: *5180780
+  version_requirements: *17694840
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: &5179260 !ruby/object:Gem::Requirement
+  requirement: &17693740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.23.0
   type: :development
   prerelease: false
-  version_requirements: *5179260
+  version_requirements: *17693740
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &5177520 !ruby/object:Gem::Requirement
+  requirement: &17692940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.1
   type: :development
   prerelease: false
-  version_requirements: *5177520
+  version_requirements: *17692940
 - !ruby/object:Gem::Dependency
   name: vcloud-tools-tester
-  requirement: &5192280 !ruby/object:Gem::Requirement
+  requirement: &17690820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 0.2.0
   type: :development
   prerelease: false
-  version_requirements: *5192280
+  version_requirements: *17690820
 description: 
 email:
 - anna.shipman@digital.cabinet-office.gov.uk
@@ -137,9 +137,11 @@ files:
 - spec/erb_helper.rb
 - spec/integration/README.md
 - spec/integration/launcher/data/basic_preamble_test.erb
+- spec/integration/launcher/data/false_cmd
 - spec/integration/launcher/data/happy_path.yaml.erb
 - spec/integration/launcher/data/minimum_data_setup.yaml.erb
 - spec/integration/launcher/data/storage_profile.yaml.erb
+- spec/integration/launcher/data/true_cmd
 - spec/integration/launcher/launch_spec.rb
 - spec/integration/launcher/storage_profile_integration_spec.rb
 - spec/integration/vcloud_tools_testing_config.yaml.template
@@ -171,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1721812803548595572
+      hash: 4391896427205100494
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -182,9 +184,11 @@ test_files:
 - spec/erb_helper.rb
 - spec/integration/README.md
 - spec/integration/launcher/data/basic_preamble_test.erb
+- spec/integration/launcher/data/false_cmd
 - spec/integration/launcher/data/happy_path.yaml.erb
 - spec/integration/launcher/data/minimum_data_setup.yaml.erb
 - spec/integration/launcher/data/storage_profile.yaml.erb
+- spec/integration/launcher/data/true_cmd
 - spec/integration/launcher/launch_spec.rb
 - spec/integration/launcher/storage_profile_integration_spec.rb
 - spec/integration/vcloud_tools_testing_config.yaml.template