orchestration 0.5.14 → 0.6.0

data/lib/orchestration/service_check.rb

@@ -3,7 +3,7 @@
 module Orchestration
   class ServiceCheck
     ATTEMPT_LIMIT = ENV.fetch('ORCHESTRATION_RETRY_LIMIT', '15').to_i
-    RETRY_INTERVAL = ENV.fetch('ORCHESTRATION_RETRY_INTERVAL', '10').to_i
+    RETRY_INTERVAL = ENV.fetch('ORCHESTRATION_RETRY_INTERVAL', '15').to_i
 
     def initialize(service, terminal, options = {})
       @service = service
@@ -31,36 +31,36 @@ module Orchestration
       @service.connect
       true
     rescue *@service.connection_errors => e
-      @attempts += 1
-      sleep @retry_interval
+      wait_failure(e)
       retry unless @attempts == @attempt_limit
       echo_error(e)
       echo_failure
       false
     end
 
-    def echo_start
-      @terminal.write(@service_name.to_sym, '', :status)
+    def wait_failure(error)
+      @attempts += 1
+      @last_error = error
+      sleep @retry_interval
     end
 
-    def echo_waiting
-      @terminal.write(:waiting, service_waiting)
+    def last_error
+      return nil if @last_error.nil?
+
+      last_error_message
     end
 
-    def service_waiting
-      I18n.t(
-        "orchestration.#{@service_name}.waiting",
-        config: friendly_config,
-        default: default_waiting
-      )
+    def last_error_message
+      "(#{@last_error&.cause&.class&.name || @last_error&.class&.name})"
     end
 
-    def default_waiting
-      I18n.t(
-        'orchestration.custom_service.waiting',
-        config: friendly_config,
-        service: @service_name
-      )
+    def echo_start
+      @terminal.write(@service_name.to_sym, '', :status)
+      @terminal.write(:config, friendly_config)
+    end
+
+    def echo_waiting
+      @terminal.write(:waiting, last_error)
     end
 
     def echo_ready
@@ -68,30 +68,16 @@ module Orchestration
     end
 
     def service_ready
-      I18n.t(
-        "orchestration.#{@service_name}.ready",
-        config: friendly_config,
-        default: default_ready
-      )
-    end
-
-    def default_ready
-      I18n.t(
-        'orchestration.custom_service.ready',
-        config: friendly_config,
-        service: @service_name
-      )
+      I18n.t('orchestration.service.ready', service: @service_name)
     end
 
     def echo_failure
-      @terminal.write(
-        :failure,
-        I18n.t('orchestration.attempt_limit', limit: @attempt_limit)
-      )
+      @terminal.write(:failure, I18n.t('orchestration.attempt_limit', limit: @attempt_limit))
     end
 
     def echo_error(error)
-      @terminal.write(:error, "[#{error.class.name}] #{error.message}")
+      cause = error.cause.nil? ? error : error.cause
+      @terminal.write(:error, "[#{cause.class.name}] #{cause.message}")
     end
 
     def friendly_config

data/lib/orchestration/services/database/adapters.rb

@@ -9,6 +9,7 @@ module Orchestration
   end
 end
 
+require 'orchestration/services/database/adapters/adapter_base'
 require 'orchestration/services/database/adapters/mysql2'
 require 'orchestration/services/database/adapters/postgresql'
 require 'orchestration/services/database/adapters/sqlite3'

data/lib/orchestration/services/database/adapters/adapter_base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Database
+      module Adapters
+        module AdapterBase
+          attr_reader :config
+
+          def initialize(config = nil)
+            @config = config
+          end
+
+          def console_command
+            I18n.t("orchestration.dbconsole.#{name}") % config.settings.transform_keys(&:to_sym)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orchestration/services/database/adapters/mysql2.rb

@@ -5,6 +5,8 @@ module Orchestration
     module Database
       module Adapters
         class Mysql2
+          include AdapterBase
+
           def name
             'mysql2'
           end

data/lib/orchestration/services/database/adapters/postgresql.rb

@@ -5,6 +5,8 @@ module Orchestration
     module Database
       module Adapters
         class Postgresql
+          include AdapterBase
+
           def name
             'postgresql'
           end

data/lib/orchestration/services/database/adapters/sqlite3.rb

@@ -5,6 +5,8 @@ module Orchestration
     module Database
       module Adapters
         class Sqlite3
+          include AdapterBase
+
           def name
             'sqlite3'
           end

data/lib/orchestration/services/database/configuration.rb

@@ -33,6 +33,10 @@ module Orchestration
           sqlite? || super
         end
 
+        def console_command
+          adapter.console_command
+        end
+
         def adapter
           url_adapter = url_config['adapter']
           file_adapter = file_config['adapter']
@@ -115,7 +119,7 @@ module Orchestration
             'mysql' => adapters::Mysql2,
             'postgresql' => adapters::Postgresql,
             'sqlite3' => adapters::Sqlite3
-          }.fetch(name).new
+          }.fetch(name).new(self)
         rescue KeyError
           Orchestration.error('database.unknown_adapter', adapter: name.inspect)
           raise

data/lib/orchestration/services/mixins/configuration_base.rb

@@ -53,7 +53,7 @@ module Orchestration
         local, remote = parse_port(service).map(&:to_i)
         return remote if @env.environment == 'test' && @options[:sidecar]
 
-        (@env.environment == 'production' ? remote : local)
+        (@env.environment == 'deployment' ? remote : local)
       end
 
       def service

data/lib/orchestration/templates/Dockerfile.erb

@@ -2,7 +2,7 @@ FROM ruby:<%= ruby_version %>
 ARG BUNDLE_BITBUCKET__ORG
 ARG BUNDLE_GITHUB__COM
 ARG GIT_COMMIT
-RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - \
+RUN curl -sL https://deb.nodesource.com/setup_14.x | bash - \
  && apt-get update \
  && DEBIAN_FRONTEND=noninteractive apt-get install -y \
       nodejs \
@@ -13,17 +13,13 @@ RUN curl -sL https://deb.nodesource.com/setup_10.x | bash - \
  && mkdir /app<%if defined?(Webpacker) %> \
  && curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash \
  && . /root/.bashrc \
- && nvm install 10.13.0 \
+ && nvm install 14.16.0 \
  && npm config set user 0 \
  && npm config set unsafe-perm true \
  && npm install -g yarn<% end %>
 WORKDIR /app
 COPY .build/Gemfile .build/Gemfile.lock ./
 RUN bundle install --without development test --deployment
-<% if defined?(Webpacker) %>
-COPY .build/package.json .build/yarn.lock ./
-RUN . /root/.bashrc ; yarn install
-<% end %>
 ADD .build/context.tar .
 <% if defined?(Webpacker) %>RUN . /root/.bashrc ; NODE_ENV=production RAILS_ENV=production yarn install && NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=abc123 bundle exec rake assets:precompile<% elsif Rake::Task.tasks.map(&:name).include?('assets:precompile') %>RUN NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=abc123 bundle exec rake assets:precompile<% end %>
 RUN echo "${GIT_COMMIT}" > /app/GIT_COMMIT

data/lib/orchestration/templates/application.mk.erb

@@ -1,20 +1,36 @@
+include $(shell bundle exec ruby -e 'require "orchestration/make"')
+
 #
 # Example test command
 #
-# This command will call `test-setup` before running your usual test pipeline.
+# Define your test tasks here. The default command runs RSpec and Rubocop but
+# you can feel free to add any other tasks you like.
 #
-# `test-setup` starts all containers specified in `docker-compose.test.yml`,
-# waits for them to be ready, and runs DB migrations.
+# Set up your test dependencies and run tests by calling: `make setup test`
 #
-# In your CI environment, simply run `make test`.
+# Subsequent test runs can skip the setup step and simply run: `make test`
 #
 .PHONY: test
-test: test-setup
+test:
 	bundle exec rspec
 	bundle exec rubocop
 
-# Start development containers and create/migrate/seed database
-.PHONY: develop
+#
+# Define any custom setup that needs to take place before running tests.
+# If the command exists, it will be called immediately after the `setup`
+# command (which starts containers and sets up the database).
+#
+# This command can be deleted if it is not needed.
+#
+.PHONY: post-setup
+post-setup:
+	# Setup tasks that are not already provided by Orchestration go here.
+
+#
+# Launch all dependencies needed for a development environment and set up the
+# development database.
+#
+.PHONY: setup
 develop:
 	bundle install
 	@$(MAKE) start env=test

data/lib/orchestration/terminal.rb

@@ -4,7 +4,6 @@ module Orchestration
   COLOR_MAP = {
     failure: %i[red bright],
     error: %i[red],
-    waiting: %i[yellow],
     ready: %i[green],
     create: %i[green],
     update: %i[yellow],
@@ -12,7 +11,9 @@ module Orchestration
     status: %i[blue],
     setup: %i[blue],
     input: %i[red],
-    skip: %i[yellow bright]
+    skip: %i[yellow bright],
+    waiting: %i[yellow],
+    config: %i[cyan]
   }.freeze
 
   class Terminal
@@ -20,7 +21,7 @@ module Orchestration
       @settings = settings
     end
 
-    def write(desc, message, color_name = nil, newline: true)
+    def write(desc, message = nil, color_name = nil, newline: true)
       output = newline ? "#{message}\n" : message.to_s
       $stdout.print colorize(desc, output, color_name)
       $stdout.flush

data/lib/orchestration/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orchestration
-  VERSION = '0.5.14'
+  VERSION = '0.6.0'
 end

data/lib/tasks/orchestration.rake

@@ -8,11 +8,9 @@ namespace :orchestration do
     Orchestration::InstallGenerator.start
   end
 
-  namespace :install do
-    desc I18n.t('orchestration.rake.install_makefile')
-    task :makefile do
-      Orchestration::InstallGenerator.new.orchestration_makefile
-    end
+  desc I18n.t('orchestration.makefile')
+  task :makefile do
+    Orchestration.makefile
   end
 
   desc I18n.t('orchestration.rake.config')
@@ -21,6 +19,20 @@ namespace :orchestration do
     puts "#{config['docker']['organization']} #{config['docker']['repository']}"
   end
 
+  namespace :db do
+    desc I18n.t('orchestration.rake.db.url')
+    task :url do
+      puts DatabaseUrl.to_active_record_url(Rails.application.config_for(:database))
+    end
+
+    desc I18n.t('orchestration.rake.db.console')
+    task :console do
+      env = Orchestration::Environment.new
+      options = ENV['db'] ? { config_path: "config/database.#{ENV['db']}.yml" } : {}
+      sh Orchestration::Services::Database::Configuration.new(env, nil, options).console_command
+    end
+  end
+
   desc I18n.t('orchestration.rake.healthcheck')
   task :healthcheck do
     Orchestration::DockerHealthcheck.execute
@@ -28,7 +40,6 @@ namespace :orchestration do
 
   desc I18n.t('orchestration.rake.wait')
   task :wait do
-    Orchestration::InstallGenerator.new.verify_makefile(skip: false)
     env = Orchestration::Environment.new
     services = Orchestration::Services
     env.docker_compose_config['services'].each do |name, _service|

data/orchestration.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'erubis', '~> 2.7'
   spec.add_runtime_dependency 'i18n', '>= 0.5'
   spec.add_runtime_dependency 'paint', '~> 2.0'
+  spec.add_runtime_dependency 'rails', '~> 6.0'
   spec.add_runtime_dependency 'thor', '~> 1.0'
 
   spec.add_development_dependency 'activerecord', '~> 6.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.5.14
+  version: 0.6.0
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -355,6 +369,8 @@ files:
 - lib/orchestration/errors.rb
 - lib/orchestration/file_helpers.rb
 - lib/orchestration/install_generator.rb
+- lib/orchestration/make.rb
+- lib/orchestration/make/orchestration.mk
 - lib/orchestration/railtie.rb
 - lib/orchestration/service_check.rb
 - lib/orchestration/services.rb
@@ -363,6 +379,7 @@ files:
 - lib/orchestration/services/app/healthcheck.rb
 - lib/orchestration/services/database.rb
 - lib/orchestration/services/database/adapters.rb
+- lib/orchestration/services/database/adapters/adapter_base.rb
 - lib/orchestration/services/database/adapters/mysql2.rb
 - lib/orchestration/services/database/adapters/postgresql.rb
 - lib/orchestration/services/database/adapters/sqlite3.rb
@@ -386,9 +403,7 @@ files:
 - lib/orchestration/templates/database.yml.erb
 - lib/orchestration/templates/entrypoint.sh.erb
 - lib/orchestration/templates/env.erb
-- lib/orchestration/templates/makefile_macros.mk.erb
 - lib/orchestration/templates/mongoid.yml.erb
-- lib/orchestration/templates/orchestration.mk.erb
 - lib/orchestration/templates/puma.rb.erb
 - lib/orchestration/templates/rabbitmq.yml.erb
 - lib/orchestration/templates/unicorn.rb.erb

data/lib/orchestration/templates/makefile_macros.mk.erb

@@ -1,112 +0,0 @@
-TERM ?= 'dumb'
-pwd:=$(shell pwd)
-ifdef mounted_orchestration
-  orchestration_dir=$(mounted_orchestration)
-else
-  orchestration_dir=${pwd}/<%= env.orchestration_dir_name %>
-endif
-
-ifdef env_file
-  custom_env_file ?= 1
-else
-  custom_env_file ?= 0
-endif
-
-ifneq (,$(wildcard ${pwd}/config/database.yml))
-  database_enabled = 1
-else
-  database_enabled = 0
-endif
-
-make=$(MAKE) $1
-orchestration_config_filename:=.orchestration.yml
-orchestration_config:=${pwd}/${orchestration_config_filename}
-print_error=printf '${red}\#${reset} '$1 | tee '${stderr}'
-println_error=$(call print_error,$1'\n')
-print=printf '${blue}\#${reset} '$1
-println=$(call print,$1'\n')
-printraw=printf $1
-printrawln=$(call printraw,$1'\n')
-stdout=${pwd}/log/orchestration.stdout.log
-stderr=${pwd}/log/orchestration.stderr.log
-log_path_length=$(shell echo "${stdout}" | wc -c)
-ifndef verbose
-log_tee:= 2>&1 | tee -a ${stdout}
-log:= >>${stdout} 2>>${stderr}
-progress_point:=perl -e 'while( my $$line = <STDIN> ) { printf("."); select()->flush(); }'
-log_progress:= > >(tee -ai ${stdout} >&1 | ${progress_point}) 2> >(tee -ai ${stderr} 2>&1 | ${progress_point})
-endif
-red:=$(shell tput setaf 1)
-green:=$(shell tput setaf 2)
-yellow:=$(shell tput setaf 3)
-blue:=$(shell tput setaf 4)
-magenta:=$(shell tput setaf 5)
-cyan:=$(shell tput setaf 6)
-gray:=$(shell tput setaf 7)
-reset:=$(shell tput sgr0)
-tick=[${green}✓${reset}]
-cross=[${red}✘${reset}]
-warn=[${yellow}!${reset}]
-hr=$(call println,"$1$(shell head -c ${log_path_length} < /dev/zero | tr '\0' '=')${reset}")
-managed_env_tag:=\# -|- ORCHESTRATION
-standard_env_path:=${pwd}/.env
-backup_env_path:=${pwd}/.env.orchestration.backup
-is_managed_env:=$$(test -f '${standard_env_path}' && tail -n 1 '${standard_env_path}') == "${managed_env_tag}"*
-token:=$(shell cat /dev/urandom | LC_CTYPE=C tr -dc 'a-z0-9' | fold -w8 | head -n1)
-back_up_env:=( \
-               [ ! -f '${standard_env_path}' ] \
-             || \
-               ( \
-                 [ -f '${standard_env_path}' ] \
-                 && cp '${standard_env_path}' '${backup_env_path}' \
-               ) \
-             )
-
-replace_env:=( \
-               ( [ "${custom_env_file}" == "0" ] ) \
-             || \
-               ( \
-                 [ "${custom_env_file}" == "1" ] \
-                 && ${back_up_env} \
-                 && cp ${env_file} '${standard_env_path}' \
-                 && $(call printraw,'\n${managed_env_tag}') >> '${standard_env_path}' \
-               ) \
-             )
-
-restore_env:=( \
-               ( \
-                 [[ ! ${is_managed_env} ]] \
-                 || [ ! -f '${backup_env_path}' ] \
-               ) \
-             || \
-               ( \
-                 [ -f '${backup_env_path}' ] \
-                 && [[ ${is_managed_env} ]] \
-                 && mv '${backup_env_path}' '${standard_env_path}' \
-               ) \
-             )
-
-key_chars:=[a-zA-Z0-9_]
-censored:=**********
-censor=s/\(^${key_chars}*$(1)${key_chars}*\)=\(.*\)$$/\1=${censored}/
-censor_urls:=s|\([a-zA-Z0-9_+]\+://.*:\).*\(@.*\)$$|\1${censored}\2|
-format_env:=sed '$(call censor,SECRET); \
-                 $(call censor,TOKEN); \
-                 $(call censor,PRIVATE); \
-                 $(call censor,KEY); \
-                 $(censor_urls); \
-                 /^\s*$$/d; \
-                 /^\s*\#/d; \
-                 s/\(^[a-zA-Z0-9_]\+\)=/${blue}\1${reset}=/; \
-                 s/^/  /; \
-                 s/=\(.*\)$$/=${yellow}\1${reset}/' | \
-            sort
-
-fail=( \
-       $(call printraw,' ${cross}') ; \
-       ${restore_env} ; \
-       $(call make,dump) ; \
-       echo ; \
-       $(call println,'Failed. ${cross}') ; \
-       exit 1 \
-    )