uff_db_loader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95175e122ab4572d155f684796d9093587d5764d330855f3f50707491d223185
+  data.tar.gz: da94a660905f4e8a768735343347bf7b8016d67a2a706c245360a14ab0eb7a02
+SHA512:
+  metadata.gz: f9ca8396b85bb4d5665f209d50dc183b97ce8020ac0393429e6f884f3455fa81cf4c6206bf05c80a6c8c1ac85d35ae254cfc919db0aa14b7a6c6425c39ac7dd1
+  data.tar.gz: a64fb6d2c537c3b5004234253ad7c7fc5acd150fa1e5b09265d8a3d89a730834dd49a1510251e1934684fe88df34a74e6453948d44ff4e45e9f5ab94eac0d1d2

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at robin@coding-robin.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in uff_db_loader.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Robin Mehner
+
+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,65 @@
+# UffDbLoader
+
+## Description
+
+`uff_db_loader` provides rake tasks to download and import databases in rails projects with a dockerized deployment that we use in multiple projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uff_db_loader'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install uff_db_loader
+
+## Configuration
+
+You can configure the gem by running the following during the initialization of the Rails app:
+```ruby
+# frozen_string_literal: true
+
+UffDbLoader.configure do |config|
+  config.environments = ['sandbox', 'production'] # default is "['staging', 'production']"
+  config.ssh_user = 'Francina'
+  config.ssh_host = 'host.of.yoursite'
+  config.db_name = 'twotter'
+  config.db_system = :postgresql # Possible values are 'postgresql' and 'mysql'.
+  config.app_name = 'my_app' # Defaults to the Rails app name
+  config.dumps_directory = '/path/to/dumps' # Defaults to Rails.root.join('dumps')
+  config.database_config_file = 'path/to/database.yml' # Defaults to Rails.root.join('config', 'database.yml')
+end
+```
+For example in a file like `config/initializers/uff_db_loader.rb`.
+
+Make sure the app's database user has the superuser role. Otherwise the app will crash on startup due to missing permissions.
+
+## Usage
+
+`uff_db_loader` provides `rails remote_database:dump` and `rails remote_database:load` which will prompt for a configured environment.
+`dump` will only create and download a current database dump, while `load`, will do the same and restore the database content into a new database and gives instructions on how to use it in development.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rmehner/uff_db_loader. 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/rmehner/uff_db_loader/blob/main/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 UffDbLoader project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rmehner/uff_db_loader/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "uff_db_loader"
+
+# 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/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "uff_db_loader"
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/*.rake").each { |f| import f }

data/lib/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "uff_db_loader/postgresql"
+require "uff_db_loader/mysql"
+
+module UffDbLoader
+  class Configuration
+    attr_accessor :environments, :ssh_host, :ssh_user, :db_name, :db_system, :app_name, :dumps_directory, :database_config_file
+
+    def initialize
+      @environments = %w[staging production]
+      @ssh_host = nil
+      @ssh_user = nil
+      @db_name = nil
+      @db_system = nil
+      @app_name = Dir.pwd.split("/").last
+      @dumps_directory = File.join(Dir.pwd, "dumps")
+      @database_config_file = File.join(Dir.pwd, "config", "database.yml")
+    end
+
+    def database
+      db_name || ssh_user
+    end
+
+    def database_system
+      case db_system.to_sym
+      when :postgresql
+        UffDbLoader::Postgresql
+      when :mysql
+        UffDbLoader::Mysql
+      else
+        raise UnknownDatabaseSystem, "Could not identify database system. Use `config.db_system` to configure it."
+      end
+    end
+  end
+end

data/lib/railtie.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "uff_db_loader"
+require "rails"
+
+module UffDbLoader
+  class Railtie < Rails::Railtie
+    railtie_name "uff_db_loader"
+
+    initializer "uff_db_loader.setup" do |app|
+      UffDbLoader.configure do |config|
+        config.dumps_directory = Rails.root.join("dumps")
+        config.database_config_file = Rails.root.join("config", "database.yml")
+        config.app_name = (Rails.application.class.respond_to?(:parent_name) ? Rails.application.class.parent_name : Rails.application.class.module_parent_name).downcase
+      end
+    end
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/uff_db_loader/tasks/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/uff_db_loader/mysql.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module UffDbLoader
+  module Mysql
+    def self.dump_extension
+      "sql"
+    end
+
+    def self.dump_command_template
+      "ssh %user%@%host% \"docker exec -i %app_name%_%environment%_db sh -c 'exec mysqldump --opt --no-tablespaces -uroot -p\"\\$MYSQL_ROOT_PASSWORD\" %database%'\" > %target%"
+    end
+
+    def self.restore_command(database_name, result_file_path)
+      "mysql -uroot #{database_name} < #{result_file_path}"
+    end
+  end
+end

data/lib/uff_db_loader/postgresql.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module UffDbLoader
+  module Postgresql
+    def self.dump_extension
+      "dump"
+    end
+
+    def self.dump_command_template
+      "ssh %user%@%host% \"docker exec -i %app_name%_%environment%_db sh -c 'exec pg_dump --username \\$POSTGRES_USER --clean --no-owner --no-acl --format=c %database%'\" > %target%"
+    end
+
+    def self.restore_command(database_name, result_file_path)
+      "pg_restore --username postgres --clean --if-exists --no-owner --no-acl --dbname #{database_name} #{result_file_path}"
+    end
+  end
+end

data/lib/uff_db_loader/tasks/remote_database.rake

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+namespace :remote_database do
+  desc "Dumps a remote database to #{UffDbLoader.config.dumps_directory}"
+  task dump: :environment do
+    prompt = TTY::Prompt.new
+    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
+    UffDbLoader.ensure_valid_environment!(environment)
+    UffDbLoader.dump_from(environment)
+  end
+
+  desc "Gets a dump from remote and loads it into the local database"
+  task load: :environment do
+    prompt = TTY::Prompt.new
+    environment = prompt.select("Which environment should we get the dump from?", UffDbLoader.config.environments)
+    UffDbLoader.ensure_valid_environment!(environment)
+    result_file_path = UffDbLoader.dump_from(environment)
+
+    puts "🤓 Reading from to #{result_file_path}"
+
+    database_name = File.basename(result_file_path, ".*")
+    ActiveRecord::Base.connection.execute("CREATE DATABASE #{database_name};")
+
+    puts "🗂  Created database #{database_name}"
+
+    command_successful = system(UffDbLoader.restore_command(database_name, result_file_path))
+    raise "Command did not run succesful: #{UffDbLoader.restore_command(database_name, result_file_path)}" unless command_successful
+
+    puts "✅ Succesfully loaded #{result_file_path} into #{database_name}"
+
+    puts "💩 Because YAML is a wonderful format, you need to adapt your config file by hand."
+    puts "🆗 Go to #{UffDbLoader.config.database_config_file} and change the development database value to: #{database_name}"
+    puts "🧑🏾‍🏫 Don't forgot to restart the Rails server after changing the database config (`rails restart`)"
+  end
+end

data/lib/uff_db_loader/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module UffDbLoader
+  VERSION = "1.0.0"
+end

data/lib/uff_db_loader.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "uff_db_loader/version"
+require "configuration"
+
+module UffDbLoader
+  require "railtie"
+
+  def self.config
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(config)
+  end
+
+  def self.dump_from(environment)
+    FileUtils.mkdir_p(config.dumps_directory)
+
+    puts "⬇️  Creating dump ..."
+
+    target = File.join(config.dumps_directory, Time.now.strftime("#{config.app_name}_#{environment}_%Y_%m_%d_%H_%M_%S.#{config.database_system.dump_extension}"))
+    command_successful = system(dump_command(environment, target))
+    raise "Command did not run succesful: #{dump_command(environment, target)}" unless command_successful
+
+    puts "✅ Succesfully dumped to #{target}"
+
+    target
+  end
+
+  def self.dump_command(environment, target)
+    config
+      .database_system
+      .dump_command_template
+      .gsub("%environment%", environment)
+      .gsub("%host%", config.ssh_host)
+      .gsub("%user%", config.ssh_user)
+      .gsub("%database%", config.database)
+      .gsub("%target%", target)
+      .gsub("%app_name%", config.app_name)
+  end
+
+  def self.ensure_valid_environment!(environment)
+    unless config.environments.include?(environment)
+      raise ForbiddenEnvironmentError, "Invalid environment: #{environment}."
+    end
+  end
+
+  def self.restore_command(database_name, result_file_path)
+    config.database_system.restore_command(database_name, result_file_path)
+  end
+
+  class ForbiddenEnvironmentError < StandardError; end
+
+  class UnknownDatabaseSystem < StandardError; end
+end

data/uff_db_loader.gemspec

@@ -0,0 +1,33 @@
+require_relative "lib/uff_db_loader/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "uff_db_loader"
+  spec.version = UffDbLoader::VERSION
+  spec.authors = ["Andreas Hellwig", "Fynn Heintz", "Robin Mehner"]
+  spec.email = ["robin@coding-robin.de"]
+
+  spec.summary = "Allows to dump, download and restore databases from docker servers."
+  spec.description = "Allows to dump, download and restore databases from servers with a specific docker setup, that UFF uses commonly."
+  spec.homepage = "https://github.com/rmehner/uff_db_loader"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata = {
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "changelog_uri" => "#{spec.homepage}/releases/tag/#{spec.version}",
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "#{spec.homepage}/tree/#{spec.version}"
+  }
+
+  # 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 "tty-prompt"
+  spec.add_dependency "activerecord", ">= 5.2"
+  spec.add_dependency "railties", ">= 5.2"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: uff_db_loader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andreas Hellwig
+- Fynn Heintz
+- Robin Mehner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description: Allows to dump, download and restore databases from servers with a specific
+  docker setup, that UFF uses commonly.
+email:
+- robin@coding-robin.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/Rakefile
+- lib/configuration.rb
+- lib/railtie.rb
+- lib/uff_db_loader.rb
+- lib/uff_db_loader/mysql.rb
+- lib/uff_db_loader/postgresql.rb
+- lib/uff_db_loader/tasks/remote_database.rake
+- lib/uff_db_loader/version.rb
+- uff_db_loader.gemspec
+homepage: https://github.com/rmehner/uff_db_loader
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/rmehner/uff_db_loader/issues
+  changelog_uri: https://github.com/rmehner/uff_db_loader/releases/tag/1.0.0
+  homepage_uri: https://github.com/rmehner/uff_db_loader
+  source_code_uri: https://github.com/rmehner/uff_db_loader/tree/1.0.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: Allows to dump, download and restore databases from docker servers.
+test_files: []