dbcp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dae551f41d7c976a088cafc8ebe340418b9e26ec
+  data.tar.gz: 1210fe47e8461e62afac77a58c238c346020e313
+SHA512:
+  metadata.gz: 88e7b3c91a04ecf258f16cf848aff23a3925653b175cd35ccc0ff1fca586a6ed2b50a1325c463249c3468c0d1f2dc48a0d17638ce67e85742272cbd17dba82cd
+  data.tar.gz: d6adbc1c6773aaf9a6a1748e94c3683ba4f91772022f66172bba177df6d8135959a5406c9f420d7e595dfd79216fe145f95f11129cea6d610f0cb459edd28055

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dbcp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gabe Martin-Dempesy
+
+MIT License
+
+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,66 @@
+# dbcp
+
+[![Build Status](https://travis-ci.org/gabetax/dbcp.svg?branch=master)](https://travis-ci.org/gabetax/dbcp)
+[![Code Climate](https://codeclimate.com/github/gabetax/dbcp.png)](https://codeclimate.com/github/gabetax/dbcp)
+
+Copy Postgres or MySQL databases between application environments.
+
+Setting an employee up to work on a web application for the first time is time consuming. Tools like [Vagrant](http://www.vagrantup.com) have made it easy to get your environment setup, but you still need to get your relational database setup. In rails you can load your `db/schema.rb` and hope that `db/seeds.rb` is well curated, but seldom has enough to let a developer hit the ground running. Working with your production database while developing is extremely convenient. The [parity](http://12factor.net/dev-prod-parity) helps preview database performance. It also makes investigating data-specific bugs much easier. The goal of `dbcp` is to make copying databases between development, staging, and production environments as easy as copying a file on your local disk.
+
+## A word of caution
+
+Depending on your application, your production database may contain sensitive personal information like financial or health data. Give careful consideration to the risks of using production data on staging and development environments, and whether it's acceptable to use a tool like this in your application's workflow.
+
+Treat your production database like a loaded gun. Consider employing some of these safe guards:
+
+- Use a separate account that only has read access.
+- Access a replication "follower" instead of the master.
+- Access a completely separate database that is periodically populated from production, but is updated to use fake values for sensitive information.
+
+## Installation
+
+`dbcp` is a stand-alone utility. To install, just run:
+
+    $ gem install dbcp
+
+You should __not__ need to include dbcp in your `Gemfile`.
+
+## Usage
+
+To copy the production database to the development environment, simply run:
+
+    $ dbcp production development
+
+Environment credentials can be defined in the following providers:
+
+### config/database.yml
+
+Rails defines credentials for its database environments in a file at [`config/database.yml`](https://github.com/rails/rails/blob/master/guides/code/getting_started/config/database.yml). By default this file is generated with only development and test environments, but any additional environments added will be leveraged by `dbcp`. Although this is a rails convention, `dbcp` parses this file outside of any framework, so it will work even if you're using this convention in another framework.
+
+The database export or import can be executed on a remote host over ssh and then copied between environment hosts if you specify the remote host via an `ssh_uri` entry in the database.yml. This is helpful if the database host only allows connections from specific servers.
+
+Example config/database.yml:
+
+```yaml
+staging:
+  adapter:  postgresql
+  database: staging_database
+  username: staging_username
+  password: staging_password
+  ssh_uri:  ssh://deploy@staging.example.com/www/staging.example.com/current
+```
+
+## Roadmap
+
+The following features are pending:
+
+Providers:
+
+- URL passed in as environment
+- capistrano task
+- heroku, inferred from git remotes
+
+Features:
+
+- Reading configuration from a remote config/database.yml
+- Definable per-tool specific options, e.g. to allow pg_dump to provide a table exclusion list

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/dbcp

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'dbcp'
+
+Dbcp::Cli.new.start ARGV

data/dbcp.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbcp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dbcp"
+  spec.version       = Dbcp::VERSION
+  spec.authors       = ["Gabe Martin-Dempesy"]
+  spec.email         = ["gabetax@gmail.com"]
+  spec.description   = %q{Copy SQL databases between application environments}
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/gabetax/dbcp"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", "~> 1.0.2"
+  spec.add_dependency "net-ssh", "~> 2.8.0"
+  spec.add_dependency "net-sftp", "~> 2.1.2"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

data/lib/dbcp/cli.rb

@@ -0,0 +1,53 @@
+module Dbcp
+  class Cli
+    DEFAULT_DESTINATION = 'development'
+
+    def initialize(stdout = $stdout)
+      @logger = Logger.new stdout
+      @logger.formatter = Proc.new do |severity, datetime, progname, msg|
+        "#{datetime}: #{msg}\n"
+      end
+    end
+
+    def start(argv)
+      if argv.length < 1
+        usage
+        exit 1
+      end
+
+      begin
+        source = Environment.find(argv.shift)
+        destination = Environment.find(argv.shift || DEFAULT_DESTINATION)
+
+        if source == destination
+          @logger.fatal "source and destination environments are the same"
+          exit 3
+        end
+
+        if source.database.adapter != destination.database.adapter
+          @logger.fatal "source (#{source.database.adapter}) and destination (#{destination.database.adapter}) environments must be the same database type"
+          exit 4
+        end
+      rescue EnvironmentNotFound => e
+        @logger.fatal e.to_s
+        exit 2
+      end
+
+      @logger.info "exporting #{source.environment_name}..."
+      source_snapshot_file = source.export
+
+      @logger.info "transferring data..."
+      destination_snapshot_file = source_snapshot_file.transfer_to(destination)
+
+      @logger.info "importing #{destination_snapshot_file.path} to #{destination.environment_name}..."
+      destination.import destination_snapshot_file
+
+      source_snapshot_file.delete
+      destination_snapshot_file.delete if source_snapshot_file != destination_snapshot_file
+    end
+
+    def usage
+      @logger.fatal "Usage: #{$0} source_environment [destination_environment || #{DEFAULT_DESTINATION}]"
+    end
+  end
+end

data/lib/dbcp/database.rb

@@ -0,0 +1,32 @@
+module Dbcp
+  class Database
+    class UnsupportedDatabaseAdapter < StandardError; end
+
+    class << self
+      def build(args)
+        klass_for_adapter(args['adapter']).new args
+      end
+
+      def klass_for_adapter(adapter)
+        klass = case adapter
+        when /mysql/
+          MysqlDatabase
+        when /postgres/
+          PostgresDatabase
+        else
+          raise UnsupportedDatabaseAdapter.new("Unsupported database adapter: #{adapter}")
+        end
+      end
+    end
+
+    include Virtus.value_object
+    values do
+      attribute :adapter
+      attribute :database
+      attribute :host, String, default: 'localhost'
+      attribute :socket
+      attribute :username
+      attribute :password
+    end
+  end
+end

data/lib/dbcp/database_snapshot_file.rb

@@ -0,0 +1,40 @@
+module Dbcp
+  class DatabaseSnapshotFile
+    attr_reader :path
+    attr_reader :environment
+
+    def initialize(environment)
+      @environment = environment
+      @path = "/tmp/dbcp_#{Time.now.to_f}"
+    end
+
+    # @return [DatabaseSnapshotFile]
+    def transfer_to(destination_environment)
+      source_host      = environment.execution_host
+      destination_host = destination_environment.execution_host
+
+      return self if source_host.local? && destination_host.local?
+      return self if source_host == destination_host
+
+      destination_snapshot_file = DatabaseSnapshotFile.new(destination_environment)
+
+      if source_host.local? && destination_host.remote?
+        destination_host.upload path, destination_snapshot_file.path
+
+      elsif source_host.remote? && destination_host.local?
+        source_host.download path, destination_snapshot_file.path
+
+      else
+        # both remote
+        source_host.download path, path
+        destination_host.upload path, destination_snapshot_file.path
+      end
+
+      destination_snapshot_file
+    end
+
+    def delete
+      environment.execution_host.execute %W(rm #{path}).shelljoin
+    end
+  end
+end

data/lib/dbcp/databases/mysql_database.rb

@@ -0,0 +1,21 @@
+module Dbcp
+  class MysqlDatabase < Database
+    def export_command(snapshot_file)
+      %W[mysqldump #{socket_or_host} --user=#{username} --password=#{password} --add-drop-table --extended-insert --result-file=#{snapshot_file.path} #{database}].shelljoin
+    end
+
+    def import_command(snapshot_file)
+      %W[mysql #{socket_or_host} --user=#{username} --password=#{password} #{database}].shelljoin + ' < ' + snapshot_file.path.shellescape
+    end
+
+    private
+
+    def socket_or_host
+      if socket
+        "--socket=#{socket}"
+      else
+        "--host=#{host}"
+      end
+    end
+  end
+end

data/lib/dbcp/databases/postgres_database.rb

@@ -0,0 +1,11 @@
+module Dbcp
+  class PostgresDatabase < Database
+    def export_command(snapshot_file)
+      %W[export PGPASSWORD=#{password}].shelljoin + '; ' + %W[pg_dump --host #{host} --username #{username} --file #{snapshot_file.path} --format c #{database}].shelljoin
+    end
+
+    def import_command(snapshot_file)
+      %W[export PGPASSWORD=#{password}].shelljoin + '; ' + %W[pg_restore --host #{host} --username #{username} --clean --dbname #{database} #{snapshot_file.path}].shelljoin
+    end
+  end
+end

data/lib/dbcp/environment.rb

@@ -0,0 +1,39 @@
+module Dbcp
+  class EnvironmentNotFound < StandardError; end
+  class ExecutionError      < StandardError; end
+
+  class Environment
+    ENVIRONMENT_PROVIDERS = [
+      DatabaseYamlEnvironmentProvider.new('config/database.yml')
+    ]
+
+    class << self
+      def find(environment_name)
+        ENVIRONMENT_PROVIDERS.each do |provider|
+          environment = provider.find environment_name
+          return environment if environment
+        end
+
+        raise EnvironmentNotFound.new "Could not locate '#{environment_name}' environment"
+      end
+    end
+
+    # coersion causes issues when assigning rspec doubles
+    include Virtus.value_object(coerce: false)
+    values do
+      attribute :environment_name, String
+      attribute :database,         Database
+      attribute :execution_host,   ExecutionHost
+    end
+
+    def export
+      DatabaseSnapshotFile.new(self).tap do |snapshot_file|
+        execution_host.execute database.export_command(snapshot_file)
+      end
+    end
+
+    def import(snapshot_file)
+      execution_host.execute database.import_command(snapshot_file)
+    end
+  end
+end

data/lib/dbcp/environment_providers/database_yaml_environment_provider.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+
+module Dbcp
+  class DatabaseYamlEnvironmentProvider
+    def initialize(database_yaml_path)
+      @database_yaml_path = database_yaml_path
+    end
+
+    # @return [Environment, nil]
+    def find(environment_name)
+      begin
+        environment_hash = read_file[environment_name]
+        if environment_hash
+          build_environment environment_name, environment_hash
+        else
+          nil
+        end
+      rescue Errno::ENOENT
+        return nil
+      end
+    end
+
+   private
+
+    def read_file
+      YAML.load_file @database_yaml_path
+    end
+
+    def build_environment(environment_name, environment_hash)
+      Environment.new({
+        environment_name: environment_name,
+        database:         Database.build(environment_hash),
+        execution_host:   ExecutionHost.build(environment_hash)
+      })
+    end
+  end
+end

data/lib/dbcp/execution_host.rb

@@ -0,0 +1,21 @@
+module Dbcp
+  class ExecutionHost
+    class << self
+      def build(args)
+        if args['ssh_uri']
+          SshExecutionHost.new_from_uri args['ssh_uri']
+        else
+          LocalExecutionHost.new
+        end
+      end
+    end
+
+  # coersion causes issues when assigning rspec doubles
+  include Virtus.value_object(coerce: false)
+
+  def local?
+    !remote?
+  end
+
+  end
+end

data/lib/dbcp/execution_hosts/local_execution_host.rb

@@ -0,0 +1,17 @@
+module Dbcp
+  class LocalExecutionHost < ExecutionHost
+
+    # Cheap way for == to evaluate to `true` between `LocalExecutionHost` objects
+    values do
+    end
+
+    def remote?
+      false
+    end
+
+    def execute(command)
+      Kernel.system command
+      raise ExecutionError.new "Execution failed with exit code #{$?.exitstatus}. Command was: #{command}" unless $?.success?
+    end
+  end
+end

data/lib/dbcp/execution_hosts/ssh_execution_host.rb

@@ -0,0 +1,80 @@
+require 'net/ssh'
+require 'net/sftp'
+require 'uri'
+
+module Dbcp
+  class SshExecutionHost < ExecutionHost
+
+    class << self
+      def new_from_uri(uri_string)
+        uri = URI.parse uri_string
+        raise URI::InvalidURIError.new "SSH URI must be in form 'ssh://username@example.com/path/to_application_root'. We received: '#{uri_string}'." unless uri.user && uri.host
+        new({
+          host:     uri.host,
+          port:     uri.port,
+          username: uri.user,
+          path:     uri.path
+        })
+      end
+    end
+
+    values do
+      attribute :host
+      attribute :port, Fixnum
+      attribute :username
+      attribute :path
+    end
+
+    def remote?
+      true
+    end
+
+    def execute(command)
+      # http://stackoverflow.com/questions/3386233/how-to-get-exit-status-with-rubys-netssh-library
+      stdout_data = ""
+      stderr_data = ""
+      exitstatus  = nil
+      exit_signal = nil
+
+      Net::SSH.start host, username do |ssh|
+        ssh.open_channel do |channel|
+          channel.exec command do |ch, success|
+            unless success
+              raise ExecutionError.new "Exection over SSH to failed for: (ssh.channel.exec)"
+            end
+            channel.on_data do |ch,data|
+              stdout_data+=data
+            end
+
+            channel.on_extended_data do |ch,type,data|
+              stderr_data+=data
+            end
+
+            channel.on_request("exit-status") do |ch,data|
+              exitstatus = data.read_long
+            end
+
+            channel.on_request("exit-signal") do |ch, data|
+              exit_signal = data.read_long
+            end
+          end
+        end
+        ssh.loop
+      end
+
+      raise ExecutionError.new "Execution failed with exit code #{$?.exitstatus}. Command was: #{command}" if exitstatus > 0
+    end
+
+    def download(source_path, destination_path)
+      Net::SFTP.start host, username do |ssh|
+        return ssh.download! source_path, destination_path
+      end
+    end
+
+    def upload(source_path, destination_path)
+      Net::SFTP.start host, username do |ssh|
+        return ssh.upload! source_path, destination_path
+      end
+    end
+  end
+end

data/lib/dbcp/version.rb

@@ -0,0 +1,3 @@
+module Dbcp
+  VERSION = "0.0.1"
+end

data/lib/dbcp.rb

@@ -0,0 +1,18 @@
+require 'pry'
+
+require 'logger'
+require 'virtus'
+require 'dbcp/cli'
+require 'dbcp/database'
+require 'dbcp/databases/mysql_database'
+require 'dbcp/databases/postgres_database'
+require 'dbcp/environment_providers/database_yaml_environment_provider'
+require 'dbcp/execution_host'
+require 'dbcp/execution_hosts/local_execution_host'
+require 'dbcp/execution_hosts/ssh_execution_host'
+require 'dbcp/environment'
+require 'dbcp/database_snapshot_file'
+require 'dbcp/version'
+
+module Dbcp
+end

data/spec/fixtures/config/database.yml

@@ -0,0 +1,16 @@
+development:
+  adapter: postgresql
+  encoding: unicode
+  database: dev_database
+  pool: 5
+  username: dev_username
+  password: dev_password
+
+staging:
+  adapter: postgresql
+  encoding: unicode
+  database: staging_database
+  pool: 5
+  username: staging_username
+  password: staging_password
+  ssh_uri: ssh://deploy@staging.example.com/www/staging.example.com/current

data/spec/lib/dbcp/cli_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Dbcp::Cli do
+  subject { Dbcp::Cli.new silent_stdout }
+  let(:silent_stdout) { '/dev/null' }
+
+  before { Dir.chdir lib = File.expand_path('../../../fixtures', __FILE__) }
+
+  describe "#start" do
+    context "success" do
+      let(:source)      { double 'Dbcp::Environment', database: double(adapter: 'postgres'), environment_name: 'staging' }
+      let(:destination) { double 'Dbcp::Environment', database: double(adapter: 'postgres'), environment_name: 'development' }
+      let(:source_snapshot_file)      { double 'Dbcp::DatabaseSnapshotFile.new', path: '/tmp/foo', transfer_to: destination_snapshot_file }
+      let(:destination_snapshot_file) { double 'Dbcp::DatabaseSnapshotFile.new', path: '/tmp/bar' }
+
+      before do
+        allow(Dbcp::Environment).to receive(:find).with('staging')     { source }
+        allow(Dbcp::Environment).to receive(:find).with('development') { destination }
+      end
+
+      it "clones the database" do
+        expect(source).to        receive(:export) { source_snapshot_file }
+        expect(destination).to   receive(:import).with(destination_snapshot_file)
+        expect(source_snapshot_file).to      receive(:delete)
+        expect(destination_snapshot_file).to receive(:delete)
+
+        subject.start ['staging']
+      end
+    end
+
+    context "too few arguments" do
+      it "exits" do
+        expect { subject.start [] }.to raise_error(SystemExit)
+      end
+    end
+
+    context "two different database types" do
+      it "exist" do
+        expect { subject.start ['development', 'sqlite'] }.to raise_error(SystemExit)
+      end
+    end
+
+    context "environments are the same" do
+      it "exits" do
+        expect { subject.start ['development', 'development'] }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/lib/dbcp/database_snapshot_file_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Dbcp::DatabaseSnapshotFile do
+  subject { Dbcp::DatabaseSnapshotFile.new environment }
+  let(:environment) { double 'Dbcp::Environment', execution_host: execution_host }
+  let(:execution_host) { double 'Dbcp::ExecutionError' }
+
+  describe "#path" do
+    it "defines a temporary path" do
+      expect(subject.path).to match '/tmp/'
+    end
+  end
+
+  describe "#transfer_to" do
+    let(:environment) { double 'Dbcp::Environment', execution_host: source_host }
+    let(:destination) { double 'Dbcp::Environment', execution_host: dest_host }
+
+    context "both local" do
+      let(:source_host) { Dbcp::LocalExecutionHost.new }
+      let(:dest_host)   { Dbcp::LocalExecutionHost.new }
+      it "does not transfer" do
+        expect(subject.transfer_to destination).to eq subject
+      end
+    end
+
+    context "source local, destination remote" do
+      let(:source_host) { Dbcp::LocalExecutionHost.new }
+      let(:dest_host)   { Dbcp::SshExecutionHost.new }
+      it "uploads to dest host" do
+        expect(dest_host).to receive(:upload)
+        subject.transfer_to destination
+      end
+    end
+
+    context "source remote, destination local" do
+      let(:source_host) { Dbcp::SshExecutionHost.new }
+      let(:dest_host)   { Dbcp::LocalExecutionHost.new }
+      it "downloads from source host" do
+        expect(source_host).to receive(:download)
+        subject.transfer_to destination
+      end
+    end
+
+    context "both remote, SAME" do
+      let(:source_host) { Dbcp::SshExecutionHost.new_from_uri 'ssh://staging_user@staging.example.com:2222/www/staging/current' }
+      let(:dest_host)   { Dbcp::SshExecutionHost.new_from_uri 'ssh://staging_user@staging.example.com:2222/www/staging/current' }
+      it "does not transfer" do
+        expect(subject.transfer_to destination).to eq subject
+      end
+    end
+
+    context "both remote, DIFFERENT" do
+      let(:source_host) { Dbcp::SshExecutionHost.new host: 'prd.example.com' }
+      let(:dest_host)   { Dbcp::SshExecutionHost.new host: 'stg.example.com' }
+      it "downloads from source host" do
+        expect(source_host).to receive(:download)
+        expect(dest_host).to receive(:upload)
+        subject.transfer_to destination
+      end
+    end
+  end
+
+  describe "#delete" do
+    it "has the host execute rm" do
+      expect(execution_host).to receive(:execute) do |command|
+        expect(command).to match 'rm'
+      end
+
+      subject.delete
+    end
+  end
+
+end

data/spec/lib/dbcp/database_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Dbcp::Database do
+  describe ".build" do
+    context "valid type" do
+      specify { expect(Dbcp::Database.build 'adapter' => 'postgresql').to be_a(Dbcp::PostgresDatabase) }
+    end
+
+    context "invalid type" do
+      specify { expect { Dbcp::Database.build 'adapter' => 'invalid'}.to raise_error(Dbcp::Database::UnsupportedDatabaseAdapter) }
+    end
+
+  end
+end

data/spec/lib/dbcp/databases/mysql_database_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Dbcp::MysqlDatabase do
+  subject do
+    Dbcp::MysqlDatabase.new({
+      host: 'local',
+      database: 'my_database',
+      username: 'my_user',
+      password: 'my_password',
+    })
+  end
+
+  let(:snapshot_file) { Dbcp::DatabaseSnapshotFile.new double }
+
+  describe "#export_command" do
+    specify { expect(subject.export_command snapshot_file).to match 'mysqldump' }
+  end
+
+  describe "#import_command" do
+    specify { expect(subject.import_command snapshot_file).to match 'mysql' }
+  end
+end

data/spec/lib/dbcp/databases/postgres_database_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Dbcp::PostgresDatabase do
+  subject do
+    Dbcp::PostgresDatabase.new({
+      host: 'local',
+      database: 'my_database',
+      username: 'my_user',
+      password: 'my_password',
+    })
+  end
+
+  let(:snapshot_file) { Dbcp::DatabaseSnapshotFile.new double }
+
+  describe "#export_command" do
+    specify { expect(subject.export_command snapshot_file).to match 'pg_dump' }
+  end
+
+  describe "#import_command" do
+    specify { expect(subject.import_command snapshot_file).to match 'pg_restore' }
+  end
+end

data/spec/lib/dbcp/environment_providers/database_yaml_environment_provider_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Dbcp::DatabaseYamlEnvironmentProvider do
+  subject { Dbcp::DatabaseYamlEnvironmentProvider.new path }
+  let(:path) { File.expand_path('../../../../fixtures/config/database.yml', __FILE__) }
+
+  describe "#find" do
+    context "when environment exists" do
+      it "returns an environment" do
+        environment = subject.find 'development'
+        expect(environment).to be_a Dbcp::Environment
+        expect(environment.database).to be_a Dbcp::Database
+        expect(environment.environment_name).to  eq 'development'
+        expect(environment.database.adapter).to  eq 'postgresql'
+        expect(environment.database.database).to eq 'dev_database'
+        expect(environment.database.username).to eq 'dev_username'
+        expect(environment.database.password).to eq 'dev_password'
+      end
+
+      context "without ssh_uri" do
+        it "executes on localhost" do
+          environment = subject.find 'development'
+          expect(environment.execution_host).to be_a Dbcp::LocalExecutionHost
+        end
+      end
+
+      context "with ssh_uri" do
+        it "executes on remote host" do
+          environment = subject.find 'staging'
+          expect(environment.execution_host).to be_a Dbcp::SshExecutionHost
+        end
+      end
+    end
+    context "when environment doesn't exist" do
+      specify { expect(subject.find 'does-not-exist').to be_nil }
+    end
+    context "when file doesn't exist" do
+    let(:path) { File.expand_path('../../../../fixtures/config/database-does-not-exist.yml', __FILE__) }
+      specify { expect(subject.find 'development').to be_nil }
+    end
+  end
+end

data/spec/lib/dbcp/environment_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Dbcp::Environment do
+
+  describe ".find" do
+    context "when not found" do
+      specify { expect { Dbcp::Environment.find 'does-not-exist' }.to raise_error(Dbcp::EnvironmentNotFound) }
+    end
+
+    context "when found" do
+      let(:environment) { double }
+      before { allow_any_instance_of(Dbcp::DatabaseYamlEnvironmentProvider).to receive(:find).and_return(environment) }
+      specify { expect(Dbcp::Environment.find 'development').to eq environment }
+    end
+  end
+
+
+  describe "import/export" do
+    subject { Dbcp::Environment.new database: database, execution_host: execution_host }
+    let(:database) { double 'Dbcp::Database', export_command: double, import_command: double }
+    let(:execution_host) { double 'Dbcp::ExecutionHost', execute: nil }
+    # before { allow(Kernel).to receive(:system) }
+
+    describe "#export" do
+      it "executes the database's export command" do
+        subject.export
+        expect(subject.execution_host).to have_received(:execute).with(database.export_command)
+      end
+
+      it "returns the snapshot file" do
+        expect(subject.export).to be_a Dbcp::DatabaseSnapshotFile
+      end
+    end
+
+    describe "#import" do
+      let(:snapshot_file) { double }
+      it "executes the database's import command" do
+        subject.import snapshot_file
+        expect(subject.execution_host).to have_received(:execute).with(database.import_command)
+      end
+    end
+  end
+
+
+end

data/spec/lib/dbcp/execution_host_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Dbcp::ExecutionHost do
+  describe ".build" do
+    context "when ssh information is present" do
+      let(:environment_hash) { { 'ssh_uri' => 'ssh://staging_user@staging.example.com/www/staging/current' } }
+      specify { expect(Dbcp::ExecutionHost.build(environment_hash)).to be_a Dbcp::SshExecutionHost }
+    end
+
+    context "without ssh information" do
+      specify { expect(Dbcp::ExecutionHost.build({})).to be_a Dbcp::LocalExecutionHost }
+    end
+  end
+end

data/spec/lib/dbcp/execution_hosts/local_execution_host_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Dbcp::LocalExecutionHost do
+
+  describe "==" do
+    specify { expect(Dbcp::LocalExecutionHost.new).to eq Dbcp::LocalExecutionHost.new }
+  end
+end

data/spec/lib/dbcp/execution_hosts/ssh_execution_host_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Dbcp::SshExecutionHost do
+  subject { Dbcp::SshExecutionHost.new_from_uri 'ssh://staging_user@staging.example.com:2222/www/staging/current' }
+  describe ".new_from_uri" do
+    context "with valid uri" do
+      specify do
+        host = Dbcp::SshExecutionHost.new_from_uri 'ssh://staging_user@staging.example.com:2222/www/staging/current'
+        expect(host).to be_a Dbcp::SshExecutionHost
+        expect(host.host).to     eq 'staging.example.com'
+        expect(host.port).to     eq 2222
+        expect(host.username).to eq 'staging_user'
+        expect(host.path).to     eq '/www/staging/current'
+      end
+    end
+
+    context "with invalid uri" do
+      specify do
+        expect { Dbcp::SshExecutionHost.new_from_uri 'staging.example.com' }.to raise_error URI::InvalidURIError
+      end
+    end
+  end
+
+  describe "#execute" do
+    # Not sure how to either easily unit test, or securely/portably integration test. Suggested appreciated.
+  end
+
+  describe "#download" do
+    let(:path) { '/tmp/foo' }
+    it "uses ssh" do
+      expect(Net::SFTP).to receive(:start).with('staging.example.com', 'staging_user') { true }
+      subject.download path, path
+    end
+  end
+
+  describe "#upload" do
+    let(:path) { '/tmp/foo' }
+    it "uses SFTP" do
+      expect(Net::SFTP).to receive(:start).with('staging.example.com', 'staging_user') { true }
+      subject.upload path, path
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require_relative '../lib/dbcp'
+
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].sort.each { |f| require f }
+

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: dbcp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gabe Martin-Dempesy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: '0'
+description: Copy SQL databases between application environments
+email:
+- gabetax@gmail.com
+executables:
+- dbcp
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dbcp
+- dbcp.gemspec
+- lib/dbcp.rb
+- lib/dbcp/cli.rb
+- lib/dbcp/database.rb
+- lib/dbcp/database_snapshot_file.rb
+- lib/dbcp/databases/mysql_database.rb
+- lib/dbcp/databases/postgres_database.rb
+- lib/dbcp/environment.rb
+- lib/dbcp/environment_providers/database_yaml_environment_provider.rb
+- lib/dbcp/execution_host.rb
+- lib/dbcp/execution_hosts/local_execution_host.rb
+- lib/dbcp/execution_hosts/ssh_execution_host.rb
+- lib/dbcp/version.rb
+- spec/fixtures/config/database.yml
+- spec/lib/dbcp/cli_spec.rb
+- spec/lib/dbcp/database_snapshot_file_spec.rb
+- spec/lib/dbcp/database_spec.rb
+- spec/lib/dbcp/databases/mysql_database_spec.rb
+- spec/lib/dbcp/databases/postgres_database_spec.rb
+- spec/lib/dbcp/environment_providers/database_yaml_environment_provider_spec.rb
+- spec/lib/dbcp/environment_spec.rb
+- spec/lib/dbcp/execution_host_spec.rb
+- spec/lib/dbcp/execution_hosts/local_execution_host_spec.rb
+- spec/lib/dbcp/execution_hosts/ssh_execution_host_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep
+homepage: https://github.com/gabetax/dbcp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/fixtures/config/database.yml
+- spec/lib/dbcp/cli_spec.rb
+- spec/lib/dbcp/database_snapshot_file_spec.rb
+- spec/lib/dbcp/database_spec.rb
+- spec/lib/dbcp/databases/mysql_database_spec.rb
+- spec/lib/dbcp/databases/postgres_database_spec.rb
+- spec/lib/dbcp/environment_providers/database_yaml_environment_provider_spec.rb
+- spec/lib/dbcp/environment_spec.rb
+- spec/lib/dbcp/execution_host_spec.rb
+- spec/lib/dbcp/execution_hosts/local_execution_host_spec.rb
+- spec/lib/dbcp/execution_hosts/ssh_execution_host_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep