vcloud-box-spinner 0.2.0

data/lib/provisioner/compute_action/delete.rb

@@ -0,0 +1,29 @@
+module Provisioner
+  module ComputeAction
+    module Delete
+
+      def delete_vapp
+        super
+        vapp_href = compute.servers.service.vapps.detect {|v| v.name == options[:vm_name] }.href
+        vapp = compute.servers.service.get_vapp(vapp_href)
+        if vapp.on? or (vapp.off? and vapp.deployed)
+          logger.debug "The vApp is running, stopping it..."
+          vapp.service.undeploy vapp_href
+          logger.debug "Waiting for vApp to stop ..."
+          vapp.wait_for { vapp.off? }
+        end
+        vapp.wait_for { vapp.off? } #double check
+
+        # This is added as vapp after being off, might still
+        # be in a state which isn't ready. This would check
+        # status of each vm associated with vapp
+        vapp.servers.entries.each { |server| server.wait_for { server.ready? } }
+
+        logger.debug "The vApp is not running now ..."
+        logger.debug "Deleting the vApp"
+        vapp.service.delete_vapp vapp_href
+      end
+
+    end
+  end
+end

data/lib/provisioner/compute_node.rb

@@ -0,0 +1,14 @@
+require 'cgi'
+require 'builder'
+require 'fog/vcloud/compute/shared' # our hack
+require 'fog/vcloud/compute/server_ready' # another hack
+require 'nokogiri'
+require 'provisioner/compute_action/create'
+require 'provisioner/compute_action/delete'
+
+module Provisioner
+  module ComputeNode
+    include ComputeAction::Create
+    include ComputeAction::Delete
+  end
+end

data/lib/provisioner/errors.rb

@@ -0,0 +1,6 @@
+module Provisioner
+  # TODO: this should be some GDS error class
+  class ProvisionerError < RuntimeError; end
+  class ConfigurationError < ProvisionerError; end
+  class NoSuchRole < ProvisionerError; end
+end

data/lib/provisioner/provisioner.rb

@@ -0,0 +1,134 @@
+module Provisioner
+  class Provisioner
+    AVAILABLE_ACTIONS = ['create', 'delete']
+
+    attr_accessor :options
+    private :options=, :options
+
+    def initialize options
+      options[:provider] = 'vcloud'
+      options[:created_by] = ENV['USER']
+      self.options = options
+    end
+
+    def execute(action)
+      unless AVAILABLE_ACTIONS.include?(action)
+        raise(ConfigurationError, "The action '#{action}' is not a valid action")
+      end
+      send(action)
+    end
+
+    def create
+      logger.debug "Validating options"
+      validate_options
+      logger.debug "Preparing the run"
+      prepare_run
+      logger.debug "Launching servers"
+      launch_servers
+      logger.debug "Done"
+    end
+    private :create
+
+    def delete
+      logger.debug "Validating options"
+      validate_options
+      if ask("Do you really want to delete '#{options[:vm_name]}'? (yes/no) ") == "yes"
+        logger.debug "Proceeding delete operation"
+        delete_vapp
+      else
+        logger.debug "Abandoning delete operation"
+      end
+    end
+    private :delete
+
+    def compute
+      @compute ||= Fog::Compute.new(
+        :provider           => options[:provider],
+        :vcloud_username    => "#{options[:user]}@#{options[:organisation]}",
+        :vcloud_password    => options[:password],
+        :vcloud_host        => options[:host],
+        :vcloud_default_vdc => options[:default_vdc],
+        :connection_options => {
+          :ssl_verify_peer   => false,
+          :omit_default_port => true
+        }
+      )
+    end
+    private :compute
+
+    def logger
+      options[:logger]
+    end
+    private :logger
+
+    def ssh
+      @ssh ||= begin
+        Provisioner.ssh_client.tap { |client|
+          logger.debug "Using #{client} as my SSH client"
+        }
+      end
+    end
+
+    def ssh_to hostname, &blk
+      puts "Sshing to #{hostname}"
+      ssh.start hostname,
+                options[:ssh_user],
+                :config => options[:ssh_config],
+                &blk
+    end
+
+    def validate_options
+      unless options[:password] && options[:user] && options[:host]
+        logger.error "VCloud credentials missing"
+        raise ConfigurationError, "VCloud credentials must be specified"
+      end
+    end
+    private :validate_options
+
+    def timestamp
+      @timestamp ||= Time.now.utc.to_i.to_s(36).tap { |ts|
+        logger.debug "The base 36 timestamp for this run in #{ts}"
+      }
+    end
+    private :timestamp
+
+    def launch_server name
+    end
+    private :launch_server
+
+    def notify message, name
+      logger.info "<%s> %s" % [ name, message ]
+    end
+    private :notify
+
+    def launch_servers
+      Parallel.each(options[:num_servers].times, :in_threads => options[:num_servers]) do |number|
+        name = server_name number
+        server = launch_server name
+        bootstrap_server server, name
+      end
+    end
+    private :launch_servers
+
+    def server_name number
+      [
+        options[:platform],
+        timestamp,
+        ("%02d" % (number + 1))
+      ].compact.join('-')
+    end
+    private :server_name
+
+    def prepare_run
+    end
+    private :prepare_run
+
+    def bootstrap_server server, name
+    end
+    private :bootstrap_server
+
+    def delete_vapp
+    end
+    private
+  end
+end

data/lib/provisioner/version.rb

@@ -0,0 +1,3 @@
+module Provisioner
+  VERSION = '0.2.0'
+end

data/lib/vcloud_box_provisioner.rb

@@ -0,0 +1,31 @@
+require 'provisioner/errors'
+require 'provisioner/provisioner'
+require 'provisioner/compute_node'
+require 'provisioner/blank_provisioner'
+require 'provisioner/cli'
+require 'provisioner/version'
+require 'socket'
+require 'logger'
+require 'net/ssh'
+require 'net/scp'
+require 'erb'
+require 'parallel'
+require 'fog'
+
+module VcloudBoxProvisioner
+  def self.build options = {}
+    options[:logger] ||= default_logger options
+    options[:logger].debug "Building provisioner for #{options.inspect}"
+    Provisioner::BlankProvisioner.new options
+  end
+
+  class << self
+    attr_accessor :ssh_client
+  end
+  self.ssh_client = Net::SSH
+
+  def self.default_logger options
+    Logger.new(STDOUT).tap { |l| l.level = options[:log_level] || Logger::ERROR }
+  end
+
+end

data/spec/fog/vcloud/compute/shared_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'fog/vcloud/compute/shared'
+require 'nokogiri'
+require 'equivalent-xml'
+
+describe Fog::Vcloud::Compute::Shared do
+  let (:fog_vcloud_test_class) do
+    Class.new do
+      include Fog::Vcloud::Compute::Shared
+
+      def xmlns
+        {}
+      end
+    end
+  end
+
+  it 'should generate InstantiateVAppTemplateParams' do
+    subject = fog_vcloud_test_class.new
+    fog_xml = subject.send(:generate_instantiate_vapp_template_request, {:name => 'foo',
+                                                         :description => 'bar',
+                                                         :template_uri => 'baz'
+                           })
+    parsed = Nokogiri::XML(fog_xml)
+
+    xml = ::Builder::XmlMarkup.new
+    expected = xml.InstantiateVAppTemplateParams({:name => 'foo', :'xml:lang' => 'en'}) {
+      xml.Description('bar')
+      xml.InstantiationParams { }
+      xml.Source(:href => 'baz')
+      xml.AllEULAsAccepted("true")
+    }
+    parsed.should be_equivalent_to Nokogiri::XML(expected)
+  end
+
+  it 'should handle network_uri correctly' do
+    subject = fog_vcloud_test_class.new
+    fog_xml = subject.send(:generate_instantiate_vapp_template_request,
+                           {:name => 'foo',
+                             :description => 'bar',
+                             :template_uri => 'baz',
+                             :network_name => 'jimmy',
+                             :network_uri => 'http://jimmy.invalid'
+                           })
+
+    xml = ::Builder::XmlMarkup.new
+    expected = xml.InstantiateVAppTemplateParams({:name => 'foo', :'xml:lang' => 'en'}) {
+      xml.Description('bar')
+      xml.InstantiationParams {
+        xml.NetworkConfigSection {
+          xml.ovf :Info
+          xml.NetworkConfig(:networkName => 'jimmy') {
+            xml.Configuration {
+              xml.ParentNetwork(:href => 'http://jimmy.invalid')
+              xml.FenceMode 'bridged'
+            }
+          }
+        }
+      }
+      xml.Source(:href => 'baz')
+      xml.AllEULAsAccepted("true")
+    }
+    Nokogiri::XML(fog_xml).should be_equivalent_to Nokogiri::XML(expected)
+  end
+end

data/spec/provisioner/cli_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+require 'provisioner/cli'
+
+MACHINE_METADATA = {
+  :puppetmaster => 'foo.bar.baz',
+  :zone         => 'foo',
+  :catalog_id   => 'default_catalog_id',
+}.freeze
+
+DEFAULTS = {
+  :debug       => false,
+  :log_level   => 5,
+  :memory      => 4096,
+  :num_cores   => 2,
+  :num_servers => 1,
+  :platform    => "production",
+  :ssh_config  => true,         # if not specified, use system defaults
+}
+
+describe Provisioner::CLI do
+  describe "#defaults" do
+    Provisioner::CLI.defaults.should ==  DEFAULTS
+  end
+
+  describe "#process" do
+    it 'should set options from built-in defaults' do
+      options = { :machine_metadata => MACHINE_METADATA,
+                  :org_config => {} }
+      res = Provisioner::CLI.process(options)
+      res.should include(DEFAULTS)
+    end
+
+    it 'should set options from the vCloud config defaults' do
+      config = { :default => { :ip => '5.6.7.8' } }
+      res = Provisioner::CLI.process({:machine_metadata => MACHINE_METADATA,
+                                      :org_config => config})
+      res.should include(:ip => '5.6.7.8')
+    end
+
+    it 'should set options from the vCloud config based on the specified zone' do
+      config = { :foo => { :ip => '9.8.7.6' } }
+      res = Provisioner::CLI.process({:org_config => config,
+                                      :machine_metadata => MACHINE_METADATA})
+      res.should include(:ip => '9.8.7.6')
+    end
+
+    it 'should set options from the machine template' do
+      options = { :machine_metadata => MACHINE_METADATA.dup.merge( :ip => '1.2.3.4' ),
+                  :org_config => {} }
+      res = Provisioner::CLI.process(options)
+      res.should include(:ip => '1.2.3.4')
+    end
+
+    it 'should set options from the command line' do
+      opts = {:ssh_user => 'donald',
+              :org_config => {},
+              :machine_metadata => MACHINE_METADATA }
+      res = Provisioner::CLI.process(opts)
+      res.should include(:ssh_user => 'donald')
+    end
+
+    it 'should override vCloud config defaults with vCloud zone defaults' do
+      config = {
+        :default => { :ip => '1.2.3.4' },
+        :foo => { :ip => '5.6.7.8' }
+      }
+      res = Provisioner::CLI.process({:org_config => config,
+                                      :machine_metadata => MACHINE_METADATA})
+      res.should include(:ip => '5.6.7.8')
+    end
+
+    it 'should override vCloud zone defaults with machine template options' do
+      options = { :org_config => { :foo => { :ip => '1.2.3.4' } },
+                  :machine_metadata => MACHINE_METADATA.dup.merge(:ip => '5.6.7.8')}
+      res = Provisioner::CLI.process(options)
+      res.should include(:ip => '5.6.7.8')
+    end
+
+    it 'should override machine template options with command line options' do
+      options = { :machine_metadata => MACHINE_METADATA.dup.
+                      merge(:ssh_user => 'aaron'),
+                  :org_config => {},
+                  :ssh_user => 'binky' }
+      res = Provisioner::CLI.process(options)
+      res.should include(:ssh_user => 'binky')
+    end
+
+    it 'should use catalog_id if present' do
+      options = { :machine_metadata => MACHINE_METADATA.dup.merge!(
+                      :catalog_id => 'wibble',
+                      :catalog_items => { :my_cool_template => 'incorrect' },
+                      :template_name => 'my_cool_template'
+                    ),
+                  :org_config => {}}
+      res = Provisioner::CLI.process(options)
+      res.should include(:catalog_id => 'wibble')
+    end
+
+    it 'should use template_name to determine catalog_id if catalog_id not present' do
+      tpl = MACHINE_METADATA.dup
+      tpl.delete(:catalog_id)
+      tpl.merge!(
+        :catalog_items => { :my_cool_template => 'https://correct_catalog_id' },
+        :template_name => 'my_cool_template'
+      )
+      res = Provisioner::CLI.process({:machine_metadata => tpl,
+                                      :org_config => {}})
+      res.should include(:catalog_id => 'https://correct_catalog_id')
+    end
+
+    it 'should require a zone to be set' do
+      tpl = MACHINE_METADATA.dup
+      tpl.delete(:zone)
+      expect do
+        Provisioner::CLI.process({:machine_metadata => tpl})
+      end.to raise_error(Provisioner::ConfigurationError, /zone/)
+    end
+
+  end
+
+  describe "#execute" do
+    before :each do silence_output end
+    after :each do silence_output end
+
+    it "should fail if two arguments not provided" do
+      expect {
+        Provisioner::CLI.new(['-u' , 'user', '-p', 'pass']).execute
+      }.to raise_error(SystemExit)
+    end
+
+    it "should call provision a machine" do
+      default_org_config =
+        { :template_name => "template-name",
+          :host=>"api-end-host",
+          :platform=>"qa",
+          :organisation=>"org-name",
+          :catalog_items => {
+            :"template-name" => "https://vendor-api-endpoint/catalogItem/100"
+          }}
+        zone_org_config =
+          { :default_vdc=>"https://vendor-api-endpoint/api/vdc/07412",
+            :domain => "tester.default",
+            :network_name => "Default",
+            :network_uri => "https://vendor-api-endpoint/api/network/0352",
+            :vdc_id=>"07412" }
+        machine_metadata = { :zone => "tester",
+                             :vm_name => "machine-2",
+                             :ip => "192.168.2.2" }
+        expected_opts = DEFAULTS.merge(default_org_config).
+          merge(zone_org_config).
+          merge(machine_metadata).
+          merge({ :user => 'badger',
+                  :password => 'eggplant',
+                  :catalog_id => "https://vendor-api-endpoint/catalogItem/100"
+        })
+
+      VcloudBoxProvisioner.should_receive(:build).
+        with(expected_opts).
+        and_return(mock(:execute => true))
+
+      cli = Provisioner::CLI.new(['-u', 'badger', '-p', 'eggplant',
+                                  '-o', 'spec/test_data/org.json',
+                                  '-m', 'spec/test_data/machine.json',
+                                  'create'
+                                ])
+      cli.execute
+    end
+  end
+
+end

data/spec/provisioner/compute_node_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require 'provisioner/compute_node'
+
+module Provisioner
+  class DummyClass
+    include ComputeNode
+  end
+end
+
+describe 'Provisoner::ComputeNode' do
+
+  it "should undeploy the vApp is running while delete action" do
+    pending "mock not supported in fog"
+  end
+
+  it "should not undeploy the vApp is stopped while delete action" do
+    pending "mock not supported in fog"
+  end
+end

data/spec/provisioner/provisioner_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'provisioner/errors'
+require 'provisioner/provisioner'
+
+shared_examples "validate credentials" do |action|
+  it "should error if credentials not provided while perfoming #{action}" do
+    logger = mock(:debug => true, :error => true)
+    expect {
+      Provisioner::Provisioner.new({:logger => logger}).execute(action)
+    }.to raise_error(Provisioner::ConfigurationError,
+                     'VCloud credentials must be specified')
+  end
+end
+
+describe 'Provisioner::Provisioner' do
+
+  it_should_behave_like "validate credentials", 'create'
+  it_should_behave_like "validate credentials", 'delete'
+
+  it "should error out if action passed isn't present" do
+    logger = mock(:debug => true, :error => true)
+    expect {
+      Provisioner::Provisioner.new({:logger => logger}).execute('disco')
+    }.to raise_error(Provisioner::ConfigurationError,
+                     'The action \'disco\' is not a valid action')
+  end
+
+  describe "delete" do
+    it "delete vApp only if you confirm to delete vApp" do
+      pending "mock not supported in fog"
+    end
+    it "don't delete vApp only if you don't confirm to delete vApp" do
+      pending "mock not supported in fog"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+specdir=File.dirname(__FILE__)
+$:.unshift File.join(specdir, '../lib')
+$:.unshift File.join(specdir, '..')
+
+require 'rspec'
+
+# Redirects stderr and stdout to /dev/null.
+def silence_output
+  @orig_stderr = $stderr
+  @orig_stdout = $stdout
+
+  # redirect stderr and stdout to /dev/null
+  $stderr = File.new('/dev/null', 'w')
+  $stdout = File.new('/dev/null', 'w')
+end
+
+# Replace stdout and stderr so anything else is output correctly.
+def enable_output
+  $stderr = @orig_stderr
+  $stdout = @orig_stdout
+  @orig_stderr = nil
+  @orig_stdout = nil
+end

data/spec/test_data/machine.json

@@ -0,0 +1,5 @@
+{
+  "zone":             "tester",
+  "vm_name":          "machine-2",
+  "ip":               "192.168.2.2"
+}

data/spec/test_data/org.json

@@ -0,0 +1,18 @@
+{
+  "default": {
+    "template_name": "template-name",
+    "host": "api-end-host",
+    "platform": "qa",
+    "organisation": "org-name",
+    "catalog_items": {
+      "template-name": "https://vendor-api-endpoint/catalogItem/100"
+    }
+  },
+  "tester": {
+    "default_vdc": "https://vendor-api-endpoint/api/vdc/07412",
+    "domain": "tester.default",
+    "network_name": "Default",
+    "network_uri": "https://vendor-api-endpoint/api/network/0352",
+    "vdc_id": "07412"
+  }
+}

data/vcloud-box-spinner.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "provisioner/version"
+
+Gem::Specification.new do |s|
+  s.name        = "vcloud-box-spinner"
+  s.version     = Provisioner::VERSION
+  s.authors     = ["Garima Singh"]
+  s.email       = ["igarimasingh@gmail.com"]
+  s.homepage    = "https://github.com/com/vcloud-box-spinner"
+  s.summary     = %q{Provision servers, with vcloud API}
+  s.description = %q{Create new VM and apply an opinionated set of commands to
+them, using vcloud API. The vcloud-box-spinner is a thin wrapper around fog,
+which enables you to be able to configure VMs with static IPs}
+
+  s.rubyforge_project = "vcloud-box-spinner"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "rspec", "~> 2.11.0"
+  s.add_development_dependency "equivalent-xml", "~> 0.2.9"
+  s.add_development_dependency "gem_publisher", "~> 1.3.0"
+  s.add_runtime_dependency "fog", "~> 1.0"
+  s.add_runtime_dependency "parallel"
+  s.add_runtime_dependency "highline"
+  s.add_runtime_dependency "nokogiri", "~> 1.5.0"
+end