copy_bot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b2ad280edebcf3bc0d1161562843dbfac9a11d2a5f6988c7b85379fbab7fec6
+  data.tar.gz: 0d1d7d715306c770a4e5aa448428b8ba10ae3f0fd5e2a91312d60c5b9c1ddb39
+SHA512:
+  metadata.gz: 58db3aa615b6c86a88fb6c98a0bbdbbf548a8bfa3bb8e9d14645b727f9719505e76d685f11ed52cefaf394d8627de34cdde52f2eb0df354b767a3617a86a7e32
+  data.tar.gz: 5ea92339041eb75bccb8341d2d9417af2644471408eae64f703f03f99b03c3480eb63d38bf2a7fd9d5e1461a700460bb65c2700e2005322b4e019c3c006107e2

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0.1'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0.1'
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec rspec

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_gem:
+  rubocop-infinum: rubocop.yml
+
+require: rubocop-infinum
+
+AllCops:
+  TargetRubyVersion: 3.0.1
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/ExampleLength:
+  Max: 15
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-02-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at eva.cukor@infinum.hr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in copy_bot.gemspec
+gemspec

data/README.md

@@ -0,0 +1,125 @@
+# CopyBot
+
+A gem that provides a rake task for importing a database dump into the local database,
+as well as for running any additional scripts afterwards.
+
+This can be useful in situations when you want to sync your staging and production data so that you can debug issues
+in production without having to access the production environment itself. Also, it is useful for populating
+a database with production data so development and testing can be performed in circumstances that are as close to
+production as possible. It is advised that the production data is anonymized beforehand.
+
+The gem assumes that the database dump that is to be restored to the local database has already been prepared and
+made available either on an AWS S3 bucket or on a local path.
+
+## Requirements
+
+* `aws-sdk-ruby`
+* `rails`
+
+## Supported databases
+
+* PostgreSQL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+gem 'copy_bot'
+
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install copy_bot
+
+## Application configuration
+
+Add `config/initializers/copy_bot.rb`
+
+```ruby
+
+CopyBot.setup do |config|
+  config.logger = Rails.logger
+  config.permitted_environments = ['development', 'staging']
+end
+
+```
+| Option                   |        Default value         | Description                                                                                              |
+|--------------------------|:----------------------------:|----------------------------------------------------------------------------------------------------------|
+| `logger`                 | Ruby's built-in Logger class | Logging utility that by default outputs to $stdout                                                       |
+| `permitted_environments` |      `['development']`       | Array with environments where the rake task is allowed to be run (since it contains destructive actions) |
+
+### Step definitions file
+
+It is necessary to define steps that should be run in a .yml file:
+
+```yml
+steps:
+  download_remote_db_dump:
+    s3_credentials:
+      access_key_id: <%= Rails.application.secrets.aws_access_key_id %>
+      access_key: <%= Rails.application.secrets.aws_secret_access_key %>
+      region: <%= Rails.application.secrets.aws_region %>
+      bucket: <%= Rails.application.secrets.aws_s3_bucket %>
+    source_file_path: '/staging_db_dump.sql'
+    destination_file_path: './tmp/downloaded_db_dump.sql'
+  create_local_db_backup:
+    destination_file_path: './tmp/development_backup.sql'
+  drop_local_db_tables:
+  import_remote_db_to_local_db:
+    remote_db_dump_file_path: './tmp/downloaded_db_dump.sql'
+  run_migrations_on_local_db:
+  delete_remote_db_dump:
+    remote_db_dump_file_path: './tmp/downloaded_db_dump.sql'
+  execute_custom_command:
+    command: 'RAILS_ENV=staging bundle exec rake some_task'
+```
+
+The example above contains all possible steps in the exact order in which they are run.
+Not all steps are mandatory.
+If a certain step doesn't need to be run, just omit it from the steps definition file. For example, you may not want
+to download the database dump from an S3 bucket, but you have acquired it in some other way and you have it available
+locally. In that case, omit the `download_remote_db_dump` step and add the relevant `remote_db_dump_file_path` to the
+`import_remote_db_to_local_db` step.
+
+**IMPORTANT:** 
+These steps include some destructive actions, e.g. `drop_local_db_tables` will drop all tables in the local database
+so make sure you don't use this gem in an environment where you do not want to lose data.
+
+## Usage
+
+To use the gem, simply run:
+
+    $ bundle exec rake copy_bot STEP_DEFINITIONS_FILE_PATH=config/copy_bot/step_definitions.yml
+
+Please note that the step definitions file is passed to the rake task as an environment variable, not an argument.
+
+## 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 the created tag, 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/infinum/copy_bot. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/infinum/copy_bot/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CopyBot project's codebases, issue trackers, chat rooms and mailing lists is expected
+to follow the [code of conduct](https://github.com/infinum/copy_bot/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'copy_bot'
+
+require 'pry'
+Pry.start

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/copy_bot.gemspec

@@ -0,0 +1,41 @@
+require_relative 'lib/copy_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'copy_bot'
+  spec.version = CopyBot::VERSION
+  spec.authors = ['Rails Team']
+  spec.email = ['team.rails@infinum.com']
+
+  spec.summary = 'Tool for syncing data between two environments.'
+  spec.description = 'Provides a rake task for importing a database dump into a database on a particular environment.'
+  spec.homepage = 'https://github.com/infinum/copy_bot'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.1')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/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(__dir__)) 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{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'aws-sdk-s3'
+  spec.add_dependency 'rails', '>= 6.1'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop-infinum'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/copy_bot/config.rb

@@ -0,0 +1,24 @@
+module CopyBot
+  class Config
+    # @return [Logger]
+    attr_accessor :logger
+
+    # @return [Array<String>]
+    attr_accessor :permitted_environments
+
+    DEFAULT_PERMITTED_ENVIRONMENTS = ['development'].freeze
+
+    def initialize
+      @logger = default_logger
+      @permitted_environments = DEFAULT_PERMITTED_ENVIRONMENTS
+    end
+
+    private
+
+    def default_logger
+      Logger.new($stdout).tap do |log|
+        log.progname = self.class.name.split('::').first
+      end
+    end
+  end
+end

data/lib/copy_bot/railtie.rb

@@ -0,0 +1,8 @@
+module CopyBot
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/copy_bot/shell_command.rb

@@ -0,0 +1,21 @@
+module CopyBot
+  class ShellCommand
+    # @param [String] command
+    def initialize(command)
+      @command = command
+    end
+
+    # @return [FalseClass, TrueClass]
+    def execute
+      stdout, stderr, status = Open3.capture3(command)
+      return true if status.exitstatus&.zero?
+
+      CopyBot.config.logger.debug { "#{stdout}, #{stderr}" }
+      false
+    end
+
+    private
+
+    attr_reader :command
+  end
+end

data/lib/copy_bot/step_definitions.rb

@@ -0,0 +1,22 @@
+module CopyBot
+  class StepDefinitions
+    # @return [Hash]
+    attr_reader :loaded_step_definitions
+
+    def initialize
+      @loaded_step_definitions = {}
+    end
+
+    # @param [String] step_definitions_file_path
+    # @return [Hash]
+    def load_step_definitions_file(step_definitions_file_path)
+      @loaded_step_definitions = YAML.safe_load(ERB.new(File.read(step_definitions_file_path)).result)
+                                     .deep_symbolize_keys
+    end
+
+    # @return [Hash]
+    def steps
+      loaded_step_definitions[:steps]
+    end
+  end
+end

data/lib/copy_bot/step_factory.rb

@@ -0,0 +1,32 @@
+module CopyBot
+  class StepFactory
+    attr_reader :step_name
+
+    # @param [Symbol] step_name
+    def initialize(step_name)
+      @step_name = step_name
+    end
+
+    # @return [Class<CopyBot::Steps::BaseStep>]
+    def build # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+      case step_name
+      when :download_remote_db_dump
+        ::CopyBot::Steps::DownloadRemoteDbDump
+      when :create_local_db_backup
+        ::CopyBot::Steps::CreateLocalDbBackup
+      when :drop_local_db_tables
+        ::CopyBot::Steps::DropLocalDbTables
+      when :import_remote_db_to_local_db
+        ::CopyBot::Steps::ImportRemoteDbToLocalDb
+      when :run_migrations_on_local_db
+        ::CopyBot::Steps::RunMigrationsOnLocalDb
+      when :delete_remote_db_dump
+        ::CopyBot::Steps::DeleteRemoteDbDump
+      when :execute_custom_command
+        ::CopyBot::Steps::ExecuteCustomCommand
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/copy_bot/step_runner.rb

@@ -0,0 +1,38 @@
+module CopyBot
+  class StepRunner
+    # @param [String] step_name
+    def initialize(step_name)
+      @step_name = step_name.to_sym
+    end
+
+    # @return [FalseClass, TrueClass]
+    def call # rubocop:disable Metrics/AbcSize
+      logger.info("Started step: #{step_name}")
+
+      step.run
+
+      step.success ? logger.info(step.message) : logger.debug(step.message)
+      step.success
+    end
+
+    private
+
+    attr_reader :step_name
+
+    def logger
+      CopyBot.config.logger
+    end
+
+    def step
+      @step ||= step_class.new(step_definition)
+    end
+
+    def step_definition
+      CopyBot.step_definitions.steps[step_name]
+    end
+
+    def step_class
+      CopyBot::StepFactory.new(step_name).build
+    end
+  end
+end

data/lib/copy_bot/steps/base_step.rb

@@ -0,0 +1,31 @@
+module CopyBot
+  module Steps
+    class BaseStep
+      # @param [String]
+      attr_reader :message
+
+      # @return [FalseClass, TrueClass]
+      attr_reader :success
+
+      # @param [Hash] step_definition
+      def initialize(step_definition)
+        @step_definition = step_definition
+        @message = nil
+        @success = false
+      end
+
+      # @raise [NotImplementedError]
+      def run
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :step_definition
+
+      def step_name
+        self.class.name.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/create_local_db_backup.rb

@@ -0,0 +1,26 @@
+module CopyBot
+  module Steps
+    class CreateLocalDbBackup < BaseStep
+      # @return [String]
+      def run
+        @success = CopyBot::ShellCommand.new(command).execute
+        @message = @success ? 'Created backup of local DB.' : 'Local DB backup creation failed.'
+      end
+
+      private
+
+      def command
+        "PGPASSWORD=#{db_conn_config[:password]} pg_dump -U #{db_conn_config[:username]} -h #{db_conn_config[:host]}" \
+          " -p #{db_conn_config[:port]} #{db_conn_config[:database]} > #{destination_file_path}"
+      end
+
+      def db_conn_config
+        ActiveRecord::Base.connection_db_config.configuration_hash
+      end
+
+      def destination_file_path
+        step_definition[:destination_file_path]
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/delete_remote_db_dump.rb

@@ -0,0 +1,24 @@
+module CopyBot
+  module Steps
+    class DeleteRemoteDbDump < BaseStep
+      # @return [String]
+      def run
+        return @message = 'Missing remote DB dump file' unless remote_db_dump_file_valid?
+
+        File.delete(remote_db_dump_file_path)
+        @success = true
+        @message = "Deleted file #{remote_db_dump_file_path}"
+      end
+
+      private
+
+      def remote_db_dump_file_valid?
+        remote_db_dump_file_path && File.exist?(remote_db_dump_file_path)
+      end
+
+      def remote_db_dump_file_path
+        step_definition[:remote_db_dump_file_path]
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/download_remote_db_dump.rb

@@ -0,0 +1,47 @@
+module CopyBot
+  module Steps
+    class DownloadRemoteDbDump < BaseStep
+      # @return [String]
+      def run
+        return @message = 'Missing S3 credentials in config' unless s3_credentials
+
+        @success = source_object.download_file(destination_file_path)
+        @message = @success ? successful_download_message : 'Remote DB dump download failed.'
+      end
+
+      private
+
+      def s3_credentials
+        step_definition[:s3_credentials]
+      end
+
+      def source_object
+        s3_resource.bucket(s3_credentials[:bucket]).object(source_file_path)
+      end
+
+      def s3_resource
+        Aws::S3::Resource.new(client: s3_client)
+      end
+
+      def s3_client
+        Aws::S3::Client.new(region: s3_credentials[:region], credentials: aws_credentials)
+      end
+
+      def aws_credentials
+        Aws::Credentials.new(s3_credentials[:access_key_id], s3_credentials[:access_key])
+      end
+
+      def successful_download_message
+        "s3://#{s3_credentials[:bucket]}/#{source_file_path} has been downloaded to #{destination_file_path}"
+      end
+
+      def source_file_path
+        step_definition[:source_file_path]
+      end
+
+      def destination_file_path
+        step_definition[:destination_file_path]
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/drop_local_db_tables.rb

@@ -0,0 +1,17 @@
+module CopyBot
+  module Steps
+    class DropLocalDbTables < BaseStep
+      # @return [String]
+      def run
+        conn = ActiveRecord::Base.connection
+        conn.tables.each do |table|
+          CopyBot.config.logger.info("Dropping #{table}")
+          conn.drop_table(table, force: :cascade, if_exists: true)
+        end
+
+        @success = true
+        @message = 'Reset local DB schema.'
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/execute_custom_command.rb

@@ -0,0 +1,21 @@
+module CopyBot
+  module Steps
+    class ExecuteCustomCommand < BaseStep
+      # @return [String]
+      def run
+        return @message = 'Custom command missing' unless custom_command
+
+        @success = CopyBot::ShellCommand.new(custom_command).execute
+        @message = @success ? 'Custom command executed.' : 'Custom command failed.'
+      end
+
+      private
+
+      def custom_command
+        return unless step_definition
+
+        step_definition[:command]
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/import_remote_db_to_local_db.rb

@@ -0,0 +1,32 @@
+module CopyBot
+  module Steps
+    class ImportRemoteDbToLocalDb < BaseStep
+      # @return [String]
+      def run
+        return @message = 'Missing remote DB dump file' unless source_file_valid?
+
+        @success = CopyBot::ShellCommand.new(command).execute
+        @message = @success ? 'Imported remote DB to local DB.' : 'Remote DB to local DB import failed.'
+      end
+
+      private
+
+      def source_file_valid?
+        source_file_path && File.exist?(source_file_path)
+      end
+
+      def source_file_path
+        step_definition[:remote_db_dump_file_path]
+      end
+
+      def command
+        "PGPASSWORD=#{db_conn_config[:password]} psql -U #{db_conn_config[:username]} -h #{db_conn_config[:host]} " \
+          "-p #{db_conn_config[:port]} #{db_conn_config[:database]} < #{source_file_path}"
+      end
+
+      def db_conn_config
+        ActiveRecord::Base.connection_db_config.configuration_hash
+      end
+    end
+  end
+end

data/lib/copy_bot/steps/run_migrations_on_local_db.rb

@@ -0,0 +1,12 @@
+module CopyBot
+  module Steps
+    class RunMigrationsOnLocalDb < BaseStep
+      # @return [String]
+      def run
+        Rake::Task['db:migrate'].invoke
+        @success = true
+        @message = 'Ran migrations on local DB.'
+      end
+    end
+  end
+end

data/lib/copy_bot/tasks/copy_bot.rake

@@ -0,0 +1,26 @@
+desc 'Starting point for data sync'
+task copy_bot: :environment do
+  logger = CopyBot.config.logger
+
+  unless CopyBot.config.permitted_environments.include?(Rails.env)
+    logger.debug('Forbidden to run in this environment')
+    abort
+  end
+
+  step_definitions_file_path = Rails.root.join(ENV['STEP_DEFINITIONS_FILE_PATH'])
+  unless step_definitions_file_path && File.exist?(step_definitions_file_path)
+    logger.debug('Invalid or missing step_definitions file path')
+    abort
+  end
+
+  CopyBot.step_definitions.load_step_definitions_file(step_definitions_file_path)
+  unless CopyBot.step_definitions.steps
+    logger.debug('Missing steps in config')
+    abort
+  end
+
+  CopyBot.step_definitions.steps.each_key do |step_name|
+    success = CopyBot::StepRunner.new(step_name).call
+    abort unless success
+  end
+end

data/lib/copy_bot/version.rb

@@ -0,0 +1,3 @@
+module CopyBot
+  VERSION = '0.1.0'.freeze
+end

data/lib/copy_bot.rb

@@ -0,0 +1,41 @@
+require 'active_record'
+require 'aws-sdk-s3'
+require 'erb'
+require 'logger'
+require 'open3'
+require 'rake'
+require 'rails'
+require 'yaml'
+
+require 'copy_bot/version'
+require 'copy_bot/shell_command'
+require 'copy_bot/config'
+require 'copy_bot/railtie' if defined?(Rails::Railtie)
+require 'copy_bot/step_definitions'
+require 'copy_bot/step_factory'
+require 'copy_bot/step_runner'
+require 'copy_bot/steps/base_step'
+require 'copy_bot/steps/create_local_db_backup'
+require 'copy_bot/steps/delete_remote_db_dump'
+require 'copy_bot/steps/download_remote_db_dump'
+require 'copy_bot/steps/drop_local_db_tables'
+require 'copy_bot/steps/execute_custom_command'
+require 'copy_bot/steps/import_remote_db_to_local_db'
+require 'copy_bot/steps/run_migrations_on_local_db'
+
+module CopyBot
+  # @yield [CopyBot::Config]
+  def self.setup
+    yield config
+  end
+
+  # @return [CopyBot::Config]
+  def self.config
+    @config ||= Config.new
+  end
+
+  # @return [CopyBot::StepDefinitions]
+  def self.step_definitions
+    @step_definitions ||= StepDefinitions.new
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: copy_bot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rails Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-infinum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a rake task for importing a database dump into a database on
+  a particular environment.
+email:
+- team.rails@infinum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- copy_bot.gemspec
+- lib/copy_bot.rb
+- lib/copy_bot/config.rb
+- lib/copy_bot/railtie.rb
+- lib/copy_bot/shell_command.rb
+- lib/copy_bot/step_definitions.rb
+- lib/copy_bot/step_factory.rb
+- lib/copy_bot/step_runner.rb
+- lib/copy_bot/steps/base_step.rb
+- lib/copy_bot/steps/create_local_db_backup.rb
+- lib/copy_bot/steps/delete_remote_db_dump.rb
+- lib/copy_bot/steps/download_remote_db_dump.rb
+- lib/copy_bot/steps/drop_local_db_tables.rb
+- lib/copy_bot/steps/execute_custom_command.rb
+- lib/copy_bot/steps/import_remote_db_to_local_db.rb
+- lib/copy_bot/steps/run_migrations_on_local_db.rb
+- lib/copy_bot/tasks/copy_bot.rake
+- lib/copy_bot/version.rb
+homepage: https://github.com/infinum/copy_bot
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/infinum/copy_bot
+  source_code_uri: https://github.com/infinum/copy_bot
+  changelog_uri: https://github.com/infinum/copy_bot/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Tool for syncing data between two environments.
+test_files: []