bareos-restore 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77f4b6e3042c4e2453c5ed4ab9842d62da720b161024298bb0c3394daf2f931
-  data.tar.gz: 127cc098dd8b2002d504fbaa7cb82fcf9c2f8d4970488cff8e2cbf62494b1133
+  metadata.gz: 216f631eff362fc9f5f3a80f434f86bb5353b14fb94165353ab6f9df4c42eca8
+  data.tar.gz: 9b8c4cad97d5756ac529a45de778e99bf680b43956c325b10bfddf39e60862bc
 SHA512:
-  metadata.gz: b8baad71dfec5b5107ff71141e181d22405f87203e7184810b95555d630f3c88bf45fcb3c0b52bcd47cea0156e763100da4a2ce0be878ceef33066d570db2efc
-  data.tar.gz: ff2989fea490a11247003dfebc343226caf305d018889bf24da73da0f04a1f91f56b640419a3eb94db68b22b7a33ba228bee828ab4b934da0f12b27105fa7355
+  metadata.gz: ffca43d03edbb7956862d659ddf7499836a0ce41b0ef07e62b15a3fa0e6a88b920483d897472e2eb4a9db0a8b2a867b2e9f338a613a4ca04548392dd09fbbfda
+  data.tar.gz: cba949d1bf989c36dbbf2002e56840b19a0ba738a91d84b1355bdf4ce910a7f596b2d6512276cad109398f5f436410af974eb79b9cb2d4f2c016a16384ffaea8

data/lib/bareos-restore.rb

@@ -13,9 +13,11 @@ require 'expect'
 require 'time'
 require 'logger'
 
-# Bareos bconsole configuration
+# Path to bconsole
 BCONSOLE_PATH = '/usr/sbin/bconsole'
 
+# Mapping of job status bytes (e.g. "C") to meaningful states (pending/running/failed)
+# and a human-readable text.
 JOBSTATUS = {
   C: {
     text: 'Created, not yet running',
@@ -180,10 +182,25 @@ module BareosRestore
   $logger.level = Logger::INFO
   #$logger.level = Logger::DEBUG
 
-  # Function to run a command in bconsole
-  # Sends input commands to bconsole and captures the output
-  # apilevel=1 -> Text-based output
-  # apilevel=2 -> JSON-based output
+  # Executes a command in the Bacula console (bconsole).
+  # It only supports one-shot commands. If you want to do complex tasks like
+  # restoring files, you need to specify all parameters to make the restore
+  # job start without getting asked further questions. The communication is
+  # not interactive.
+  #
+  # @param command [String] The Bacula console command to execute
+  #
+  # @param apilevel [Integer] The API level (1 for text, 2 for JSON, default: 2)
+  #
+  # @return [String, Hash] Text output for level 1, parsed JSON for level 2
+  #
+  # @example Text output
+  #
+  #   bconsole("status jobid=12345", apilevel: 1) => "…"
+  #
+  # @example JSON output
+  #
+  #   bconsole("status jobid=12345") #=> { "status": "running" }
   def self.bconsole(command, apilevel: 2)
     bconsole_cmd = ".api #{apilevel}\n#{command}\n"
     output = nil
@@ -209,6 +226,11 @@ module BareosRestore
     raise "Error parsing JSON: #{e.message}"
   end
 
+  # Get the Job ID of the last run backup job.
+  #
+  # @param backup_name [String] Name of the backup job.
+  #
+  # @return [Integer] job ID
   def self.latest_jobid(backup_name)
     $logger.info "Getting latest job ID for backup #{backup_name}"
     $logger.info "list jobs job=#{backup_name} jobstatus=T jobtype=B last"
@@ -218,6 +240,11 @@ module BareosRestore
     output['jobs'].first['jobid']
   end
 
+  # Get the log messages of a Bareos job. It uses `get joblog jobid=…` in the background.
+  #
+  # @param job_id [Integer] ID of the backup/restore job
+  #
+  # @return [String] job's log if the job succeeded
   def self.get_joblog(job_id)
     $logger.info "Getting job log for job #{job_id}"
     output = bconsole "list joblog jobid=#{job_id}"
@@ -228,7 +255,15 @@ module BareosRestore
     $logger.info "JOBLOG…\n#{textblock.join("\n")}"
   end
 
-  # Function to initiate restore and wait for job completion
+  # Start a restore job and wait for its completion.
+  #
+  # @param job_id [Integer] ID of the backup job
+  #
+  # @param target_directory [String] Destination directory to restore the files
+  #
+  # @param restore_client [String] Bareos client/file-daemon used to restore the files
+  #
+  # @return [String] job's log if the job succeeded (exits with non-zero code otherwise)
   def self.perform_restore(job_id, restore_dir, bareos_client)
     $logger.info "Gathering Full/Diff/Incr jobs to get a complete restore of Job ID #{job_id}"
     output = bconsole ".bvfs_get_jobids jobid=#{job_id}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bareos-restore
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Christoph Haas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-03 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-filesystem