bup 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9226e1ffb057342aaf45173d2ecaafc78537d19a25db5e25ae8275311e3c46f
-  data.tar.gz: 74a4207d1606adbca58e7f2650a01f3ae422a8c9c752832c1e684faf817fd6a8
+  metadata.gz: 3228f83fe11f72b1e77210809dec6e3d8a4ccbdc849fa756c97f525803e04357
+  data.tar.gz: ea48181ef6b1adb871c2b558a6bfb9bdb50ef364459ec0fc453837d33dc57589
 SHA512:
-  metadata.gz: 6d0c35ab5eb84c7a1a68527fe49e28f1347f6c0e9cc38017aa160ff31f41046afba36674cf5ce42cf6c6f1e30b2bad0c4f62108b54734253a490c21d5e73c8b1
-  data.tar.gz: 835d1ec79c3c4fcd7b42d9632b4e8c649ee41cefcac949fd658d8874d50c25edd7b99768e461e230fe7d0b385997f4a8dd6772d2f4d8d4e6835d603da2f3e448
+  metadata.gz: 106db1b2e171e056b9bf19763f269898a2b5eeea115ce30918353fab95147850d124ffb53bcb64dfd35c46f220c71019ac0de8a3276263f93fc79c39a42a53b6
+  data.tar.gz: 64217767bfc2cbcfe73b7c1963175481cdfa4d8318ee2e2f4f92317bccddb1690244e48666891a78b5aa1d61da8876f90a80c8495850c62a3800619b2a4983d4

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [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.

data/README.md

@@ -20,6 +20,7 @@ profiles:
     description: Simple backup of critical files.
     include:
     - "$HOME"
+    - /$BUP_DESTINATION/db.dump
     exclude:
     - "$HOME"
     - "$HOME/backups"
@@ -30,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
@@ -57,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/exe/bup

@@ -19,8 +19,12 @@ OptParse.new do |opt|
     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

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 = profile["destination"] || "."
+
       type = @config.runtime["type"] || "full"
 
       FileUtils.mkdir_p(destination) unless File.exist?(destination)
@@ -52,6 +53,8 @@ module Bup
         end
       end
 
+      ENV["BUP_DESTINATION"] = destination
+      ENV["BUP_FILENAME"] = filename
       filename
     end
 
@@ -90,32 +93,47 @@ module Bup
 
       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

data/lib/bup/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bup
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.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.