cknife 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14209947e3be6f0beb5fcb80bbc9e6d949d3016e
-  data.tar.gz: 8f252a3c65e2457678ce467a4a423b330d8e078c
+  metadata.gz: 10d313111e83364d913d12d981ccbca713a6d36e
+  data.tar.gz: def05bdb2b133e4d94660097a0b7a9661be2102c
 SHA512:
-  metadata.gz: c72064ad1f12de37de9a12b97d1e354e73e3b72921d171fba04deebd723607b9aa4013cef76cdb1b6ba6aeac6018bd568e55c5e40caf8f16f5b9fa03959acb0a
-  data.tar.gz: 7d0f4b2317cf17885daf81ca3be7d76fc2d7b8a7f385f9d6727c054d48f7340a8fb4006986ca9a039e2a5f5f52574a42b81cd31e47cff67bf92b215a2a85a979
+  metadata.gz: 01a7497e314bcefcdd892afa20fefcf320f48713b561c9ff856e52d983b00c109fe8a40eff9e72d2a3bcc3e625dd10bab95ed9dd6cf91cf059b583a23b2c19d7
+  data.tar.gz: ba94d943c666da16b953e8f2db2614d7f9670fcdb40166d314e127761f17d018b65d10707a696f73ea6c0c1bc26cf1547ec6d3ca9c9b8507e9ce3d11af592ad5

data/README.md

@@ -194,9 +194,13 @@ switched to DNS Simple and don't use this much anymore.
       cknifezerigo help [TASK]         # Describe available tasks or one specific task
       cknifezerigo list                # List available host names.
 
-# Postgre SQL Backups
+# PostgreSQL Backups
 
-This requires the following setup in the configuration:
+This is a wrapper around the PostgreSQL backup and restore command
+line utilities.
+
+It requires the following Rails-style configuration in the
+configuration file:
 
     pg:
       host: localhost
@@ -204,8 +208,8 @@ This requires the following setup in the configuration:
       username: dbuser
       password: dbpassword
 
-Setup Postgres credentials in a Rails-style configuration (in the same
-cknife config file) and you can capture a snapshot of your database.
+Then you can capture a snapshot of your database. You can also restore
+it using this tool.
 
     > bundle exec cknifepg help 
     Tasks:
@@ -215,6 +219,51 @@ cknife config file) and you can capture a snapshot of your database.
       cknifepg restore      # Restore a file. Use the one with the most recent mtime by default. Searches for db*.dump files in the CWD.
       cknifepg sessions     # List active sessions in this database and provide a string suitable for giving to kill for stopping those sessions.
 
+This generates and deletes a `.pgpass` file before and after the
+command line session. Be aware that if this process is interrupted,
+the `.pgpass` file may be left on disk in the CWD.
+
+# MySQL Backups
+
+Like pg, this requires a similar setup in the configuration:
+
+    mysql:
+      host: localhost
+      database: dbname
+      username: dbuser
+      password: dbpassword
+
+Then you can capture a snapshot of your database.
+
+    > bundle exec cknifemysql help 
+    Tasks:
+      cknifemysql capture      # Capture a dump of the database to db(current timestamp).sql.
+      cknifemysql help [TASK]  # Describe available tasks or one specific task
+      cknifemysql restore      # Restore a file. Use the one with the most recent mtime by default. Searches for db*.sql files in the CWD.
+
+Sample output:
+
+    > bundle exec cknifemysql capture 
+    mysqldump --defaults-file=my.cnf -h localhost -P 3306 -u dbuser dbname --add-drop-database --result-file=db20150617125335.sql
+    Captured db20150617125335.sql.
+
+And the accompanying restore, were you to run it immediately afterwards:
+
+    > bundle exec cknifemysql restore 
+    Restore db20150617125335.sql? y
+    Doing restore...
+    mysql --defaults-file=my.cnf -h localhost -P 3306 -u dbuser dbname
+    source db20150617125335.sql;
+    Restored db20150617125335.sql
+
+**Important:** As you can see, a my.cnf is generated and your password
+stored in there. That file is removed when the command is done
+executing.  This keeps your password off of the command line and
+hidden from certain `top` or `ps` invocations by other users who may
+be on the same machine. This rational is taken from the PostgreSQL
+PGPASSFILE documentation. If this command error's-out, you'll be
+warned to remove this file yourself for security purposes.
+
 # Dub
 
 Like du, but sorts your output by size.  This helps you determine
@@ -231,6 +280,34 @@ Options:
 
     -c Enable colorized output. 
 
+# A typical cron script for capturing PostgreSQL backups and uploading them to S3
+
+    #!/bin/bash
+    
+    source "$HOME/.rvm/scripts/rvm";
+
+    rvm use 2.0.0;
+
+    cd path/to/backups/dir/with/cknife/config;
+
+    cknifepg capture;
+
+    cknifeaws upsync backups-bucket . --noprompt --backups-retain --glob="db*.dump";
+
+Which can be used with the following sample [crontab](http://en.wikipedia.org/wiki/Cron#Examples),
+executing once a day at 2am:
+
+    # * * * * *  command to execute
+    # │ │ │ │ │
+    # │ │ │ │ │
+    # │ │ │ │ └───── day of week (0 - 6) (0 to 6 are Sunday to Saturday, or use names; 7 is Sunday, the same as 0)
+    # │ │ │ └────────── month (1 - 12)
+    # │ │ └─────────────── day of month (1 - 31)
+    # │ └──────────────────── hour (0 - 23)
+    # └───────────────────────── min (0 - 59)
+
+    0 2 * * *  path/to/script > /dev/null
+
 
 # Contributing
 

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/bin/cknifemysql

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cknife/cknife_mysql'
+
+CKnife::CKnifeMysql.start

data/cknife.gemspec

@@ -2,19 +2,19 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: cknife 0.1.6 ruby lib
+# stub: cknife 0.1.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cknife"
-  s.version = "0.1.6"
+  s.version = "0.1.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Mike De La Loza"]
-  s.date = "2015-06-06"
+  s.date = "2015-06-17"
   s.description = "Cali Army Knife, a collection of command line tools, especially for popular API services."
   s.email = "mikedll@mikedll.com"
-  s.executables = ["cknifeaws", "cknifedub", "cknifemail", "cknifenowtimestamp", "cknifepg", "cknifewcdir", "cknifezerigo"]
+  s.executables = ["cknifeaws", "cknifedub", "cknifemail", "cknifemysql", "cknifenowtimestamp", "cknifepg", "cknifewcdir", "cknifezerigo"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.md"
@@ -31,13 +31,16 @@ Gem::Specification.new do |s|
     "bin/cknifeaws",
     "bin/cknifedub",
     "bin/cknifemail",
+    "bin/cknifemysql",
     "bin/cknifenowtimestamp",
     "bin/cknifepg",
     "bin/cknifewcdir",
     "bin/cknifezerigo",
     "cknife.gemspec",
     "cknife.yml.sample",
+    "lib/cknife/cknife_mysql.rb",
     "lib/cknife/cknife_pg.rb",
+    "lib/cknife/command_line.rb",
     "lib/cknife/config.rb"
   ]
   s.homepage = "http://github.com/mikedll/cali-army-knife"

data/lib/cknife/cknife_mysql.rb

@@ -0,0 +1,83 @@
+require 'open3'
+require 'thor'
+require 'cknife/config'
+require 'cknife/command_line'
+
+module CKnife
+  class CKnifeMysql < Thor
+
+    no_tasks do
+      def config
+        @config ||= Config
+      end
+
+      def conf
+        @conf ||= {
+          :host      => config['mysql.host'] || "localhost",
+          :port      => config['mysql.port'] || 3306,
+          :database  => config['mysql.database'],
+          :username  => config['mysql.username'],
+          :password  => config['mysql.password']
+        }
+      end
+
+      def connection_options
+        "--defaults-file=#{option_file} -h #{conf[:host]} -P #{conf[:port]} -u #{conf[:username]}"
+      end
+
+      def option_file
+        @option_file ||= "my.cnf"
+      end
+
+      def command_line
+        @command_line ||= CommandLine.new(option_file, "[client]\npassword=\"#{conf[:password]}\"", self)
+      end
+
+    end
+
+    desc "capture", "Capture a dump of the database to db(current timestamp).sql."
+    def capture
+      file_name = "db" + Time.now.strftime("%Y%m%d%H%M%S") + ".sql"
+
+      if File.exists?(file_name)
+        say("File already exists: #{file_name}.", :red)
+      end
+
+      command_line.with_option_file do |c|
+        c.execute "mysqldump #{connection_options} #{conf[:database]} --add-drop-database --result-file=#{file_name}" do
+          say("Captured #{file_name}.")
+        end
+      end
+    end
+
+    desc "restore", "Restore a file. Use the one with the most recent mtime by default. Searches for db*.sql files in the CWD."
+    method_options :filename => nil
+    def restore
+      to_restore = options[:filename] if options[:filename]
+      if to_restore.nil?
+        files = Dir["db*.sql"]
+        with_mtime = files.map { |f| [f, File.mtime(f)] }
+        with_mtime.sort! { |a,b| a.last <=> b.last }
+        files = with_mtime.map(&:first)
+        to_restore = files.last
+      end
+
+      if to_restore.nil?
+        say("No backups file to restore. None given on the command line and none could be found in the CWD.", :red)
+        return
+      else
+        if !yes?("Restore #{to_restore}?", :green)
+          return
+        end
+      end
+
+      command_line.with_option_file do |c|
+        say("Doing restore...")
+
+        c.execute("mysql #{connection_options} #{conf[:database]}", "source #{to_restore};") do
+          say("Restored #{to_restore}")
+        end
+      end
+    end
+  end
+end

data/lib/cknife/command_line.rb

@@ -0,0 +1,62 @@
+module CKnife
+  class CommandLine
+
+    attr_accessor :option_file, :option_file_contents, :thor_output
+
+    def initialize(f, s, o)
+      self.option_file = f
+      self.option_file_contents = s
+      self.thor_output = o
+    end
+
+    def execute(cmd, input = nil)
+      return if !@session_ok
+      puts cmd
+      stdin, stdout, stderr, wait_thread = Open3.popen3(cmd)
+      if input
+        puts input
+        stdin.write input
+        stdin.close
+      end
+      output = stdout.read
+      output += stderr.read
+      $stdout.write output
+      stdout.close
+      stderr.close
+      result = wait_thread.value.to_i
+      @session_ok = @session_ok && (result == 0)
+      yield if @session_ok && block_given?
+      output
+    end
+
+    def with_option_file
+      if @session_live
+        return yield
+      end
+
+      @session_live = true
+      @session_ok = true
+
+      if File.exists?(option_file)
+        thor_output.say("This generates a file named #{option_file}, but one is already on disk. Exiting.")
+        return
+      end
+
+      File.open(option_file, "w", 0600) { |f| f.write option_file_contents }
+
+      result = yield self
+
+      FileUtils.rm(option_file)
+      if File.exists?(option_file)
+        thor_output.say("Failed to remove #{option_file} file. Please remove it for security purposes.")
+      end
+
+      thor_output.say
+      thor_output.say("Command failed.", :red) if !@session_ok
+      @session_live = false
+
+      result
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cknife
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Mike De La Loza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -215,6 +215,7 @@ executables:
 - cknifeaws
 - cknifedub
 - cknifemail
+- cknifemysql
 - cknifenowtimestamp
 - cknifepg
 - cknifewcdir
@@ -235,13 +236,16 @@ files:
 - bin/cknifeaws
 - bin/cknifedub
 - bin/cknifemail
+- bin/cknifemysql
 - bin/cknifenowtimestamp
 - bin/cknifepg
 - bin/cknifewcdir
 - bin/cknifezerigo
 - cknife.gemspec
 - cknife.yml.sample
+- lib/cknife/cknife_mysql.rb
 - lib/cknife/cknife_pg.rb
+- lib/cknife/command_line.rb
 - lib/cknife/config.rb
 homepage: http://github.com/mikedll/cali-army-knife
 licenses: