bleib 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a34d27aee38f1710132dd474bc51bf4e2653b0b
+  data.tar.gz: 99174d377d7b00fbcafbcb2e834131926de04b73
+SHA512:
+  metadata.gz: ce8c1536ee576b3d8b3fe5448e01ea0f92558688af1c746234e7042795be081a7c1329a768634c82d3ea13b4aa348d524e4893fafd47d73c317e668448d6e508
+  data.tar.gz: 88ad1141821e37b1575c4e0aa4a17f6e42815a8acf34950175ac3563d19e846cce271a043dcc293b0c7665c2d3f2f8be906a2425226c237d15b438c71300e4fa

data/lib/bleib.rb

@@ -0,0 +1,10 @@
+require 'bleib/version'
+
+require 'bleib/railtie' if defined?(Rails)
+
+require 'bleib/configuration'
+require 'bleib/database'
+require 'bleib/migrations'
+
+module Bleib
+end

data/lib/bleib/configuration.rb

@@ -0,0 +1,94 @@
+module Bleib
+  class Configuration
+    class UnsupportedAdapterException < Exception; end
+    class DatabaseYmlNotFoundException < Exception; end
+
+    attr_reader :database, :check_database_interval, :check_migrations_interval
+
+    DEFAULT_CHECK_DATABASE_INTERVAL = 5 # Seconds
+    DEFAULT_CHECK_MIGRATIONS_INTERVAL = 5 # Seconds
+    DEFAULT_DATABASE_YML_PATH = 'config/database'
+
+    def self.from_environment
+      check_database_interval = interval_or_default(
+        ENV['BLEIB_CHECK_DATABASE_INTERVAL'],
+        DEFAULT_CHECK_DATABASE_INTERVAL
+      )
+      check_migrations_interval = interval_or_default(
+        ENV['BLEIB_CHECK_MIGRATIONS_INTERVAL'],
+        DEFAULT_CHECK_MIGRATIONS_INTERVAL
+      )
+
+      database_yml_path = ENV['BLEIB_DATABASE_YML_PATH']
+      database_yml_path ||= File.expand_path('config/database.yml')
+      ensure_database_yml!(database_yml_path)
+
+      rails_env = ENV['RAILS_ENV'] || 'development'
+
+      new(
+        rails_database(database_yml_path, rails_env),
+        check_database_interval: check_database_interval.to_i,
+        check_migrations_interval: check_migrations_interval.to_i
+      )
+    end
+
+    def initialize(database_configuration,
+                   check_database_interval: DEFAULT_CHECK_DATABASE_INTERVAL,
+                   check_migrations_interval: DEFAULT_CHECK_MIGRATIONS_INTERVAL)
+      # To be 100% sure which connection the
+      # active record pool creates, returns or removes.
+      only_one_connection = { 'pool' => 1 }
+
+      @database = database_configuration.merge(only_one_connection)
+
+      @check_database_interval = check_database_interval
+      @check_migrations_interval = check_migrations_interval
+
+      check!
+    end
+
+    def logger
+      return @logger unless @logger.nil?
+
+      @logger = Logger.new(STDOUT)
+      @logger.level = if ENV['BLEIB_LOG_LEVEL'] == 'debug'
+                        Logger::DEBUG
+                      else
+                        Logger::INFO
+                      end
+      @logger
+    end
+
+    private
+
+    def self.interval_or_default(string, default)
+      given = string.to_i
+      given <= 0 ? default : given
+    end
+
+    def self.ensure_database_yml!(path)
+      return if File.exist?(path)
+
+      fail DatabaseYmlNotFoundException,
+           'database.yml not found, set or fix' \
+           ' BLEIB_DATABASE_YML_PATH or execute me' \
+           ' from the rails root.'
+    end
+
+    def self.rails_database(database_yml_path, rails_env)
+      contents = File.read(database_yml_path)
+      config = YAML.load(ERB.new(contents).result)
+      config[rails_env]
+    end
+
+    def check!
+      # We should add clean rescue statements to
+      # `Bleib::Database#database_down?`to support
+      # other adapters.
+      if @database['adapter'] != 'postgresql'
+        fail UnsupportedAdapterException,
+             "Unknown database adapter #{@database['adapter']}"
+      end
+    end
+  end
+end

data/lib/bleib/database.rb

@@ -0,0 +1,73 @@
+module Bleib
+  # Finds out if a database is running and accessible.
+  #
+  # Does so by using ActiveRecord without a booted rails
+  # environment (because a non-accessible database can
+  # cause the bootup to fail).
+  class Database
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def wait_for_connection
+      logger.info('Waiting for connection to database')
+
+      wait while database_down?
+
+      logger.info('Connection to database established')
+
+      # Nobody else shall use our single-connection pool.
+      remove_connection
+    end
+
+    private
+
+    def wait
+      duration = @configuration.check_database_interval
+
+      logger.debug "Waiting for #{duration} seconds"
+
+      sleep(duration)
+    end
+
+    def database_down?
+      logger.debug('Checking database')
+
+      # Adopted from the default OpenShift readiness check for postgresql.
+      ActiveRecord::Base.establish_connection(@configuration.database)
+      ActiveRecord::Base.connection.execute('SELECT 1;')
+
+      logger.debug('Database check succeeded')
+
+      false
+    rescue PG::ConnectionBad => e
+      # On stopped database:
+      #   PG::ConnectionBad: could not connect to server: Connection refused
+      #   Is the server running on host "127.0.0.1" and accepting
+      #   TCP/IP connections on port 5432?
+      # On wrong/missing user:
+      #   PG::ConnectionBad: FATAL:  password authentication failed for user "wrong"
+      # On wrong password:
+      #   PG::ConnectionBad: FATAL:  password authentication failed for user "user"
+
+      logger.debug("Database check failed: #{e}")
+
+      true
+    rescue ActiveRecord::NoDatabaseError
+      # On missing database:
+      #   ActiveRecord::NoDatabaseError: FATAL:  database "wrong" does not exist
+
+      logger.debug("Database check failed: #{e}")
+
+      true
+    end
+
+    def remove_connection
+      ActiveRecord::Base.remove_connection
+    end
+
+    def logger
+      @configuration.logger
+    end
+  end
+end

data/lib/bleib/migrations.rb

@@ -0,0 +1,71 @@
+module Bleib
+  # Finds out if all migrations are up.
+  #
+  # Knows how to handle multitenancy with Apartment, if used.
+  class Migrations
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def wait_until_done
+      logger.info('Waiting for migrations' \
+                   ' (Also checking apartment tenants:' \
+                   " #{apartment_gem? ? 'yes' : 'no'})")
+
+      wait while pending_migrations?
+
+      logger.info('All migrations are up')
+    end
+
+    private
+
+    def wait
+      duration = @configuration.check_migrations_interval
+
+      logger.debug "Waiting for #{@configuration.check_migrations_interval} seconds"
+
+      sleep(duration)
+    end
+
+    def pending_migrations?
+      logger.debug('Checking migrations')
+
+      if apartment_gem?
+        in_all_tenant_contexts { check_migrations! }
+      else
+        check_migrations!
+      end
+
+      logger.debug('Migrations check succeeded.')
+
+      false
+    rescue ActiveRecord::PendingMigrationError
+      logger.debug('Migrations pending, check failed')
+
+      true
+    end
+
+    def apartment_gem?
+      defined?(Apartment::Tenant)
+    end
+
+    def check_migrations!
+      ActiveRecord::Migration.check_pending!
+    end
+
+    def in_all_tenant_contexts
+      tenants = ['public']
+      Apartment::Tenant.each { |tenant| tenants << tenant }
+
+      tenants.each do |tenant|
+        Apartment::Tenant.switch(tenant) do
+          yield
+        end
+      end
+    end
+
+    def logger
+      @configuration.logger
+    end
+  end
+end

data/lib/bleib/railtie.rb

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

data/lib/bleib/version.rb

@@ -0,0 +1,3 @@
+module Bleib
+  VERSION = '0.0.7'.freeze
+end

data/lib/tasks/bleib.rake

@@ -0,0 +1,14 @@
+namespace :bleib do
+  desc 'Waits for database access'
+  task :wait_for_database do
+    configuration = Bleib::Configuration.from_environment
+    Bleib::Database.new(configuration).wait_for_connection
+  end
+
+  desc 'Waits for database access and migrations'
+  task wait_for_migrations: [:wait_for_database, :environment] do
+    configuration = Bleib::Configuration.from_environment
+
+    Bleib::Migrations.new(configuration).wait_until_done
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: bleib
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Puzzle ITC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-04 00:00:00.000000000 Z
+dependencies: []
+description: Intended for use in containerized setups whereanother component takes
+  care of migrating the database.
+email: raez@puzzle.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bleib.rb
+- lib/bleib/configuration.rb
+- lib/bleib/database.rb
+- lib/bleib/migrations.rb
+- lib/bleib/railtie.rb
+- lib/bleib/version.rb
+- lib/tasks/bleib.rake
+homepage: http://rubygems.org/gems/bleib
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/puzzle/bleib
+  documentation_uri: https://github.com/puzzle/bleib
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Use a rake task to wait on database and migrations.
+test_files: []
+has_rdoc: