backup-remote 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6162739675f6b4821155caf28c60e1fec69f9cec
-  data.tar.gz: 7025b3537b82c39ee76745a901a17cb20ae4efb7
+  metadata.gz: 60dcb5cc5bb3e4b58fa3c5ee62da0b1c75eac09e
+  data.tar.gz: c4ab9f0eebfd1cb916159ef874159e8ccb6f1bc5
 SHA512:
-  metadata.gz: 1e0f6c25f973fecf29c4bc5809a3cab8512bce0dcc51f37f5f0e3a673b17e3dba4478532e1e36f224f8008737e624f74741393ea47823ef7fd550199556fd74e
-  data.tar.gz: bed9ee7905040dfdc5fc0f3cbf98a78225f64ac8824033a2d1935d1796f15e02f870f5a69c334becf42ca14a45e58dd9f85604819baa9ffd0dd51b045254823a
+  metadata.gz: 6ed749efeaded026be7c9eb989ac2c9fa8c9429aee4a852bfc2d0ee5dd77d25f69bd0e92e344ce9d4d6799f9289f4d36c0ea7deb8c27fb65460c6d8bbb870e3e
+  data.tar.gz: dfaaab1e3547f58fd5c37204cdc6293cd151870b25ac97556a9c8d40bf68069e640cdc26aa55b0a53944822aafef7c67b214810aa000d953e1e6fef8ecd3d1ed

data/lib/backup/database/remote_mysql.rb

@@ -15,9 +15,12 @@ module Backup
 
       # server options
       attr_accessor :server_host
+      attr_accessor :server_ssh_options
+      attr_accessor :server_ssh_port
       attr_accessor :server_ssh_user
       attr_accessor :server_ssh_password
       attr_accessor :server_ssh_key
+
       attr_accessor :server_backup_path
 
 
@@ -93,6 +96,8 @@ module Backup
       def perform!
         super
 
+        # prepare
+        build_server_ssh_options
 
         #
         pipeline = Pipeline.new
@@ -114,17 +119,18 @@ module Backup
         # generate backup on remote server
         cmd_remote = pipeline.commands.join(" | ")
 
+
         remote = Backup::Remote::Command.new
-        res_generate = remote.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, cmd_remote)
+        res_generate = remote.run_ssh_cmd(server_host, server_ssh_options, cmd_remote)
 
         if res_generate[:res]==0
-          raise 'Cannot create backup on server'
+          raise "Cannot create backup on server. #{res_generate[:error]}"
         end
 
         # download backup
         dump_file = File.join(dump_path, dump_filename+"."+dump_ext)
 
-        res_download = remote.ssh_download_file(server_host, server_ssh_user, server_ssh_password, dump_remote_file, dump_file)
+        res_download = remote.ssh_download_file(server_host, server_ssh_options, dump_remote_file, dump_file)
 
         if res_download[:res]==0
           raise 'Cannot download file from server'
@@ -142,11 +148,30 @@ module Backup
         #end
       end
 
+      def build_server_ssh_options
+        ssh_options = {}
+        v = self.server_ssh_user
+        ssh_options[:user] = v if v
+
+
+        v = self.server_ssh_password
+        ssh_options[:password] = v if v
+
+        v = self.server_ssh_key
+        ssh_options[:key] = v if v
+
+        v = self.server_ssh_port
+        ssh_options[:port] = v if v
+
+
+        self.server_ssh_options = ssh_options
+      end
+
       private
 
       def mysqldump
         #"#{ utility(:mysqldump) } #{ user_options } #{ credential_options } " +
-        u = utility_remote(:mysqldump, server_host, server_ssh_user, server_ssh_password)
+        u = utility_remote(:mysqldump)
         "#{u} #{ user_options } #{ credential_options } " +
         "#{ connectivity_options } #{ name_option } " +
         "#{ tables_to_dump } #{ tables_to_skip }"

data/lib/backup/remote/command.rb

@@ -11,12 +11,23 @@ module Backup
       include SSHKit::DSL
 
 
-      def run_ssh_cmd(hostname, ssh_user, ssh_pass, cmd)
-        #cmd = "bash -c 'whoami'"
+      def self.build_sshkit_host(hostname, ssh_options)
+        puts "DEBUG: #{ssh_options}"
+        ssh_user = ssh_options[:user]
+        ssh_pass = ssh_options[:password]
+        ssh_key = ssh_options[:key]
 
-        #puts "run ssh cmd: #{hostname}, #{ssh_user}, #{ssh_pass}, #{cmd}"
         host = SSHKit::Host.new({hostname: hostname, user: ssh_user})
-        host.password = ssh_pass
+        host.port = ssh_options[:port] || 22
+        host.key = ssh_key if ssh_key
+        host.password = ssh_pass if ssh_pass
+
+        host
+      end
+
+      def run_ssh_cmd(hostname, ssh_options, cmd)
+        #puts "run ssh cmd: #{hostname}, #{ssh_user}, #{ssh_pass}, #{cmd}"
+        host = Command.build_sshkit_host(hostname, ssh_options)
 
         #srv = ssh_user+'@'+hostname
         all_servers = [host]
@@ -43,7 +54,7 @@ module Backup
         return {     res: 1,      output: output   }
 
       rescue => e
-        #puts "ssh error: #{e.message}, #{e.backtrace}"
+        puts "ssh error: #{e.message}, #{e.backtrace}"
 
         {
             res: 0,
@@ -82,12 +93,17 @@ module Backup
 
 
 
-  def ssh_download_file(hostname, ssh_user, ssh_pass, remote_filename, dest_filename)
-    return ssh_download_file_sshkit(hostname, ssh_user, ssh_pass, remote_filename, dest_filename)
+  def ssh_download_file(hostname, ssh_options, remote_filename, dest_filename)
+    return ssh_download_file_sshkit(hostname, ssh_options, remote_filename, dest_filename)
     #return ssh_download_file_scp(hostname, ssh_user, ssh_pass, remote_filename, dest_filename)
   end
 
-  def ssh_download_file_scp(hostname, ssh_user, ssh_pass, remote_filename, dest_filename)
+  def ssh_download_file_scp(hostname, ssh_options, remote_filename, dest_filename)
+    ssh_user = ssh_options[:ssh_user]
+    ssh_pass = ssh_options[:ssh_password]
+    ssh_key = ssh_options[:ssh_key]
+
+    # work
     Net::SCP.download!(hostname, ssh_user, remote_filename, dest_filename, :ssh => { :password => ssh_pass })
 
     #
@@ -101,9 +117,8 @@ module Backup
   end
 
   # !! NOT work on big files > 4Gb
-  def ssh_download_file_sshkit(hostname, ssh_user, ssh_pass, remote_filename, dest_filename)
-    host = SSHKit::Host.new("#{ssh_user}@#{hostname}")
-    host.password = ssh_pass
+  def ssh_download_file_sshkit(hostname, ssh_options, remote_filename, dest_filename)
+    host = Command.build_sshkit_host(hostname, ssh_options)
 
     on host do |host|
       download! remote_filename, dest_filename
@@ -119,9 +134,8 @@ module Backup
     }
   end
 
-  def ssh_upload_file(hostname, ssh_user, ssh_pass, source_file, dest_file, handler=nil)
-    host = SSHKit::Host.new("#{ssh_user}@#{hostname}")
-    host.password = ssh_pass
+  def ssh_upload_file(hostname, ssh_options, source_file, dest_file, handler=nil)
+    host = Command.build_sshkit_host(hostname, ssh_options)
 
     # scp
     f_temp = "/tmp/#{SecureRandom.uuid}"

data/lib/backup/remote_archive.rb

@@ -18,9 +18,7 @@ module Backup
 
     # server options
     attr_accessor :server_host
-    attr_accessor :server_ssh_user
-    attr_accessor :server_ssh_password
-    attr_accessor :server_ssh_key
+    attr_accessor :server_ssh_options
     attr_accessor :server_backup_path
 
 
@@ -29,7 +27,7 @@ module Backup
     # Adds a new Archive to a Backup Model.
     #
     #     Backup::Model.new(:my_backup, 'My Backup') do
-    #       archive :my_archive do |archive|
+    #       remote_archive :my_archive do |archive|
     #         archive.add 'path/to/archive'
     #         archive.add '/another/path/to/archive'
     #         archive.exclude 'path/to/exclude'
@@ -82,10 +80,23 @@ module Backup
 
       DSL.new(@options).instance_eval(&block)
 
-      #
+      # server options
       self.server_host = @options[:server_host]
-      self.server_ssh_user = @options[:server_ssh_user]
-      self.server_ssh_password = @options[:server_ssh_password]
+      ssh_options = {}
+      v = @options[:server_ssh_user]
+      ssh_options[:user] = v if v
+
+      v = @options[:server_ssh_password]
+      ssh_options[:password] = v if v
+
+      v = @options[:server_ssh_key]
+      ssh_options[:key] = v if v
+
+      v = @options[:server_ssh_port]
+      ssh_options[:port] = v if v
+
+
+      self.server_ssh_options = ssh_options
     end
 
     def perform!
@@ -102,7 +113,7 @@ module Backup
       pipeline = Pipeline.new
       with_files_from(paths_to_package) do |files_from|
         # upload to server
-        res_upload = remote.ssh_upload_file(server_host, server_ssh_user, server_ssh_password, files_from, files_from)
+        res_upload = remote.ssh_upload_file(server_host, server_ssh_options, files_from, files_from)
 
         if res_upload[:res]==0
           raise "Cannot upload file to server - #{files_from}"
@@ -136,14 +147,14 @@ module Backup
         #exit
 
 
-        res_generate = remote.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, cmd_remote)
+        res_generate = remote.run_ssh_cmd(server_host, server_ssh_options, cmd_remote)
 
         if res_generate[:res]==0
           raise 'Cannot create backup on server'
         end
 
         # download backup
-        res_download = remote.ssh_download_file(server_host, server_ssh_user, server_ssh_password, remote_archive_file, archive_file)
+        res_download = remote.ssh_download_file(server_host, server_ssh_options, remote_archive_file, archive_file)
 
         #puts "res: #{res_download}"
 
@@ -152,7 +163,7 @@ module Backup
         end
 
         # delete archive on server
-        res_delete = remote.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, "rm #{remote_archive_file}")
+        res_delete = remote.run_ssh_cmd(server_host, server_ssh_options, "rm #{remote_archive_file}")
 
       end
 
@@ -223,12 +234,19 @@ module Backup
         @options[:server_host] = val
       end
 
+      def server_ssh_port=(val = true)
+        @options[:server_ssh_port] = val
+      end
+
       def server_ssh_user=(val = true)
         @options[:server_ssh_user] = val
       end
       def server_ssh_password=(val = true)
         @options[:server_ssh_password] = val
       end
+      def server_ssh_key=(val = true)
+        @options[:server_ssh_key] = val
+      end
 
       ###
       def use_sudo(val = true)

data/lib/backup/remote_data.rb

@@ -18,9 +18,8 @@ module Backup
 
     # server options
     attr_accessor :server_host
-    attr_accessor :server_ssh_user
-    attr_accessor :server_ssh_password
-    attr_accessor :server_ssh_key
+    attr_accessor :server_ssh_options
+
     attr_accessor :server_path
     attr_accessor :server_command
     attr_accessor :script
@@ -43,10 +42,27 @@ module Backup
 
       DSL.new(@options).instance_eval(&block)
 
-      #
+      # ssh options
       self.server_host = @options[:server_host]
-      self.server_ssh_user = @options[:server_ssh_user]
-      self.server_ssh_password = @options[:server_ssh_password]
+
+      # server options
+      ssh_options = {}
+      v = @options[:server_ssh_user]
+      ssh_options[:user] = v if v
+
+      v = @options[:server_ssh_password]
+      ssh_options[:password] = v if v
+
+      v = @options[:server_ssh_key]
+      ssh_options[:key] = v if v
+
+      v = @options[:server_ssh_port]
+      ssh_options[:port] = v if v
+
+
+      self.server_ssh_options = ssh_options
+
+      # server options
       self.server_path = @options[:server_path]
       self.server_command = @options[:server_command]
       self.script = @options[:script]
@@ -82,27 +98,23 @@ module Backup
 
         Logger.info "upload script #{local_script_path} --> #{remote_script_path}"
 
-        remote.ssh_upload_file(server_host, server_ssh_user, server_ssh_password, local_script_path, remote_script_path)
+        remote.ssh_upload_file(server_host, server_ssh_options, local_script_path, remote_script_path)
 
         cmd_remote = "chmod +x #{remote_script_path} && sh #{remote_script_path}"
-        res_generate = remote.run_ssh_cmd(
-            server_host, server_ssh_user, server_ssh_password,
-            cmd_remote)
+        res_generate = remote.run_ssh_cmd(server_host, server_ssh_options, cmd_remote)
 
         # delete temp script
         cmd_delete = "rm -rf #{remote_script_path}"
-        res_delete = remote.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, cmd_delete)
+        res_delete = remote.run_ssh_cmd(server_host, server_ssh_options, cmd_delete)
 
       else
         # use command
         cmd_remote = server_command
-        res_generate = remote.run_ssh_cmd(
-            server_host, server_ssh_user, server_ssh_password,
-            cmd_remote)
+        res_generate = remote.run_ssh_cmd(server_host, server_ssh_options, cmd_remote)
       end
 
       if res_generate[:res]==0
-        raise 'Cannot create backup on server'
+        raise "Cannot create backup on server: #{res_generate[:error]}"
       end
 
 
@@ -119,18 +131,14 @@ module Backup
       # download backup
       Logger.info "download from #{remote_archive_file} to #{temp_local_file}"
 
-      res_download = remote.ssh_download_file(
-          server_host, server_ssh_user, server_ssh_password,
-          remote_archive_file, temp_local_file)
+      res_download = remote.ssh_download_file(server_host, server_ssh_options, remote_archive_file, temp_local_file)
 
       if res_download[:res]==0
         raise 'Cannot download file from server'
       end
 
       # delete archive on server
-      res_delete = remote.run_ssh_cmd(
-          server_host, server_ssh_user, server_ssh_password,
-          "rm #{remote_archive_file}")
+      res_delete = remote.run_ssh_cmd(server_host, server_ssh_options, "rm #{remote_archive_file}")
 
 
       # process archive locally
@@ -232,12 +240,20 @@ module Backup
         @options[:server_host] = val
       end
 
+      def server_ssh_port=(val = true)
+        @options[:server_ssh_port] = val
+      end
+
       def server_ssh_user=(val = true)
         @options[:server_ssh_user] = val
       end
       def server_ssh_password=(val = true)
         @options[:server_ssh_password] = val
       end
+      def server_ssh_key=(val = true)
+        @options[:server_ssh_key] = val
+      end
+
 
       def server_command=(val = true)
         @options[:server_command] = val

data/lib/backup/utilities.rb

@@ -226,16 +226,13 @@ module Backup
       ##
       # Returns the full path to the specified utility.
       # Raises an error if utility can not be found in the system's $PATH
-      def utility_remote(name, hostname, server_ssh_user, server_ssh_password)
+      def utility_remote(name)
         name = name.to_s.strip
         raise Error, 'Utility Name Empty' if name.empty?
 
         req = Backup::Remote::Command.new
-        #req.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, "whoami")
-        #req.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, "which ruby")
-
         cmd = %Q(which '#{ name }' 2>/dev/null)
-        res = req.run_ssh_cmd(server_host, server_ssh_user, server_ssh_password, cmd)
+        res = req.run_ssh_cmd(server_host, server_ssh_options, cmd)
         output = res[:output].chomp
 
         raise Error, <<-EOS if res[:res]==0 || output.empty?

data/lib/backup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '0.0.16'
+  VERSION = '0.0.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup-remote
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Max Ivak, Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList