snapsync 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a591ba7179ca6238815f6aa99b747ce66468010
-  data.tar.gz: e8cdd470db1ed3e0118c8a6c4804c548f62fec96
+  metadata.gz: 6537d4331f2602702b307130fda024bdab894efa
+  data.tar.gz: ee06446c1c840e41217616528ec5ac10e29db0cb
 SHA512:
-  metadata.gz: c2f58dd6c19a0cdca23cf65f6564a151ac126eee30af7e84bcfc7120be42f83460912f01ec8fcfdee627ca17f6df6d47d23e2418802450605c1be9a739d7f841
-  data.tar.gz: f85021d8c1b5375b50b7f4b1e4bb89706d45e6ebc19f26c4ff69177ae6fc4755f6bb71822a64ac2621126c53295948cec608bcdb43c4096f54e3f4091c84fb9d
+  metadata.gz: a128cafd4224ebac10c98d333e90c3fee57812d19e9c57f5460b626d7008c302e28f7b3730d1b0535ae3f8230d80578f1020a0d0f926071ddd5de2d861526c63
+  data.tar.gz: 32cb9bb06f3340f10f7b2087ee4eb63a8f4411f7c421155420c7b1b264b03f6118e25fb93c05d95d7b2cd1e7bc307fa36b03b6801347ba0b5536e8effb241f47

data/Rakefile

@@ -1,9 +1,10 @@
+require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
 task :default => :test

data/install.sh

@@ -10,8 +10,9 @@ GEMFILE
 bundler install --standalone --binstubs
 if test -d /opt/snapsync; then
     sudo rm -rf /opt/snapsync
-    sudo cp -r . /opt/snapsync
 fi
+sudo cp -r . /opt/snapsync
+sudo chmod go+rX /opt/snapsync
 
 if test -d /lib/systemd/system; then
     snapsync_gem=`bundler show snapsync`
@@ -22,4 +23,3 @@ if test -d /lib/systemd/system; then
 fi
 
 rm -rf $target
-

data/lib/snapsync/cli.rb

@@ -52,6 +52,11 @@ module Snapsync
                     end
                 end
             end
+
+            def partition_of(dir)
+                partitions = PartitionsMonitor.new
+                PartitionsMonitor.new.partition_of(dir)
+            end
         end
 
         desc 'sync CONFIG DIR', 'synchronizes the snapper configuration CONFIG with the snapsync target DIR'
@@ -91,8 +96,27 @@ module Snapsync
             end
         end
 
-        desc 'init NAME DIR [POLICY]', 'creates a synchronization target, optionally specifying the synchronization and cleanup policy'
+        no_commands do
+            def normalize_policy(args)
+                policy =
+                    if args.empty?
+                        ['default', Array.new]
+                    elsif args.size == 1
+                        args + [Array.new]
+                    else
+                        [args.shift, args]
+                    end
+
+                LocalTarget.parse_policy(*policy)
+                return *policy
+            end
+        end
+
+        desc 'init [NAME] DIR [POLICY]', 'creates a synchronization target, optionally adding it to the auto-sync targets and specifying the synchronization and cleanup policies'
         long_desc <<-EOD
+NAME must be provided if DIR is to be added to the auto-sync targets (which
+is the default).
+
 By default, the default policy is used. To change this, provide additional
 arguments as would be expected by the policy subcommand. Run snapsync help
 policy for more information
@@ -103,13 +127,52 @@ policy for more information
             desc: "if true (the default), add the newly created target to auto-sync"
         option :automount, type: :boolean, default: true,
             desc: 'whether the supporting partition should be auto-mounted by snapsync when needed or not (the default is yes). Only useful if --no-auto has not been provided on the command line.'
-        def init(name, dir, *policy)
+        option :config_file, default: '/etc/snapsync.conf',
+            desc: 'the configuration file that should be updated'
+        def init(*args)
+            if options[:auto] && !options[:all]
+                raise ArgumentError, "cannot use --auto without --all"
+            end
+
+            if options[:auto]
+                if args.size < 2
+                    self.class.handle_argument_error(self.class.all_commands['init'], nil, args, 2)
+                end
+                name, dir, *policy = *args
+            else
+                if args.size < 1
+                    self.class.handle_argument_error(self.class.all_commands['init'], nil, args, 1)
+                end
+                dir, *policy = *args
+            end
             dir = Pathname.new(dir)
 
-            if policy.empty?
-                policy = ['default', Array.new]
-            elsif policy.size == 1
-                policy << Array.new
+            # Parse the policy option early to avoid breaking later
+            begin
+                policy = normalize_policy(policy)
+            rescue Exception
+                # Try to see if the user forgot to add the NAME option or added
+                # the name option but should not have
+                if options[:auto]
+                    valid_policy = begin normalize_policy(args[1..-1])
+                                       true
+                                   rescue InvalidConfiguration
+                                       false
+                                   end
+                    if valid_policy
+                        raise ArgumentError, "--auto is set but it seems that you did not provide a name"
+                    end
+                else
+                    valid_policy = begin normalize_policy(args[2..-1])
+                                       true
+                                   rescue InvalidConfiguration
+                                       false
+                                   end
+                    if valid_policy
+                        raise ArgumentError, "--auto is not set but it seems that you provided a name"
+                    end
+                end
+                raise ArgumentError, "invalid policy #{policy}"
             end
 
             dirs = Array.new
@@ -134,31 +197,39 @@ policy for more information
                 end
             end
 
-            if options[:auto]
-                if !options[:all]
-                    Snapsync.warn "cannot use --auto without --all"
-                else
-                    auto_add(name, dir)
-                end
+            # We check that both options are set together for some added safety,
+            # but it's checked at the top of the method
+            if options[:auto] && options[:all]
+                auto_add(name, dir)
             end
         end
 
         desc 'auto-add NAME DIR', "add DIR to the set of targets for auto-sync"
         option :automount, type: :boolean, default: true,
             desc: 'whether the supporting partition should be auto-mounted by snapsync when needed or not (the default is yes)'
+        option :config_file, default: '/etc/snapsync.conf',
+            desc: 'the configuration file that should be updated'
         def auto_add(name, dir)
-            partitions = PartitionsMonitor.new
-            uuid, relative = partitions.partition_of(Pathname.new(dir))
-
-            conf_path = Pathname.new('/etc/snapsync.conf')
+            uuid, relative = partition_of(Pathname.new(dir))
+            conf_path = Pathname.new(options[:config_file])
 
             autosync = AutoSync.new
-            autosync.load_config(conf_path)
+            if conf_path.exist?
+                autosync.load_config(conf_path)
+            end
             exists = autosync.each_autosync_target.find do |t|
                 t.partition_uuid == uuid && t.path.cleanpath == relative.cleanpath
             end
             if exists
-                if exists.automount == options[:automount]
+                if !exists.name
+                    if (exists.automount ^ options[:automount]) && name
+                        Snapsync.info "already exists without a name, setting the name to #{name}"
+                    elsif name
+                        Snapsync.info "already exists without a name and a different automount flag, setting the name to #{name} and updating the automount flag"
+                    else
+                        Snapsync.info "already exists with different automount flag, updating"
+                    end
+                elsif exists.automount == options[:automount]
                     Snapsync.info "already exists under the name #{exists.name}"
                 else
                     Snapsync.info "already exists under the name #{exists.name} but with a different automount flag, changing"
@@ -197,6 +268,8 @@ for 10 days). snapsync understands the following period names: year month day ho
         EOD
         def policy(dir, type, *options)
             handle_class_options
+            # Parse the policy early to avoid breaking later
+            LocalTarget.parse_policy(*policy)
             each_target(dir) do |_, target|
                 target.change_policy(type, options)
                 target.write_config
@@ -231,9 +304,7 @@ While it can easily be done manually, this command makes sure that the snapshots
         desc 'list [DIR]', 'list the snapshots present on DIR. If DIR is omitted, tries to access all targets defined as auto-sync targets'
         def list(dir = nil)
             handle_class_options
-            matched_uuids = Set.new
             each_target(dir) do |_, target|
-                matched_uuids << target.uuid
                 puts "== #{target.dir}"
                 puts "UUID: #{target.uuid}"
                 puts "Enabled: #{target.enabled?}"

data/lib/snapsync/exceptions.rb

@@ -5,4 +5,6 @@ module Snapsync
     # Exception raised when a snapshot directory is given to {Snapshot} but
     # snapshot_dir/info.xml does not look like a valid snapper info file.
     class InvalidInfoFile < InvalidSnapshot; end
+    # Invalid configuration requested
+    class InvalidConfiguration < ArgumentError; end
 end

data/lib/snapsync/local_target.rb

@@ -75,14 +75,17 @@ module Snapsync
             config['enabled'] = enabled?
             config['autoclean'] = autoclean?
 
-            File.open(config_path, 'w') do |io|
-                io.write YAML.dump(config)
+            config_path.open('w') do |io|
+                YAML.dump(config, io)
             end
         end
 
         def read_config
             begin
-                raw_config = YAML.load(config_path.read)
+                if !(raw_config = YAML.load(config_path.read))
+                    raise NoUUIDError, "empty configuration file found in #{config_path}"
+                end
+
             rescue Errno::ENOENT => e
                 raise NoUUIDError, e.message, e.backtrace
             end
@@ -113,26 +116,51 @@ module Snapsync
         def config_path
             dir + "snapsync.config"
         end
-        
-        def change_policy(type, options)
+
+        # Parse a policy specification as provided on the command line or saved
+        # in the config file into sync and cleanup policy objects
+        #
+        # @param [String] type the policy type, either default, timeline or last
+        # @param [Array<String>] options to be passed to the #from_config method
+        #   on the underlying policy classes
+        #
+        # @return [(#filter_snapshots,#filter_snapshots)] the sync policy
+        #   and the cleanup policy. The cleanup policy might be nil
+        # @raise [InvalidConfiguration] if the policy type is unknown
+        # @see DefaultSyncPolicy TimelineSyncPolicy SyncLastPolicy
+        def self.parse_policy(type, options)
             case type
             when 'default'
                 sync_policy = DefaultSyncPolicy
-                cleanup = nil
+                cleanup     = nil
             when 'timeline'
                 sync_policy = TimelineSyncPolicy
-                cleanup = TimelineSyncPolicy
+                cleanup     = TimelineSyncPolicy
             when 'last'
                 sync_policy = SyncLastPolicy
-                cleanup = SyncLastPolicy
+                cleanup     = SyncLastPolicy
             else
                 raise InvalidConfiguration, "synchronization policy #{type} does not exist"
             end
-            @sync_policy = sync_policy.from_config(options)
-            @cleanup =
+            sync_policy = sync_policy.from_config(options)
+            cleanup =
                 if cleanup
                     Cleanup.new(cleanup.from_config(options))
                 end
+            return sync_policy, cleanup
+        end
+
+        # Verifies that the given policy type and options are valid
+        def self.valid_policy?(type, options)
+            parse_policy(type, options)
+            true
+        rescue InvalidConfiguration
+            false
+        end
+
+        def change_policy(type, options)
+            @sync_policy, @cleanup =
+                self.class.parse_policy(type, options)
         end
 
         def delete(s, dry_run: false)

data/lib/snapsync/test.rb

@@ -15,7 +15,7 @@ end
 
 require 'minitest/autorun'
 require 'snapsync'
-require 'flexmock/test_unit'
+require 'flexmock/minitest'
 require 'minitest/spec'
 
 if ENV['TEST_ENABLE_PRY'] != '0'

data/lib/snapsync/timeline_sync_policy.rb

@@ -19,7 +19,10 @@ module Snapsync
 
         def parse_config(config)
             config.each_slice(2) do |period, count|
-                add(period.to_sym, Integer(count))
+                begin add(period.to_sym, Integer(count))
+                rescue ArgumentError
+                    raise InvalidConfiguration, "invalid timeline period or count #{period} #{count}"
+                end
             end
         end
 

data/lib/snapsync/version.rb

@@ -1,3 +1,3 @@
 module Snapsync
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
 end

data/snapsync.gemspec

@@ -31,5 +31,6 @@ EOD
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0", ">= 5.7"
-  spec.add_development_dependency "flexmock", "~> 1.3", ">= 1.3.3"
+  spec.add_development_dependency "flexmock", "~> 2.0", ">= 2.0"
+  spec.add_development_dependency "fakefs"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapsync
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sylvain Joyeux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -144,20 +144,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  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: 1.3.3
+        version: '0'
 description: |
   Snapsync is a tool that automates transferring snapper snapshots to
   external media (USB drives ...) and managing these snapshots (e.g.