backupii 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db08b57a1783a56efe5583ab413bf42721a5d2c7c5a4567fe523ddc0068e7874
+  data.tar.gz: 4858c38e6c35d3c80429bb8a9311f3f152f632551a80eeebbbc27a8aab6c3087
+SHA512:
+  metadata.gz: 9e2361e3b6afd6cc9e34b766fdd4eb4744b47492b97ce9763efb02ed2f60a89abc2c6c2dda95adf9b26ada65dae2286e6c2f9322feffe95d0bfd7c4ccbc3cb7d
+  data.tar.gz: ee8027246ecb416e99ca09066789b5437a1ff147f29020fe78206e267ffa7389330f374ffc13aca1147b2c900a862c09d451246064c56d6e3dccf2c4844ca71b

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009-2017 Michael van Rooijen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+Backup II
+=========
+
+[![Code Climate](https://codeclimate.com/github/backupii/backupii.svg)](https://codeclimate.com/github/backupii/backupii)
+[![Build Status](https://travis-ci.org/backupii/backupii.svg?branch=master)](https://travis-ci.org/backupii/backupii)
+
+> This project is a fork of the excellent but un-maintained backup gem.
+
+BackupII is a system utility for Linux and Mac OS X, distributed as a
+RubyGem, that allows you to easily perform backup operations. It
+provides an elegant DSL in Ruby for _modeling_ your backups. BackupII
+has built-in support for various databases, storage
+protocols/services, syncers, compressors, encryptors and notifiers
+which you can mix and match. It was built with modularity,
+extensibility and simplicity in mind.
+
+[Installation][] · [Release Notes][] · [Documentation][] · [Issues][] · [Contributing and getting started][]
+
+## Project Status: Forking just started ##
+
+I'm giving a try on taking over the maintenance of this project as I'm
+using it on many infrastructure and overall like it very much.
+
+If you use this project and would like to develop it further, please
+introduce yourself on the [maintainers wanted][Maintainers wanted]
+ticket.
+
+**Copyright (c) 2009-2017 [Michael van Rooijen][]**
+Released under the **MIT** [LICENSE](LICENSE).
+
+[Installation]:  http://backupii.github.io/backupii/v0/installation
+[Release Notes]: http://backupii.github.io/backupii/v0/release-notes
+[Documentation]: http://backupii.github.io/backupii/v0
+[Issues]: https://github.com/backupii/backupii/issues
+[Contributing and getting started]: CONTRIBUTING.md
+[Maintainers wanted]: https://github.com/backupii/backupii/issues/1
+[Michael van Rooijen]: http://github.com/mrrooijen

data/bin/backupii

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require File.expand_path("../lib/backup", __dir__)
+Backup::CLI.start

data/bin/docker_test

@@ -0,0 +1,24 @@
+#!/bin/bash
+set -eu
+
+export BUNDLE_PATH=/tmp/docker/bundle
+export BUNDLE_JOBS=4
+
+case "${1-}" in
+prepare)
+  bundle check || bundle install
+  ;;
+rspec)
+  bundle exec rspec spec
+  ;;
+integration)
+  bundle exec rspec integration/acceptance/
+  ;;
+console)
+  bash
+  ;;
+*)
+  echo "Task not found"
+  exit 1
+  ;;
+esac

data/lib/backup/archive.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Backup
+  class Archive
+    class Error < Backup::Error; end
+
+    include Utilities::Helpers
+    attr_reader :name, :options
+
+    ##
+    # Adds a new Archive to a Backup Model.
+    #
+    #     Backup::Model.new(:my_backup, 'My Backup') do
+    #       archive :my_archive do |archive|
+    #         archive.add 'path/to/archive'
+    #         archive.add '/another/path/to/archive'
+    #         archive.exclude 'path/to/exclude'
+    #         archive.exclude '/another/path/to/exclude'
+    #       end
+    #     end
+    #
+    # All paths added using `add` or `exclude` will be expanded to their
+    # full paths from the root of the filesystem. Files will be added to
+    # the tar archive using these full paths, and their leading `/` will
+    # be preserved (using tar's `-P` option).
+    #
+    #     /path/to/pwd/path/to/archive/...
+    #     /another/path/to/archive/...
+    #
+    # When a `root` path is given, paths to add/exclude are taken as
+    # relative to the `root` path, unless given as absolute paths.
+    #
+    #     Backup::Model.new(:my_backup, 'My Backup') do
+    #       archive :my_archive do |archive|
+    #         archive.root '~/my_data'
+    #         archive.add 'path/to/archive'
+    #         archive.add '/another/path/to/archive'
+    #         archive.exclude 'path/to/exclude'
+    #         archive.exclude '/another/path/to/exclude'
+    #       end
+    #     end
+    #
+    # This directs `tar` to change directories to the `root` path to create
+    # the archive. Unless paths were given as absolute, the paths within the
+    # archive will be relative to the `root` path.
+    #
+    #     path/to/archive/...
+    #     /another/path/to/archive/...
+    #
+    # For absolute paths added to this archive, the leading `/` will be
+    # preserved. Take note that when archives are extracted, leading `/` are
+    # stripped by default, so care must be taken when extracting archives with
+    # mixed relative/absolute paths.
+    def initialize(model, name, &block)
+      @model   = model
+      @name    = name.to_s
+      @options = {
+        sudo: false,
+        root: false,
+        paths: [],
+        excludes: [],
+        tar_options: ""
+      }
+      DSL.new(@options).instance_eval(&block)
+    end
+
+    def perform!
+      Logger.info "Creating Archive '#{name}'..."
+
+      path = File.join(Config.tmp_path, @model.trigger, "archives")
+      FileUtils.mkdir_p(path)
+
+      pipeline = Pipeline.new
+      with_files_from(paths_to_package) do |files_from|
+        pipeline.add(
+          "#{tar_command} #{tar_options} -cPf -#{tar_root} " \
+            "#{paths_to_exclude} #{files_from}",
+          tar_success_codes
+        )
+
+        extension = "tar".dup
+        if @model.compressor
+          @model.compressor.compress_with do |command, ext|
+            pipeline << command
+            extension << ext
+          end
+        end
+
+        pipeline << "#{utility(:cat)} > " \
+          "'#{File.join(path, "#{name}.#{extension}")}'"
+        pipeline.run
+      end
+
+      if pipeline.success?
+        Logger.info "Archive '#{name}' Complete!"
+      else
+        raise Error, "Failed to Create Archive '#{name}'\n" +
+          pipeline.error_messages
+      end
+    end
+
+    private
+
+    def tar_command
+      tar = utility(:tar)
+      options[:sudo] ? "#{utility(:sudo)} -n #{tar}" : tar
+    end
+
+    def tar_root
+      options[:root] ? " -C '#{File.expand_path(options[:root])}'" : ""
+    end
+
+    def paths_to_package
+      options[:paths].map { |path| prepare_path(path) }
+    end
+
+    def with_files_from(paths)
+      tmpfile = Tempfile.new("backup-archive-paths")
+      paths.each { |path| tmpfile.puts path }
+      tmpfile.close
+      yield "-T '#{tmpfile.path}'"
+    ensure
+      tmpfile.delete
+    end
+
+    def paths_to_exclude
+      options[:excludes].map do |path|
+        "--exclude='#{prepare_path(path)}'"
+      end.join(" ")
+    end
+
+    def prepare_path(path)
+      options[:root] ? path : File.expand_path(path)
+    end
+
+    def tar_options
+      args = options[:tar_options]
+      gnu_tar? ? "--ignore-failed-read #{args}".strip : args
+    end
+
+    def tar_success_codes
+      gnu_tar? ? [0, 1] : [0]
+    end
+
+    class DSL
+      def initialize(options)
+        @options = options
+      end
+
+      def use_sudo(val = true)
+        @options[:sudo] = val
+      end
+
+      def root(path)
+        @options[:root] = path
+      end
+
+      def add(path)
+        @options[:paths] << path
+      end
+
+      def exclude(path)
+        @options[:excludes] << path
+      end
+
+      def tar_options(opts)
+        @options[:tar_options] = opts
+      end
+    end
+  end
+end

data/lib/backup/binder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Backup
+  class Binder
+    ##
+    # Creates a new Backup::Notifier::Binder instance. Loops through the
+    # provided Hash to set instance variables
+    def initialize(key_and_values)
+      key_and_values.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    ##
+    # Returns the binding (needs a wrapper method because #binding is a private
+    # method)
+    # rubocop:disable Naming/AccessorMethodName
+    def get_binding
+      binding
+    end
+    # rubocop:enable Naming/AccessorMethodName
+  end
+end

data/lib/backup/cleaner.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Backup
+  module Cleaner
+    class Error < Backup::Error; end
+
+    class << self
+      ##
+      # Logs warnings if any temporary files still exist
+      # from the last time this model/trigger was run,
+      # then removes the files.
+      def prepare(model)
+        messages = []
+
+        packaging_folder = File.join(Config.tmp_path, model.trigger)
+        if File.exist?(packaging_folder)
+          messages << <<-EOS
+            The temporary packaging folder still exists!
+            '#{packaging_folder}'
+            It will now be removed.
+          EOS
+          FileUtils.rm_rf(packaging_folder)
+        end
+
+        package_files = package_files_for(model.trigger)
+        unless package_files.empty?
+          # the chances of the packaging folder AND
+          # the package files existing are practically nil
+          messages << ("-" * 74) unless messages.empty?
+
+          messages << <<-EOS
+            The temporary backup folder '#{Config.tmp_path}'
+            appears to contain the package files from the previous backup!
+            #{package_files.join("\n")}
+            These files will now be removed.
+          EOS
+          package_files.each { |file| FileUtils.rm_f(file) }
+        end
+
+        unless messages.empty?
+          Logger.warn Error.new(<<-EOS)
+            Cleanup Warning
+            #{messages.join("\n")}
+            Please check the log for messages and/or your notifications
+            concerning this backup: '#{model.label} (#{model.trigger})'
+            The temporary files which had to be removed should not have existed.
+          EOS
+        end
+      end
+
+      ##
+      # Remove the temporary folder used during packaging
+      def remove_packaging(model)
+        Logger.info "Cleaning up the temporary files..."
+        FileUtils.rm_rf(File.join(Config.tmp_path, model.trigger))
+      end
+
+      ##
+      # Remove the final package files from tmp_path
+      # Note: 'force' is used, since a Local Storage may *move* these files.
+      def remove_package(package)
+        Logger.info "Cleaning up the package files..."
+        package.filenames.each do |file|
+          FileUtils.rm_f(File.join(Config.tmp_path, file))
+        end
+      end
+
+      ##
+      # Logs warnings if any temporary files still exist
+      # when errors occur during the backup
+      def warnings(model)
+        messages = []
+
+        packaging_folder = File.join(Config.tmp_path, model.trigger)
+        if File.exist?(packaging_folder)
+          messages << <<-EOS
+            The temporary packaging folder still exists!
+            '#{packaging_folder}'
+            This folder may contain completed Archives and/or Database backups.
+          EOS
+        end
+
+        package_files = package_files_for(model.trigger)
+        unless package_files.empty?
+          # the chances of the packaging folder AND
+          # the package files existing are practically nil
+          messages << ("-" * 74) unless messages.empty?
+
+          messages << <<-EOS
+            The temporary backup folder '#{Config.tmp_path}'
+            appears to contain the backup files which were to be stored:
+            #{package_files.join("\n")}
+          EOS
+        end
+
+        unless messages.empty?
+          Logger.warn Error.new(<<-EOS)
+            Cleanup Warning
+            #{messages.join("\n")}
+            Make sure you check these files before the next scheduled backup for
+            '#{model.label} (#{model.trigger})'
+            These files will be removed at that time!
+          EOS
+        end
+      end
+
+      private
+
+      def package_files_for(trigger)
+        Dir[File.join(Config.tmp_path, "#{trigger}.tar{,[.-]*}")]
+      end
+    end
+  end
+end