bup 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a9931bc931a38f83fe2eebebfb5939d997d685fe3bbb7fdf863860dab36c402
-  data.tar.gz: 701c9661de7b80acb3dec18b4ae053aec13cd41e73a4992e8f458f0cfcdaa2ea
+  metadata.gz: 817a27933493ae6ac118d4c6d9def7851bd44151f4bfd8b5ec1293cd485351e8
+  data.tar.gz: b49c3a4cd1dec954a400bee0d9aa7ac5259b19e9bfadc26baa3a479a73d4af89
 SHA512:
-  metadata.gz: 2bb473340913988672050f49f0fa8ecdede02ac622b6a9630d1cd91ea3481c487da20997c313a2ee77c60cfd3a8be305e722a430506ac79c08c53cb705770ea3
-  data.tar.gz: 776de0097acfe0da73daa50ab4943cafab33524508c21d70e670a95c6a89d7de1d0f22de82eba354f27086da69387985a3a962a0a540f8117b0206c4b6de4ff4
+  metadata.gz: '014508ef6bbc01de2eebf734b96173ac0a8c3891ae85ccfd5fd985ed03a3553344331e938bc079777e8ae492155c61abc1f56de6dd0bf8bd6c0212a599579fd7'
+  data.tar.gz: e62b3723768c1f6d948f627c437a175be706344eabaa0ec1bbf4a07116bdae1ad4667a11d279c850d937ab7bdabe7295bcbb537a0f0eaff5fc7e84aaf9b9b348

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 ## [Unreleased]
 
+## [0.7.0] - 2021-11-29
+
+- BUG FIX: Create destination was not being expanded.
+
+## [0.6.0] - 2021-11-29
+
+- Add pre_cmds list to allow executing command before backup, such as dumping a database.
+- Add BUP_DESTINATION that holds the backup destination directory.
+  This may be used to put dumped database files in before a backup and clean 
+  them up with a post_cmd.
+- Refactor the tar.rb file for more simple individual function calls
+  and to do a little less redundant processing.
+- Replaced --type=[full|incremental] with --incremental and --full options.
+
+## [0.5.0] - 2021-11-13
+
+- Allow for a history size of 0.
+- Add default_profile setting.
+
+## [0.4.0] - 2021-11-13
+
+- Bug fix for empty post_cmds list.
+
+## [0.3.0] - 2021-11-13
+
 - Communicate the backup file base name through the environment variable BUP_FILENAME.
 - Rubocop fixes or ignore files.
 - Add post commands, incase you want to default copy something around.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bup (0.3.0)
+    bup (0.6.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,11 +14,13 @@ Create a file ~/.buprc with the default contents...
 
 ```yaml
 ---
+default_profile: default
 profiles:
   default:
     description: Simple backup of critical files.
     include:
     - "$HOME"
+    - /$BUP_DESTINATION/db.dump
     exclude:
     - "$HOME"
     - "$HOME/backups"
@@ -29,9 +31,14 @@ profiles:
     - tar
     - cJvf
     - "${BUP_FILENAME}.tar.xz"
+    pre_cmds:
+    - - dumpdatabase
+      - /$BUP_DESTINATION/db.dump
     post_cmds:
     - - ls
       - $BUP_FILENAME.tar.xz
+    - - rm
+      - /$BUP_DESTINATION/db.dump
 ```
 
 This defines a single profile, "default". You can list
@@ -56,4 +63,4 @@ Before a new backup is run, previous backups are removed. If you run many
 uncompleted backups, you will eventually remove all good backups from your
 backup history. This behavior is desired because backups should nearly always
 succeed and we want to ensure that disk pressure is kep lower than higher.
-Higher disk pressure might cause a backup to fail.
+Higher disk pressure might cause a backup to fail.

data/buprc

@@ -1,4 +1,5 @@
 ---
+default_profile: default
 profiles:
   default:
     description: Simple backup of critical files.

data/exe/bup

@@ -6,6 +6,7 @@ require "optparse"
 
 configfile = File.join(ENV["HOME"], ".buprc")
 config = Bup::Config.new
+profile = nil
 
 OptParse.new do |opt|
   opt.banner = "#{$PROGRAM_NAME} #{Bup::VERSION}"
@@ -15,11 +16,15 @@ OptParse.new do |opt|
   end
 
   opt.on("-p", "--profile=profile", String, "Profile name.") do |p|
-    config.runtime["profile"] = p
+    profile = p
   end
 
-  opt.on("-t", "--type=type", String, "Type of backup.") do |t|
-    config.runtime["type"] = t == "incremental" ? t : "full"
+  opt.on("-i", "--incremental", String, "Set the type of backup to incremental.") do 
+    config.runtime["type"] = "incremental"
+  end
+
+  opt.on("-f", "--full", String, "Set the type of backup to full.") do 
+    config.runtime["type"] = "full"
   end
 
   opt.on("-l", "--list", "List profiles and exit.") do
@@ -29,6 +34,13 @@ end.parse!
 
 config.load(configfile) if File.exist?(configfile)
 
+if profile
+  config.runtime["profile"] = profile
+elsif config.config["default_profile"]
+  config.runtime["profile"] = config.config["default_profile"]
+end
+
+
 case config.runtime["action"]
 when "list"
   config.config["profiles"].each do |key, profile|

data/lib/bup/tar.rb

@@ -32,8 +32,9 @@ module Bup
     end
 
     # Prepare the destination directory.
-    def prepare_destination(profile_name)
-      destination = expand_string(@config.profile(profile_name)["destination"] || ".")
+    def prepare_destination(profile_name, profile)
+      destination = expand_string(profile["destination"] || ".")
+
       type = @config.runtime["type"] || "full"
 
       FileUtils.mkdir_p(destination) unless File.exist?(destination)
@@ -44,68 +45,100 @@ module Bup
 
       history = @config.profile(profile_name)["history"] || 0
 
-      if type == "full" && history.positive?
+      if type == "full" 
+        if history.positive?
+          prune_history(profile_name, destination, filename_base, history)
+        elsif history == 0
+          clear_history(profile_name, destination)
+        end
+      end
 
-        oldest_kept_file = nil
+      ENV["BUP_DESTINATION"] = destination
+      ENV["BUP_FILENAME"] = filename
+      filename
+    end
 
-        # Keep some full backups and remove the others.
-        # We capture the oldest full backup and get rid of preceeding incrementals.
-        Dir["#{destination}/#{filename_base}*"].sort.reverse.each_with_index do |fullbackup, idx|
-          if idx < history
-            oldest_kept_file = fullbackup
-          else
-            File.delete(fullbackup)
-          end
-        end
+    def clear_history(profile_name, destination)
+      Dir["#{destination}/#{profile_name}*"].each do |backup|
+        File.delete(backup)
+      end
+    end
 
-        # Remove all incremental files that are older than the oldest kept full backup.
-        if oldest_kept_file
-          remove_before = File.stat(oldest_kept_file).ctime
-          Dir["#{destination}/#{profile_name}*"].each do |backupfile|
-            File.delete(backupfile) if File.stat(backupfile).ctime < remove_before
-          end
+    def prune_history(profile_name, destination, filename_base, history)
+      oldest_kept_file = nil
+
+      # Keep some full backups and remove the others.
+      # We capture the oldest full backup and get rid of preceeding incrementals.
+      Dir["#{destination}/#{filename_base}*"].sort.reverse.each_with_index do |fullbackup, idx|
+        if idx < history
+          oldest_kept_file = fullbackup
+        else
+          File.delete(fullbackup)
         end
       end
 
-      filename
+      # Remove all incremental files that are older than the oldest kept full backup.
+      if oldest_kept_file
+        remove_before = File.stat(oldest_kept_file).ctime
+        Dir["#{destination}/#{profile_name}*"].each do |backupfile|
+          File.delete(backupfile) if File.stat(backupfile).ctime < remove_before
+        end
+      end
     end
 
+    # Run tar.
     def call(profile_name = nil)
       profile_name ||= @config.runtime["profile"]
       profile = @config.config["profiles"][profile_name]
 
       raise "Missing profile #{profile_name}." unless profile
 
-      args = @config.profile(profile_name)["tarcmd"].dup || ["tar", "cJvf", "${BUP_FILENAME}.tar.xz"]
+      args = profile["tarcmd"].dup || ["tar", "cJvf", "${BUP_FILENAME}.tar.xz"]
 
-      ENV["BUP_FILENAME"] = prepare_destination(profile_name)
+      prepare_destination(profile_name, profile)
 
       if @config.runtime["type"] == "incremental"
         lastrun = @config.lastrun(profile_name)
         args += ["--newer", lastrun.strftime("%Y-%m-%d %H:%M:%S %z")] if lastrun
       end
 
+      run_pre_cmds profile
+
       @config.update_lastrun(profile_name)
 
       tf = build_exclude_file(profile["exclude"] || [])
 
-      args += ["--exclude-from", tf.path]
-      args += (@config.profile(profile_name)["include"] || ["."])
-      args = args.map do |str|
-        expand_string(str)
-      end
-
+      # Build and run tar command.
       begin
+        args += ["--exclude-from", tf.path]
+        args += (profile["include"] || ["."])
+        args = args.map do |str|
+          expand_string(str)
+        end
+
+        # Run tar.
         run_cmd(*args)
       ensure
         tf.unlink
       end
 
-      @config.profile(profile_name)["post_cmds"].each do |args|
+      run_post_cmds profile
+    end
+
+    def run_pre_cmds(profile)
+      # Before we update the last_run, execute any pre_cmds.
+      (profile["pre_cmds"] || []).each do |args|
+        run_cmd(*args.map { |c| expand_string(c) })
+      end
+    end
+
+    def run_post_cmds(profile)
+      (profile["post_cmds"] || []).each do |args|
         run_cmd(*args.map { |c| expand_string(c) })
       end
     end
 
+    # Exec and run a command in a standard way.
     def run_cmd(*args)
       Open3.popen3(*args) do |stdin, stdout, stderr, wait_thr|
         stdin.close

data/lib/bup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bup
-  VERSION = "0.3.0"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bup
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Sam Baskinger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies: []
 description: Backup tool driver that connects tar, gnupg, and other tools to accomplish
   backups.