capistrano-container-db 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d98988d18e9e5933477ae48f580f326c1437354
+  data.tar.gz: 34fa561aa7fe1c6f24d5104a9d62d71dd027278b
+SHA512:
+  metadata.gz: ca50a7a187fe63763af30a83ae7017178210bbfbf5ebbba12633464bcfd01a0de95485de113f56990490603d466db8e4faf4e4df97d2bb31daed54789e2ee72e
+  data.tar.gz: 73e5b05349530e7dad385de6125639be794a918981a45083a36fc3a5b080f2769f9ba3ba2572af883b6ae73a473aa1b1e07e5af291778ee5bd3ee3c227144937

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 creative-workflow
+
+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,93 @@
+# Capistrano::Container::Db [![Gem Version](https://badge.fury.io/rb/capistrano-container-db.svg)](https://badge.fury.io/rb/capistrano-container-db)
+
+Helps managing databases on local and remote stages, also on remote [docker](https://www.docker.com/) container for Capistrano 3.x.
+
+This project is in an early stage but helps me alot dealing with my container deployments and keeps my code clean. It is not only ment for mysql, but at the moment there only supports mysql, feel free to contribute =)
+
+This gem depends on [capistrano-container](https://github.com/creative-workflow/capistrano-container).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano', '>= 3.0.0'
+gem 'capistrano-container-db'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-container-db
+
+Dont forget to require the module in your Capfile:
+
+```ruby
+require 'capistrano/container/db'
+```  
+
+## Usage
+### definition
+To define and register a container do the following in your stage config or deploy.rb:
+
+```ruby
+...
+
+# for usage in conjunction with capistrano-container
+server('www.example.com', user: 'root', roles: %w{web})
+
+container 'db',  roles: %w{db},
+                 container_id: 'website_company_beta_db',
+                 server: ['www.example.com']
+
+# here the capistrano-container-db config comes
+
+set :db_is_container, true
+set :db_user, 'wordpress'
+set :db_pass, 'wordpress'
+set :db_name, 'my_wordpress_db_inside_docker'
+
+...
+```
+
+This configures the db access for the db container. If 'db_is_container' is true, the gem uses the capistrano-container extension to select the container by name 'fetch(:db_container_name)' (defaults to 'db').
+
+If the stage name is equal ':local', the gem runs export/import on local host.
+
+If the stage is unequal ':local' and the param ':db_is_container' is false, the export/import will run on remote host.
+
+### commandline tasks
+```ruby
+cap db:export               # export a local, remote or remote container mysql db
+cap db:import               # import a local, remote or remote container mysql db
+```
+
+### default configuration
+```ruby
+set :db_user, 'root'
+set :db_pass, ''
+set :db_name, ''
+set :db_remote_dump, '/tmp/dump.sql'
+set :db_local_dump, 'config/db/dump.sql'
+set :db_is_container, false
+set :db_container_name, 'db'
+```
+
+## TODO
+  * Implement provider pattern for other db engines.
+  * Write tests.
+
+## Changes
+### Version 0.0.1
+  * Initial release
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano-container-db.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'capistrano-container-db'
+  spec.version     = '0.0.1'
+  spec.date        = '2016-09-26'
+  spec.summary     = 'Helps managing databases on local and remote stages, also on remote docker container'
+  spec.description = spec.summary
+  spec.authors     = ['Tom Hanoldt']
+  spec.email       = ['tom@creative-workflow.berlin']
+  spec.homepage    = 'https://github.com/creative-workflow/capistrano-container-db'
+  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 'capistrano', '>= 3.0.0.pre'
+  spec.add_dependency 'capistrano-container', '>= 0.0.4'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+end

data/lib/capistrano-container-db.rb

@@ -0,0 +1 @@
+require_relative 'capistrano/container/db.rb'

data/lib/capistrano/container/db.rb

@@ -0,0 +1,11 @@
+require_relative '../tasks/db.rb'
+
+module Capistrano
+  module Container
+    module DB
+      require_relative '../../db/helper.rb'
+      require_relative '../../db/load_helper.rb'
+      require_relative '../../db/dump_helper.rb'
+    end
+  end
+end

data/lib/capistrano/tasks/db.rb

@@ -0,0 +1,46 @@
+require_relative('../../db/helper.rb')
+require_relative('../../db/dump_helper.rb')
+require_relative('../../db/load_helper.rb')
+
+namespace :db do
+  desc "export a local, remote or remote container mysql db"
+  task :export do
+    on roles(:db, :container_host) do |host|
+
+      if fetch(:db_is_container)
+        DumpHelper::dump_on_container_and_download container_by_name(fetch(:db_container_name))
+      elsif fetch(:stage) == :local
+        DumpHelper::dump_on_local
+      else
+        DumpHelper::dump_on_server_and_download
+      end
+
+      Helper::duplicate_local_dump_to_staged_dump
+    end
+  end
+
+  desc "import a local, remote or remote container mysql db"
+  task :import do
+    on roles(:db, :container_host) do
+      if fetch(:db_is_container)
+        LoadHelper::import_on_container container_by_name(fetch(:db_container_name))
+      elsif fetch(:stage) == :local
+        LoadHelper::import_on_local
+      else
+        LoadHelper::import_on_server
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :db_user, 'root'
+    set :db_pass, ''
+    set :db_name, ''
+    set :db_remote_dump, '/tmp/dump.sql'
+    set :db_local_dump, 'config/db/dump.sql'
+    set :db_is_container, false
+    set :db_container_name, 'db'
+  end
+end

data/lib/db/dump_helper.rb

@@ -0,0 +1,27 @@
+require_relative "helper.rb"
+
+module DumpHelper
+  def self.dump_on_local()
+    args = Helper::mysql_args(['--no-create-db'])
+
+    run_locally do
+      execute "mysqldump #{args} > #{fetch(:db_local_dump)}"
+    end
+  end
+
+  def self.dump_on_server_and_download()
+    args = Helper::mysql_args(['--no-create-db'])
+
+    execute "mysqldump #{args} > #{fetch(:db_remote_dump)}"
+
+    download!(fetch(:db_remote_dump), fetch(:db_local_dump))
+  end
+
+  def self.dump_on_container_and_download(container)
+    args = Helper::mysql_args(['--no-create-db'])
+
+    container.execute("mysqldump #{args} > #{fetch(:db_remote_dump)}")
+
+    container.download!(fetch(:db_remote_dump), fetch(:db_local_dump))
+  end
+end

data/lib/db/helper.rb

@@ -0,0 +1,24 @@
+module Helper
+  def self.mysql_args(additional_args=[])
+    command = " -u #{fetch(:db_user)}"
+    command+= " -p#{fetch(:db_pass)}" unless fetch(:db_pass).empty?
+    command+= " #{additional_args.join(' ')} "
+
+    # dont use --database statement, so no use '...' will be generated
+    command+= " #{fetch(:db_name)}" unless fetch(:db_name).empty?
+    command
+  end
+
+  def self.append_stage_to_filename(file_name, stage = 'local')
+    splitted  = file_name.split('.')
+    extension = splitted.pop
+    splitted.push stage, extension
+    splitted.join('.')
+  end
+
+  def self.duplicate_local_dump_to_staged_dump()
+    staged_file = append_stage_to_filename(fetch(:db_local_dump), fetch(:stage))
+
+    FileUtils.cp(fetch(:db_local_dump), staged_file)
+  end
+end

data/lib/db/load_helper.rb

@@ -0,0 +1,21 @@
+require_relative "helper.rb"
+
+module LoadHelper
+  def self.import_on_local()
+    run_locally do
+      execute "mysql #{Helper::mysql_args} < #{fetch(:db_local_dump)}"
+    end
+  end
+
+  def self.import_on_container(container)
+    container.upload!(fetch(:db_local_dump), fetch(:db_remote_dump))
+
+    container.execute("mysql #{Helper::mysql_args} < #{fetch(:db_remote_dump)}")
+  end
+
+  def self.import_on_server()
+    upload!(fetch(:db_local_dump), fetch(:db_remote_dump))
+
+    execute("mysql #{Helper::mysql_args} < #{fetch(:db_remote_dump)}")
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-container-db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tom Hanoldt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0.pre
+- !ruby/object:Gem::Dependency
+  name: capistrano-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: Helps managing databases on local and remote stages, also on remote docker
+  container
+email:
+- tom@creative-workflow.berlin
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-container-db.gemspec
+- lib/capistrano-container-db.rb
+- lib/capistrano/container/db.rb
+- lib/capistrano/tasks/db.rb
+- lib/db/dump_helper.rb
+- lib/db/helper.rb
+- lib/db/load_helper.rb
+homepage: https://github.com/creative-workflow/capistrano-container-db
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Helps managing databases on local and remote stages, also on remote docker
+  container
+test_files: []