restic-service 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc0cdefcecb418357241e0acc940dc84572263d8
-  data.tar.gz: 9b3bf2bc152405e6fd8d4ffd4e950f8176b34a7f
+  metadata.gz: b797f08f3ae90d533967c28a43d70b695d2d5ff4
+  data.tar.gz: 695d8520af725f6f9002c0764ff2e5aec4f503ca
 SHA512:
-  metadata.gz: 58013743c7a6ebf256b6eddc6ade110c43245513fa78242cb151698538307388af6a95e3c36b46fc381d19219780cec4c1c8543d571757429a3f81671083ae00
-  data.tar.gz: bd65807a2ca4f8314b39cf4f4c1fd571693c9148bb6f70db19c75d2965526bc0b69a28c4449e468a77b7ddcfd733a26650275a0138553f205cc6f8776a27e69b
+  metadata.gz: da19f6808c3d4ddee424c67629a3c733da6dbc1cfb98039679c75cc1490e9dcc33d0f218495dfdceb6eed46bccdd4b6f74201b24dc0ceafb0acefaf3b13f88ce
+  data.tar.gz: c2ad3daec120eabe099b2e3e67135aa5cd19555d6b48a16ad6c12c26a29b9be189e326b96dbed484dbd642bb62dd51f8e191205ee89f543b417e51da9fe91224

data/lib/restic/service.rb

@@ -5,11 +5,13 @@ require 'tempfile'
 require "restic/service/version"
 require "restic/service/auto_update"
 require "restic/service/targets/base"
+require "restic/service/targets/ssh_target"
 require "restic/service/targets/restic"
 require "restic/service/targets/b2"
 require "restic/service/targets/restic_b2"
 require "restic/service/targets/restic_file"
 require "restic/service/targets/restic_sftp"
 require "restic/service/targets/rclone_b2"
+require "restic/service/targets/rsync"
 require "restic/service/ssh_keys"
 require "restic/service/conf"

data/lib/restic/service/conf.rb

@@ -37,7 +37,8 @@ module Restic
                 'restic-b2' => Targets::ResticB2,
                 'restic-sftp' => Targets::ResticSFTP,
                 'restic-file' => Targets::ResticFile,
-                'rclone-b2' => Targets::RcloneB2]
+                'rclone-b2' => Targets::RcloneB2,
+                'rsync' => Targets::Rsync]
 
             TOOLS = %w{restic rclone}
 
@@ -73,7 +74,8 @@ module Restic
 
                     target_class = target_class_from_type(target['type'])
                     if !target_class
-                        raise InvalidConfigurationFile, "target type #{target['type']} does not exist, available targets: #{TARGET_CLASS_FROM_TYPE.keys.sort.join(", ")}"
+                        raise InvalidConfigurationFile, "target type #{target['type']} does not exist, "\
+                            "available targets: #{TARGET_CLASS_FROM_TYPE.keys.sort.join(", ")}"
                     end
 
                     name = target['name'].to_s

data/lib/restic/service/targets/base.rb

@@ -6,8 +6,18 @@ module Restic
 
                 def initialize(name)
                     @name = name
-
                     @bandwidth_limit = nil
+                    @io_class = nil
+                    @io_priority = nil
+                    @cpu_priority = nil
+                end
+
+                def self.normalize_yaml(yaml)
+                    yaml.dup
+                end
+
+                def available?
+                    true
                 end
 
                 def setup_from_conf(conf, yaml)
@@ -15,6 +25,29 @@ module Restic
                         if limit = yaml.fetch('bandwidth_limit', conf.bandwidth_limit)
                             Conf.parse_bandwidth_limit(limit)
                         end
+                    if (io_class = yaml['io_class'])
+                        @io_class = Integer(io_class)
+                    end
+                    if (io_priority = yaml['io_priority'])
+                        @io_priority = Integer(io_priority)
+                    end
+                    if (cpu_priority = yaml['cpu_priority'])
+                        @cpu_priority = Integer(cpu_priority)
+                    end
+                end
+
+                def nice_commands
+                    result = []
+                    if @io_class
+                        result << 'ionice' << '-c' << @io_class.to_s
+                        if @io_priority
+                            result << '-n' << @io_priority.to_s
+                        end
+                    end
+                    if @cpu_priority
+                        result << "nice" << "-#{@cpu_priority}"
+                    end
+                    result
                 end
             end
         end

data/lib/restic/service/targets/rclone_b2.rb

@@ -19,6 +19,7 @@ module Restic
                     @rclone_path = conf.tool_path('rclone')
                     @src = yaml['src']
                     @filter = yaml['filter'] || []
+                    @verbose = yaml.fetch('verbose', true)
                     @conf_path = conf.conf_path
                 end
 
@@ -27,6 +28,9 @@ module Restic
                     if @bandwidth_limit
                         extra_args << '--bwlimit' << @bandwidth_limit.to_s
                     end
+                    if @verbose
+                        extra_args << "--verbose"
+                    end
 
                     Tempfile.create "rclone-#{@name}", @conf_path.to_path, perm: 0600 do |io|
                         io.puts <<-EOCONF

data/lib/restic/service/targets/restic.rb

@@ -96,14 +96,8 @@ module Restic
                         extra_args << '--limit-download' << limit_KiB.to_s << '--limit-upload' << limit_KiB.to_s
                     end
 
-                    ionice_args = []
-                    if @io_class != 3
-                        ionice_args << '-n' << @io_priority.to_s
-                    end
-
                     system(Hash['HOME' => home, 'RESTIC_PASSWORD' => @password].merge(env),
-                           'ionice', '-c', @io_class.to_s, *ionice_args,
-                           'nice', "-#{@cpu_priority}",
+                           *nice_commands,
                            @restic_path.to_path, "--cleanup-cache", *args, *extra_args, in: :close, **options)
                 end
 

data/lib/restic/service/targets/restic_sftp.rb

@@ -5,18 +5,12 @@ module Restic
             #
             # See README.md for the YAML configuration file format
             class ResticSFTP < Restic
+                include SSHTarget
+
                 def initialize(name)
                     super
-                    @host = nil
                     @username = nil
                     @path = nil
-                    @host_keys = []
-                end
-
-                def available?
-                    ssh = SSHKeys.new
-                    actual_keys = ssh.query_keys(@host)
-                    valid?(actual_keys)
                 end
 
                 def self.normalize_yaml(yaml)
@@ -29,36 +23,24 @@ module Restic
                 end
 
                 def setup_from_conf(conf, yaml)
+                    super
                     @target_name = yaml['name']
-                    @key_path    = conf.conf_keys_path_for(self)
-                    @host_keys = SSHKeys.load_keys_from_file(@key_path)
-                    @host      = yaml['host'].to_str
                     @username  = yaml['username'].to_str
                     @path      = yaml['path'].to_str
                     @password  = yaml['password'].to_str
                     super
                 end
 
-                def valid?(actual_keys)
-                    actual_keys.any? { |k| @host_keys.include?(k) }
-                end
-
                 def run
-                    ssh = SSHKeys.new
-                    ssh_config_name = ssh.ssh_setup_config(@target_name, @username, @host, @key_path)
-
-                    run_backup('-r', "sftp:#{ssh_config_name}:#{@path}", 'backup')
-                ensure
-                    ssh.ssh_cleanup_config
+                    with_ssh_config do |ssh_config_name|
+                        run_backup('-r', "sftp:#{ssh_config_name}:#{@path}", 'backup')
+                    end
                 end
 
                 def forget
-                    ssh = SSHKeys.new
-                    ssh_config_name = ssh.ssh_setup_config(@target_name, @username, @host, @key_path)
-
-                    run_forget('-r', "sftp:#{ssh_config_name}:#{@path}", 'forget')
-                ensure
-                    ssh.ssh_cleanup_config
+                    with_ssh_config do |ssh_config_name|
+                        run_forget('-r', "sftp:#{ssh_config_name}:#{@path}", 'forget')
+                    end
                 end
             end
         end

data/lib/restic/service/targets/rsync.rb

@@ -0,0 +1,50 @@
+module Restic
+    module Service
+        module Targets
+            class Rsync < Base
+                include SSHTarget
+
+                def self.normalize_yaml(yaml)
+                    yaml = super
+                    if !yaml['host']
+                        raise Conf::InvalidConfigurationFile, "no host given"
+                    elsif !yaml['source']
+                        raise Conf::InvalidConfigurationFile, "no source given"
+                    elsif !yaml['target']
+                        raise Conf::InvalidConfigurationFile, "no target given"
+                    end
+                    yaml
+                end
+
+                def setup_from_conf(conf, yaml)
+                    super
+                    @source = yaml.fetch('source')
+                    @target = yaml.fetch('target')
+                    @one_file_system = yaml.fetch('one_file_system', false)
+                    @filters = yaml.fetch('filters', [])
+                end
+
+                def run(*args, **options)
+                    extra_args = []
+                    if @one_file_system
+                        extra_args << "--one-file-system"
+                    end
+                    if @bandwidth_limit
+                        limit_KiB = @bandwidth_limit / 1000 
+                        extra_args << "--bwlimit=#{limit_KiB}"
+                    end
+
+                    home = ENV['HOME'] || '/root'
+
+                    with_ssh_config do |ssh_config_name|
+                        system(Hash['HOME' => home], *nice_commands,
+                               'rsync', '-a', '--delete-during',
+                               *@filters.map { |arg| "--filter=#{arg}" },
+                               *extra_args, @source, "#{ssh_config_name}:#{@target}")
+                    end
+                end
+            end
+        end
+    end
+end
+

data/lib/restic/service/targets/ssh_target.rb

@@ -0,0 +1,42 @@
+module Restic
+    module Service
+        module Targets
+            module SSHTarget
+                def initialize(name)
+                    super
+                    @key_path = nil
+                    @host = nil
+                    @username = nil
+                    @host_keys = []
+                end
+
+                def setup_from_conf(conf, yaml)
+                    super
+                    @username  = yaml.fetch('username').to_str
+                    @host      = yaml.fetch('host').to_str
+                    @key_path  = conf.conf_keys_path_for(self)
+                    @host_keys = SSHKeys.load_keys_from_file(@key_path)
+                end
+
+                def available?
+                    ssh = SSHKeys.new
+                    actual_keys = ssh.query_keys(@host)
+                    valid?(actual_keys)
+                end
+
+                def valid?(actual_keys)
+                    actual_keys.any? { |k| @host_keys.include?(k) }
+                end
+
+                def with_ssh_config
+                    ssh = SSHKeys.new
+                    ssh_config_name = ssh.ssh_setup_config(
+                        name, @username, @host, @key_path)
+                    yield(ssh_config_name)
+                ensure
+                    ssh.ssh_cleanup_config if ssh_config_name
+                end
+            end
+        end
+    end
+end

data/lib/restic/service/version.rb

@@ -1,5 +1,5 @@
 module Restic
   module Service
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restic-service
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -111,6 +111,8 @@ files:
 - lib/restic/service/targets/restic_b2.rb
 - lib/restic/service/targets/restic_file.rb
 - lib/restic/service/targets/restic_sftp.rb
+- lib/restic/service/targets/rsync.rb
+- lib/restic/service/targets/ssh_target.rb
 - lib/restic/service/version.rb
 - restic-service.gemspec
 - restic-service.service