dbcp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e37c2566e5ac25d166c8fd27df6209e2f83863f1
-  data.tar.gz: 0960077bc0488bd979f3b97b751a940b3e6f11c4
+  metadata.gz: 9c641bd106b4541cdac1d446c797ba2c4ff3f9d5
+  data.tar.gz: 0dccc3c0a43466de4d64091afc3c3abb2ad3a386
 SHA512:
-  metadata.gz: 0d8b2f092e45700399fbfda1e91cdb0c80205ecf9670b07c5b5996d153ddf9570df48c57278a8427e7ec32350d11148356864f3a0c427d74dc462a45b0747ff0
-  data.tar.gz: fdde59cd6bd19e060aefd6a1c5999087ebeab62aa2c08c5f4135fadb320979bffb0e8b514256258fc65767646a990b16ec498bbd686aee5741af50b491d70bec
+  metadata.gz: 2784736ffcbae106f94c4563e720e6812dc103db3edd75918104ccc9ee089db2957fd16371b99fe5f816887403b730ce91dccc0cc7e8be631cc39b96ef37ee4b
+  data.tar.gz: 0de40673b043e993bc02d203f4f73b496afa813bcd0c2369f7edc62196f9d050925882843b00af7e4a85f011c10e221579fd633b214517fa597c1bd7ecd76a33

data/README.md

@@ -74,24 +74,33 @@ You can use a database URI in place of an environment name as follows:
 
     $ dbcp postgres://my_username:my_pass@db.example.com/my_database development
 
+### Capistrano v3
+
+If you deploy your application via Capistrano, `dbcp` will lookup and invoke for a matching task name in your capistrano configuration to read the remote ssh and path information for the primary `:db` server role. It will ssh to that server both to read the remote remote `#{deploy_to}/current/config/database.yml` and execute the database export from.
+
+Example, with `config/deploy/staging.rb`
+
+```ruby
+server 'staging.example.com', user: 'staging', roles: %w{web app db}
+set :deploy_to, '/www/staging.example.com'
+```
+
+and separately defined `development` environment will allow you to run:
+
+    $ cap staging development
+
 ## Roadmap
 
 The following features are pending:
 
 Providers:
 
-- Capistrano task
 - Heroku, environment name inferred from git remotes
 
-Features:
-
-- Definable per-tool specific options, e.g. to allow pg_dump to provide a table exclusion list
-- URI Provider: specify an remote ssh execution host, perhaps using '@@' as a URI separator?
-
 Refactors:
 
 - Handle pg_restore warnings
 - Better logging
 - Better help
 
-[Open an issue](https://github.com/gabetax/dbcp/issues) if there's something else you'd like to see supported.
+Please [open an issue](https://github.com/gabetax/dbcp/issues) or send a pull request if you see a weird error, a database or environment definition you want supported, or anything you want to see improved.

data/dbcp.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |spec|
   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 "capistrano", "~> 3.1"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "codeclimate-test-reporter"
-  spec.add_development_dependency "rake"
+  # Rake 10.2.0 conflicts with `TypeError: no implicit conversion of Rake::Task into String`
+  # https://github.com/capistrano/capistrano/pull/983
+  spec.add_development_dependency "rake", "10.1.1"
   spec.add_development_dependency "pry"
 end

data/lib/dbcp/environment.rb

@@ -5,8 +5,9 @@ module Dbcp
   class Environment
     ENVIRONMENT_PROVIDERS = [
       DatabaseYamlEnvironmentProvider.new('config/database.yml'),
-      UriEnvironmentProvider.new
-    ]
+      UriEnvironmentProvider.new,
+      (Capistrano3EnvironmentProvider.new if defined?(Capistrano3EnvironmentProvider.new))
+    ].compact
 
     class << self
       def find(environment_name)

data/lib/dbcp/environment_providers/capistrano_3_environment_provider.rb

@@ -0,0 +1,64 @@
+begin
+  # Capistrano 3 is built on rake. Capistrano 2 has a totally different API
+  gem 'capistrano', '~> 3.0'
+  require 'capistrano/all'
+
+  module Dbcp
+    class Capistrano3EnvironmentProvider
+      REMOTE_YAML_PATH = 'config/database.yml'
+
+      # @return [Environment, nil]
+      def find(environment_name)
+        task = capistrano_application.lookup environment_name
+        if task
+          build_environment environment_name, task
+        end
+      end
+
+      private
+
+      # Capistrano and rake both use a lot of global state. `load_rakefile`
+      # loads _ONLY_ to the global `Rake.application` instance. If you load
+      # the Capfile twice, the second time comes back empty.
+      def capistrano_application
+        @@capistrano_application ||= load_capistrano_application
+      end
+
+      def load_capistrano_application
+        original_application = Rake.application
+
+        Rake.application = Capistrano::Application.new
+        Rake.application.init
+        Rake.application.load_rakefile
+
+        Rake.application
+      end
+
+
+      def build_environment(environment_name, task)
+        execution_host = execution_host_from_task task
+        Environment.new({
+          environment_name: environment_name,
+          database:         execution_host.remote_database('current/config/database.yml', environment_name),
+          execution_host:   execution_host
+        })
+      end
+
+      def execution_host_from_task(task)
+        task.invoke
+        cap_env = Capistrano::Configuration.env
+        server  = Capistrano::Configuration.env.primary(:db)
+
+        SshExecutionHost.new({
+          host:     server.hostname,
+          port:     server.port,
+          username: server.user,
+          path:     cap_env.fetch(:deploy_to)
+        })
+      end
+    end
+  end
+
+rescue LoadError
+  # Class won't exist. Make sure to check `if defined?(Dbcp::CapistranoEnvironmentProvider)`
+end

data/lib/dbcp/environment_providers/database_yaml_environment_provider.rb

@@ -33,7 +33,7 @@ module Dbcp
         database = Database.build(environment_hash)
       rescue Database::BlankDatabaseDefinition => e
         if execution_host.remote?
-          database = Database.build fetch_remote_environment_hash(execution_host)[environment_name]
+          database = execution_host.remote_database
         else
           raise e
         end
@@ -46,9 +46,5 @@ module Dbcp
       })
     end
 
-    def fetch_remote_environment_hash(execution_host)
-      YAML.load execution_host.download "#{execution_host.path}/#{@database_yaml_path}"
-    end
-
   end
 end

data/lib/dbcp/execution_hosts/ssh_execution_host.rb

@@ -77,5 +77,13 @@ module Dbcp
         return ssh.upload! source_path, destination_path
       end
     end
+
+    def remote_database(database_yaml_path, environment_name)
+      Database.build remote_yaml(database_yaml_path)[environment_name]
+    end
+
+    def remote_yaml(remote_yaml_path)
+      YAML.load download("#{path}/#{remote_yaml_path}")
+    end
   end
 end

data/lib/dbcp/version.rb

@@ -1,3 +1,3 @@
 module Dbcp
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/dbcp.rb

@@ -5,8 +5,9 @@ require 'dbcp/cli'
 require 'dbcp/database'
 require 'dbcp/databases/mysql_database'
 require 'dbcp/databases/postgres_database'
-require 'dbcp/environment_providers/uri_environment_provider'
+require 'dbcp/environment_providers/capistrano_3_environment_provider'
 require 'dbcp/environment_providers/database_yaml_environment_provider'
+require 'dbcp/environment_providers/uri_environment_provider'
 require 'dbcp/execution_host'
 require 'dbcp/execution_hosts/local_execution_host'
 require 'dbcp/execution_hosts/ssh_execution_host'

data/spec/fixtures/Capfile

@@ -0,0 +1,25 @@
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'
+
+# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
+Dir.glob('lib/capistrano/tasks/*.cap').each { |r| import r }

data/spec/fixtures/config/deploy/staging.rb

@@ -0,0 +1,10 @@
+# Simple Role Syntax
+# ==================
+# Supports bulk-adding hosts to roles, the primary
+# server in each group is considered to be the first
+# unless any hosts have the primary property set.
+# Don't declare `role :all`, it's a meta role
+role :app, %w{staging_user@app.example.com}
+role :web, %w{staging_user@web.example.com}
+role :db,  %w{staging_user@db.example.com}
+set :deploy_to, '/www/staging.example.com/current'

data/spec/fixtures/config/deploy.rb

@@ -0,0 +1,58 @@
+# config valid only for Capistrano 3.1
+lock '3.1.0'
+
+set :application, 'my_app_name'
+set :repo_url, 'git@example.com:me/my_repo.git'
+
+# Default branch is :master
+# ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }
+
+# Default deploy_to directory is /var/www/my_app
+# set :deploy_to, '/var/www/my_app'
+
+# Default value for :scm is :git
+# set :scm, :git
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+# Default value for :log_level is :debug
+# set :log_level, :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, %w{config/database.yml}
+
+# Default value for linked_dirs is []
+# set :linked_dirs, %w{bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system}
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+# Default value for keep_releases is 5
+# set :keep_releases, 5
+
+namespace :deploy do
+
+  desc 'Restart application'
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      # Your restart mechanism here, for example:
+      # execute :touch, release_path.join('tmp/restart.txt')
+    end
+  end
+
+  after :publishing, :restart
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      # end
+    end
+  end
+
+end

data/spec/lib/dbcp/cli_spec.rb

@@ -4,9 +4,6 @@ describe Dbcp::Cli do
   subject { Dbcp::Cli.new silent_stdout }
   let(:silent_stdout) { '/dev/null' }
 
-  extend ExecuteInDirectory
-  execute_in_directory(File.expand_path('../../../fixtures', __FILE__))
-
   describe "#start" do
     context "success" do
       let(:source)      { double 'Dbcp::Environment', database: double(adapter: 'postgres'), environment_name: 'staging' }

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

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Dbcp::Capistrano3EnvironmentProvider do
+  subject { Dbcp::Capistrano3EnvironmentProvider.new }
+
+  describe "#find" do
+    context "when task exists" do
+      let(:remote_database) { double 'Database' }
+      it "returns an environment" do
+        allow_any_instance_of(Dbcp::SshExecutionHost).to receive(:remote_database) { remote_database }
+        environment = subject.find 'staging'
+        expect(environment).to be_a Dbcp::Environment
+        expect(environment.environment_name).to  eq 'staging'
+        expect(environment.execution_host).to be_a Dbcp::SshExecutionHost
+        expect(environment.execution_host.host).to eq 'db.example.com'
+        expect(environment.execution_host.username).to eq 'staging_user'
+        expect(environment.execution_host.path).to eq '/www/staging.example.com/current'
+        expect(environment.database).to eq remote_database
+      end
+    end
+
+    context "when task doesn't exist" do
+      specify do
+        expect(subject.find('doesnt-exist')).to be_nil
+      end
+    end
+
+    context "Capfile does't exist" do
+      let(:path) { 'doesnt-exist' }
+      specify do
+        expect(subject.find('production')).to be_nil
+      end
+    end
+  end
+
+
+end

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

@@ -4,9 +4,6 @@ describe Dbcp::DatabaseYamlEnvironmentProvider do
   subject { Dbcp::DatabaseYamlEnvironmentProvider.new path }
   let(:path) { 'config/database.yml' }
 
-  extend ExecuteInDirectory
-  execute_in_directory(File.expand_path('../../../../fixtures', __FILE__))
-
   describe "#find" do
     context "when environment exists" do
       it "returns an environment" do
@@ -37,15 +34,11 @@ describe Dbcp::DatabaseYamlEnvironmentProvider do
       end
 
       context "without database definition, but with ssh_uri" do
-        let(:remote_yaml) { File.read remote_yaml_path }
-        let(:remote_yaml_path) { File.expand_path('../../../../fixtures/config/remote_database.yml', __FILE__) }
+        let(:remote_database) { double 'Dbcp::Database' }
         it "fetches database definition from database.yml on remote host" do
-          allow_any_instance_of(Dbcp::SshExecutionHost).to receive(:download).with('/www/staging.example.com/current/config/database.yml') { remote_yaml }
+          allow_any_instance_of(Dbcp::SshExecutionHost).to receive(:remote_database) { remote_database }
           environment = subject.find 'staging_ssh_only'
-          expect(environment.database).to be_a Dbcp::PostgresDatabase
-          expect(environment.database.database).to eq 'remote_staging_database'
-          expect(environment.database.username).to eq 'remote_staging_username'
-          expect(environment.database.password).to eq 'remote_staging_password'
+          expect(environment.database).to eq remote_database
         end
       end
     end

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

@@ -41,5 +41,23 @@ describe Dbcp::SshExecutionHost do
     end
   end
 
+  context "remote yaml" do
+    let(:local_yaml_path) { File.expand_path('../../../../fixtures/config/remote_database.yml', __FILE__) }
+    before { allow(subject).to receive(:download) { File.read local_yaml_path } }
+
+    describe "#remote_database" do
+      it "downloads and parses the YAML" do
+        database = subject.remote_database 'config/database.yml', 'staging_ssh_only'
+        expect(database).to be_a Dbcp::Database
+        expect(database.database).to eq 'remote_staging_database'
+      end
+    end
+
+    describe "#remote_yaml" do
+      it "downloads and parses the YAML" do
+        expect(subject.remote_yaml 'config/database.yml').to have_key('staging_ssh_only')
+      end
+    end
+  end
 
 end

data/spec/spec_helper.rb

@@ -7,3 +7,6 @@ require_relative '../lib/dbcp'
 
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].sort.each { |f| require f }
 
+RSpec.configure do |config|
+  config.before(:suite) { Dir.chdir File.expand_path('../fixtures', __FILE__) }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbcp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabe Martin-Dempesy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +112,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -145,19 +159,24 @@ files:
 - lib/dbcp/databases/mysql_database.rb
 - lib/dbcp/databases/postgres_database.rb
 - lib/dbcp/environment.rb
+- lib/dbcp/environment_providers/capistrano_3_environment_provider.rb
 - lib/dbcp/environment_providers/database_yaml_environment_provider.rb
 - lib/dbcp/environment_providers/uri_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/Capfile
 - spec/fixtures/config/database.yml
+- spec/fixtures/config/deploy.rb
+- spec/fixtures/config/deploy/staging.rb
 - spec/fixtures/config/remote_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/capistrano_3_environment_provider_spec.rb
 - spec/lib/dbcp/environment_providers/database_yaml_environment_provider_spec.rb
 - spec/lib/dbcp/environment_providers/uri_environment_provider_spec.rb
 - spec/lib/dbcp/environment_spec.rb
@@ -166,7 +185,6 @@ files:
 - spec/lib/dbcp/execution_hosts/ssh_execution_host_spec.rb
 - spec/spec_helper.rb
 - spec/support/.keep
-- spec/support/execute_in_directory.rb
 homepage: https://github.com/gabetax/dbcp
 licenses:
 - MIT
@@ -192,13 +210,17 @@ signing_key:
 specification_version: 4
 summary: ''
 test_files:
+- spec/fixtures/Capfile
 - spec/fixtures/config/database.yml
+- spec/fixtures/config/deploy.rb
+- spec/fixtures/config/deploy/staging.rb
 - spec/fixtures/config/remote_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/capistrano_3_environment_provider_spec.rb
 - spec/lib/dbcp/environment_providers/database_yaml_environment_provider_spec.rb
 - spec/lib/dbcp/environment_providers/uri_environment_provider_spec.rb
 - spec/lib/dbcp/environment_spec.rb
@@ -207,4 +229,3 @@ test_files:
 - spec/lib/dbcp/execution_hosts/ssh_execution_host_spec.rb
 - spec/spec_helper.rb
 - spec/support/.keep
-- spec/support/execute_in_directory.rb

data/spec/support/execute_in_directory.rb

@@ -1,10 +0,0 @@
-module ExecuteInDirectory
-  def execute_in_directory(path)
-    around(:each) do |example|
-      old = Dir.pwd
-      Dir.chdir path
-      example.run
-      Dir.chdir old
-    end
-  end
-end