dumpman 1.3.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d345a9992461b65c538df3ae71a8f05a5e638974736a9502058ed952b99c80b4
-  data.tar.gz: 39166bd9c4a97d9e6240822a14479f93526cd1ccf303497714cb98cfce1713ff
+  metadata.gz: 4062be5d02a9d24bdec99a061b1f1deaed5e4ee3059ccf6adbdf88c9ab168b39
+  data.tar.gz: 06634d8fc978f0bae92a4b0707966f2402ccb545c648cb89a4111ea977ffadd3
 SHA512:
-  metadata.gz: 166f605b6b46744c70abd551ffda4226656fb16c2d4b2ac0286a6619518e4ad724ee2064f31e3ab2d0bf502a74c2e21d09c5aeaae8a3011e23a03557bd8aaa10
-  data.tar.gz: 6ab0e4d3b452fe9763ba7b51febbed1d750694a9ac79e30853796b8037d02f74c91c18935c61acccde85e5d6279cfe3a983ba282710b4dc85cd20023601940a7
+  metadata.gz: f52bbffb820dca550dce9d7dd47ac7019395994021a77cd860fb1d1d457a7ed7fda8bd87a321add31a8e88128f442f53664acc0498f1b2ab211d1aa2e87ad66a
+  data.tar.gz: eedf62ad6ea423c2c99484fb74dade067ee4be6f7030c9b2e3353c000c21e03a17c0598e94d09ffb78d1168f5695cb3a2e977c95df4ae4c84a76e07868cb3f6f

data/.travis.yml

@@ -8,10 +8,9 @@ env:
 language: ruby
 
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
 
 before_install:
   - gem install bundler -v 1.15.3

data/README.md

@@ -4,7 +4,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/3f69b1bb862be2a7e6ce/test_coverage)](https://codeclimate.com/github/skcc321/dumpman/test_coverage)
 
 # Dumpman
-Dumpman gem is what you need if you have application somewhere and need to dump your DB download it and up that dump localy!
+Dumpman gem is what you need if you have application somewhere and need to dump your DB, download it and restore that dump localy!
 
 ### use case:
 You have staging OR production server with running rails app on it.
@@ -12,7 +12,7 @@ You have staging OR production server with running rails app on it.
 For some reason you need DB dump from that server.
 
 What you can do?
-- Solution 1: connect to that server, make dump via CLI, download it, extract it on your loacl machine
+- Solution 1: connect to that server, make dump via CLI, download it, extract it on your local machine
 - Solution 2: install this gem and run ```bash rake db:prod:up``` and that's it.
 
 ![alt text](https://farm8.staticflickr.com/7347/10602023975_fd3e5b61b7_b.jpg)
@@ -55,6 +55,20 @@ Dumpman.setup do
     # example:
     # ssh_opts '-i ~/.ssh/sertificate.pem'
 
+    # fetch strategy
+    # if you are using capistrano or other deployment methods
+    # where you have direct access to filesystem where the application code is located
+    # you should use :direct strategy
+    fetch_strategy :direct
+    # if your application is running under the docker you can use :docker strategy
+
+    # if you selected :docker as fetch_strategy
+    # you have to set docker_image as well
+    # docker_image "645843940509.dkr.ecr.us-east-1.amazonaws.com/oh-snowflake"
+
+    # if you selected :direct as fetch strategy
+    # please set
+
     # app path on the remote server
     app_path '~/application/current'
   end
@@ -70,7 +84,11 @@ Now you are able to use awesome commands:
     $ rake db:prod:up # makes db dump on that server, compreses it, downloads, extracts localy
     $ rake db:stage:up
     $ rake db:qa:up
-    ...
+
+    as well as local dump&restor
+
+    $ rake db:dump
+    $ rake db:restore
 
 ## Contributing
 

data/lib/dumpman.rb

@@ -5,6 +5,8 @@ require 'dumpman/adapters/pg'
 require 'dumpman/adapters/mysql'
 require 'dumpman/comandor'
 require 'dumpman/executor'
+require 'dumpman/fetchers/direct'
+require 'dumpman/fetchers/docker'
 require 'dumpman/fetcher'
 require 'dumpman/railtie'
 require 'dumpman/version'

data/lib/dumpman/adapters/base.rb

@@ -46,15 +46,15 @@ module Dumpman
         end
 
         def username
-          @username ||= db_config.fetch(:username)
+          @username ||= db_config.fetch(:username) { db_config.fetch(:user) }
         end
 
         def password
-          @password ||= db_config.fetch(:password)
+          @password ||= db_config.fetch(:password) { raise("you should set password in 'database.yml'") }
         end
 
         def host
-          @host ||= db_config.fetch(:host)
+          @host ||= db_config.fetch(:host) { 'localhost' }
         end
     end
   end

data/lib/dumpman/connection.rb

@@ -1,6 +1,6 @@
 module Dumpman
   class Connection
-    attr_accessor :name, :app_env, :ssh_cmd, :app_path, :ssh_opts
+    attr_accessor :name, :app_env, :ssh_cmd, :app_path, :ssh_opts, :fetch_strategy, :docker_image
 
     def initialize(name)
       @name = name
@@ -12,6 +12,8 @@ module Dumpman
         ssh_cmd: @ssh_cmd,
         ssh_opts: @ssh_opts,
         app_path: @app_path,
+        fetch_strategy: @fetch_strategy,
+        docker_image: @docker_image,
       }
     end
 
@@ -30,5 +32,13 @@ module Dumpman
     def ssh_opts(val)
       self.ssh_opts = val
     end
+
+    def fetch_strategy(val)
+      self.fetch_strategy = val
+    end
+
+    def docker_image(val)
+      self.docker_image = val
+    end
   end
 end

data/lib/dumpman/executor.rb

@@ -4,8 +4,17 @@ module Dumpman
 
     def system(*commands)
       cmd = commands.join(' && ')
-      puts("executing: #{cmd}")
-      Kernel.system(cmd)
+      info(cmd)
+
+      # execute & capture the result
+      if block_given?
+        # if success yield the result message
+        result = %x[#{cmd}].strip
+        yield result if $?.success?
+      else
+        # return execution t/f
+        result = Kernel.system(cmd)
+      end
     end
 
     def rake(*commands)
@@ -14,5 +23,14 @@ module Dumpman
         Rake::Task["db:#{command}"].invoke
       end
     end
+
+    def info(cmd)
+      puts 'EXECUTING:'
+
+      puts cmd.gsub(/(\s{2})/, '\1')
+          .split(/\n/)
+          .map { |x| x.squeeze(' ') }
+          .reject(&:blank?)
+    end
   end
 end

data/lib/dumpman/fetcher.rb

@@ -5,25 +5,24 @@ module Dumpman
         connection.name == connection_name
       end
 
-      instance = self.new(connection.attrs)
+      instance = self.new(attrs: connection.attrs)
       instance.fetch_remote_dump
     end
 
     def fetch_remote_dump
-      Dumpman::Executor.system(
-        compress_dump_remotely,
-        fetch_dump_to_local
-      )
+      fetcher = fetcher_class.new(attrs)
+      fetcher.get_dump
     end
 
     private
 
-    def compress_dump_remotely
-      "ssh #{ssh_opts} #{ssh_cmd} 'cd #{app_path} && bash --login -c \"RAILS_ENV=#{app_env} bundle exec rake db:dump\"'"
-    end
-
-    def fetch_dump_to_local
-      "scp #{ssh_opts} #{ssh_cmd}:#{app_path}/#{Dumpman.dump_file_name} #{Dumpman.dump_folder}/"
-    end
+      def fetcher_class
+        case attrs[:fetch_strategy]
+        when :docker then Dumpman::Fetchers::Docker
+        when :direct then Dumpman::Fetchers::Direct
+        else
+          Dumpman::Fetchers::Direct
+        end
+      end
   end
 end

data/lib/dumpman/fetchers/direct.rb

@@ -0,0 +1,46 @@
+module Dumpman
+  module Fetchers
+    # it triggers rake db:dump
+    # inside app_path
+    # and copies dump into tmp directory
+    # after that it gets dump from remote server
+    class Direct
+      attr_reader :ssh_opts, :ssh_cmd, :app_path, :app_env
+
+      def initialize(ssh_opts:, ssh_cmd:, app_path:, app_env:, **)
+        @ssh_opts = ssh_opts
+        @ssh_cmd = ssh_cmd
+        @app_path = app_path
+        @app_env = app_env
+      end
+
+      def get_dump
+        Dumpman::Executor.system(make_dump_remotely) do |dump_location|
+          Dumpman::Executor.system(fetch_dump_to_local(dump_location))
+        end
+      end
+
+      private
+
+        def make_dump_remotely
+          <<~SSH_COMMAND
+            ssh #{ssh_opts} #{ssh_cmd} '\
+            export TEMP_DIR=$(mktemp -d)\
+
+            cd #{app_path} && \
+            bash --login -c "RAILS_ENV=#{app_env} bundle exec rake db:dump \
+            && cp #{Dumpman.dump_file_name} $TEMP_DIR/"\
+
+            echo $TEMP_DIR'
+          SSH_COMMAND
+        end
+
+        def fetch_dump_to_local(dump_location)
+          <<~SSH_COMMAND
+            scp #{ssh_opts} #{ssh_cmd}:#{dump_location}/#{Dumpman.dump_file_name} \
+            #{Dumpman.dump_folder}/
+          SSH_COMMAND
+        end
+    end
+  end
+end

data/lib/dumpman/fetchers/docker.rb

@@ -0,0 +1,52 @@
+module Dumpman
+  module Fetchers
+    # it runs docker task to make dump
+    # copies dump into tmp dir
+    # and retrieves dump to local machine
+    class Docker
+      attr_reader :ssh_opts, :ssh_cmd, :docker_image, :app_env
+
+      def initialize(ssh_opts:, ssh_cmd:, docker_image:, app_env:, **)
+        @ssh_opts = ssh_opts
+        @ssh_cmd = ssh_cmd
+        @docker_image = docker_image
+        @app_env = app_env
+      end
+
+      def get_dump
+        Dumpman::Executor.system(make_dump_remotely) do |dump_location|
+          Dumpman::Executor.system(fetch_dump_to_local(dump_location))
+        end
+      end
+
+      def make_dump_remotely
+        <<~SSH_COMMAND
+          ssh #{ssh_opts} #{ssh_cmd} '
+            export TEMP_DIR=$(mktemp -d)
+            export DOCKER_IMAGE=$(docker images #{docker_image} --format "{{.ID}}" | head -1)
+
+            docker run -d \
+              --name pgdmp \
+              --rm \
+              -e RAILS_ENV=#{app_env} \
+              -v ${TEMP_DIR}:/opt \
+              -u root \
+              ${DOCKER_IMAGE} /bin/bash -c \
+                "bundle exec rake db:dump && cp #{Dumpman.dump_file_name} /opt/ && exit" > /dev/null
+
+            docker wait pgdmp >/dev/null
+
+            echo $TEMP_DIR
+          '
+        SSH_COMMAND
+      end
+
+      def fetch_dump_to_local(dump_location)
+        <<~SSH_COMMAND
+          scp #{ssh_opts} #{ssh_cmd}:#{dump_location}/#{Dumpman.dump_file_name} \
+            #{Dumpman.dump_folder}/
+        SSH_COMMAND
+      end
+    end
+  end
+end

data/lib/dumpman/version.rb

@@ -1,3 +1,3 @@
 module Dumpman
-  VERSION = '1.3.0'
+  VERSION = '1.8.1'
 end

data/lib/generators/dumpman/templates/dumpman.rb

@@ -12,8 +12,21 @@ Dumpman.setup do
 
     # ssh options for connection to the remote server
     # example:
-    # ssh_opts '-i ~/.ssh/sertificate.pem'
+    ssh_opts '-i ~/.ssh/sertificate.pem'
 
+    # fetch strategy
+    # if you are using capistrano or other deployment methods
+    # where you have direct access to filesystem where the application code is located
+    # you should use :direct strategy
+    fetch_strategy :direct
+    # if your application is running under the docker you can use :docker strategy
+
+    # if you selected :docker as fetch_strategy
+    # you have to set docker_image as well
+    # docker_image "645843940509.dkr.ecr.us-east-1.amazonaws.com/oh-snowflake"
+
+    # if you selected :direct as fetch strategy
+    # please set
     # app path on the remote server
     app_path '~/application/current'
   end

data/lib/tasks/db.rake

@@ -9,7 +9,7 @@ namespace :db do
       desc "up #{name} dump"
       task :up => :environment do
         Dumpman::Fetcher.fetch(name)
-        Dumpman::Executor.rake(:up)
+        # Dumpman::Executor.rake(:up)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dumpman
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.8.1
 platform: ruby
 authors:
 - rafael
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-29 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -306,6 +306,8 @@ files:
 - lib/dumpman/database.rb
 - lib/dumpman/executor.rb
 - lib/dumpman/fetcher.rb
+- lib/dumpman/fetchers/direct.rb
+- lib/dumpman/fetchers/docker.rb
 - lib/dumpman/railtie.rb
 - lib/dumpman/version.rb
 - lib/generators/dumpman/dumpman_generator.rb