multi_db_migration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5cf93d64500c13a30417619c04b4dd63719f9cae1c5709ea3f1c59dc500b427
+  data.tar.gz: 4d6441944ee98083f0ae0be1015c779b09bb8755e49bf96e5b96e3f56595d0ed
+SHA512:
+  metadata.gz: 7c6153f530af30f3615ea50779d6eb41f8eec39028999ca871188ee37844c722a40dde8e489b4a4d6b8d32773bf2532be3c01475d8fa27d1f18c0f2275f4f9e4
+  data.tar.gz: 512fb3716f3f9205f7a0235a518ca7fb3051ea5578bbd7c63ac178b15024f2c880e15a0992e38b49529b8b1c53503e92a6bf33a429cde24f2169a865dba7c1ed

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+vendor/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in multi_db_migration.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Takahiro Ooishi
+
+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,73 @@
+# MultiDbMigration
+
+Multiple database migration use ridgepole
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'multi_db_migration'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install multi_db_migration
+
+## Configuration
+
+- `config/multi_db_migration.yml`
+
+```yaml
+parallel_num: 1
+db:
+  config: config/database.yml
+shards:
+  primary:
+    options:
+      - --spec-name=primary
+      - --ignore-tables=^need_ignore_tables$
+      - --skip-drop-table
+      - --file=db/schemas/primary/Schemafile
+  animals:
+    options:
+      - --spec-name=animals
+      - --ignore-tables=^need_ignore_tables$
+      - --skip-drop-table
+      - --file=db/schemas/animals/Schemafile
+```
+
+## ENV
+
+| Name | Default | Description |
+| --- | --- | --- |
+| MULTI_DB_MIGRATION_CONFIG | config/multi_db_migration.yml | path for multi_db_migration.yml |
+
+## Usage
+
+- dry run
+
+```
+bundle rake multi_db_migration:dry_run
+```
+
+- migrate
+
+```
+bundle rake multi_db_migration:migrate
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taka0125/multi_db_migration.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "multi_db_migration"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/multi_db_migration.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+require 'multi_db_migration/version'
+require 'multi_db_migration/ridgepole_client'
+require 'multi_db_migration/config'
+require 'multi_db_migration/railtie' if defined?(::Rails::Railtie)
+
+module MultiDbMigration
+  class Error < StandardError; end
+end

data/lib/multi_db_migration/config.rb

@@ -0,0 +1,47 @@
+require 'yaml'
+
+module MultiDbMigration
+  class Config
+    DEFAULT_PATH = 'config/multi_db_migration.yml'
+    DEFAULT_PARALLEL_NUM = 1
+    DEFAULT_DB_CONFIG_PATH = 'config/database.yml'
+
+    def initialize(path = nil)
+      @path = path.presence || DEFAULT_PATH
+    end
+
+    def parallel_num
+      config.dig(:parallel_num)&.to_i || DEFAULT_PARALLEL_NUM
+    end
+
+    def db_config
+      config.dig(:db, :config) || DEFAULT_DB_CONFIG_PATH
+    end
+
+    def shards
+      config.dig(:shards)&.keys || []
+    end
+
+    def shard_config(shard)
+      config.dig(:shards, shard)
+    end
+
+    private
+
+    def config
+      @config ||= load_yaml
+    end
+
+    def load_yaml
+      raise "#{@path} not found." unless ::File.exist?(@path)
+
+      yaml = ::ERB.new(File.read(@path)).result
+      ::YAML.safe_load(
+        yaml,
+        permitted_classes: [Symbol],
+        permitted_symbols: [],
+        aliases: true
+      )&.with_indifferent_access
+    end
+  end
+end

data/lib/multi_db_migration/railtie.rb

@@ -0,0 +1,7 @@
+module MultiDbMigration
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'tasks/multi_db_migration.rake'
+    end
+  end
+end

data/lib/multi_db_migration/ridgepole_client.rb

@@ -0,0 +1,43 @@
+module MultiDbMigration
+  class RidgepoleClient
+    def initialize(shard_config: nil, env: nil, config: nil, dry_run: true)
+      @shard_config = shard_config.presence || {}
+      @env = env
+      @config = config.presence || MultiDbMigration::Config::DEFAULT_DB_CONFIG_PATH
+      @dry_run = dry_run
+    end
+
+    def generate_command
+      "bundle exec ridgepole #{command_options.join(' ')}"
+    end
+
+    private
+
+    def command_options
+      options = @shard_config.dig(:options) || []
+      options << env_option
+      options << config_option
+      options << dry_run_option
+      options << '--apply'
+      options.compact
+    end
+
+    def env_option
+      return if @env.blank?
+
+      "--env #{@env}"
+    end
+
+    def config_option
+      return if @config.blank?
+
+      "--config #{@config}"
+    end
+
+    def dry_run_option
+      return if @dry_run.blank?
+
+      "--dry-run"
+    end
+  end
+end

data/lib/multi_db_migration/version.rb

@@ -0,0 +1,3 @@
+module MultiDbMigration
+  VERSION = "0.1.0"
+end

data/lib/tasks/multi_db_migration.rake

@@ -0,0 +1,67 @@
+require 'open3'
+require 'parallel'
+
+namespace :multi_db_migration do
+  desc 'migrate'
+  task :migrate do
+    ENV['RAILS_ENV'] ||= "development"
+    config = MultiDbMigration::Config.new(config_path)
+    parallel_migrate(config, false)
+  end
+
+  desc 'dry run'
+  task :dry_run do
+    ENV['RAILS_ENV'] ||= "development"
+    config = MultiDbMigration::Config.new(config_path)
+    parallel_migrate(config, true)
+  end
+
+  private
+
+  def config_path
+    @config_path ||= ENV.fetch('MULTI_DB_MIGRATION_CONFIG', MultiDbMigration::Config::DEFAULT_PATH)
+  end
+
+  def parallel_migrate(config, dry_run)
+    shards = config.shards
+    parallel_num = config.parallel_num
+
+    ::Parallel.each(shards, in_threads: parallel_num) do |shard|
+      migrate(config, shard, dry_run)
+    end
+  end
+
+  def migrate(config, shard, dry_run)
+    shard_config = config.shard_config(shard)
+
+    client = MultiDbMigration::RidgepoleClient.new(
+      env: ENV['RAILS_ENV'],
+      config: config.db_config,
+      file: shard_config[:file],
+      spec_name: shard_config[:spec_name],
+      dry_run: dry_run,
+      ignore_tables: shard_config[:ignore_tables],
+      skip_drop_table: shard_config[:skip_drop_table],
+      mysql_change_table_comment: shard_config[:mysql_change_table_comment],
+    )
+
+    command = client.generate_command
+    execute_command(shard, command)
+  end
+
+  def execute_command(shard, command)
+    puts "[#{shard}] #{command}"
+
+    is_success = Open3.popen2e(command) do |stdin, stdout_and_stderr, wait_thr|
+      stdin.close
+
+      stdout_and_stderr.each_line do |line|
+        puts "[#{shard}] #{line}"
+      end
+
+      wait_thr.value.success?
+    end
+
+    exit(1) unless is_success
+  end
+end

data/multi_db_migration.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/multi_db_migration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_db_migration"
+  spec.version       = MultiDbMigration::VERSION
+  spec.authors       = ["Takahiro Ooishi"]
+  spec.email         = ["taka0125@gmil.com"]
+
+  spec.summary       = %q{Multiple database migration use ridgepole}
+  spec.description   = %q{Multiple database migration use ridgepole}
+  spec.homepage      = "https://github.com/taka0125/multi_db_migration"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.3")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/taka0125/multi_db_migration"
+  spec.metadata["changelog_uri"] = "https://github.com/taka0125/multi_db_migration/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ridgepole", ">= 0.8"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "parallel"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: multi_db_migration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takahiro Ooishi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ridgepole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Multiple database migration use ridgepole
+email:
+- taka0125@gmil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/multi_db_migration.rb
+- lib/multi_db_migration/config.rb
+- lib/multi_db_migration/railtie.rb
+- lib/multi_db_migration/ridgepole_client.rb
+- lib/multi_db_migration/version.rb
+- lib/tasks/multi_db_migration.rake
+- multi_db_migration.gemspec
+homepage: https://github.com/taka0125/multi_db_migration
+licenses: []
+metadata:
+  homepage_uri: https://github.com/taka0125/multi_db_migration
+  source_code_uri: https://github.com/taka0125/multi_db_migration
+  changelog_uri: https://github.com/taka0125/multi_db_migration/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Multiple database migration use ridgepole
+test_files: []