bosh_cpi 1.2539.0 → 1.2546.0

data/lib/cloud.rb

@@ -7,6 +7,7 @@ require "forwardable"
 require "cloud/config"
 require "cloud/errors"
 require "cloud/provider"
+require "cloud/external_cpi"
 
 module Bosh
 

data/lib/cloud/external_cpi.rb

@@ -0,0 +1,140 @@
+require 'membrane'
+require 'open3'
+
+module Bosh::Clouds
+  class ExternalCpi
+    ##
+    # Raised when the external CPI executable returns an error unknown to director
+    #
+    class UnknownError < StandardError; end
+
+    ##
+    # Raised when the external CPI executable returns nil or invalid JSON format to director
+    class InvalidResponse < StandardError; end
+
+    ##
+    # Raised when the external CPI bin/cpi is not executable
+    class NonExecutable < StandardError; end
+
+    KNOWN_RPC_ERRORS = %w(
+      Bosh::Clouds::VMCreationFailed
+      Bosh::Clouds::DiskNotFound
+      Bosh::Clouds::DiskNotAttached
+      Bosh::Clouds::NoDiskSpace
+      Bosh::Clouds::CloudError
+      Bosh::Clouds::CpiError
+    ).freeze
+
+    KNOWN_RPC_METHODS = %w(
+      current_vm_id
+      create_stemcell
+      delete_stemcell
+      create_vm
+      delete_vm
+      has_vm?
+      reboot_vm
+      set_vm_metadata
+      configure_networks
+      create_disk
+      delete_disk
+      attach_disk
+      detach_disk
+      snapshot_disk
+      delete_snapshot
+      get_disks
+      ping
+    ).freeze
+
+    RESPONSE_SCHEMA = Membrane::SchemaParser.parse do
+      {
+        'result' => any,
+        'error' => enum(nil,
+          { 'type' => String,
+            'message' => String,
+            'ok_to_retry' => bool
+          }
+        )
+      }
+    end
+
+    def initialize(cpi_path, director_uuid)
+      @cpi_path = cpi_path
+      @director_uuid = director_uuid
+      @logger = Config.logger
+    end
+
+    KNOWN_RPC_METHODS.each do |method_name|
+      define_method method_name do |*arguments|
+        request = JSON.dump({
+          'method' => method_name.gsub(/\?$/,''),
+          'arguments' => arguments,
+          'context' => {
+            'director_uuid' => @director_uuid
+          }
+        })
+
+        env = {'PATH' => '/usr/sbin:/usr/bin:/sbin:/bin', 'TMPDIR' => ENV['TMPDIR']}
+        cpi_exec_path = checked_cpi_exec_path
+
+        @logger.debug("External CPI sending request: #{request} with command: #{cpi_exec_path}")
+        cpi_response, stderr, exit_status = Open3.capture3(env, cpi_exec_path, stdin_data: request)
+        @logger.debug("External CPI got response: #{cpi_response}, err: #{stderr}, exit_status: #{exit_status}")
+
+        parsed_response = parsed_response(cpi_response)
+        validate_response(parsed_response)
+
+        if parsed_response['error']
+          handle_error(parsed_response['error'])
+        end
+
+        parsed_response['result']
+      end
+    end
+
+    private
+
+    def checked_cpi_exec_path
+      unless File.executable?(@cpi_path)
+        raise NonExecutable, "Failed to run cpi: `#{@cpi_path}' is not executable"
+      end
+      @cpi_path
+    end
+
+    def handle_error(error_response)
+      error_type = error_response['type']
+      error_message = error_response['message']
+      unless KNOWN_RPC_ERRORS.include?(error_type)
+        raise UnknownError, "Received unknown error from cpi: #{error_type} with message #{error_message}"
+      end
+
+      error_class = constantize(error_type)
+
+      if error_class <= RetriableCloudError
+        error = error_class.new(error_response['ok_to_retry'])
+      else
+        error = error_class.new(error_message)
+      end
+
+      raise error, error_message
+    end
+
+    def parsed_response(input)
+      begin
+        JSON.load(input)
+      rescue JSON::ParserError => e
+        raise InvalidResponse, "Received invalid response from cpi with error #{e.message}"
+      end
+    end
+
+    def validate_response(response)
+      RESPONSE_SCHEMA.validate(response)
+    rescue Membrane::SchemaValidationError => e
+      raise InvalidResponse, "Received invalid response from cpi with error #{e.message}"
+    end
+
+    def constantize(camel_cased_word)
+      error_name = camel_cased_word.split('::').last
+      Bosh::Clouds.const_get(error_name)
+    end
+  end
+end

data/lib/cloud/provider.rb

@@ -1,6 +1,17 @@
 module Bosh::Clouds
   class Provider
+    def self.create(cloud_config, director_uuid)
+      if cloud_config.fetch('external_cpi',{}).fetch('enabled', false)
+        ExternalCpiProvider.create(cloud_config['external_cpi'], director_uuid)
+      else
+        PluginCloudProvider.create(cloud_config['plugin'], cloud_config['properties'])
+      end
+    end
+  end
 
+  private
+
+  class PluginCloudProvider
     def self.create(plugin, options)
       begin
         require "cloud/#{plugin}"
@@ -10,6 +21,11 @@ module Bosh::Clouds
 
       Bosh::Clouds.const_get(plugin.capitalize).new(options)
     end
+  end
 
+  class ExternalCpiProvider
+    def self.create(external_cpi_config, director_uuid)
+      ExternalCpi.new(external_cpi_config['cpi_path'], director_uuid)
+    end
   end
 end

data/lib/cloud/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Clouds
-    VERSION = '1.2539.0'
+    VERSION = '1.2546.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh_cpi
 version: !ruby/object:Gem::Version
-  version: 1.2539.0
+  version: 1.2546.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-10 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bosh_common
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2539.0
+        version: 1.2546.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,10 +26,10 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2539.0
+        version: 1.2546.0
 description: ! 'BOSH CPI
 
-  69090d'
+  e8aedb'
 email: support@cloudfoundry.com
 executables: []
 extensions: []
@@ -44,6 +44,7 @@ files:
 - lib/cloud.rb
 - lib/cloud/config.rb
 - lib/cloud/errors.rb
+- lib/cloud/external_cpi.rb
 - lib/cloud/provider.rb
 - lib/cloud/version.rb
 - README
@@ -68,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -52753533641108904
+      hash: -941851252333260636
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23