vcloud-launcher 0.1.0 → 0.2.0

data/.gitignore

@@ -6,6 +6,7 @@
 /.ruby-version
 /Gemfile.lock
 /bundle/
+/coverage/
 /pkg/
 fog_integration_test.config
 .idea

data/.travis.yml

@@ -2,5 +2,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
+  - 2.1.2
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.2.0 (2014-07-14)
+
+Features:
+
+  - `vcloud-configure-edge --version` now only returns the version string
+      and no usage information.
+
+API changes:
+
+  - New `Vcloud::Launcher::Preamble` class for generating preambles, containing
+    logic moved from vCloud Core. Thanks to @bazbremner for this contribution.
+  - The minimum required Ruby version is now 1.9.3.
+
 ## 0.1.0 (2014-06-02)
 
 Features:

data/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to vCloud Launcher
+
+We really welcome contributions.
+
+## A quick guide on how to contribute
+
+1. Clone the repo:
+
+        git clone git@github.com:gds-operations/vcloud-launcher.git
+
+2. Run `bundle` to get the required dependecies
+
+3. Run the tests. Pull requests that add features must include unit tests,
+   so it is good to ensure you've got them passing to begin with.
+
+        bundle exec rake
+
+   If you have access to a live environment for testing, it would be great
+   if you could run the integration tests too - for more details on the
+   set-up for that, please see the [integration tests README]
+   (https://github.com/gds-operations/vcloud-launcher/blob/master/spec/integration/README.md)
+
+4. Add your functionality or bug fix and a test for your change. Only refactoring and
+   documentation changes do not require tests. If the functionality is at all complicated
+   then it is likely that more than one test will be required. If you would like help
+   with writing tests please do ask us.
+
+5. Make sure all the tests pass, including the integration tests if possible.
+
+6. Update the [CHANGELOG](https://github.com/gds-operations/vcloud-launcher/blob/master/CHANGELOG.md)
+   with a short description of what the change is. This may be a feature, a bugfix, or an
+   API change. If your change is documenation or refactoring, you do not need to add a line
+   to the CHANGELOG.
+
+7. Fork the repo, push to your fork, and submit a pull request.
+
+## How soon will we respond?
+
+We will comment on your pull request within two working days. However, we might not be able to review it immediately.
+
+We may come back to you with comments and suggestions, and if we would like you to make changes, we will close the pull request as well as adding details of the changes we'd like you to make.
+
+If you feel your pull request has been outstanding too long, please feel free to bump it by making a comment on it.
+
+## Guidelines for making a pull request
+
+    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
+    "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be
+    interpreted as described in RFC 2119.
+
+## In order for a pull request to be accepted, it MUST
+
+- Include at least one test (unless it is documentation or refactoring). If you have any questions about how to write tests, please ask us, we will be happy to help
+- Follow our [Git style guide](https://github.com/alphagov/styleguides/blob/master/git.md)
+- Include a clear summary in the pull request comments as to what the change is and why
+  you are making it
+- Be readable - we might ask you to change unclear variable names or obscure syntactic sugar
+- Have [good commit messages](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message)
+  that explain the change being made in that commit. Don't be afraid to write a lot in the
+  detail.
+
+## In order for a pull request to be accepted, it SHOULD
+
+- Include a line in the CHANGELOG unless it is a refactoring or documentation change
+- If it is code, follow our [Ruby style guide](https://github.com/alphagov/styleguides/blob/master/ruby.md)
+- If it is documentation, follow the [GDS content style guide](https://www.gov.uk/design-principles/style-guide/style-points)

data/Gemfile

@@ -1,9 +1,9 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 
 if ENV['VCLOUD_CORE_DEV_MASTER']
-  gem 'vcloud-core', :git => 'git@github.com:alphagov/vcloud-core.git', :branch => 'master'
+  gem 'vcloud-core', :git => 'git@github.com:gds-operations/vcloud-core.git', :branch => 'master'
 elsif ENV['VCLOUD_CORE_DEV_LOCAL']
   gem 'vcloud-core', :path => '../vcloud-core'
 end

data/Rakefile

@@ -1,23 +1,17 @@
-require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'gem_publisher'
 
-task :default => [:rubocop, :spec, :features]
+task :default => [:rubocop, :spec]
 task :integration => ['integration:all']
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   # Set a bogus Fog credential, otherwise it's possible for the unit
-  # tests to accidentially run (and succeed against!) an actual 
+  # tests to accidentially run (and succeed against!) an actual
   # environment, if Fog connection is not stubbed correctly.
   ENV['FOG_CREDENTIAL'] = 'random_nonsense_owiejfoweijf'
   task.pattern = FileList['spec/vcloud/**/*_spec.rb']
 end
 
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "--format pretty --no-source"
-  t.fork = false
-end
-
 RSpec::Core::RakeTask.new('integration:quick') do |t|
   t.rspec_opts = %w(--tag ~take_too_long)
   t.pattern = FileList['spec/integration/**/*_spec.rb']
@@ -33,6 +27,6 @@ task :publish_gem do
 end
 
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop) do |task|
+RuboCop::RakeTask.new(:rubocop) do |task|
   task.options = ['--lint']
 end

data/bin/vcloud-launch

@@ -1,48 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
-require 'bundler/setup'
-require 'optparse'
-require 'methadone'
-
 require 'vcloud/launcher'
 
-class App
-  include Methadone::Main
-  include Methadone::CLILogging
-
-  main do |org_config_file|
-    Vcloud::Launcher::Launch.new.run(org_config_file, options)
-  end
-
-  on("-x", "--dont-power-on", "Do not power on vApps (default is to power on)")
-  on("-c", "--continue-on-error", "Continue on error ( default is false) ")
-  on("-q", "--quiet",   "Quiet output - only report errors")
-  on("-v", "--verbose", "Verbose output")
-
-  arg :org_config_file
-
-  examples_dir = File.absolute_path(
-    File.join(
-      File.dirname(__FILE__),
-      "..",
-      "examples",
-      File.basename(__FILE__),
-  ))
-
-  description "
-  vcloud-launch takes a configuration describing a vCloud Org,
-  and tries to make it a reality.
-
-  See https://github.com/alphagov/vcloud-tools for more info
-
-  Example configuration files can be found in:
-    #{examples_dir}
-  "
-
-  version Vcloud::Launcher::VERSION
-
-  #use_log_level_option
-
-  go!
-end
+Vcloud::Launcher::Cli.new(ARGV).run

data/lib/vcloud/launcher.rb

@@ -1,11 +1,13 @@
 require 'vcloud/fog'
 require 'vcloud/core'
 
+require 'vcloud/launcher/cli'
 require 'vcloud/launcher/schema/vm'
 require 'vcloud/launcher/schema/vapp'
 require 'vcloud/launcher/schema/launcher_vapps'
 
 require 'vcloud/launcher/launch'
+require 'vcloud/launcher/preamble'
 require 'vcloud/launcher/vm_orchestrator'
 require 'vcloud/launcher/vapp_orchestrator'
 

data/lib/vcloud/launcher/cli.rb

@@ -0,0 +1,103 @@
+require 'optparse'
+
+module Vcloud
+  module Launcher
+    class Cli
+
+      def initialize(argv_array)
+        @config_file = nil
+        @usage_text = nil
+        @options = {
+          "dont-power-on"     => false,
+          "continue-on-error" => false,
+          "quiet"             => false,
+          "verbose"           => false,
+        }
+
+        parse(argv_array)
+      end
+
+      def run
+        begin
+          Vcloud::Launcher::Launch.new.run(@config_file, @options)
+        rescue => error_msg
+          $stderr.puts(error_msg)
+          exit 1
+        end
+      end
+
+      private
+
+      def parse(args)
+        opt_parser = OptionParser.new do |opts|
+          examples_dir = File.absolute_path(
+            File.join(
+              File.dirname(__FILE__),
+              "..",
+              "..",
+              "..",
+              "examples",
+              File.basename($0),
+            ))
+
+          opts.banner = <<-EOS
+Usage: #{$0} [options] config_file
+
+vcloud-launch takes a configuration describing a vCloud Org,
+and tries to make it a reality.
+
+See https://github.com/gds-operations/vcloud-tools for more info
+
+Example configuration files can be found in:
+          #{examples_dir}
+          EOS
+
+          opts.separator ""
+          opts.separator "Options:"
+
+          opts.on("-x", "--dont-power-on", "Do not power on vApps (default is to power on)") do
+            @options["dont-power-on"] = true
+          end
+
+          opts.on("-c", "--continue-on-error", "Continue on error (default is false)") do
+            @options["continue-on-error"] = true
+          end
+
+          opts.on("-q", "--quiet", "Quiet output - only report errors") do
+            @options["quiet"] = true
+          end
+
+          opts.on("-v", "--verbose", "Verbose output") do
+            @options["verbose"] = true
+          end
+
+          opts.on("-h", "--help", "Print usage and exit") do
+            $stderr.puts opts
+            exit
+          end
+
+          opts.on("--version", "Display version and exit") do
+            puts Vcloud::Launcher::VERSION
+            exit
+          end
+        end
+
+        @usage_text = opt_parser.to_s
+        begin
+          opt_parser.parse!(args)
+        rescue OptionParser::InvalidOption => e
+          exit_error_usage(e)
+        end
+
+        exit_error_usage("must supply config_file") unless args.size == 1
+        @config_file = args.first
+      end
+
+      def exit_error_usage(error)
+        $stderr.puts "#{$0}: #{error}"
+        $stderr.puts @usage_text
+        exit 2
+      end
+    end
+  end
+end

data/lib/vcloud/launcher/launch.rb

@@ -2,13 +2,21 @@ module Vcloud
   module Launcher
     class Launch
 
+      class MissingPreambleError < RuntimeError ; end
+      class MissingConfigurationError < RuntimeError ; end
+
+      attr_reader :config
+
       def initialize
         @config_loader = Vcloud::Core::ConfigLoader.new
       end
 
       def run(config_file = nil, cli_options = {})
         set_logging_level(cli_options)
-        config = @config_loader.load_config(config_file, Vcloud::Launcher::Schema::LAUNCHER_VAPPS)
+        @config = @config_loader.load_config(config_file, Vcloud::Launcher::Schema::LAUNCHER_VAPPS)
+
+        validate_config
+
         config[:vapps].each do |vapp_config|
           Vcloud::Core.logger.info("Provisioning vApp #{vapp_config[:name]}.")
           begin
@@ -34,6 +42,33 @@ module Vcloud
         end
       end
 
+      private
+
+      def validate_config
+        @config[:vapps].each do |vapp_config|
+          validate_vapp_config(vapp_config)
+        end
+      end
+
+      def validate_vapp_config(vapp_config)
+        bootstrap_config = vapp_config.fetch(:bootstrap, nil)
+
+        return unless bootstrap_config
+
+        if ! bootstrap_config[:script_path]
+          raise MissingConfigurationError, "Preamble script (script_path) not specified"
+        end
+
+        if bootstrap_config[:script_path] && ! File.exist?( bootstrap_config[:script_path])
+          raise MissingPreambleError, "Unable to find specified preamble script (#{bootstrap_config[:script_path]})"
+        end
+
+        template_vars = bootstrap_config.fetch(:vars, {})
+
+        if bootstrap_config[:script_path] && template_vars.empty?
+          Vcloud::Core.logger.info("Preamble file/template specified without variables to template.")
+        end
+      end
     end
   end
 end

data/lib/vcloud/launcher/preamble.rb

@@ -0,0 +1,60 @@
+module Vcloud
+  module Launcher
+    class Preamble
+      class MissingConfigurationError < StandardError ; end
+      class MissingTemplateError < StandardError ; end
+
+      attr_reader :preamble_vars, :script_path
+
+      def initialize(vapp_name, vm_config)
+        @vapp_name        = vapp_name
+        bootstrap_config  = vm_config[:bootstrap]
+
+        raise MissingConfigurationError if bootstrap_config.nil?
+
+        @script_path = bootstrap_config.fetch(:script_path, nil)
+        raise MissingTemplateError unless @script_path
+
+        # Missing vars is acceptable - noop template.
+        @preamble_vars = bootstrap_config.fetch(:vars, {})
+        extra_disks    = vm_config.fetch(:extra_disks, {})
+
+        @preamble_vars.merge!(extra_disks: extra_disks)
+
+        @script_post_processor = bootstrap_config.fetch(:script_post_processor, nil)
+      end
+
+      def generate
+        @script_post_processor ? post_process_erb_output : interpolated_preamble
+      end
+
+      def interpolated_preamble
+        @interpolated_preamble = interpolate_erb_file
+      end
+
+      private
+
+      def interpolate_erb_file
+        erb_vars = OpenStruct.new({
+          vapp_name: @vapp_name,
+          vars:      @preamble_vars,
+        })
+        binding_object  = erb_vars.instance_eval { binding }
+        template_string = load_erb_file
+
+        ERB.new(template_string, nil, '>-').result(binding_object)
+      end
+
+      def load_erb_file
+        File.read(File.expand_path(@script_path))
+      end
+
+      def post_process_erb_output
+        # Open3.capture2, as we just need to return STDOUT of the post_processor_script
+        Open3.capture2(
+          File.expand_path(@script_post_processor),
+          stdin_data: interpolated_preamble).first
+      end
+    end
+  end
+end

data/lib/vcloud/launcher/version.rb

@@ -1,5 +1,5 @@
 module Vcloud
   module Launcher
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/vcloud/launcher/vm_orchestrator.rb

@@ -17,13 +17,18 @@ module Vcloud
         end
         @vm.add_extra_disks(vm_config[:extra_disks])
         @vm.update_metadata(vm_config[:metadata])
-        @vm.configure_guest_customization_section(
-            @vm.vapp_name,
-            vm_config[:bootstrap],
-            vm_config[:extra_disks]
-        )
+
+        preamble = vm_config[:bootstrap] ? generate_preamble(vm_config) : ''
+
+        @vm.configure_guest_customization_section(preamble)
       end
 
+      private
+
+      def generate_preamble(vm_config)
+        preamble = ::Vcloud::Launcher::Preamble.new(@vm.vapp_name, vm_config)
+        preamble.generate
+      end
     end
   end
 end