nifty 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68c088e57ad02f6bb9d2dceec0d3588683a6f894
-  data.tar.gz: 4f9dcbb17e3e765b38601ff095d33b5a1c692a21
+  metadata.gz: 8bb90e66cb5a6b7793a52fd759d51383d80351f3
+  data.tar.gz: 7b415c03cf167b1484b264b543d99d1838c6d73c
 SHA512:
-  metadata.gz: 65001ed5788bbdf0e1d73d9398f6141f66278636ee38207c33990e99e35f8fb9cd008fe01961e1d0ac6331620c9c431162e7407a1c8b2d6099aa3c366f6f7690
-  data.tar.gz: beecedc0d211218c0df2145f0f77c6cbae6cf26a8b3908ac6375e0d1d1729e4e6626436bb3d4039dcee817fbf3598bfe49d847709320a52c294f4c6d24ed37ad
+  metadata.gz: b23e146c4e2390dbc4d7052180dedd77b5e3d08fcdf4b679faff9b87b7567705d36a79401c632329a7346af2a79e5bd959e00b19eb2bee968a7356b25715d103
+  data.tar.gz: 8b00582017c6899d7cf96497e0d7785683431b0347224d1a370511c70d06537b24ca4d0a41def9f54f4b00b5ce6a691280a453ba3669b2f80552ed0bf5a5854b

data/config/nifty.yml

@@ -3,6 +3,9 @@ production:
   transfer:
     method: noop # Transfer method for image upload. Available methods can be listed in help.
     destination: # Image upload destination. Format depends on transfer method.
+    # SCP method specific:
+    # remote-host: # Address of the remote host to copy images to
+    # remote-user: # Name of the remote user used to access the remote host
   opennebula:
     secret: oneadmin:opennebula # If not specified, looking for secret in environment variable ONE_AUTH and file ~/.one/one_auth
     endpoint: http://localhost:2633/RPC2 # If not specified, looking for endpoint in environment variable ONE_XMLRPC and file ~/.one/one_endpoint

data/lib/nifty/backends/opennebula.rb

@@ -169,7 +169,7 @@ class Nifty::Backends::Opennebula < Nifty::Backend
     # @option parameters [String] secret OpenNebula's secret
     # @option parameters [String] endpoint OpenNebula's endpoint
     def expiration_check(parameters)
-      interval = ChronicDuration.parse(parameters[:'expiration-interval'])
+      interval = ChronicDuration.parse(parameters[:'expiration-interval'].to_s)
       return unless interval
 
       client = Nifty::Backends::Utils::Opennebula::Helper.client(parameters[:secret], parameters[:endpoint])

data/lib/nifty/command_executioner.rb

@@ -63,6 +63,14 @@ class Nifty::CommandExecutioner < Thor
                 :type => :string,
                 :aliases => '-t',
                 :desc => 'Image upload destination'
+  class_option :"remote-host",
+                :default => Nifty::Settings['transfer']['remote-host'],
+                :type => :string,
+                :desc => 'Name of the remote host'
+  class_option :"remote-user",
+                :default => Nifty::Settings['transfer']['remote-user'],
+                :type => :string,
+                :desc => 'Name of the remote user'
   class_option :"logging-level",
                 :required => true,
                 :default => Nifty::Settings['logging']['level'],
@@ -95,7 +103,7 @@ class Nifty::CommandExecutioner < Thor
     backend_clazz = Nifty::Backends.const_get(backend.camelize)
     options = backend_clazz.options
     options.each do |name, parameters|
-      parameters[:default] = Nifty::Settings[backend][name.to_s] unless parameters[:default]
+      parameters[:default] = Nifty::Settings[backend][name.to_s] || parameters[:default]
       method_option name, parameters
     end
 
@@ -118,7 +126,7 @@ end
     if backend_clazz.respond_to? 'migrate'
       options = backend_clazz.migrate_options
       options.each do |name, parameters|
-        parameters[:default] = Nifty::Settings[backend][name.to_s] unless parameters[:default]
+        parameters[:default] = Nifty::Settings[backend][name.to_s] || parameters[:default]
         method_option name, parameters
       end
 
@@ -219,7 +227,7 @@ end
   def construct_transfer_method(backend, parameters)
     transfer_method_const = transfer_method_constant(backend, parameters[:"transfer-method"])
 
-    transfer_method_const.new(parameters[:"transfer-destination"])
+    transfer_method_const.new(parameters[:"transfer-destination"], parameters)
   rescue Nifty::Errors::TransferMethodError => ex
     $stdout.puts ex.message
     exit Nifty::ExitCodes::TRANSFER_METHOD_ERROR_EXIT_CODE

data/lib/nifty/errors/transfer_methods/no_remote_host_error.rb

@@ -0,0 +1 @@
+class Nifty::Errors::TransferMethods::NoRemoteHostError < Nifty::Errors::TransferMethodError; end

data/lib/nifty/errors/transfer_methods/scp_command_execution_error.rb

@@ -0,0 +1 @@
+class Nifty::Errors::TransferMethods::ScpCommandExecutionError < Nifty::Errors::TransferMethodError; end

data/lib/nifty/transfer_method.rb

@@ -6,7 +6,7 @@ require 'fileutils'
 # @abstract
 # @attr_reader [String] destination path to destination directory for the transfer method
 class Nifty::TransferMethod
-  attr_reader :destination
+  attr_reader :destination, :options
 
   class << self
     # Helper method to recognize NIFTY transfer method
@@ -37,8 +37,9 @@ class Nifty::TransferMethod
   # Constructor
   #
   # @param [String] destination for the transfer method
-  def initialize(destination)
+  def initialize(destination, options={})
     @destination = destination
+    @options = options
   end
 
   # Transfers file to the destination

data/lib/nifty/transfer_methods/opennebula/cp.rb

@@ -19,7 +19,7 @@ class Nifty::TransferMethods::Opennebula::Cp < Nifty::TransferMethod
   end
 
   # @see Nifty::TransferMethod#initialize
-  def initialize(destination)
+  def initialize(destination, options={})
     fail Nifty::Errors::TransferMethods::DestinationNotDirectoryError, "Destination #{destination.inspect} is not a directory" unless (destination && File.directory?(destination))
     fail Nifty::Errors::TransferMethods::DestinationNotWritableError, "Destination directory #{destination.inspect} is not writable" unless File.writable?(destination)
 

data/lib/nifty/transfer_methods/opennebula/scp.rb

@@ -0,0 +1,61 @@
+require 'etc'
+require 'mixlib/shellout'
+
+# SCP transfer method
+# Copies file from remote server to the destination and clens it after the event is processed
+class Nifty::TransferMethods::Opennebula::Scp < Nifty::TransferMethod
+  attr_reader :user, :host
+  class << self
+    # @see Nifty::TransferMethod#description
+    def description
+      'SCP transfer method - copies images from remote host'
+    end
+
+    # @see Nifty::TransferMethod#backend
+    def backend
+      Nifty::Backends::Opennebula
+    end
+
+    # @see Nifty::TransferMethod#transfer_method?
+    def transfer_method?
+      true
+    end
+  end
+
+  # @see Nifty::TransferMethod#initialize
+  def initialize(destination, options={})
+    fail Nifty::Errors::TransferMethods::NoRemoteHostError, 'Missing remote host option for SCP transfer method' unless options[:'remote-host']
+
+    @host = options[:'remote-host']
+    @user = options[:'remote-user'] || Etc.getlogin
+
+    super(destination, options)
+  end
+
+  # @see Nifty::TransferMethod#transfer
+  def transfer(file)
+    destination_line = "#{user}@#{host}:#{destination}"
+    logger.debug("Copying file #{file.inspect} to destination #{destination_line.inspect}")
+    scp_command = Mixlib::ShellOut.new('scp', file, destination_line)
+    scp_command.run_command
+
+    if scp_command.error?
+      raise Nifty::Errors::TransferMethods::ScpCommandExecutionError, "Command #{scp_command.command.inspect} terminated with an " \
+                                                                      "error: #{scp_command.stderr}"
+    end
+
+    destination_file file
+  end
+
+  # @see Nifty::TransferMethod#clean_copy
+  def clean_copy(file)
+    # no remote cleaning
+  end
+
+  private
+
+  #TODO duplicit method (cp transfer method) -> move to helper class
+  def destination_file(file)
+    File.join(destination, File.basename(file))
+  end
+end

data/lib/nifty/version.rb

@@ -1,3 +1,3 @@
 module Nifty
-  VERSION = "0.2.9"
+  VERSION = "0.2.10"
 end

data/nifty.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'json-schema', '~> 2.5'
   spec.add_runtime_dependency 'tilt', '~> 2.0'
   spec.add_runtime_dependency 'chronic_duration', '~> 0.10'
+  spec.add_runtime_dependency 'mixlib-shellout', '~> 2.2'
 
   spec.required_ruby_version = '>= 1.9.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nifty
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Michal Kimle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -254,6 +254,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 description: A tool for uploading and registering cloud appliances in OpenNebula.
 email:
 - kimle.michal@gmail.com
@@ -314,6 +328,8 @@ files:
 - lib/nifty/errors/transfer_methods/destination_not_directory_error.rb
 - lib/nifty/errors/transfer_methods/destination_not_writable_error.rb
 - lib/nifty/errors/transfer_methods/image_file_not_readable_error.rb
+- lib/nifty/errors/transfer_methods/no_remote_host_error.rb
+- lib/nifty/errors/transfer_methods/scp_command_execution_error.rb
 - lib/nifty/event.rb
 - lib/nifty/event/converter.rb
 - lib/nifty/event/loader.rb
@@ -334,6 +350,7 @@ files:
 - lib/nifty/transfer_methods/opennebula.rb
 - lib/nifty/transfer_methods/opennebula/cp.rb
 - lib/nifty/transfer_methods/opennebula/noop.rb
+- lib/nifty/transfer_methods/opennebula/scp.rb
 - lib/nifty/version.rb
 - nifty.gemspec
 - schema/appliance.json
@@ -359,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A tool for uploading and registering cloud appliances in OpenNebula.