vpsadmin-client 3.0.0.master.202211181.pre.0.ac358990 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9014c08e0f38faa0c2ef3ff240d919521ff77609f7c638c3497fdf730d76a2d9
-  data.tar.gz: 4639e16cc11b5b4a81ebd787e6dedf15ec6da46177920de95e442ff8bc13ad86
+  metadata.gz: 73f9447cec0e8278700d4d5e56fdc50bd7b88ceb6debac252d3ab9bb5322260e
+  data.tar.gz: 45c1ef064847694f9432da3872baa7f67844b1fbd69500caa9369f4187f04bc5
 SHA512:
-  metadata.gz: 63cec139647a45f1b78e31189634c3f876d5531efd3abb9ab535146cb2d34d3e13cb27f9d9a1cdf0fe8c7031cd4bee87774f1d1f1387fa349f21dce5d1a87792
-  data.tar.gz: 5431b10cbef22f09b69e7a4968bf3b0959dae30df08e2e3f24363ca5513931bec674b98fd203a77b326abffe4f87e4377638473031db122fef50d86fa0ad4e40
+  metadata.gz: df1defede9d7b25d5279d0cfb75f84025ac503851737bda802acd084cb4cf3423fd2390d7083a8597b40f0bef86391fe6f74de67305505256cde04591a6082ee
+  data.tar.gz: e712ebdfc1f68faba266f8e117cf19403d705bf1f9f96bdf31824223362171506ac8de647eccd26ad239975179941f9747784da8ab347a0b5dca87d0f0849ac0

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: ../.rubocop.yml
+
+
+AllCops:
+  TargetRubyVersion: 3.0

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'rake'
+end

data/Rakefile

@@ -1,2 +1 @@
 require 'bundler/gem_tasks'
-

data/lib/{terminal-size.rb → terminal_size.rb}

@@ -1,55 +1,61 @@
 class Terminal
-  class Size; VERSION = '0.0.6' end
+  class Size; VERSION = '0.0.6'.freeze end
   class << self
     def size
       size_via_low_level_ioctl or size_via_stty or nil
     end
-    def size!; size or _height_width_hash_from 25, 80 end
+
+    def size!
+      size or _height_width_hash_from 25, 80
+    end
 
     # These are experimental
-    def resize direction, magnitude
+    def resize(direction, magnitude)
       tmux 'resize-pane', "-#{direction}", magnitude
     end
 
     def tmux *cmd
-      system 'tmux', *(cmd.map &:to_s)
+      system 'tmux', *cmd.map(&:to_s)
     end
 
-    IOCTL_INPUT_BUF = "\x00"*8
+    IOCTL_INPUT_BUF = "\x00" * 8
     def size_via_low_level_ioctl
       # Thanks to runpaint for the general approach to this
       return unless $stdin.respond_to? :ioctl
+
       code = tiocgwinsz_value_for RUBY_PLATFORM
       return unless code
+
       buf = IOCTL_INPUT_BUF.dup
-      return unless $stdout.ioctl(code, buf).zero?
-      return if IOCTL_INPUT_BUF == buf
+      return if $stdout.ioctl(code, buf) != 0
+      return if buf == IOCTL_INPUT_BUF
+
       got = buf.unpack('S4')[0..1]
-      _height_width_hash_from *got
-    rescue
+      _height_width_hash_from(*got)
+    rescue StandardError
       nil
     end
 
-    def tiocgwinsz_value_for platform
+    def tiocgwinsz_value_for(platform)
       # This is as reported by <sys/ioctl.h>
       # Hard-coding because it seems like overkll to acutally involve C for this.
       {
         /linux/ => 0x5413,
-        /darwin/ => 0x40087468, # thanks to brandon@brandon.io for the lookup!
-      }.find{|k,v| platform[k]}
+        /darwin/ => 0x40087468 # thanks to brandon@brandon.io for the lookup!
+      }.find { |k, _v| platform[k] }
     end
 
     def size_via_stty
-      ints = `stty size`.scan(/\d+/).map &:to_i
-      _height_width_hash_from *ints
-    rescue
+      ints = `stty size`.scan(/\d+/).map(&:to_i)
+      _height_width_hash_from(*ints)
+    rescue StandardError
       nil
     end
 
     private
+
     def _height_width_hash_from *dimensions
-      { :height => dimensions[0], :width => dimensions[1] }
+      { height: dimensions[0], width: dimensions[1] }
     end
-
   end
 end

data/lib/vpsadmin/cli/commands/backup_dataset.rb

@@ -21,7 +21,7 @@ module VpsAdmin::CLI::Commands
         attempts: 10,
         checksum: true,
         delete_after: true,
-        sudo: true,
+        sudo: true
       }
 
       opts.on('-p', '--pretend', 'Print what would the program do') do
@@ -93,14 +93,14 @@ module VpsAdmin::CLI::Commands
 
         ds_id = read_dataset_id(fs)
 
-        if ds_id
-          ds = @api.dataset.show(ds_id)
-        else
-          ds = dataset_chooser
-        end
+        ds = if ds_id
+               @api.dataset.show(ds_id)
+             else
+               dataset_chooser
+             end
 
       elsif args.size != 2
-        warn "Provide DATASET_ID and FILESYSTEM arguments"
+        warn 'Provide DATASET_ID and FILESYSTEM arguments'
         exit(false)
 
       else
@@ -144,15 +144,15 @@ module VpsAdmin::CLI::Commands
       # This is the first run within this history id, no local snapshots are
       # present
       if !latest_local_snapshot && @opts[:init_snapshots]
-        remote_state[ds.current_history_id] = \
+        remote_state[ds.current_history_id] =
           remote_state[ds.current_history_id].last(@opts[:init_snapshots])
       end
 
       remote_state[ds.current_history_id].each do |snap|
         found = false
 
-        local_state.values.each do |snapshots|
-          found = snapshots.detect { |s| s.name == snap.name }
+        local_state.each_value do |local_snapshots|
+          found = local_snapshots.detect { |s| s.name == snap.name }
           break if found
         end
 
@@ -170,33 +170,33 @@ module VpsAdmin::CLI::Commands
       if for_transfer.empty?
         if found_latest
           exit_msg(
-            "Nothing to transfer: all snapshots with history id "+
+            'Nothing to transfer: all snapshots with history id ' \
             "#{ds.current_history_id} are already present locally",
             error: @opts[:no_snapshots_error]
           )
 
         else
-          exit_msg(<<END
-Unable to transfer: the common snapshot has not been found
+          exit_msg(<<~END
+            Unable to transfer: the common snapshot has not been found
 
-This can happen when the latest local snapshot was deleted from the server,
-i.e. you have not backed up this dataset for quite some time.
+            This can happen when the latest local snapshot was deleted from the server,
+            i.e. you have not backed up this dataset for quite some time.
 
-You can either rename or destroy the whole current history id:
+            You can either rename or destroy the whole current history id:
 
-  zfs rename #{fs}/#{ds.current_history_id} #{fs}/#{ds.current_history_id}.old
+              zfs rename #{fs}/#{ds.current_history_id} #{fs}/#{ds.current_history_id}.old
 
-or
+            or
 
-  zfs list -r -t all #{fs}/#{ds.current_history_id}
-  zfs destroy -r #{fs}/#{ds.current_history_id}
+              zfs list -r -t all #{fs}/#{ds.current_history_id}
+              zfs destroy -r #{fs}/#{ds.current_history_id}
 
-which will destroy all snapshots with this history id.
+            which will destroy all snapshots with this history id.
 
-You can also destroy the local backup completely or backup to another dataset
-and start anew.
-END
-          )
+            You can also destroy the local backup completely or backup to another dataset
+            and start anew.
+          END
+                  )
         end
       end
 
@@ -226,9 +226,7 @@ END
         if shared_name
           shared = remote_state[ds.current_history_id].detect { |s| s.name == shared_name }
 
-          if shared && !for_transfer.detect { |s| s.id == shared.id }
-            for_transfer.insert(0, shared)
-          end
+          for_transfer.insert(0, shared) if shared && !for_transfer.detect { |s| s.id == shared.id }
         end
 
         write_dataset_id!(ds, fs) unless written_dataset_id?
@@ -238,13 +236,12 @@ END
     end
 
     protected
+
     def transfer(local_state, snapshots, hist_id, fs)
       ds = "#{fs}/#{hist_id}"
       no_local_snapshots = local_state[hist_id].nil? || local_state[hist_id].empty?
 
-      if local_state[hist_id].nil?
-        zfs(:create, nil, ds)
-      end
+      zfs(:create, nil, ds) if local_state[hist_id].nil?
 
       if no_local_snapshots
         msg "Performing a full receive of @#{snapshots.first.name} to #{ds}"
@@ -255,60 +252,59 @@ END
         else
           run_piped(zfs_cmd(:recv, '-F', ds)) do
             SnapshotSend.new({}, @api).do_exec({
-              snapshot: snapshots.first.id,
-              send_mail: false,
-              delete_after: @opts[:delete_after],
-              max_rate: @opts[:max_rate],
-              checksum: @opts[:checksum],
-              quiet: @opts[:quiet],
-            })
+                                                 snapshot: snapshots.first.id,
+                                                 send_mail: false,
+                                                 delete_after: @opts[:delete_after],
+                                                 max_rate: @opts[:max_rate],
+                                                 checksum: @opts[:checksum],
+                                                 quiet: @opts[:quiet]
+                                               })
           end || exit_msg('Receive failed')
         end
       end
 
-      if !no_local_snapshots || snapshots.size > 1
-        msg "Performing an incremental receive of "+
-            "@#{snapshots.first.name} - @#{snapshots.last.name} to #{ds}"
+      return unless !no_local_snapshots || snapshots.size > 1
 
-        if @opts[:safe]
-          safe_download(ds, snapshots.last, snapshots.first)
+      msg 'Performing an incremental receive of ' \
+          "@#{snapshots.first.name} - @#{snapshots.last.name} to #{ds}"
 
-        else
-          run_piped(zfs_cmd(:recv, '-F', ds)) do
-            SnapshotSend.new({}, @api).do_exec({
-              snapshot: snapshots.last.id,
-              from_snapshot: snapshots.first.id,
-              send_mail: false,
-              delete_after: @opts[:delete_after],
-              max_rate: @opts[:max_rate],
-              checksum: @opts[:checksum],
-              quiet: @opts[:quiet],
-            })
-          end || exit_msg('Receive failed')
-        end
+      if @opts[:safe]
+        safe_download(ds, snapshots.last, snapshots.first)
+
+      else
+        run_piped(zfs_cmd(:recv, '-F', ds)) do
+          SnapshotSend.new({}, @api).do_exec({
+                                               snapshot: snapshots.last.id,
+                                               from_snapshot: snapshots.first.id,
+                                               send_mail: false,
+                                               delete_after: @opts[:delete_after],
+                                               max_rate: @opts[:max_rate],
+                                               checksum: @opts[:checksum],
+                                               quiet: @opts[:quiet]
+                                             })
+        end || exit_msg('Receive failed')
       end
     end
 
     def safe_download(ds, snapshot, from_snapshot = nil)
       part, full = snapshot_tmp_file(snapshot, from_snapshot)
 
-      if !File.exists?(full)
+      unless File.exist?(full)
         attempts = 0
 
         begin
           SnapshotDownload.new({}, @api).do_exec({
-            snapshot: snapshot.id,
-            from_snapshot: from_snapshot && from_snapshot.id,
-            format: from_snapshot ? :incremental_stream : :stream,
-            file: part,
-            max_rate: @opts[:max_rate],
-            checksum: @opts[:checksum],
-            quiet: @opts[:quiet],
-            resume: true,
-            delete_after: @opts[:delete_after],
-            send_mail: false,
-          })
-
+                                                   snapshot: snapshot.id,
+                                                   from_snapshot: from_snapshot && from_snapshot.id,
+                                                   format: from_snapshot ? :incremental_stream : :stream,
+                                                   file: part,
+                                                   max_rate: @opts[:max_rate],
+                                                   checksum: @opts[:checksum],
+                                                   quiet: @opts[:quiet],
+                                                   resume: true,
+                                                   delete_after: @opts[:delete_after],
+                                                   send_mail: false
+                                                 })
         rescue Errno::ECONNREFUSED,
                Errno::ETIMEDOUT,
                Errno::EHOSTUNREACH,
@@ -318,11 +314,11 @@ END
           attempts += 1
 
           if attempts >= @opts[:attempts]
-            warn "Run out of attempts"
+            warn 'Run out of attempts'
             exit(false)
 
           else
-            warn "Retry in 60 seconds"
+            warn 'Retry in 60 seconds'
             sleep(60)
             retry
           end
@@ -339,15 +335,15 @@ END
     end
 
     def rotate(fs, pretend: false)
-      msg "Rotating snapshots"
-      local_state = pretend ? pretend : parse_tree(fs)
+      msg 'Rotating snapshots'
+      local_state = pretend || parse_tree(fs)
 
       # Order snapshots by date of creation
       snapshots = local_state.values.flatten.sort do |a, b|
         a.creation <=> b.creation
       end
 
-      cnt = local_state.values.inject(0) { |sum, snapshots| sum + snapshots.count }
+      cnt = local_state.values.inject(0) { |sum, local_snapshots| sum + local_snapshots.count }
       deleted = 0
       oldest = Time.now.to_i - (@opts[:max_age] * 60 * 60 * 24)
 
@@ -366,8 +362,8 @@ END
         zfs(:destroy, nil, "#{ds}@#{s.name}", pretend: pretend)
       end
 
-      local_state.each do |hist_id, snapshots|
-        next unless snapshots.empty?
+      local_state.each do |hist_id, local_snapshots|
+        next unless local_snapshots.empty?
 
         ds = "#{fs}/#{hist_id}"
 
@@ -382,15 +378,15 @@ END
       # This is intentionally done by two zfs commands, because -d2 would include
       # nested subdatasets, which should not be there, but the user might create
       # them and it could confuse the program.
-      zfs(:list, '-r -d1 -tfilesystem -H -oname', fs).split("\n")[1..-1].each do |name|
+      zfs(:list, '-r -d1 -tfilesystem -H -oname', fs).split("\n")[1..].each do |name|
         last_name = name.split('/').last
         ret[last_name.to_i] = [] if dataset?(last_name)
       end
 
       zfs(
-          :get,
-          '-Hrp -d2 -tsnapshot -oname,property,value name,creation',
-          fs
+        :get,
+        '-Hrp -d2 -tsnapshot -oname,property,value name,creation',
+        fs
       ).split("\n").each do |line|
         name, property, value = line.split
         ds, snap_name = name.split('@')
@@ -399,7 +395,7 @@ END
 
         hist_id = ds_name.to_i
 
-        if snap = ret[hist_id].detect { |s| s.name == snap_name }
+        if (snap = ret[hist_id].detect { |s| s.name == snap_name })
           snap.send("#{property}=", value)
 
         else
@@ -418,14 +414,15 @@ END
     def read_dataset_id(fs)
       ds_id = zfs(:get, '-H -ovalue cz.vpsfree.vpsadmin:dataset_id', fs).strip
       return nil if ds_id == '-'
+
       @dataset_id = ds_id.to_i
     end
 
     def check_dataset_id!(ds, fs)
-      if @dataset_id && @dataset_id != ds.id
-        warn "Dataset '#{fs}' is used to backup remote dataset with id '#{@dataset_id}', not '#{ds.id}'"
-        exit(false)
-      end
+      return unless @dataset_id && @dataset_id != ds.id
+
+      warn "Dataset '#{fs}' is used to backup remote dataset with id '#{@dataset_id}', not '#{ds.id}'"
+      exit(false)
     end
 
     def written_dataset_id?
@@ -444,13 +441,13 @@ END
 
       pids << Process.fork do
         r.close
-        STDOUT.reopen(w)
+        $stdout.reopen(w)
         block.call
       end
 
       pids << Process.fork do
         w.close
-        STDIN.reopen(r)
+        $stdin.reopen(r)
         Process.exec(cmd2)
       end
 
@@ -500,11 +497,12 @@ END
       ds_map = {}
 
       @api.dataset.index(user: user.id).each do |ds|
-        if vps = vps_map[ds.id]
+        if (vps = vps_map[ds.id])
           puts "(#{i}) VPS ##{vps.id}"
 
         else
           next if vps_only
+
           puts "(#{i}) Dataset #{ds.name}"
         end
 
@@ -513,10 +511,10 @@ END
       end
 
       loop do
-        STDOUT.write('Pick a dataset to backup: ')
-        STDOUT.flush
+        $stdout.write('Pick a dataset to backup: ')
+        $stdout.flush
 
-        i = STDIN.readline.strip.to_i
+        i = $stdin.readline.strip.to_i
         next if i <= 0 || ds_map[i].nil?
 
         return ds_map[i]
@@ -524,12 +522,12 @@ END
     end
 
     def snapshot_tmp_file(s, from_s = nil)
-      if from_s
-        base = ".snapshot_#{from_s.id}-#{s.id}.inc.dat.gz"
+      base = if from_s
+               ".snapshot_#{from_s.id}-#{s.id}.inc.dat.gz"
 
-      else
-        base = ".snapshot_#{s.id}.dat.gz"
-      end
+             else
+               ".snapshot_#{s.id}.dat.gz"
+             end
 
       ["#{base}.part", base]
     end

data/lib/vpsadmin/cli/commands/backup_vps.rb

@@ -22,7 +22,7 @@ module VpsAdmin::CLI::Commands
         super([@api.vps.show(args[0].to_i).dataset_id, args[1]])
 
       else
-        super(args)
+        super
       end
     end
   end

data/lib/vpsadmin/cli/commands/base_download.rb

@@ -7,15 +7,15 @@ module VpsAdmin::CLI::Commands
     end
 
     protected
+
     def find_or_create_dl(opts, do_create = true)
       @api.snapshot_download.index(snapshot: opts[:snapshot]).each do |r|
-        if opts[:from_snapshot] == (r.from_snapshot && r.from_snapshot_id)
-          if r.format != opts[:format].to_s
-            fail "SnapshotDownload id=#{r.id} is in unusable format '#{r.format}' (needs '#{opts[:format]}')"
-          end
-
-          return [r, false]
+        next unless opts[:from_snapshot] == (r.from_snapshot && r.from_snapshot_id)
+        if r.format != opts[:format].to_s
+          raise "SnapshotDownload id=#{r.id} is in unusable format '#{r.format}' (needs '#{opts[:format]}')"
         end
+
+        return [r, false]
       end
 
       if do_create