bosh_cpi 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77f9ed40e596e15952e7c43452f19682c0e1ea83
-  data.tar.gz: 9939c9c1db5797ee1311541d2e8d34ab63dc6d14
+  metadata.gz: 709fb1fb7802d5480f997bf7d63c42b61aef2733
+  data.tar.gz: fe72f9fbfb9d259a9d8b1a8624065f233d21f70f
 SHA512:
-  metadata.gz: c889201fd88c6abbbb1cb77b4fc123dc1f49398dff060907f5ed1e9d9c79e6999fd2f94aebeb0a644fcfaeb9cebc094d67557791ded96b03ef358a05f5b4f086
-  data.tar.gz: 98d595503bd95bb1e477bd7ba47529f675e34d7d574e152276ba9c9147595c629cef76567819a763b0abe7659a5b873da0a6dd3706d5c3d89569eb40e9f43318
+  metadata.gz: 103658fa73d06670a6167225b12a2905d6680f73b45aef8d93f763c597296143156b19746a311ae5970ddb9ef6ad50a42144d407a6f5dae95ac8f0b00998f4b0
+  data.tar.gz: 98e3ccf062d0ce32c07664f34be7ee38525e897096da0241d3cd63468a943a3d6aede383cb584a9bb3f06709ad900e192c9fb33af89776717e24500b4587fa10

data/lib/bosh/cpi.rb

@@ -3,4 +3,5 @@ module Bosh
 end
 
 require 'bosh/cpi/cli'
+require 'bosh/cpi/logger'
 require 'bosh/cpi/registry_client'

data/lib/bosh/cpi/cli.rb

@@ -34,6 +34,7 @@ class Bosh::Cpi::Cli
     @cpi = cpi
     @logs_string_io = logs_string_io
     @result_io = result_io
+    @logger = Bosh::Cpi::Logger.new(STDERR)
   end
 
   def run(json)
@@ -62,12 +63,19 @@ class Bosh::Cpi::Cli
       return error_response(INVALID_CALL_ERROR_TYPE, "Request should include context with director uuid, got: '#{context.inspect}'", false)
     end
 
+    req_id = context['request_id']
+    @logger.set_request_id(req_id)
+
     configure_director(context['director_uuid'])
 
     ruby_method = RPC_METHOD_TO_RUBY_METHOD[method] || method
 
     begin
+      start_time = Time.now.utc
+      @logger.info("Starting #{method}...")
+
       cpi = @cpi.call(context)
+
       result = cpi.public_send(ruby_method, *arguments)
     rescue Bosh::Clouds::RetriableCloudError => e
       return error_response(error_name(e), e.message, e.ok_to_retry, e.backtrace)
@@ -77,6 +85,9 @@ class Bosh::Cpi::Cli
       return error_response(INVALID_CALL_ERROR_TYPE, "Arguments are not correct, details: '#{e.message}'", false, e.backtrace)
     rescue Exception => e
       return error_response(UNKNOWN_ERROR_TYPE, e.message, false, e.backtrace)
+    ensure
+      end_time = Time.now.utc
+      @logger.info("Finished #{method} in #{(end_time - start_time).round(2)} seconds")
     end
 
     result_response(result)

data/lib/bosh/cpi/logger.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+class Bosh::Cpi::Logger < Logger
+
+  def initialize(log_device)
+    super(log_device)
+  end
+
+  def set_request_id(req_id)
+    original_formatter = Logger::Formatter.new
+    self.formatter = proc { |severity, datetime, progname, msg|
+      original_formatter.call(severity, datetime, "[req_id #{req_id}]#{progname}", msg)
+    }
+  end
+end

data/lib/cloud.rb

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

data/lib/cloud/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Clouds
-    VERSION = '2.0.1'
+    VERSION = '0.0.0'
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: bosh_cpi
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - VMware
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bosh_common
+  name: membrane
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3262.24.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3262.24.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: membrane
+  name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
-  name: logging
+  name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 2.7.1
 description: BOSH CPI
 email: support@cloudfoundry.com
 executables: []
@@ -62,15 +62,13 @@ files:
 - lib/bosh/cpi/cli.rb
 - lib/bosh/cpi/compatibility_helpers.rb
 - lib/bosh/cpi/compatibility_helpers/delete_vm.rb
+- lib/bosh/cpi/logger.rb
 - lib/bosh/cpi/registry_client.rb
 - lib/bosh/cpi/tasks.rb
 - lib/bosh/cpi/tasks/spec.rake
 - lib/cloud.rb
 - lib/cloud/config.rb
 - lib/cloud/errors.rb
-- lib/cloud/external_cpi.rb
-- lib/cloud/internal_cpi.rb
-- lib/cloud/provider.rb
 - lib/cloud/version.rb
 homepage: https://github.com/cloudfoundry/bosh
 licenses:
@@ -92,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: BOSH CPI

data/lib/cloud/external_cpi.rb

@@ -1,163 +0,0 @@
-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::CpiError
-      Bosh::Clouds::NotSupported
-      Bosh::Clouds::NotImplemented
-
-      Bosh::Clouds::CloudError
-      Bosh::Clouds::VMNotFound
-
-      Bosh::Clouds::NoDiskSpace
-      Bosh::Clouds::DiskNotAttached
-      Bosh::Clouds::DiskNotFound
-      Bosh::Clouds::VMCreationFailed
-    ).freeze
-
-    RESPONSE_SCHEMA = Membrane::SchemaParser.parse do
-      {
-        'result' => any,
-        'error' => enum(nil,
-          { 'type' => String,
-            'message' => String,
-            'ok_to_retry' => bool
-          }
-        ),
-        'log' => String
-      }
-    end
-
-    def initialize(cpi_path, director_uuid, properties_from_cpi_config = nil)
-      @cpi_path = cpi_path
-      @director_uuid = director_uuid
-      @logger = Config.logger
-      @properties_from_cpi_config = properties_from_cpi_config
-    end
-
-    def current_vm_id(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def create_stemcell(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def delete_stemcell(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def create_vm(*arguments) invoke_cpi_method(__method__.to_s, *arguments); end
-    def delete_vm(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def has_vm?(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def reboot_vm(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def set_vm_metadata(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def create_disk(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def has_disk?(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def delete_disk(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def attach_disk(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def detach_disk(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def snapshot_disk(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def delete_snapshot(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def get_disks(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-    def ping(*arguments); invoke_cpi_method(__method__.to_s, *arguments); end
-
-    private
-
-    def invoke_cpi_method(method_name, *arguments)
-      context = {
-          'director_uuid' => @director_uuid
-      }
-      context.merge!(@properties_from_cpi_config) unless @properties_from_cpi_config.nil?
-
-      request = request_json(method_name, arguments, context)
-      redacted_request = request_json(method_name, arguments, redact_context(context))
-
-      env = {'PATH' => '/usr/sbin:/usr/bin:/sbin:/bin', 'TMPDIR' => ENV['TMPDIR']}
-      cpi_exec_path = checked_cpi_exec_path
-
-      @logger.debug("External CPI sending request: #{redacted_request} with command: #{cpi_exec_path}")
-      cpi_response, stderr, exit_status = Open3.capture3(env, cpi_exec_path, stdin_data: request, unsetenv_others: true)
-      @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'], method_name)
-      end
-
-      save_cpi_log(parsed_response['log'])
-      save_cpi_log(stderr)
-
-      parsed_response['result']
-    end
-
-    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 redact_context(context)
-      return context if @properties_from_cpi_config.nil?
-      Hash[context.map{|k,v|[k,@properties_from_cpi_config.keys.include?(k) ? '<redacted>' : v]}]
-    end
-
-    def request_json(method_name, arguments, context)
-      JSON.dump({
-                    'method' => method_name.gsub(/\?$/,''),
-                    'arguments' => arguments,
-                    'context' => context
-                })
-    end
-
-    def handle_error(error_response, method_name)
-      error_type = error_response['type']
-      error_message = error_response['message']
-      unless KNOWN_RPC_ERRORS.include?(error_type)
-        raise UnknownError, "Unknown CPI error '#{error_type}' with message '#{error_message}' in '#{method_name}' CPI method"
-      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, "CPI error '#{error_type}' with message '#{error_message}' in '#{method_name}' CPI method"
-    end
-
-    def save_cpi_log(output)
-      # cpi log path is set up at the beginning of every task in Config
-      # see JobRunner#setup_task_logging
-      File.open(Config.cpi_task_log, 'a') do |f|
-        f.write(output)
-      end
-    end
-
-    def parsed_response(input)
-      begin
-        JSON.load(input)
-      rescue JSON::ParserError => e
-        raise InvalidResponse, "Invalid CPI response - ParserError - #{e.message}"
-      end
-    end
-
-    def validate_response(response)
-      RESPONSE_SCHEMA.validate(response)
-    rescue Membrane::SchemaValidationError => e
-      raise InvalidResponse, "Invalid CPI response - SchemaValidationError: #{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/internal_cpi.rb

@@ -1,25 +0,0 @@
-module Bosh::Clouds
-  class InternalCpi
-    def initialize(cloud)
-      @cloud = cloud
-    end
-
-    private
-
-    def method_missing(method_sym, *arguments, &block)
-      invoke_cpi_method(method_sym, arguments)
-    end
-
-    def respond_to?(method_sym)
-      cloud.respond_to?(method_sym)
-    end
-
-    def cloud
-      @cloud
-    end
-
-    def invoke_cpi_method(method_sym, arguments)
-      cloud.send(method_sym, *JSON.parse(JSON.dump(arguments)))
-    end
-  end
-end

data/lib/cloud/provider.rb

@@ -1,31 +0,0 @@
-module Bosh::Clouds
-  class Provider
-    def self.create(cloud_config, director_uuid)
-      if cloud_config.has_key?('provider')
-        ExternalCpiProvider.create(cloud_config['provider']['path'], director_uuid)
-      else
-        InternalCpiProvider.create(cloud_config['plugin'], cloud_config['properties'])
-      end
-    end
-  end
-
-  private
-
-  class InternalCpiProvider
-    def self.create(plugin, options)
-      begin
-        require "cloud/#{plugin}"
-      rescue LoadError => error
-        raise CloudError, "Could not load Cloud Provider Plugin: #{plugin}, with error #{error.inspect}"
-      end
-
-      InternalCpi.new(Bosh::Clouds.const_get(plugin.capitalize).new(options))
-    end
-  end
-
-  class ExternalCpiProvider
-    def self.create(cpi_job_path, director_uuid)
-      ExternalCpi.new(cpi_job_path, director_uuid)
-    end
-  end
-end