chef_backup 0.0.1 → 0.1.0

data/lib/chef_backup/runner.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'pathname'
+require "fileutils"
+require "pathname"
 
 module ChefBackup
   # ChefBackup::Runner class initializes the strategy and runs the action
@@ -7,8 +7,6 @@ module ChefBackup
     include ChefBackup::Helpers
     include ChefBackup::Exceptions
 
-    attr_reader :restore_param
-
     #
     # @param running_config [Hash] A hash of the private-chef-running.json
     #   or the CLI args for a restore
@@ -17,7 +15,7 @@ module ChefBackup
     #
     def initialize(running_config)
       ChefBackup::Config.config = running_config
-      ChefBackup::Logger.logger(service_config['backup']['logfile'] || nil)
+      ChefBackup::Logger.logger(service_config["backup"]["logfile"] || nil)
     end
 
     #
@@ -47,7 +45,7 @@ module ChefBackup
     # @return [String] String name of the configured backup strategy
     #
     def backup_strategy
-      service_config['backup']['strategy']
+      service_config["backup"]["strategy"]
     end
 
     #
@@ -55,7 +53,7 @@ module ChefBackup
     #   or a path to a tarball
     #
     def restore_param
-      config['restore_param']
+      config["restore_param"]
     end
 
     #
@@ -65,9 +63,9 @@ module ChefBackup
       @restore_strategy ||= begin
         if tarball?
           unpack_tarball
-          manifest['strategy']
+          manifest["strategy"]
         elsif ebs_snapshot?
-          'ebs'
+          "ebs"
         else
           raise InvalidStrategy, "#{restore_param} is not a valid backup"
         end
@@ -79,7 +77,7 @@ module ChefBackup
     #
     def tarball?
       file = Pathname.new(File.expand_path(restore_param))
-      file.exist? && file.extname == '.tgz'
+      file.exist? && file.extname == ".tgz"
     end
 
     #
@@ -104,7 +102,7 @@ module ChefBackup
     #
     def backup_name
       if tarball?
-        Pathname.new(restore_param).basename.sub_ext('').to_s
+        Pathname.new(restore_param).basename.sub_ext("").to_s
       elsif ebs_snapshot?
         restore_param
       end
@@ -117,7 +115,7 @@ module ChefBackup
     # @return [String] A path to the restore directory
     #
     def restore_directory
-      config['restore_dir'] ||= begin
+      config["restore_dir"] ||= begin
         dir_name = File.join(tmp_dir, backup_name)
         if File.directory?(dir_name)
           # clean restore directory if it exists
@@ -135,7 +133,7 @@ module ChefBackup
     def manifest
       @manifest ||= begin
         file = "#{restore_directory}/manifest.json"
-        ensure_file!(file, InvalidTarball, 'No manifest found in tarball')
+        ensure_file!(file, InvalidTarball, "No manifest found in tarball")
         JSON.parse(File.read(file))
       end
     end

data/lib/chef_backup/strategy.rb

@@ -2,16 +2,16 @@
 #
 # All Rights Reserved
 
-require 'chef_backup/strategy/backup/tar'
-require 'chef_backup/strategy/backup/lvm'
-require 'chef_backup/strategy/backup/ebs'
-require 'chef_backup/strategy/backup/object'
-require 'chef_backup/strategy/backup/custom'
-require 'chef_backup/strategy/restore/tar'
-require 'chef_backup/strategy/restore/lvm'
-require 'chef_backup/strategy/restore/ebs'
-require 'chef_backup/strategy/restore/object'
-require 'chef_backup/strategy/restore/custom'
+require "chef_backup/strategy/backup/tar"
+require "chef_backup/strategy/backup/lvm"
+require "chef_backup/strategy/backup/ebs"
+require "chef_backup/strategy/backup/object"
+require "chef_backup/strategy/backup/custom"
+require "chef_backup/strategy/restore/tar"
+require "chef_backup/strategy/restore/lvm"
+require "chef_backup/strategy/restore/ebs"
+require "chef_backup/strategy/restore/object"
+require "chef_backup/strategy/restore/custom"
 
 module ChefBackup
   # ChefBackup::Strategy factory returns an ChefBackup::Strategy object

data/lib/chef_backup/strategy/backup/custom.rb

@@ -2,6 +2,5 @@
 #   - Verify that backup executable exists and is runnable
 #   - exec script
 class ChefBackup::Strategy::CustomBackup < ChefBackup::Strategy::TarBackup
-  def backup
-  end
+  def backup; end
 end

data/lib/chef_backup/strategy/backup/ebs.rb

@@ -17,12 +17,9 @@ class ChefBackup::Strategy::EbsBackup < ChefBackup::Strategy::TarBackup
     cleanup
   end
 
-  def verify_ebs
-  end
+  def verify_ebs; end
 
-  def take_ebs_snapshot
-  end
+  def take_ebs_snapshot; end
 
-  def copy_opscode_config
-  end
+  def copy_opscode_config; end
 end

data/lib/chef_backup/strategy/backup/lvm.rb

@@ -34,9 +34,7 @@ class ChefBackup::Strategy::LvmBackup < ChefBackup::Strategy::TarBackup
     # warn if vg space is low
   end
 
-  def take_lvm_snapshot
-  end
+  def take_lvm_snapshot; end
 
-  def mount_lvm_snapshot
-  end
+  def mount_lvm_snapshot; end
 end

data/lib/chef_backup/strategy/backup/object.rb

@@ -21,9 +21,7 @@ class ChefBackup::Strategy::ObjectBackup < ChefBackup::Strategy::TarBackup
     cleanup
   end
 
-  def verify_object
-  end
+  def verify_object; end
 
-  def knife_ec_backup
-  end
+  def knife_ec_backup; end
 end

data/lib/chef_backup/strategy/backup/tar.rb

@@ -56,8 +56,7 @@ class TarBackup
     cmd = [chpst,
            "-u #{pg_user}",
            pg_dumpall,
-           "> #{sql_file}"
-          ].join(' ')
+           "> #{sql_file}"].join(' ')
     log "Dumping Postgresql database to #{sql_file}"
     shell_out!(cmd, env: ["PGOPTIONS=#{pg_options}"])
     data_map.services['postgresql']['pg_dump_success'] = true
@@ -85,11 +84,24 @@ class TarBackup
       data_map.add_config(config, "/etc/#{config}")
     end
 
+    populate_versions
+
     # Don't forget the upgrades!
     if service_config.key?('upgrades')
       data_map.add_service('upgrades', service_config['upgrades']['dir'])
     end
 
+    add_ha_services
+  end
+
+  def populate_versions
+    project_names.each do |project|
+      path = File.join(addon_install_dir(project), '/version-manifest.json')
+      data_map.add_version(project, version_from_manifest_file(path))
+    end
+  end
+
+  def add_ha_services
     if ha? && !config_only?
       data_map.add_service('keepalived', service_config['keepalived']['dir'])
       data_map.add_ha_info('provider', service_config['ha']['provider'])
@@ -108,12 +120,12 @@ class TarBackup
     end
   end
 
-  DEFAULT_STATEFUL_SERVICES = %w(rabbitmq
+  DEFAULT_STATEFUL_SERVICES = %w[rabbitmq
                                  opscode-solr4
                                  elasticsearch
                                  redis_lb
                                  postgresql
-                                 bookshelf).freeze
+                                 bookshelf].freeze
 
   def stateful_services
     if service_config.key?('drbd') && service_config['drbd']['enable'] == true
@@ -129,6 +141,10 @@ class TarBackup
     [project_name] + enabled_addons.keys
   end
 
+  def project_names
+    ([project_name] + enabled_addons.keys).uniq
+  end
+
   # The data_map is a working record of all of the data that is backed up.
   def data_map
     @data_map ||= ChefBackup::DataMap.new do |data|
@@ -150,7 +166,7 @@ class TarBackup
     if backend? && !config_only?
       if !online?
         ask_to_go_offline unless offline_permission_granted?
-        stop_chef_server(except: [:keepalived, :postgresql])
+        stop_chef_server(except: %i[keepalived postgresql])
         dump_db
         stop_service(:postgresql)
         stopped = true
@@ -181,7 +197,7 @@ class TarBackup
       Dir["#{tmp_dir}/*"].map { |f| File.basename(f) }.join(' ')
     ].join(' ').strip
 
-    res = shell_out(cmd, cwd: tmp_dir)
+    res = shell_out!(cmd, cwd: tmp_dir)
     res
   end
 
@@ -189,7 +205,7 @@ class TarBackup
     log "Exporting tarball to #{export_dir}"
     cmd = "rsync -chaz #{tmp_dir}/#{export_filename} #{export_dir}/"
 
-    res = shell_out(cmd)
+    res = shell_out!(cmd)
     res
   end
 

data/lib/chef_backup/strategy/restore/tar.rb

@@ -1,7 +1,7 @@
-require 'fileutils'
-require 'pathname'
-require 'forwardable'
-require 'chef/mixin/deep_merge'
+require "fileutils"
+require "pathname"
+require "forwardable"
+require "chef_backup/deep_merge"
 
 # rubocop:disable IndentationWidth
 module ChefBackup
@@ -11,7 +11,7 @@ class TarRestore
   # rubocop:enable IndentationWidth
   include ChefBackup::Helpers
   include ChefBackup::Exceptions
-  include Chef::Mixin::DeepMerge
+  include ChefBackup::Mixin::DeepMerge
   extend Forwardable
 
   attr_accessor :tarball_path
@@ -21,14 +21,16 @@ class TarRestore
 
   def initialize(path)
     @tarball_path = path
-    @log = ChefBackup::Logger.logger(service_config['backup']['logfile'] || nil)
+    @log = ChefBackup::Logger.logger(service_config["backup"]["logfile"] || nil)
   end
 
   def restore
-    log 'Restoring Chef Server from backup'
-    cleanse_chef_server(config['agree_to_cleanse'])
+    log "Restoring Chef Server from backup"
+    return unless check_manifest_version
+
+    cleanse_chef_server(config["agree_to_cleanse"])
     if ha?
-      log 'Performing HA restore - please ensure that keepalived is not running on the standby host'
+      log "Performing HA restore - please ensure that keepalived is not running on the standby host"
       fix_ha_plugins
       check_ha_volume
       touch_drbd_ready
@@ -44,64 +46,63 @@ class TarRestore
     reconfigure_add_ons
     restart_add_ons
     cleanup
-    log 'Restoration Completed!'
+    log "Restoration Completed!"
   end
 
   def manifest
     @manifest ||= begin
-      manifest = File.expand_path(File.join(ChefBackup::Config['restore_dir'],
-                                            'manifest.json'))
+      manifest = File.expand_path(File.join(ChefBackup::Config["restore_dir"],
+        "manifest.json"))
       ensure_file!(manifest, InvalidManifest, "#{manifest} not found")
       JSON.parse(File.read(manifest))
     end
   end
 
   def restore_db_dump?
-    manifest['services']['postgresql']['pg_dump_success'] && !frontend?
+    manifest["services"]["postgresql"]["pg_dump_success"] && !frontend?
   rescue NoMethodError
     false
   end
 
   def import_db
-    start_service('postgresql')
-    sql_file = File.join(ChefBackup::Config['restore_dir'],
-                         "chef_backup-#{manifest['backup_time']}.sql")
+    start_service("postgresql")
+    sql_file = File.join(ChefBackup::Config["restore_dir"],
+      "chef_backup-#{manifest["backup_time"]}.sql")
     ensure_file!(sql_file, InvalidDatabaseDump, "#{sql_file} not found")
 
     cmd = [chpst,
-           "-u #{manifest['services']['postgresql']['username']}",
+           "-u #{manifest["services"]["postgresql"]["username"]}",
            pgsql,
-           "-U #{manifest['services']['postgresql']['username']}",
+           "-U #{manifest["services"]["postgresql"]["username"]}",
            "-d #{database_name}",
-           "< #{sql_file}"
-          ].join(' ')
-    log 'Importing Database dump'
+           "< #{sql_file}"].join(" ")
+    log "Importing Database dump"
     shell_out!(cmd, env: ["PGOPTIONS=#{pg_options}"])
   end
 
   def restore_services
-    manifest.key?('services') && manifest['services'].keys.each do |service|
+    manifest.key?("services") && manifest["services"].keys.each do |service|
       restore_data(:services, service)
     end
   end
 
   def restore_configs
-    manifest.key?('configs') && manifest['configs'].keys.each do |config|
+    manifest.key?("configs") && manifest["configs"].keys.each do |config|
       restore_data(:configs, config)
     end
   end
 
   def touch_sentinel
-    dir = '/var/opt/opscode'
-    sentinel = File.join(dir, 'bootstrapped')
+    dir = "/var/opt/opscode"
+    sentinel = File.join(dir, "bootstrapped")
     FileUtils.mkdir_p(dir) unless File.directory?(dir)
-    File.open(sentinel, 'w') { |file| file.write 'bootstrapped!' }
+    File.open(sentinel, "w") { |file| file.write "bootstrapped!" }
   end
 
   def restore_data(type, name)
-    source = File.expand_path(File.join(config['restore_dir'],
-                                        manifest[type.to_s][name]['data_dir']))
-    destination = manifest[type.to_s][name]['data_dir']
+    source = File.expand_path(File.join(config["restore_dir"],
+      manifest[type.to_s][name]["data_dir"]))
+    destination = manifest[type.to_s][name]["data_dir"]
     FileUtils.mkdir_p(destination) unless File.directory?(destination)
     cmd = "rsync -chaz --delete #{source}/ #{destination}"
     log "Restoring the #{name} data"
@@ -109,22 +110,42 @@ class TarRestore
   end
 
   def backup_name
-    @backup_name ||= Pathname.new(tarball_path).basename.sub_ext('').to_s
+    @backup_name ||= Pathname.new(tarball_path).basename.sub_ext("").to_s
+  end
+
+  def check_manifest_version
+    unless manifest["versions"]
+      log "no version information in manifest"
+      return true
+    end
+
+    manifest["versions"].each_pair do |name, data|
+      installed = version_from_manifest_file(data["path"])
+
+      if installed == :no_version
+        log "Warning: #{name} @ #{data["version"]} not installed"
+      elsif installed["version"] != data["version"]
+        log "package #{name} #{installed["version"]} installed, but backup was"\
+            " from #{data["version"]}. Please install correct version, restore, then upgrade."
+        return false
+      end
+    end
+    true
   end
 
   def fix_ha_plugins
-    log 'Fixing HA plugins directory (https://github.com/chef/chef-server/issues/115)'
-    plugins_dir = '/var/opt/opscode/plugins'
-    drbd_plugin = File.join(plugins_dir, 'chef-ha-drbd.rb')
+    log "Fixing HA plugins directory (https://github.com/chef/chef-server/issues/115)"
+    plugins_dir = "/var/opt/opscode/plugins"
+    drbd_plugin = File.join(plugins_dir, "chef-ha-drbd.rb")
 
     FileUtils.mkdir_p(plugins_dir) unless Dir.exist?(plugins_dir)
-    FileUtils.ln_sf('/opt/opscode/chef-server-plugin.rb', drbd_plugin) unless
+    FileUtils.ln_sf("/opt/opscode/chef-server-plugin.rb", drbd_plugin) unless
       File.exist?(drbd_plugin)
   end
 
   def check_ha_volume
-    log 'Checking that the HA storage volume is mounted'
-    ha_data_dir = manifest['ha']['path']
+    log "Checking that the HA storage volume is mounted"
+    ha_data_dir = manifest["ha"]["path"]
 
     unless ha_data_dir_mounted?(ha_data_dir)
       raise "Please mount the data directory #{ha_data_dir} and perform any DRBD configuration before continuing"
@@ -132,23 +153,28 @@ class TarRestore
   end
 
   def ha_data_dir_mounted?(ha_data_dir)
-    File.read('/proc/mounts').split("\n").grep(/#{ha_data_dir}/).count > 0
+    File.read("/proc/mounts").split("\n").grep(/#{ha_data_dir}/).count > 0
   end
 
   def touch_drbd_ready
-    log 'Touching drbd_ready file'
-    FileUtils.touch('/var/opt/opscode/drbd/drbd_ready') unless
-      File.exist?('/var/opt/opscode/drbd/drbd_ready')
+    log "Touching drbd_ready file"
+    FileUtils.touch("/var/opt/opscode/drbd/drbd_ready") unless
+      File.exist?("/var/opt/opscode/drbd/drbd_ready")
   end
 
   def reconfigure_server
-    log 'Reconfiguring the Chef Server'
+    log "Reconfiguring the Chef Server"
     shell_out("#{ctl_command} reconfigure")
   end
 
   def cleanse_chef_server(agree)
-    log 'Cleaning up any old files'
-    shell_out!("#{ctl_command} cleanse #{agree || ''}")
+    log "Cleaning up any old files"
+    # The chef-server-ctl cleanse command deliberately waits 60 seconds to give
+    # you an option to cancel it.  Therefore, don't count it in the timeout that
+    # the user provided.  If the user has eagerly dismissed that wait period,
+    # then don't elongate the timeout.  The user can do this with the -c flag.
+    timeout = shell_timeout + (agree ? 0 : 60) if shell_timeout
+    shell_out!("#{ctl_command} cleanse #{agree || ""}", "timeout" => timeout)
   end
 
   def running_config