postmodern 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 055d04cc5e601c998c72b53a2fda3604f97841e9
-  data.tar.gz: 4e5467e5fb94f5792501cbcfed2a66e643d4d8b2
+  metadata.gz: 124f924267587d2aab3717d32850512d77af8451
+  data.tar.gz: b5af8d5ad7a974e415498571326bdb39700b0224
 SHA512:
-  metadata.gz: 75a712569b224019786007c756a6d7513b20693ada6bcd0065be09e9a4689e8a71e991a4ee81b0ae57f57dde3357f2361e1ec975c430f9c42b1fae55a9292ed6
-  data.tar.gz: 206c146dc6e605fe26614a469186eff630fbde959f6385feaee93b9cb143b9aa95d4094582c5da3c9f5a56a48e947465bd33a69a7da213f5d1c0f57a923cb04b
+  metadata.gz: 0f7a404c5c59c19dc7c1bb4cfdb55f475727badce1177a04b0d98e8a739f3d42737d3f706d54efb5de3cbc1165e96449a9f7ec71130df5191d5e398c3b72a08e
+  data.tar.gz: dc9a9175c931aabc5ad4446cbf8f8788bc0b25f3cfee9ebf41ef375094436fcad40961b6fa642f1be43fe93cc1da47154c901cae0a2f345674fd984f2083b1d7

data/README.md

@@ -24,6 +24,36 @@ the system's ruby, however that is installed.
 
 ## Usage
 
+### Backup
+
+Backup all databases in a Postgres instance using `pg_basebackup`. This assumes that
+there are no additional tablespaces (see the documentation on
+`pg_basebackup`).
+
+```
+Usage: postmodern backup <options>
+
+Creates a gzipped archive of a pg_basebackup, with file name:
+  NAME.basebackup.CURRENTDATE.tar.gz
+
+    -U, --user USER                  Postgres user (default: "postgres")
+    -d, --directory DIRECTORY        Local directory to put backups (required)
+    -H, --host HOST                  Host of database (eg: fqdn, IP) (required)
+    -p, --port PORT                  Port of database (default: 5432)
+    -n, --name NAME                  Name of backup (required)
+        --pigz CONCURRENCY           Use pigz with concurrency CONCURRENCY
+    -h, --help                       Show this message
+        --version                    Show version
+```
+
+`CURRENTDATE` will be in the format `YYYYMMDD`, and will be the contents of the
+Postgres data directory of the backed-up instance. When restoring from
+these backups, note that it should be untarred directly into a new data
+directory. For instance, if Postgres on the restored hosts is configured
+with a data directory of `/var/pgsql/data94`, then the archive should be
+untarred within `/var/pgsql/data94`, not in the parent directory.
+
+
 ### Vacuuming and Vacuum Freezing
 
 Postmodern's vacuum scripts run table by table, with various constraints

data/lib/postmodern/backup/backup.rb

@@ -0,0 +1,130 @@
+require 'postmodern/command'
+require 'fileutils'
+require 'open3'
+
+module Postmodern
+  module Backup
+    class Backup < Postmodern::Command
+      required_option :directory, :host, :name
+      default_option :user, 'postgres'
+      default_option :port, 5432
+      default_option :pigz, false
+      default_option :concurrency, 4
+
+      def parser
+        @parser ||= OptionParser.new do |opts|
+          opts.banner = 'Usage: postmodern backup <options>'
+
+          opts.separator ''
+          opts.separator 'Creates a gzipped archive of a pg_basebackup, with file name:'
+          opts.separator '  NAME.basebackup.CURRENTDATE.tar.gz'
+          opts.separator ''
+
+          opts.on('-U', '--user USER', 'Postgres user (default: "postgres")') do |o|
+            self.options[:user] = o
+          end
+
+          opts.on('-d', '--directory DIRECTORY', 'Local directory to put backups (required)') do |o|
+            self.options[:directory] = o
+          end
+
+          opts.on('-H', '--host HOST', 'Host of database (eg: fqdn, IP) (required)') do |o|
+            self.options[:host] = o
+          end
+
+          opts.on('-p', '--port PORT', 'Port of database (default: 5432)') do |o|
+            self.options[:port] = o
+          end
+
+          opts.on('-n', '--name NAME', 'Name of backup (required)') do |o|
+            self.options[:name] = o
+          end
+
+          opts.on('--pigz CONCURRENCY', 'Use pigz with concurrency CONCURRENCY') do |o|
+            self.options[:pigz] = true
+            self.options[:concurrency] = o
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+
+          opts.on_tail("--version", "Show version") do
+            require 'postmodern/version'
+            puts Postmodern::VERSION
+            exit
+          end
+        end
+      end
+
+      def run
+        setup_environment
+        run_basebackup
+      end
+
+      private
+
+      # option wrappers
+
+      def directory
+        @options[:directory]
+      end
+
+      def host
+        @options[:host]
+      end
+
+      def name
+        @options[:name]
+      end
+
+      def port
+        @options[:port]
+      end
+
+      def user
+        @options[:user]
+      end
+
+      # backup methods
+
+      def archive_command
+        return 'gzip -9' unless options[:pigz]
+        "pigz -9 -p #{options[:concurrency]}"
+      end
+
+      def archive_file
+        "#{directory}/#{name}.basebackup.#{current_date}.tar.gz"
+      end
+
+      def basebackup_command
+        "pg_basebackup --checkpoint=fast -F tar -D - -U #{user} -h #{host} -p #{port} | #{archive_command} > #{archive_file}"
+      end
+
+      def current_date
+        Time.now.strftime('%Y%m%d')
+      end
+
+      def run_basebackup
+        $stderr.puts "[#{Time.now.utc}] Creating basebackup: #{host}"
+        stdout, stderr, status = Open3.capture3(script_env, basebackup_command)
+        $stdout.print stdout
+        $stderr.print stderr
+        $stderr.puts "[#{Time.now.utc}] Finished basebackup: #{host}"
+        exit status.exitstatus
+      end
+
+      def setup_environment
+        FileUtils.mkdir_p(directory)
+      end
+
+      def script_env
+        {
+          'PATH' => ENV['PATH']
+        }
+      end
+    end
+  end
+end
+

data/lib/postmodern/dummy.rb

@@ -13,6 +13,7 @@ module Postmodern
 
         opts.separator ""
         opts.separator "Available commands:"
+        opts.separator "    backup"
         opts.separator "    archive"
         opts.separator "    restore"
         opts.separator "    vacuum"

data/lib/postmodern/runner.rb

@@ -1,4 +1,5 @@
 require 'postmodern'
+require 'postmodern/backup/backup'
 require 'postmodern/wal/archive'
 require 'postmodern/wal/restore'
 require 'postmodern/vacuum/vacuum'
@@ -11,6 +12,7 @@ module Postmodern
 
     DEFAULT_COMMAND = Dummy
     COMMAND_MAP = {
+      'backup' => Backup::Backup,
       'archive' => WAL::Archive,
       'restore' => WAL::Restore,
       'vacuum' => Vacuum::Vacuum,
@@ -20,7 +22,7 @@ module Postmodern
     def self.run(args)
       command_for(args.first).new(args).run
     end
-    
+
     def self.command_for(command)
       COMMAND_MAP[command] || DEFAULT_COMMAND
     end

data/lib/postmodern/version.rb

@@ -1,3 +1,3 @@
 module Postmodern
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/postmodern/wal/restore.rb

@@ -8,7 +8,7 @@ module Postmodern
       def local_script
         'postmodern_restore.local'
       end
-      
+
       def log
         puts "Restoring file: #{filename}, path: #{path}"
       end

data/spec/features/dummy_spec.rb

@@ -7,6 +7,7 @@ describe 'dummy' do
 Usage: postmodern <command> <options>
 
 Available commands:
+    backup
     archive
     restore
     vacuum

data/spec/postmodern/backup/backup_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'postmodern/backup/backup'
+
+describe Postmodern::Backup::Backup do
+  let(:stdout) { double(to_s: '') }
+  let(:stderr) { double(to_s: '') }
+  let(:status) { double(exitstatus: 0) }
+
+  let(:directory) { '/tmp/pg_backup' }
+  let(:user) { 'pg' }
+  let(:host) { '127.0.0.1' }
+  let(:name) { 'host.com' }
+  let(:port) { 5433 }
+  let(:current_date) { Time.now.strftime('%Y%m%d') }
+  let(:arguments) { %W(--user #{user} --directory #{directory} --host #{host} --name #{name} --port #{port}) }
+
+  subject(:backup) { Postmodern::Backup::Backup.new(arguments) }
+
+  before do
+    allow(Open3).to receive(:capture3).and_return([stdout, stderr, status])
+    allow($stderr).to receive(:puts)
+    allow(backup).to receive(:exit)
+  end
+
+  describe '#run' do
+    let(:backup_command) { "pg_basebackup --checkpoint=fast -F tar -D - -U #{user} -h #{host} -p #{port}" }
+
+    it 'archives the data directory with gzip' do
+      backup.run
+      expect(Open3).to have_received(:capture3).with(
+        {
+          'PATH' => anything
+        },
+        "#{backup_command} | gzip -9 > #{directory}/#{name}.basebackup.#{current_date}.tar.gz"
+      )
+    end
+
+    context 'with --pigz' do
+      let(:arguments) { %W(-U #{user} -d #{directory} -H #{host} -n #{name} -p #{port} --pigz 12) }
+
+      it 'archives the data directory with pigz' do
+        backup.run
+        expect(Open3).to have_received(:capture3).with(
+          {
+            'PATH' => anything
+          },
+          "#{backup_command} | pigz -9 -p 12 > #{directory}/#{name}.basebackup.#{current_date}.tar.gz"
+        )
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmodern
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Eric Saxby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -73,6 +73,7 @@ files:
 - examples/postmodern_archive.local
 - examples/postmodern_restore.local
 - lib/postmodern.rb
+- lib/postmodern/backup/backup.rb
 - lib/postmodern/command.rb
 - lib/postmodern/db/adapter.rb
 - lib/postmodern/dummy.rb
@@ -89,6 +90,7 @@ files:
 - spec/features/restore_spec.rb
 - spec/features/vacuum_spec.rb
 - spec/fixtures/wal/env/postmodern_archive.local
+- spec/postmodern/backup/backup_spec.rb
 - spec/postmodern/command_spec.rb
 - spec/postmodern/db/adapter_spec.rb
 - spec/postmodern/postmodern_spec.rb
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Tools for managing PostgreSQL
@@ -130,6 +132,7 @@ test_files:
 - spec/features/restore_spec.rb
 - spec/features/vacuum_spec.rb
 - spec/fixtures/wal/env/postmodern_archive.local
+- spec/postmodern/backup/backup_spec.rb
 - spec/postmodern/command_spec.rb
 - spec/postmodern/db/adapter_spec.rb
 - spec/postmodern/postmodern_spec.rb