snapsync 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c809fd16c3f578d58d3af399333f68781bf53ae4
-  data.tar.gz: 4822cfbeb7c7dc00cff374a07dbf55d17a328719
+  metadata.gz: 95ec11fc2543f694b0067aec51d92e8a377db86c
+  data.tar.gz: 68c883971fa9a51ada600b7bf5d581ac7989374a
 SHA512:
-  metadata.gz: 84c69e553af59dadd780a38905d36751a90854f865026426e0f433aeddd5adca40dfa66851f988a7b3a3c1ae2eede39404242a66d7c3b399ec3a1065aa2f098c
-  data.tar.gz: 7e8c97f3edaa6c0162e6db011a17f0b866c94a2e55b0b06fadbf5ac75bef1aa5a16df39fb6a6a222f590797f72863c3dbdc46d6040d0d83e73fb2e04066ad1ca
+  metadata.gz: 42b5c23eea493a255c85571dbb6427ddc2e4f6cfb24c6c3c1549bb7d2bd2dcf5a8b9a6a65d01f73aae48e5a6fdb62ffb300d5e3e9f6a0848ebe82596b83a9983
+  data.tar.gz: 233573b3be382d2d9ab5cc5e6e467bbe45cf54e6930c3fffcef438fdbe24808b4bb87a9a46a631a35b8c169d24e99c3d50132ee8578c5750bea4eafb6046ca0e

data/lib/snapsync/btrfs.rb

@@ -17,20 +17,24 @@ module Snapsync
             end
         end
 
+        class UnexpectedBtrfsOutput < Error
+        end
+
+        # @api private
+        #
+        # A IO.popen-like API to btrfs subcommands
         def self.popen(*args, mode: 'r', raise_on_error: true, **options)
             err_r, err_w = IO.pipe
 
             block_error, block_result = nil
             IO.popen(['btrfs', *args, err: err_w, **options], mode) do |io|
                 err_w.close
-                if block_given?
-                    begin
-                        block_result = yield(io)
-                    rescue Error
-                        raise
-                    rescue Exception => block_error
-                    end
-                else io.read
+
+                begin
+                    block_result = yield(io)
+                rescue Error
+                    raise
+                rescue Exception => block_error
                 end
             end
 
@@ -56,8 +60,39 @@ module Snapsync
 
         def self.run(*args, **options)
             popen(*args, **options) do |io|
-                io.read
+                io.read.encode('utf-8', undef: :replace, invalid: :replace)
             end
         end
+
+        # Facade for finding the generation of a subvolume using 'btrfs show'
+        #
+        # @param [Pathname] path the subvolume path
+        # @return [Integer] the subvolume's generation
+        def self.generation_of(path)
+            info = Btrfs.run('subvolume', 'show', path.to_s)
+            if info =~ /Generation[^:]*:\s+(\d+)/
+                Integer($1)
+            else
+                raise UnexpectedBtrfsOutput, "unexpected output for 'btrfs subvolume show', expected #{info} to contain a Generation: line"
+            end
+        end
+
+        # Facade for 'btrfs subvolume find-new'
+        #
+        # It computes what changed between a reference generation of a
+        # subvolume, and that subvolume's current state
+        #
+        # @param [String] subvolume_dir the subvolume target of find-new
+        # @param [Integer] last_gen the reference generation
+        #
+        # @overload find_new(subvolume_dir, last_gen)
+        #   @yieldparam [String] a line of the find-new output
+        #
+        # @overload find_new(subvolume_dir, last_gen)
+        #   @return [#each] an enumeration of the lines of the find-new output
+        def self.find_new(subvolume_dir, last_gen, &block)
+            run('subvolume', 'find-new', subvolume_dir.to_s, last_gen.to_s).
+                each_line(&block)
+        end
     end
 end

data/lib/snapsync/local_sync.rb

@@ -84,7 +84,7 @@ module Snapsync
 
             if copy_snapshot(target_snapshot_dir, src, parent: parent)
                 partial_marker_path.unlink
-                Btrfs.popen("filesystem", "sync", target_snapshot_dir.to_s)
+                Btrfs.run("filesystem", "sync", target_snapshot_dir.to_s)
                 Snapsync.info "Successfully synchronized #{src.snapshot_dir}"
                 true
             end

data/lib/snapsync/local_target.rb

@@ -172,7 +172,7 @@ module Snapsync
             return if dry_run
 
             begin
-                Btrfs.popen("subvolume", "delete", '--commit-each', s.subvolume_dir.to_s)
+                Btrfs.run("subvolume", "delete", '--commit-each', s.subvolume_dir.to_s)
             rescue Btrfs::Error
                 Snapsync.warn "failed to remove snapshot at #{s.subvolume_dir}, keeping the rest of the snapshot"
                 return
@@ -180,7 +180,7 @@ module Snapsync
 
             Snapsync.info "Flushing data to disk"
             begin
-                Btrfs.popen("subvolume", "sync", self.dir.to_s)
+                Btrfs.run("subvolume", "sync", self.dir.to_s)
             rescue Btrfs::Error
             end
 

data/lib/snapsync/snapshot.rb

@@ -77,21 +77,34 @@ module Snapsync
         #
         # This is an estimate of the size required to send this snapshot using
         # the given snapshot as parent
+        #
+        # @param [Snapshot] a reference snapshot, which would be used as parent
+        #   in the 'send' operation
+        # @return [Integer] the size in bytes of the difference between the
+        #   given snapshot and the current subvolume's state
         def size_diff_from(snapshot)
-            info = Btrfs.run('subvolume', 'show', snapshot.subvolume_dir.to_s)
-            info =~ /Generation[^:]*:\s+(\d+)/
-            size_diff_from_gen(Integer($1))
+            snapshot_gen = Btrfs.generation_of(snapshot.subvolume_dir)
+            size_diff_from_gen(snapshot_gen)
         end
 
-        # Compute the size of the snapshot
+        # Compute an estimate of the size of sending the whole subvolume
+        #
+        # @return [Integer] size in bytes
         def size
             size_diff_from_gen(0)
         end
 
+        # @api private
+        #
+        # Compute the size of the 'diff' between a generation and the
+        # subvolume's current state
+        #
+        # @param [Integer] gen the reference generation (the 'from' in the diff)
+        # @return [Integer] size in bytes
+        # @see size_diff_from size
         def size_diff_from_gen(gen)
-            new = Btrfs.run('subvolume', 'find-new', subvolume_dir.to_s, gen.to_s)
-            new.split("\n").inject(0) do |size, line|
-                if line.strip =~ /len (\d+)/
+            Btrfs.find_new(subvolume_dir, gen).inject(0) do |size, line|
+                if line =~ /len (\d+)/
                     size + Integer($1)
                 else size
                 end

data/lib/snapsync/sync.rb

@@ -38,9 +38,9 @@ module Snapsync
                 Snapsync.info "Removing partial snapshot at #{path}"
                 begin
                     if (path + "snapshot").exist?
-                        Btrfs.popen("subvolume", "delete", (path + "snapshot").to_s)
+                        Btrfs.run("subvolume", "delete", (path + "snapshot").to_s)
                     elsif (path + "snapshot.partial").exist?
-                        Btrfs.popen("subvolume", "delete", (path + "snapshot.partial").to_s)
+                        Btrfs.run("subvolume", "delete", (path + "snapshot.partial").to_s)
                     end
                 rescue Btrfs::Error => e
                     Snapsync.warn "failed to remove snapshot at #{path}, keeping the rest of the snapshot"
@@ -51,7 +51,7 @@ module Snapsync
                 path.rmtree
                 Snapsync.info "Flushing data to disk"
                 begin
-                    Btrfs.popen("subvolume", "sync", path.to_s)
+                    Btrfs.run("subvolume", "sync", path.to_s)
                 rescue Btrfs::Error
                 end
             end

data/lib/snapsync/test.rb

@@ -38,25 +38,25 @@ module Snapsync
     #   end
     #
     module SelfTest
-        if defined? FlexMock
-            include FlexMock::ArgumentTypes
-            include FlexMock::MockContainer
-        end
-
         def setup
+            @tempdirs = Array.new
+            super
             # Setup code for all the tests
         end
 
         def teardown
-            if defined? FlexMock
-                flexmock_teardown
+            @tempdirs.each do |dir|
+                FileUtils.rm_rf dir
             end
             super
             # Teardown code for all the tests
         end
+
+        def make_tmpdir
+            @tempdirs << Dir.mktmpdir
+        end
     end
 end
 
 Minitest::Test.include Snapsync::SelfTest
 
-

data/lib/snapsync/version.rb

@@ -1,3 +1,3 @@
 module Snapsync
-    VERSION = "0.3.5"
+    VERSION = "0.3.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapsync
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -237,3 +237,4 @@ signing_key:
 specification_version: 4
 summary: tool to automate backing up snapper snapshots to other medias
 test_files: []
+has_rdoc: