bareos-restore 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d77f4b6e3042c4e2453c5ed4ab9842d62da720b161024298bb0c3394daf2f931
+  data.tar.gz: 127cc098dd8b2002d504fbaa7cb82fcf9c2f8d4970488cff8e2cbf62494b1133
+SHA512:
+  metadata.gz: b8baad71dfec5b5107ff71141e181d22405f87203e7184810b95555d630f3c88bf45fcb3c0b52bcd47cea0156e763100da4a2ce0be878ceef33066d570db2efc
+  data.tar.gz: ff2989fea490a11247003dfebc343226caf305d018889bf24da73da0f04a1f91f56b640419a3eb94db68b22b7a33ba228bee828ab4b934da0f12b27105fa7355

data/lib/bareos-restore.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+# todo:
+#   - bareos-job abbrechen, wenn SIGINT kommt
+
+# Prerequisites:
+# - apt install ruby-sys-filesystem
+
+require 'open3'
+require 'json'
+require 'pty'
+require 'expect'
+require 'time'
+require 'logger'
+
+# Bareos bconsole configuration
+BCONSOLE_PATH = '/usr/sbin/bconsole'
+
+JOBSTATUS = {
+  C: {
+    text: 'Created, not yet running',
+    pending: true,
+    running: false,
+    failed: false
+  },
+  R: {
+    text: 'Running',
+    pending: false,
+    running: true,
+    failed: false
+  },
+  B: {
+    text: 'Blocked',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  T: {
+    text: 'Completed successfully',
+    pending: false,
+    running: false,
+    failed: false
+  },
+  E: {
+    text: 'Terminated with errors',
+    pending: false,
+    running: false,
+    failed: true
+  },
+  e: {
+    text: 'Non-fatal error',
+    pending: false,
+    running: false,
+    failed: false
+  },
+  f: {
+    text: 'Fatal error',
+    pending: false,
+    running: false,
+    failed: true
+  },
+  D: {
+    text: 'Verify found differences',
+    pending: false,
+    running: false,
+    failed: true
+  },
+  A: {
+    text: 'Cancelled by user',
+    pending: false,
+    running: false,
+    failed: true
+  },
+  I: {
+    text: 'Incomplete job',
+    pending: false,
+    running: false,
+    failed: true
+  },
+  L: {
+    text: 'Comitting data',
+    pending: false,
+    running: true,
+    failed: false
+  },
+  W: {
+    text: 'Terminated with warnings',
+    pending: false,
+    running: false,
+    failed: false
+  },
+  l: {
+    text: 'Doing data despooling',
+    pending: false,
+    running: true,
+    failed: false
+  },
+  q: {
+    text: 'Queued waiting for device',
+    pending: true,
+    running: false,
+    failed: false
+  },
+  F: {
+    text: 'Waiting for client',
+    pending: true,
+    running: false,
+    failed: false
+  },
+  S: {
+    text: 'Waiting for storage daemon',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  m: {
+    text: 'Waiting for new media',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  M: {
+    text: 'Waiting for media mount',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  s: {
+    text: 'Waiting for storage resource',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  j: {
+    text: 'Waiting for job resource',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  c: {
+    text: 'Waiting for client resource',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  d: {
+    text: 'Waiting on maximum jobs',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  t: {
+    text: 'Waiting on start time',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  p: {
+    text: 'Waiting on higher priority jobs',
+    pending: true,
+    running: true,
+    failed: false
+  },
+  i: {
+    text: 'Doing batch insert file records',
+    pending: false,
+    running: true,
+    failed: false
+  },
+  a: {
+    text: 'Despooling attributes',
+    pending: false,
+    running: true,
+    failed: false
+  }
+}.freeze
+
+module BareosRestore
+  $logger = Logger.new(STDOUT)
+  $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
+  def self.bconsole(command, apilevel: 2)
+    bconsole_cmd = ".api #{apilevel}\n#{command}\n"
+    output = nil
+
+    $logger.debug "Running #{bconsole_cmd}"
+
+    IO.popen(BCONSOLE_PATH, 'r+') do |io|
+      io.puts(bconsole_cmd) # Pipe the input to the command
+      io.close_write # Close the write stream to signal EOF
+      output = io.read # Read the output from the command
+    end
+
+    # Get the last block of { … }
+    output = output.scan(/(^{$.+?^})/m).last
+
+    if apilevel == 1
+      output
+    elsif apilevel == 2
+      # Parse from JSON and isolate the result sub-structure
+      JSON.parse(::Regexp.last_match(1))['result']
+    end
+  rescue JSON::ParserError => e
+    raise "Error parsing JSON: #{e.message}"
+  end
+
+  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"
+    output = bconsole "list jobs job=#{backup_name} jobstatus=T jobtype=B last"
+    $logger.debug output.inspect
+    raise "No successful backup job found." unless output['jobs'].length>0
+    output['jobs'].first['jobid']
+  end
+
+  def self.get_joblog(job_id)
+    $logger.info "Getting job log for job #{job_id}"
+    output = bconsole "list joblog jobid=#{job_id}"
+    textblock = []
+    output['joblog'].each do |entry|
+      textblock << "#{entry['time']} #{entry['logtext']}"
+    end
+    $logger.info "JOBLOG…\n#{textblock.join("\n")}"
+  end
+
+  # Function to initiate restore and wait for job completion
+  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}"
+    all_jobs = output['jobids'].map { |x| x['id'] }.join(',')
+
+    $logger.info "These jobs are needed apparently: #{all_jobs}"
+
+    $logger.info 'Initiating restore'
+    output = bconsole "restore client=#{bareos_client} where=#{restore_dir} restorejob=RestoreFiles jobid=#{all_jobs} all done yes"
+
+    restore_job = output['run']['jobid']
+    $logger.info "Restore job queued. ID=#{restore_job}"
+
+    loop do
+      output = bconsole "list jobid=#{restore_job}"
+      $logger.debug output
+      jobstatus = JOBSTATUS[output['jobs'].first['jobstatus'].to_sym]
+      # puts "Status: #{jobstatus}"
+      # $logger.info "Status: #{jobstatus} (#{jobstatus[:text]})"
+
+      if jobstatus[:failed]
+        $logger.error 'Job failed.'
+        get_joblog(restore_job)
+        exit 10
+      elsif jobstatus[:running]
+        $logger.info 'Job running.'
+      elsif jobstatus[:pending]
+        $logger.info 'Job pending.'
+      else
+        $logger.info 'Job finished.'
+        get_joblog(restore_job)
+        break
+      end
+      sleep 5
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: bareos-restore
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Christoph Haas
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sys-filesystem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |2
+      Automatically restore a Bareos Backup. Useful for automated restore tests.
+      This simple module cannot do more than that.
+email: rubygems@christoph-haas.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bareos-restore.rb
+homepage: https://rubygems.org/gems/bareosrestore
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Restore a Bareos backup
+test_files: []