backupper 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 433774005bc1b3d59b575acf5878d1bb9f202d5f
-  data.tar.gz: 7efb646234fa7392394ce2980728961b13ae196c
+SHA256:
+  metadata.gz: 6732c30468e86071392cbc1545ade2132f75f10fc10a5c5ef603309c1c8778a0
+  data.tar.gz: 6277da7cf00f5ce107dca80ac6a703f94890be3aa0d4c1eb920cd3bb59826b88
 SHA512:
-  metadata.gz: 0f97d4c32a27d19ab7925b6b868acda6325954cfa4870e3a795efd0a96c32930d2ee2258baa95df4fc0ee50aa5a88b9ab4d4d58ad2c9b36e44ed1137c456dbea
-  data.tar.gz: 3439ec0927796ac074a51b51f68d32787c0992622e9dc9c46f38066f55f497bf59a1a15c257d910f5d1411465ecbd84814a530f6f71869cbbd17d6c5965ccaf3
+  metadata.gz: 37f1f3d7417ad9b7603eee7dcedbacd51efa4d9e5c9cf5df795cbedb9638421a9ed3fd02a658bc0e69bbcbcefd0e4ea9ec98b8f6f75e5a8f54be3729da5e8c4d
+  data.tar.gz: 132024ca21163d430a93f864fee2b97411041446955ef1834f2d79b7eaffdc848cc3ec1efa376a053a402f7401082f9d247bb6785b5a24f0385465fa8d8e9df3

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.byebug_history
 /.yardoc
 /_yardoc/
 /coverage/

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in backupper.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    backupper (0.4.2)
+      mail (~> 2.7)
+      sshkit (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.0.1)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.1.2)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    rake (10.5.0)
+    sshkit (1.21.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-18
+
+DEPENDENCIES
+  backupper!
+  bundler
+  byebug
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.3.8

data/README.md

@@ -1,6 +1,6 @@
 # Backupper
 
-Backupper is a tool to backup all your databases spread in the world!
+Backupper is a tool to backup all your databases spread all over the world!
 
 ## Installation
 
@@ -8,7 +8,7 @@ Backupper is a tool to backup all your databases spread in the world!
 
 ## Usage
 
-    $ backupper path/to/config.yml
+    $ backupper path/to/config.yml [options]
 
 ## Configuration file
 
@@ -52,6 +52,12 @@ After done all backups a report email is sent to you using gmail smtp service (r
 
 ⚠️ __WARNING__: the backupper configuration file contains many important passwords, so be careful to lock it and protect it with care!
 
+To backup only specific databases you can pass the option `-o db1,db3`. In this way only databases under the key `db1` and `db3` will be backupped,
+ignoring the others configuration keys.
+
+## Resources
+* [Blog post about Backupper](https://tech.uqido.com/2018/07/16/backupper-tool-backup-database/) (italian only).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/uqido/backupper.
@@ -67,4 +73,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 Backupper is maintained and funded by [Uqido](https://uqido.com).
 The names and logos for Uqido are trademarks of Uqido s.r.l.
 
-The [Uqido team](https://www.uqido.com/en/about-us/).
+The [Uqido team](https://www.uqido.com/en/about-us/).

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/backupper.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'backupper/version'
 
@@ -9,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['pioz']
   spec.email         = ['enrico.pilotto@uqido.com']
 
-  spec.summary       = %q{Tool to backup databases}
-  spec.description   = %q{Backupper is a tool to backup all your databases spread in the world}
+  spec.summary       = 'Tool to backup databases'
+  spec.description   = 'Backupper is a tool to backup all your databases spread all over the world'
   spec.homepage      = 'https://github.com/uqido/backupper'
   spec.license       = 'MIT'
 
@@ -22,16 +21,17 @@ Gem::Specification.new do |spec|
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(/^(test|spec|features)\//)
   end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'sshkit', '~> 1.15'
   spec.add_runtime_dependency 'mail', '~> 2.7'
+  spec.add_runtime_dependency 'sshkit', '~> 1.15'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/bin/backupper

@@ -1,11 +1,34 @@
 #!/usr/bin/env ruby
 
-require 'backupper'
+require 'optparse'
 
-if ARGV.size != 1
-  puts "usage: #{$0} path/to/config.yml"
+require_relative '../lib/backupper'
+
+options = {}
+parser = OptionParser.new do |opts|
+  opts.banner = "usage: #{$PROGRAM_NAME} path/to/config.yml [options]"
+
+  opts.on('-v', 'Print version') do |v|
+    options[:version] = v
+  end
+
+  opts.on('-o', '--only=conf-key1,conf-key2', Array, 'Backup only specific database configurations') do |keys|
+    options[:only] = keys
+  end
+end
+
+begin
+  parser.parse!
+  raise OptionParser::InvalidOption if ARGV.size != 1
+rescue OptionParser::InvalidOption
+  puts parser.banner
   exit 1
 end
 
+if options[:version]
+  puts Backupper::VERSION
+  exit 0
+end
+
 b = Backupper.new(ARGV.first)
-b.backup!
+b.backup!(options[:only])

data/lib/backupper/backupper.rb

@@ -1,17 +1,18 @@
-require 'yaml'
 require 'fileutils'
 require 'sshkit'
 require 'sshkit/dsl'
-require 'backupper/dump_command'
-require 'backupper/mailer'
-include SSHKit::DSL
+require 'yaml'
+
+require_relative 'dump_command'
+require_relative 'mailer'
 
 class Backupper
+  include SSHKit::DSL
 
   SSHKit::Backend::Netssh.configure do |ssh|
     ssh.connection_timeout = 30
     ssh.ssh_options = {
-      auth_methods: %w(publickey password)
+      auth_methods: %w[publickey password]
     }
   end
 
@@ -19,17 +20,20 @@ class Backupper
     conf = YAML.load_file(conf_file_path)
     @default = conf['default'] || {}
     @mailer = conf['mailer'] || {}
-    @conf = conf.select{|k, v| !%w(default mailer).include?(k) && (v['disabled'].nil? || v['disabled'] == false)}
+    @conf = conf.select { |k, v| !%w[default mailer].include?(k) && (v['disabled'].nil? || v['disabled'] == false) }
     @report = {}
+    @logger = SSHKit::Formatter::Pretty.new($stdout)
   end
 
-  def backup!
-    @conf.each do |k, options|
-      puts "⬇️  backing up #{k}..."
+  def backup!(only_these_keys = nil)
+    filtered_conf = @conf
+    filtered_conf = @conf.slice(*only_these_keys) if only_these_keys
+    filtered_conf.each do |k, options|
+      @logger.info "[#{Time.now}] ⬇️  backing up #{k}..."
       o, err = setup_options(options)
       if err
         error(k, err)
-        puts err
+        @logger.error err
         next
       end
       begin
@@ -47,7 +51,7 @@ class Backupper
         )
       rescue SSHKit::Runner::ExecuteError => e
         error(k, e.to_s)
-        puts e
+        @logger.error e
       end
     end
     send_report_email!
@@ -73,58 +77,55 @@ class Backupper
       size: (File.size(path).to_f / 2**20).round(2),
       time: (Process.clock_gettime(Process::CLOCK_MONOTONIC) - t).round(2)
     }
-    @report[key].merge!({extra_copy: File.absolute_path(File.join(extra_copy, dumpname))}) if extra_copy
+    @report[key].merge!({ extra_copy: File.absolute_path(File.join(extra_copy, dumpname)) }) if extra_copy
   end
 
   private
 
-  def setup_options(options)
-    o = @default.merge(options)
-    o['outdir'] = check_dir(o['dump'].to_s)
-    unless o['outdir']
-      return nil, 'Invalid directory where to save database dump'
-    end
-    unless o['database']
-      return nil, 'Please specify the database name!'
-    end
-    unless o['host']
-      return nil, 'Please specify the host!'
-    end
-    o['url'] = o['host']
-    o['url'] = "#{o['username']}@#{o['url']}" if o['username']
-    o['url'] = "#{o['url']}:#{o['port']}" if o['port']
-    o['adapter'] ||= 'mysql'
-    unless DumpCommand.respond_to?(o['adapter'])
-      return nil, "Cannot handle adapter '#{o['adapter']}'"
+    def setup_options(options)
+      o = @default.merge(options)
+      o['outdir'] = check_dir(o['dump'].to_s)
+      return nil, 'Invalid directory where to save database dump' unless o['outdir']
+      return nil, 'Please specify the database name!' unless o['database']
+      return nil, 'Please specify the host!' unless o['host']
+
+      o['url'] = o['host']
+      o['url'] = "#{o['username']}@#{o['url']}" if o['username']
+      o['url'] = "#{o['url']}:#{o['port']}" if o['port']
+      o['adapter'] ||= 'mysql'
+      unless DumpCommand.respond_to?(o['adapter'])
+        return nil, "Cannot handle adapter '#{o['adapter']}'"
+      end
+
+      return o, nil
     end
-    return o, nil
-  end
 
-  def send_report_email!
-    if @report.any? && @mailer['from'] && @mailer['to'] && @mailer['password']
-      begin
-        Mailer.send(from: @mailer['from'], to: @mailer['to'], password: @mailer['password'], report: @report)
-      rescue Net::SMTPAuthenticationError => e
-        puts e
+    def send_report_email!
+      if @report.any? && @mailer['from'] && @mailer['to'] && @mailer['password']
+        begin
+          Mailer.send(from: @mailer['from'], to: @mailer['to'], password: @mailer['password'], report: @report)
+        rescue Net::SMTPAuthenticationError => e
+          @logger.error e
+        end
       end
     end
-  end
 
-  def error(key, error)
-    @report[key] = {error: error}
-  end
+    def error(key, error)
+      @report[key] = { error: error }
+    end
 
-  def check_dir(dirpath)
-    return nil if dirpath.nil?
-    unless File.exists?(dirpath)
-      begin
-        FileUtils::mkdir_p(dirpath)
-      rescue => e
-        return nil
+    def check_dir(dirpath)
+      return nil if dirpath.nil?
+
+      unless File.exist?(dirpath)
+        begin
+          FileUtils.mkdir_p(dirpath)
+        rescue StandardError => _e
+          return nil
+        end
       end
-    end
-    return File.dirname(dirpath) unless File.directory?(dirpath)
-    return dirpath
-  end
+      return File.dirname(dirpath) unless File.directory?(dirpath)
 
-end
+      return dirpath
+    end
+end

data/lib/backupper/dump_command.rb

@@ -1,20 +1,18 @@
 module DumpCommand
-
   def self.mysql(database:, username: 'root', password: nil, dump_options: nil, outfile:)
     params = []
     params << "--databases '#{database}'"
-    params << "-u#{username}"
-    params << "-p#{password}" if password
+    params << "-u'#{username}'"
+    params << "-p'#{password}'" if password
     params << dump_options if dump_options
     return "mysqldump #{params.join(' ')} | bzip2 > '#{outfile}'"
   end
 
   def self.postgresql(database:, username: 'root', password: nil, dump_options: nil, outfile:)
     params = []
-    params << "-U #{username}"
+    params << "-U '#{username}'"
     params << "'#{database}'"
     params << dump_options if dump_options
-    return "PGPASSWORD=#{password} pg_dump #{params.join(' ')} | bzip2 > '#{outfile}'"
+    return "PGPASSWORD='#{password}' pg_dump #{params.join(' ')} | bzip2 > '#{outfile}'"
   end
-
-end
+end

data/lib/backupper/mailer.rb

@@ -1,7 +1,6 @@
 require 'mail'
 
 class Mailer
-
   def self.send(from:, to:, password:, report:)
     options = {
       address:              'smtp.gmail.com',
@@ -14,50 +13,45 @@ class Mailer
     Mail.defaults do
       delivery_method :smtp, options
     end
-    Mail.deliver do
-      to to
-      from from
-      subject Mailer.subject(report)
-      body Mailer.body(report)
-    end
+    Mail.deliver(to: to, from: from, subject: generate_subject(report), body: generate_body(report))
   end
 
-  private
+  class << self
+    private
 
-  def self.body(report)
-    b = []
-    report.each do |k, data|
-      s = ''
-      if data[:error]
-        s << "❌ #{k}\n"
-        s << '=' * 80 << "\n"
-        s << "Backup FAILED!\n"
-        s << "  error: #{data[:error]}\n"
-        b << s
-      else
-        s << "️✅ #{k}\n"
-        s << '=' * 80 << "\n"
-        s << "Backup SUCCESS!\n"
-        s << "  dump size: #{data[:size]} MB\n"
-        s << "  time: #{data[:time]} seconds\n"
-        s << "  dump saved in: #{data[:path]}\n"
-        if data[:extra_copy]
-          s << "  extra copy in: #{data[:extra_copy]}\n"
-        else
-          s << "  no extra copy has been made\n"
+      def generate_body(report)
+        b = []
+        report.each do |k, data|
+          s = ''
+          if data[:error]
+            s << "❌ #{k}\n"
+            s << '=' * 80 << "\n"
+            s << "Backup FAILED!\n"
+            s << "  error: #{data[:error]}\n"
+          else
+            s << "️✅ #{k}\n"
+            s << '=' * 80 << "\n"
+            s << "Backup SUCCESS!\n"
+            s << "  dump size: #{data[:size]} MB\n"
+            s << "  time: #{data[:time]} seconds\n"
+            s << "  dump saved in: #{data[:path]}\n"
+            if data[:extra_copy]
+              s << "  extra copy in: #{data[:extra_copy]}\n"
+            else
+              s << "  no extra copy has been made\n"
+            end
+          end
+          b << s
         end
-        b << s
-      end    
-    end
-    return "Report for backups (#{Time.now})\n\n#{b.join("\n\n")}"
-  end
+        return "Report for backups (#{Time.now})\n\n#{b.join("\n\n")}"
+      end
 
-  def self.subject(report)
-    errors = report.select{|k, v| v[:error]}.size
-    icon = '✅'
-    icon = '⚠️' if errors > 0
-    icon = '❌' if errors == report.size
-    return "[Backupper] #{report.size-errors}/#{report.size} backups successfully completed #{icon}"
+      def generate_subject(report)
+        errors = report.select { |_k, v| v[:error] }.size
+        icon = '✅'
+        icon = '⚠️' if errors > 0
+        icon = '❌' if errors == report.size
+        return "[Backupper] #{report.size - errors}/#{report.size} backups successfully completed #{icon}"
+      end
   end
-
-end
+end

data/lib/backupper/version.rb

@@ -1,3 +1,3 @@
 class Backupper
-  VERSION = '0.3.0'
+  VERSION = '0.4.2'.freeze
 end

data/lib/backupper.rb

@@ -1,2 +1,2 @@
-require 'backupper/backupper'
-require 'backupper/version'
+require_relative 'backupper/backupper'
+require_relative 'backupper/version'

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: backupper
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - pioz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sshkit
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: sshkit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Backupper is a tool to backup all your databases spread in the world
+description: Backupper is a tool to backup all your databases spread all over the
+  world
 email:
 - enrico.pilotto@uqido.com
 executables:
@@ -76,6 +91,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -106,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Tool to backup databases