zfs_mgmt 0.4.7 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f291d60850dca4bda6a4e388d17cd18700406522f159eb1a3489215d0332fdb3
-  data.tar.gz: 3e8bc46616b93dbc119a5ff6e7e24c5e44d579bd330bf18b5a3658fe368ebc15
+  metadata.gz: 97a0bda8881608e6e7fae8a94103e2867d199923f2df9ca9d1776ad6d4626fbe
+  data.tar.gz: 1851e69229905792ace9c998a3f6e88129c4d2f3d45440e8e2c3f7c07626c147
 SHA512:
-  metadata.gz: 1cb48795d7c1d0f9f5499b65149c555aa633e6db1f357c451dba90c5264cc26a81acb62e552b5bea6c241a79bcde488b50eab445f4214be68aa322d91d2d7dab
-  data.tar.gz: 3c5a1b003771b5481ac5419facf28ecbd25c92cf1095fa173a8f0ff4e2b326f2ffdd31bcc9ad4fa0978dd6c5ca583215228f43ec9da69540ce5c6ea28a73c467
+  metadata.gz: 74fc7184eaf7b95edbe8d28dc804230c63c30ff3db0a495e4f86d395006d85ec29e3f2a7ce73d891c0d76627ee47004443d0c81819ece352933dde2a2115c844
+  data.tar.gz: 3437621f4c6ba8e52254c48d0496685efb530f31bfc96d5b73c396fd275161aae02aeef8714ace50682c086f748b5fe787324372b5994947e69ec6c40ab988a6

data/Gemfile

@@ -7,4 +7,5 @@ gem "thor"
 gem "text-table"
 gem "filesize"
 gem "json"
+gem "timeout"
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zfs_mgmt (0.4.7)
+    zfs_mgmt (0.4.9)
       filesize (~> 0.2)
       text-table (~> 1.2)
       thor (~> 1.0)
@@ -28,6 +28,7 @@ GEM
     rspec-support (3.11.0)
     text-table (1.2.4)
     thor (1.2.1)
+    timeout (0.4.1)
 
 PLATFORMS
   x86_64-linux
@@ -40,6 +41,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   text-table
   thor
+  timeout
   zfs_mgmt!
 
 BUNDLED WITH

data/README.md

@@ -4,8 +4,8 @@ zfs_mgmt aims to provide some useful helpers for managing zfs
 snapshots, and eventually send/recv duties via the zfsmgr script in
 bin/.
 
-Currently only snapshot destruction is implemented by a policy
-specification stored in zfs properties.
+Snapshot creation and deletion by policy along with zfs send wrapping
+are implementation by specifications stored in zfs properties.
 
 ## Installation
 

data/bin/zfsmgr

@@ -16,6 +16,12 @@ class ZfsMgr < Thor
   class_option :loglevel, :type => :string, :default => ( $stdout.isatty ? 'info' : 'warn' ),
                :enum => ['debug','error','fatal','info','warn'],
                :desc => 'set logging level to specified severity'
+  class_option :lock, :type => :boolean, :default => false,
+               :desc => 'lock before running'
+  class_option :lock_file, :type => :string, :default => '/run/zfsmgr.lock',
+               :desc => 'lock file'
+  class_option :lock_wait, :type => :numeric, :default => 0,
+               :desc => 'wait N seconds for lock'
   desc "zfsget [ZFS]", "execute zfs get for the given properties and types and parse the output into a nested hash"
   method_option :properties, :type => :string, :default => ['name'], :desc => "List of properties passed to zfs get", repeatable: true
   method_option :types,      :type => :array, :default => ['filesystem','volume'], enum: ['filesystem','volume','snapshot'], :desc => "list of types"

data/lib/zfs_mgmt/version.rb

@@ -1,3 +1,3 @@
 module ZfsMgmt
-  VERSION = "0.4.7"
+  VERSION = "0.4.9"
 end

data/lib/zfs_mgmt/zfs_mgr/send.rb

@@ -34,7 +34,9 @@ class ZfsMgmt::ZfsMgr::Send < Thor
   def all()
     ZfsMgmt.set_log_level(options[:loglevel])
     ZfsMgmt.global_options = options
+    lock = ZfsMgmt.lock(options)
 
     ZfsMgmt.zfs_send_all(options)
+    ZfsMgmt.unlock(lock)
   end
 end

data/lib/zfs_mgmt/zfs_mgr/snapshot.rb

@@ -11,7 +11,9 @@ class ZfsMgmt::ZfsMgr::Snapshot < Thor
   def destroy()
     ZfsMgmt.set_log_level(options[:loglevel])
     ZfsMgmt.global_options = options
+    lock = ZfsMgmt.lock(options)
     ZfsMgmt.snapshot_destroy(noop: options[:noop], verbose: options[:verbose], filter: options[:filter])
+    ZfsMgmt.unlock(lock)
   end
   desc "policy", "print the policy table for zfs"
   def policy()
@@ -25,6 +27,7 @@ class ZfsMgmt::ZfsMgr::Snapshot < Thor
   def create()
     ZfsMgmt.set_log_level(options[:loglevel])
     ZfsMgmt.global_options = options
+    lock = ZfsMgmt.lock(options)
     ZfsMgmt.snapshot_create(noop: options[:noop], filter: options[:filter])
   end
 end

data/lib/zfs_mgmt.rb

@@ -8,6 +8,7 @@ require 'logger'
 require 'text-table'
 require 'open3'
 require 'filesize'
+require 'timeout'
 
 $logger = Logger.new(STDERR, progname: 'zfs_mgmt')
 
@@ -37,6 +38,8 @@ $properties_xlate = {
   'creation' => ->(x) { x.to_i },
 }
 
+$lock = nil
+
 module ZfsMgmt
   class << self
     attr_accessor :global_options
@@ -254,7 +257,7 @@ module ZfsMgmt
       next unless managed
       snaps = self.zfsget(properties: ['name','creation','userrefs','used','written','referenced'],types: ['snapshot'], zfs: zfs)
       if snaps.length == 0
-        $logger.warn("unable to process this zfs, no snapshots at all: #{zfs}")
+        $logger.debug("not processing #{zfs} as there are no snapshots")
         next
       end
       zfss.push([zfs,props,snaps])
@@ -688,4 +691,47 @@ module ZfsMgmt
       zfs_send(options,zfs,props,snaps)
     end
   end
+  def self.lock(options)
+    # open lock file, try to lock file until lock_wait has expired or
+    # lock is obtained, write pid?
+    return nil unless options[:lock]
+    begin
+      lock = File.open(options[:lock_file], File::RDWR|File::CREAT, 0644)
+    rescue Errno::ENOENT => error
+      $logger.error("unable to open lock file (#{options[:lock_file]}), possibly the directory doesn't exist")
+      raise
+    end
+    if lock.flock(File::LOCK_EX|File::LOCK_NB)
+      lock.flock(File::LOCK_UN)
+    else
+      # we failed to lock so locked without NB is likely to block for some amount of time
+      $logger.info("attempting to lock control file, this may block")
+    end
+
+    if options[:lock_wait] > 0
+      begin
+        status = Timeout::timeout(options[:lock_wait]) do
+          return lock if lock.flock(File::LOCK_EX)
+          $logger.error("flock of #{options[:lock_file]} failed")
+          raise "flock failed"
+        end
+      rescue Timeout::Error => error
+        $logger.error("timed out waiting to lock")
+        raise
+      end
+    else
+      # zero is wait forever!
+      return lock if lock.flock(File::LOCK_EX)
+      $logger.error("flock of #{options[:lock_file]} failed")
+      raise "flock failed"
+    end
+    $logger.error("unable to obtain lock")
+    raise "unknown failure in locking file"
+  end
+  def self.unlock(lock)
+    unless lock.nil?
+      lock.flock(File::LOCK_UN)
+      lock.close()
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zfs_mgmt
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.9
 platform: ruby
 authors:
 - Aran Cox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-12 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Misc. helpers regarding snapshots and send/recv.