db-clone 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1ab0818f5cf4ec50e0e763f3ec4aba7fed545fa
+  data.tar.gz: 62d920d4cab87adde594c102329469209dc82ed9
+SHA512:
+  metadata.gz: c26ba96324376ce1ce7609643116df1ad2ea6484ba42fd61e085a734b5f8748af0c858ffddb33c08865d463d1ebea2f5e3f0997264cbde6e0ceebbd58de9a03d
+  data.tar.gz: 3d12bba1f9f407419c68a11e3b9f315cdc1fa7e51515646c3a2a5556c94f81d810426915606e63d7cf4985e747246932656d82be9dc787bdb5c69f4edeb0a136

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Sean Huber
+
+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.rdoc

@@ -0,0 +1,3 @@
+= DbSync
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+ require 'bundler/setup'
+rescue LoadError
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/javascripts/db_sync/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/db_sync/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/db_sync/application_controller.rb

@@ -0,0 +1,5 @@
+module DbSync
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/db_sync/application_helper.rb

@@ -0,0 +1,4 @@
+module DbSync
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/db_sync/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>DbSync</title>
+  <%= stylesheet_link_tag    "db_sync/application", media: "all" %>
+  <%= javascript_include_tag "db_sync/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+DbSync::Engine.routes.draw do
+end

data/lib/db_sync.rb

@@ -0,0 +1,27 @@
+require 'colorize'
+require 'db_sync/cmd_builder'
+require 'db_sync/db_selections'
+require 'db_sync/engine'
+
+module DbSync
+  mattr_accessor :config
+
+  def self.sync!( **opts )
+    DbSync.config ||= {}
+    DbSync.config[:ignore_tables] ||= []
+    DbSync.config[:default_source] ||= 'production'
+    DbSync.config[:default_destination] ||= 'development'
+
+    ds = DbSelections.new Rails.root.join('config', 'database.yml')
+    src_dest = if opts[:manual]
+      [:source_prompt, :source_get, :dest_prompt, :dest_get].each{|m| ds.send(m)}
+      ds.selections
+    else
+      ds.selections( use_defaults: true )
+    end
+
+    cb = CmdBuilder.new src_dest
+    puts "\n  Executing: #{cb.get_cmd.light_blue}\n\n"
+    cb.exec!
+  end
+end

data/lib/db_sync/cmd_builder.rb

@@ -0,0 +1,58 @@
+module DbSync
+  class CmdBuilder
+    VALID_DB_KEYS = ['host', 'port', 'username', 'database', 'password']
+    SUPPORTED_DBS = [:mysql, :postgresql]
+
+    def exec!() exec @cmd end
+
+    def initialize( selections )
+      raise(ArgumentError, 'Both source and destination must be set') unless selections[:src] && selections[:dest]
+      raise(ArgumentError, 'Source and destination databases must be of the same type') unless selections[:src]['adapter'] == selections[:dest]['adapter']
+      SUPPORTED_DBS.each{|db| @db_type = db if selections[:src]['adapter'].include?(db.to_s)}
+      raise(ArgumentError, "Unsupported database: #{selections[:src]['adapter']}") unless @db_type
+      src_dest = selections.map{|k,v| [k,v.delete_if{|i,j| !VALID_DB_KEYS.include?(i)}]}.to_h
+      @cmd = send("build_#{@db_type}_cmd", src_dest)
+    end
+
+    def get_cmd() @cmd end
+
+    private
+
+    def build_mysql_cmd( src_dest )
+      mysqldump_args = [
+        "mysqldump --no-create-db --add-drop-table --lock-tables=false",
+        "--user=#{src_dest[:src]['username']}",
+        "--password=#{src_dest[:src]['password']}",
+        "--host=#{src_dest[:src]['host']}",
+        "--port=#{src_dest[:src]['port']}"
+      ]
+
+      DbSync.config[:ignore_tables].each{|tbl| mysqldump_args << "--ignore-table=#{src_dest[:dest]['database']}.#{tbl}"} if DbSync.config && DbSync.config[:ignore_tables].is_a?(Array)
+
+      (mysqldump_args + [
+        "#{src_dest[:src]['database']}",
+        "| mysql",
+        "--user=#{src_dest[:dest]['username']}",
+        "--password=#{src_dest[:dest]['password']}",
+        "--host=#{src_dest[:dest]['host']}",
+        "--port=#{src_dest[:dest]['port']}",
+        "#{src_dest[:dest]['database']}"
+      ]).join(' ')
+    end
+
+    def build_postgresql_cmd( src_dest )
+      [
+        "pg_dump --no-password --clean",
+        "--host=#{src_dest[:src]['host']}",
+        "--port=#{src_dest[:src]['port']}",
+        "--username=#{src_dest[:src]['username']}",
+        "#{src_dest[:src]['database']}",
+        "| psql",
+        "--host=#{src_dest[:dest]['host']}",
+        "--port=#{src_dest[:dest]['port']}",
+        "--username=#{src_dest[:dest]['username']}",
+        "#{src_dest[:dest]['database']}"
+      ].join(' ')
+    end
+  end
+end

data/lib/db_sync/db_selections.rb

@@ -0,0 +1,65 @@
+require 'yaml'
+
+module DbSync
+  class DbSelections
+    # read database blocks from config/database.yml
+    def initialize( database_yml )
+      h = YAML.load_file database_yml
+      @dbs = h.sort_by{|k,v| k}.map{|k,v| v.merge(label: k)}
+      @default_src_idx = @dbs.find_index{|db| db[:label] == DbSync.config[:default_source]}
+      @default_dest_idx = @dbs.find_index{|db| db[:label] == DbSync.config[:default_destination]}
+      @selections = {src: nil, dest: nil}
+    end
+
+    # STEP 1: prompt user for which database block to use as the source
+    def source_prompt
+      db_prompt 'source'
+    end
+
+    # STEP 2: retrieve from use which database block to use as the source
+    def source_get
+      db_select 'source'
+    end
+
+    # STEP 3: prompt user for which database block to use as the destination
+    def dest_prompt
+      db_prompt 'destination'
+    end
+
+    # STEP 4: retrieve from use which database block to use as the destination
+    def dest_get
+      db_select 'destination'
+    end
+
+    def selections( **opts )
+      opts[:use_defaults] ? {src: @dbs[@default_src_idx], dest: @dbs[@default_dest_idx]} : @selections.map{|k,v| [k, v.nil? ? nil : @dbs[v]] }.to_h
+    end
+
+    private
+
+    def db_prompt( src_dest )
+      num_dbs = @dbs.length
+      puts "\n  Choose a #{src_dest.magenta} database from one of the blocks defined in #{'config/database.yml'.light_green}:\n\n"
+      @dbs.each_with_index do |db, idx|
+        if src_dest == 'destination' && idx == @selections[:src]
+          puts "    [ #{"#{'X'.ljust(num_dbs.to_s.length).red}"} ] #{db[:label].red}"
+        else
+          puts "    [ #{"#{(idx+1).to_s.ljust(num_dbs.to_s.length).light_blue}"} ] #{db[:label].yellow}"
+        end
+      end
+      default = src_dest=='source' ? "#{@dbs[@default_src_idx][:label]} = #{(@default_src_idx+1).to_s.light_blue}" : "#{@dbs[@default_dest_idx][:label]} = #{(@default_dest_idx+1).to_s.light_blue}"
+      print "\n  Choose a #{src_dest.magenta} database (#{'1'.light_blue}-#{num_dbs.to_s.light_blue}) [#{default}]: "
+    end
+
+    def db_select( src_dest )
+      sk = src_dest=='source' ? :src : :dest
+      idx = STDIN.gets.chomp
+      idx = ((src_dest=='source' ? @default_src_idx : @default_dest_idx)+1).to_s if idx == ''
+      raise(ArgumentError, "Invalid selection: #{src_idx}") unless (1..@dbs.length).map(&:to_s).include?(idx)
+      @selections[sk] = idx.to_i - 1
+      raise(ArgumentError, 'Destination cannot be the same as the source') unless @selections.values.uniq.length == 2
+      raise(ArgumentError, 'Source and destination databases must be of the same type') if src_dest=='destination' && @dbs[@selections[:src]]['adapter'] != @dbs[@selections[:dest]]['adapter']
+      puts "\n  #{src_dest.capitalize.magenta} set to: #{@dbs[@selections[sk]][:label].yellow}"
+    end
+  end
+end

data/lib/db_sync/engine.rb

@@ -0,0 +1,12 @@
+module DbSync
+  class Engine < ::Rails::Engine
+    isolate_namespace DbSync
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/db_sync/version.rb

@@ -0,0 +1,3 @@
+module DbSync
+  VERSION = '1.0.0'
+end

data/lib/tasks/db_sync_tasks.rake

@@ -0,0 +1,6 @@
+namespace :db do
+  desc 'syncs a source database to a destination database'
+  task :sync, [:manual] => :environment do |t, args|
+    DbSync.sync! manual: args[:manual].present?
+  end
+end

data/spec/cmd_builder_spec.rb

@@ -0,0 +1,73 @@
+require 'rails_helper'
+
+module DbSync
+  describe CmdBuilder do
+    describe 'postgresql command builder' do
+      h = {
+        src: {
+          'adapter'  => 'postgresql',
+          'encoding' => 'unicode',
+          'database' => 'other_postgresql_db',
+          'username' => 'other_postgresql_user',
+          'password' => 'other_postgresql_password',
+          'host'     => 'fake_postgresql_host',
+          'port'     => 5432,
+          :label     => 'second_test_postgresql'
+        },
+        dest: {
+          'adapter'  => 'postgresql',
+          'encoding' => 'unicode',
+          'database' => 'fake_postgresql_db',
+          'username' => 'fake_postgresql_user',
+          'password' => 'fake_postgresql_password',
+          'host'     => 'fake_postgresql_host',
+          'port'     => 5432,
+          :label     => 'test_postgresql'
+        }
+      }
+      cb = CmdBuilder.new h
+
+      it 'should be able to generate a pg_dump command' do
+        expect(cb.get_cmd).to eql("pg_dump --no-password --clean --host=fake_postgresql_host --port=5432 --username=other_postgresql_user other_postgresql_db | psql --host=fake_postgresql_host --port=5432 --username=fake_postgresql_user fake_postgresql_db")
+      end
+    end
+
+    describe 'mysql command builder' do
+      before(:each) do
+        @h = {
+         :src => {
+             'adapter' => 'mysql2',
+            'database' => 'fake_mysql_db',
+            'username' => 'fake_mysql_usr',
+            'password' => 'fake_mysql_password',
+                'host' => 'fake_mysql_host',
+                'port' => 3306,
+                :label => 'test_mysql'
+          },
+          :dest => {
+               'adapter' => 'mysql2',
+              'database' => 'other_mysql_db',
+              'username' => 'other_mysql_usr',
+              'password' => 'other_mysql_password',
+                  'host' => 'other_mysql_host',
+                  'port' => 3306,
+                  :label => 'second_test_mysql'
+          }
+        }
+      end
+
+      it 'should be able to generate a mysqldump command' do
+        cb = CmdBuilder.new @h
+        expect(cb.get_cmd).to eql("mysqldump --no-create-db --add-drop-table --lock-tables=false --user=fake_mysql_usr --password=fake_mysql_password --host=fake_mysql_host --port=3306 fake_mysql_db | mysql --user=other_mysql_usr --password=other_mysql_password --host=other_mysql_host --port=3306 other_mysql_db")
+      end
+
+      it 'should be able to generate a mysqldump command with ignore tables' do
+        DbSync.config = {
+          ignore_tables: ['tableAAAA', 'tableBBBB', 'tableCCCC']
+        }
+        cb = CmdBuilder.new @h
+        expect(cb.get_cmd).to eql("mysqldump --no-create-db --add-drop-table --lock-tables=false --user=fake_mysql_usr --password=fake_mysql_password --host=fake_mysql_host --port=3306 --ignore-table=other_mysql_db.tableAAAA --ignore-table=other_mysql_db.tableBBBB --ignore-table=other_mysql_db.tableCCCC fake_mysql_db | mysql --user=other_mysql_usr --password=other_mysql_password --host=other_mysql_host --port=3306 other_mysql_db")
+      end
+    end
+  end
+end

data/spec/db_selections_spec.rb

@@ -0,0 +1,74 @@
+require 'rails_helper'
+
+module DbSync
+  describe DbSelections do
+    describe 'db selections' do
+      DbSync.config = {
+        default_source: 'production',
+        default_destination: 'development',
+      }
+      ds = DbSelections.new Rails.root.join('config', 'database.yml')
+
+      it 'should prompt for a source' do
+        str = "\n  Choose a \e[0;35;49msource\e[0m database from one of the blocks defined in \e[0;92;49mconfig/database.yml\e[0m:\n\n    [ \e[0;94;49m1\e[0m ] \e[0;33;49mdefault\e[0m\n    [ \e[0;94;49m2\e[0m ] \e[0;33;49mdevelopment\e[0m\n    [ \e[0;94;49m3\e[0m ] \e[0;33;49mproduction\e[0m\n    [ \e[0;94;49m4\e[0m ] \e[0;33;49msecond_test_mysql\e[0m\n    [ \e[0;94;49m5\e[0m ] \e[0;33;49msecond_test_postgresql\e[0m\n    [ \e[0;94;49m6\e[0m ] \e[0;33;49mtest\e[0m\n    [ \e[0;94;49m7\e[0m ] \e[0;33;49mtest_mysql\e[0m\n    [ \e[0;94;49m8\e[0m ] \e[0;33;49mtest_postgresql\e[0m\n\n  Choose a \e[0;35;49msource\e[0m database (\e[0;94;49m1\e[0m-\e[0;94;49m8\e[0m) [production = \e[0;94;49m3\e[0m]: "
+        expect { ds.source_prompt }.to output(str).to_stdout
+      end
+
+      it 'should set a source' do
+        allow(STDIN).to receive(:gets) { '5' }
+        str = "\n  \e[0;35;49mSource\e[0m set to: \e[0;33;49msecond_test_postgresql\e[0m\n"
+        expect { ds.source_get }.to output(str).to_stdout
+      end
+
+      it 'should prompt for a destination' do
+        str = "\n  Choose a \e[0;35;49mdestination\e[0m database from one of the blocks defined in \e[0;92;49mconfig/database.yml\e[0m:\n\n    [ \e[0;94;49m1\e[0m ] \e[0;33;49mdefault\e[0m\n    [ \e[0;94;49m2\e[0m ] \e[0;33;49mdevelopment\e[0m\n    [ \e[0;94;49m3\e[0m ] \e[0;33;49mproduction\e[0m\n    [ \e[0;94;49m4\e[0m ] \e[0;33;49msecond_test_mysql\e[0m\n    [ \e[0;31;49mX\e[0m ] \e[0;31;49msecond_test_postgresql\e[0m\n    [ \e[0;94;49m6\e[0m ] \e[0;33;49mtest\e[0m\n    [ \e[0;94;49m7\e[0m ] \e[0;33;49mtest_mysql\e[0m\n    [ \e[0;94;49m8\e[0m ] \e[0;33;49mtest_postgresql\e[0m\n\n  Choose a \e[0;35;49mdestination\e[0m database (\e[0;94;49m1\e[0m-\e[0;94;49m8\e[0m) [development = \e[0;94;49m2\e[0m]: "
+        expect { ds.dest_prompt }.to output(str).to_stdout
+      end
+
+      it 'should set a destination' do
+        allow(STDIN).to receive(:gets) { '8' }
+        str = "\n  \e[0;35;49mDestination\e[0m set to: \e[0;33;49mtest_postgresql\e[0m\n"
+        expect { ds.dest_get }.to output(str).to_stdout
+      end
+
+      it 'should have a source and destination set' do
+        expected_selections = {
+          src: {
+            'adapter'  => 'postgresql',
+            'encoding' => 'unicode',
+            'database' => 'other_postgresql_db',
+            'username' => 'other_postgresql_user',
+            'password' => 'other_postgresql_password',
+            'host'     => 'fake_postgresql_host',
+            'port'     => 5432,
+            :label     => 'second_test_postgresql'
+          },
+          dest: {
+            'adapter'  => 'postgresql',
+            'encoding' => 'unicode',
+            'database' => 'fake_postgresql_db',
+            'username' => 'fake_postgresql_user',
+            'password' => 'fake_postgresql_password',
+            'host'     => 'fake_postgresql_host',
+            'port'     => 5432,
+            :label     => 'test_postgresql'
+          }
+        }
+        expect(ds.selections).to eql(expected_selections)
+      end
+    end
+
+    describe 'db mismatched selections' do
+      ds = DbSelections.new Rails.root.join('config', 'database.yml')
+
+      it 'should prohibit syncing between different adapters' do
+        expect { ds.source_prompt }.to output.to_stdout
+        allow(STDIN).to receive(:gets) { '7' }
+        expect { ds.source_get }.to output.to_stdout
+        expect { ds.dest_prompt }.to output.to_stdout
+        allow(STDIN).to receive(:gets) { '8' }
+        expect { ds.dest_get }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end