snapsync 0.3.8 → 0.4.0

data/lib/snapsync/sync.rb

@@ -3,6 +3,7 @@ module Snapsync
     class Sync
         attr_reader :config
 
+        # @return [SyncTarget]
         attr_reader :target
 
         def initialize(config, target, autoclean: nil)
@@ -28,19 +29,21 @@ module Snapsync
         # One usually wants to call {#run}, which also takes care of running
         # cleanup if {#autoclean?} is true
         def sync
-            LocalSync.new(config, target).sync
+            SnapshotTransfer.new(config, target).sync
         end
 
         def remove_partially_synchronized_snapshots
+            btrfs_target = Btrfs.get(@target.dir)
+
             target.each_snapshot_raw do |path, snapshot, error|
                 next if !error && !snapshot.partial?
 
                 Snapsync.info "Removing partial snapshot at #{path}"
                 begin
                     if (path + "snapshot").exist?
-                        Btrfs.run("subvolume", "delete", (path + "snapshot").to_s)
+                        btrfs_target.run("subvolume", "delete", (path + "snapshot").path_part)
                     elsif (path + "snapshot.partial").exist?
-                        Btrfs.run("subvolume", "delete", (path + "snapshot.partial").to_s)
+                        btrfs_target.run("subvolume", "delete", (path + "snapshot.partial").path_part)
                     end
                 rescue Btrfs::Error => e
                     Snapsync.warn "failed to remove snapshot at #{path}, keeping the rest of the snapshot"
@@ -51,8 +54,9 @@ module Snapsync
                 path.rmtree
                 Snapsync.info "Flushing data to disk"
                 begin
-                    Btrfs.run("subvolume", "sync", path.to_s)
+                    btrfs_target.run("subvolume", "sync", path.path_part)
                 rescue Btrfs::Error
+                    # Ignored
                 end
             end
         end

data/lib/snapsync/sync_all.rb

@@ -40,7 +40,7 @@ module Snapsync
                 if !dir.exist?
                     Snapsync.warn "no directory for configuration #{config.name} in #{target_dir}"
                 else
-                    yield(config, LocalTarget.new(dir))
+                    yield(config, SyncTarget.new(dir))
                 end
             end
         end

data/lib/snapsync/{local_target.rb → sync_target.rb}

@@ -1,5 +1,5 @@
 module Snapsync
-    class LocalTarget
+    class SyncTarget
         # The target's UUID
         #
         # @return [String]
@@ -9,9 +9,11 @@ module Snapsync
         attr_reader :dir
 
         # The target sync policy
+        # @return [DefaultSyncPolicy]
         attr_reader :sync_policy
 
         # The cleanup object
+        # @return [Cleanup]
         attr_reader :cleanup
 
         # Whether this target is enabled or not
@@ -38,6 +40,7 @@ module Snapsync
             "local:#{dir}"
         end
 
+        # @param [AgnosticPath] dir
         def initialize(dir, create_if_needed: true)
             if !dir.directory?
                 raise ArgumentError, "#{dir} does not exist"
@@ -55,18 +58,21 @@ module Snapsync
                 @cleanup = nil
                 @enabled = true
                 @autoclean = true
+                write_config
             end
-            write_config
         end
 
         def each_snapshot_raw(&block)
             Snapshot.each_snapshot_raw(dir, &block)
         end
+
+        # @yieldparam snapshot [Snapshot]
         def each_snapshot(&block)
             Snapshot.each(dir, &block)
         end
 
         def write_config
+            Snapsync.debug "SyncTarget #{dir} write_config"
             config = Hash['uuid' => uuid, 'policy' => Hash.new]
             config['policy']['type'] =
                 case sync_policy
@@ -85,6 +91,7 @@ module Snapsync
         end
 
         def read_config
+            Snapsync.debug "SyncTarget #{dir} read_config"
             begin
                 if !(raw_config = YAML.load(config_path.read))
                     raise NoUUIDError, "empty configuration file found in #{config_path}"
@@ -167,12 +174,15 @@ module Snapsync
                 self.class.parse_policy(type, options)
         end
 
+        # @param [Snapshot] s
         def delete(s, dry_run: false)
+            btrfs = Btrfs.get(s.subvolume_dir)
+
             Snapsync.info "Removing snapshot #{s.num} #{s.date.to_time} at #{s.subvolume_dir}"
             return if dry_run
 
             begin
-                Btrfs.run("subvolume", "delete", '--commit-each', s.subvolume_dir.to_s)
+                btrfs.run("subvolume", "delete", s.subvolume_dir.path_part)
             rescue Btrfs::Error
                 Snapsync.warn "failed to remove snapshot at #{s.subvolume_dir}, keeping the rest of the snapshot"
                 return
@@ -180,7 +190,7 @@ module Snapsync
 
             Snapsync.info "Flushing data to disk"
             begin
-                Btrfs.run("subvolume", "sync", self.dir.to_s)
+                btrfs.run("subvolume", "sync", self.dir.to_s)
             rescue Btrfs::Error
             end
 

data/lib/snapsync/test.rb

@@ -28,18 +28,11 @@ end
 
 module Snapsync
     # This module is the common setup for all tests
-    #
-    # It should be included in the toplevel describe blocks
-    #
-    # @example
-    #   require 'snapsync/test'
-    #   describe Snapsync do
-    #     include Snapsync::SelfTest
-    #   end
-    #
     module SelfTest
         def setup
             @tempdirs = Array.new
+            Snapsync._mountpointCache = {}
+            Snapsync::Btrfs._mountpointCache = {}
             super
             # Setup code for all the tests
         end

data/lib/snapsync/util.rb

@@ -0,0 +1,18 @@
+module Kernel
+  def human_readable_time(time)
+    hrs = time / 3600
+    min = (time / 60) % 60
+    sec = time % 60
+    "%02i:%02i:%02i" % [hrs, min, sec]
+  end
+
+  def human_readable_size(size, digits: 1)
+    order = ['B', 'kB', 'MB', 'GB']
+    magnitude =
+      if size > 0
+        Integer(Math.log2(size) / 10)
+      else 0
+      end
+    "%.#{digits}f#{order[magnitude]}" % [Float(size) / (1024 ** magnitude)]
+  end
+end

data/lib/snapsync/version.rb

@@ -1,3 +1,3 @@
 module Snapsync
-    VERSION = "0.3.8"
+    VERSION = "0.4.0"
 end

data/lib/snapsync.rb

@@ -1,3 +1,7 @@
+require 'uri/ssh_git'
+require 'net/ssh'
+require 'net/sftp'
+
 require 'pathname'
 require 'logging'
 require 'pp'
@@ -8,14 +12,19 @@ require 'date'
 require 'concurrent'
 
 require "snapsync/version"
+require "snapsync/util"
 require "snapsync/exceptions"
 require 'snapsync/btrfs'
+require 'snapsync/btrfs_subvolume'
 require "snapsync/snapper_config"
 require "snapsync/snapshot"
-require "snapsync/local_target"
-require "snapsync/local_sync"
+require "snapsync/sync_target"
+require "snapsync/snapshot_transfer"
 require 'snapsync/cleanup'
 
+require 'snapsync/remote_pathname'
+require 'snapsync/ssh_popen'
+
 require 'snapsync/default_sync_policy'
 require 'snapsync/timeline_sync_policy'
 require 'snapsync/sync_last_policy'
@@ -91,5 +100,25 @@ end
 
 module Snapsync
     install_root_logging(forward: true)
+
+    class << self
+        attr_accessor :SSH_DEBUG
+    end
+    Snapsync.SSH_DEBUG = false
+
+    # @param [String] dir
+    # @return [AgnosticPath]
+    def self.path(dir)
+        raise "Nil dir" if dir.nil?
+        if dir.instance_of? RemotePathname or dir.include? ':'
+            begin
+                RemotePathname.new(dir)
+            rescue URI::InvalidComponentError
+                LocalPathname.new(dir)
+            end
+        else
+            LocalPathname.new dir
+        end
+    end
 end
 

data/snapsync.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   spec.description   =<<-EOD
 Snapsync is a tool that automates transferring snapper snapshots to
-external media (USB drives ...) and managing these snapshots (e.g.
+external media (USB drives ...), remote filesystems [experimental] and managing these snapshots (e.g.
 timeline cleanup)
 EOD
 
@@ -23,14 +23,21 @@ EOD
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'rexml', '~> 3.2.0'
   spec.add_dependency 'logging', '~> 2.0', ">= 2.0.0"
-  spec.add_dependency 'concurrent-ruby', '~> 0.9.0', '>= 0.9'
-  spec.add_dependency 'ruby-dbus', "~> 0.11.0", ">= 0.11"
-  spec.add_dependency 'thor', "~> 0.19.0", ">= 0.19.1"
+  spec.add_dependency 'concurrent-ruby', '~> 1.1'
+  spec.add_dependency 'ruby-dbus', "~> 0.16.0"
+  spec.add_dependency 'thor', "~> 1.1"
+  spec.add_dependency 'uri-ssh_git', "~> 2.0.0"
+  spec.add_dependency 'net-ssh', ">= 6.3.1"
+  spec.add_dependency 'net-sftp', "~> 3.0.0"
+  spec.add_dependency 'ed25519', ">= 1.2"
+  spec.add_dependency 'bcrypt_pbkdf', ">= 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "minitest", "~> 5.0", ">= 5.7"
   spec.add_development_dependency "flexmock", "~> 2.0", ">= 2.0"
   spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "irb"
 end

data/snapsync.service

@@ -4,7 +4,10 @@ Wants=udisks2.service
 
 [Service]
 Type=simple
-ExecStart=/opt/snapsync/bin/snapsync auto-sync
+ExecStart=/usr/bin/snapsync auto-sync --one-shot
+Nice=19
+IOSchedulingClass=idle
+KillSignal=SIGINT
 
 [Install]
 WantedBy=default.target

data/snapsync.timer

@@ -0,0 +1,10 @@
+[Unit]
+Description=Run snapsync
+
+[Timer]
+OnCalendar=*-*-* 20:00:00
+RandomizedDelaySec=5min
+Persistent=true
+
+[Install]
+WantedBy=timers.target

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: snapsync
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.4.0
 platform: ruby
 authors:
 - Sylvain Joyeux
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -36,88 +50,140 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: ruby-dbus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
-    - - ">="
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.16.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: uri-ssh_git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 6.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: net-sftp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -172,9 +238,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Snapsync is a tool that automates transferring snapper snapshots to
-  external media (USB drives ...) and managing these snapshots (e.g.
+  external media (USB drives ...), remote filesystems [experimental] and managing these snapshots (e.g.
   timeline cleanup)
 email:
 - sylvain.joyeux@m4x.org
@@ -195,28 +275,33 @@ files:
 - lib/snapsync.rb
 - lib/snapsync/auto_sync.rb
 - lib/snapsync/btrfs.rb
+- lib/snapsync/btrfs_subvolume.rb
 - lib/snapsync/cleanup.rb
 - lib/snapsync/cli.rb
 - lib/snapsync/default_sync_policy.rb
 - lib/snapsync/exceptions.rb
-- lib/snapsync/local_sync.rb
-- lib/snapsync/local_target.rb
 - lib/snapsync/partitions_monitor.rb
+- lib/snapsync/remote_pathname.rb
 - lib/snapsync/snapper_config.rb
 - lib/snapsync/snapshot.rb
+- lib/snapsync/snapshot_transfer.rb
+- lib/snapsync/ssh_popen.rb
 - lib/snapsync/sync.rb
 - lib/snapsync/sync_all.rb
 - lib/snapsync/sync_last_policy.rb
+- lib/snapsync/sync_target.rb
 - lib/snapsync/test.rb
 - lib/snapsync/timeline_sync_policy.rb
+- lib/snapsync/util.rb
 - lib/snapsync/version.rb
 - snapsync.gemspec
 - snapsync.service
+- snapsync.timer
 homepage: https://github.com/doudou/snapsync
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -231,9 +316,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.8
+signing_key:
 specification_version: 4
 summary: tool to automate backing up snapper snapshots to other medias
 test_files: []