orchestration 0.6.5 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c01beaeb79e418062c87c7d0d8d9fdc472cc479c16a47d9be01ca0278abc04
-  data.tar.gz: 78ad03978e9fcdb0ebf9cf1a02af1395dc356cdf5dac048eb06ab741396f4166
+  metadata.gz: 12b69a813bf576761bf0c72198b9bf68a9e1ce212d4dd1f1c819f50c2b3a46cf
+  data.tar.gz: '0383c1b95a84b29fe78ab766ed6fb8f862f32f8cd33a1695b815ecb752f00be5'
 SHA512:
-  metadata.gz: 94d8bdc996d37ae9b51bfd3a44f945e0f30b466d3bebb753b535c9e63558962d0661905fd4690677e946789bef76d9276f7047c4c990e7d9cfe6518b584e752f
-  data.tar.gz: 9f785e2f76dac85f01c36db3fbc3d24724e52e4f36aaffe95f388e782b98b0d6f351b173383a42950405b3fe427901c4ba49c5a6e64d61f0b88c385e0a581393
+  metadata.gz: 8b1df8619845cdf6383360e22b051f0307665b9c7137d2e2a105595cbc9ba38b39745b9c44169c3585edabc389dab18ec61f8371e73b1899c84e6a8f2c212bc3
+  data.tar.gz: 2d467b15257d2ce8346e9f6e9efdebbb7e23d25aed0576b205c5ec9da85dc038b81fd8d92d6dfd35cf0fbe6358aab92ef71fef94071009a941a95220741aaab7

data/.strong_versions.yml

@@ -1,2 +1,3 @@
 ignore:
   - i18n
+  - rails

data/README.md

@@ -29,7 +29,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.6.5'
+gem 'orchestration', '~> 0.6.6'
 ```
 
 Install:

data/UPGRADE.md

@@ -1,6 +1,18 @@
-# Upgrade guide
+# Upgrade guide (0.5 to 0.6)
 
-## 0.5 to 0.6
+## Automatic Upgrade
+
+A _Rake_ task is provided to automatically upgrade your application:
+
+```bash
+bundle exec rake orchestration:upgrade
+```
+
+Obsolete files will be removed and required modifications to existing files will be applied.
+
+It is recommended to manually verify the validity of all changes to ensure that no custom configuration is lost.
+
+## Manual Upgrade
 
 ### Delete/rename files
 
@@ -48,6 +60,14 @@ post-setup:
 
 Replace the body of this target with any commands that you want to take place once the initial setup (launching development/test containers, running migrations, etc.) is complete. For example, running migrations for a secondary database.
 
+### Update Dockerfile healthcheck
+
+Edit `orchestration/Dockerfile` and edit the `HEALTHCHECK` directive's `CMD` to:
+
+```
+CMD ["bundle","exec","rake","orchestration:healthcheck"]
+```
+
 ### Continuous Integration files
 
 Update any continuous integration scripts (e.g. `Jenkinsfile`) to run the `setup` target before `test`, e.g.:

data/config/locales/en.yml

@@ -28,6 +28,7 @@ en:
 
     rake:
       config: "Parse and output Orchestration config (internal use)"
+      upgrade: "Upgrade from Orchestration 0.5.x to 0.6.x"
       healthcheck: "Execute healthcheck; used for HEALTHCHECK command in Docker image"
       compose_services: "Output configured services for a given environment (RAILS_ENV)"
       install: "Install Orchestration tools"

data/lib/orchestration/make/orchestration.mk

@@ -99,13 +99,21 @@ exit_fail=( \
         )
 
 ifdef env_file
-  -include ${env_file}
+  env_path=${env_file}
 else
-ifneq (${env},test)
-ifeq (,$(findstring test,$(MAKECMDGOALS)))
-  -include .env
+  env_path=.env
 endif
+
+ifneq (${env},test)
+  ifeq (,$(findstring test,$(MAKECMDGOALS)))
+    ifeq (,$(findstring deploy,$(MAKECMDGOALS)))
+      -include ${env_path}
+    endif
+  endif
 endif
+
+ifneq (,$(findstring deploy,$(MAKECMDGOALS)))
+  RAILS_ENV=$(shell grep '^RAILS_ENV=' '${env_path}' | tail -n1 | sed 's/^RAILS_ENV=//')
 endif
 
 export
@@ -130,11 +138,13 @@ DOCKER_TAG ?= latest
 ifneq (,$(wildcard ./Gemfile))
   bundle_cmd = bundle exec
 endif
-rake=DEVPACK_DISABLE=1 RACK_ENV=${env} RAILS_ENV=${env} ${bundle_cmd} rake
+rake=DEVPACK_DISABLE=1 RACK_ENV=${env} SECRET_KEY_BASE='placeholder-secret' RAILS_ENV=${env} ${bundle_cmd} rake
 
 ifneq (,$(wildcard ${env_file}))
-  rake_cmd:=${rake}
-  rake=. ${env_file} && ${rake_cmd}
+  ifeq (,$(findstring deploy,$(MAKECMDGOALS)))
+    rake_cmd:=${rake}
+    rake=. ${env_file} && ${rake_cmd}
+  endif
 endif
 
 docker_config:=$(shell DEVPACK_DISABLE=1 RAILS_ENV=development ${bundle_cmd} rake orchestration:config 2>/dev/null || echo no-org no-repo)
@@ -295,27 +305,27 @@ db-console:
 
 .PHONY: setup
 ifneq (,$(wildcard config/database.yml))
-setup: url = $(shell ${rake} orchestration:db:url RAILS_ENV=${env})
+setup: url = $(shell ${rake} orchestration:db:url RAILS_ENV=${env} 2>/dev/null)
 endif
 setup: _log-notify
 	@$(call echo,Setting up ${env_human} environment)
 	@$(call make,start env=${env})
 ifneq (,$(wildcard config/database.yml))
 	@$(call echo,Preparing ${env_human} database)
-	@$(call system,rake db:create DATABASE_URL="${url}")
+	@$(call system,rake db:create RAILS_ENV="${env}")
 	@${rake} db:create RAILS_ENV=${env} ${log} || : ${log}
   ifneq (,$(wildcard db/structure.sql))
-	@$(call system,rake db:schema:load DATABASE_URL="${url}")
-	@${rake} db:schema:load DATABASE_URL='${url}' ${log} || ${exit_fail}
+	@$(call system,rake db:structure:load RAILS_ENV="${env}" DATABASE_URL="${url}")
+	@${rake} db:structure:load RAILS_ENV="${env}" DATABASE_URL='${url}' ${log} || ${exit_fail}
   else ifneq (,$(wildcard db/schema.rb))
-	@$(call system,rake db:schema:load DATABASE_URL="${url}")
-	@${rake} db:schema:load DATABASE_URL='${url}' ${log} || ${exit_fail}
+	@$(call system,rake db:schema:load RAILS_ENV="${env}" DATABASE_URL="${url}")
+	@${rake} db:schema:load RAILS_ENV="${env}" DATABASE_URL='${url}' ${log} || ${exit_fail}
   endif
-	@$(call system,rake db:migrate DATABASE_URL="${url}")
-	@${rake} db:migrate RAILS_ENV=${env}
+	@$(call system,rake db:migrate RAILS_ENV="${env}" DATABASE_URL="${url}")
+	@${rake} db:migrate RAILS_ENV=${env} ${log} || ${exit_fail}
 endif
 	@if $(MAKE) -n post-setup >/dev/null 2>&1; then \
-          $(call system,make post-setup RAILS_ENV=${env}) \
+          $(call system,make post-setup RAILS_ENV="${env}") \
           && $(MAKE) post-setup RAILS_ENV=${env}; fi
 	@$(call echo,${env_human} environment setup complete ${tick})
 
@@ -422,15 +432,9 @@ wait-listener:
 build: _log-notify _clean-logs
 build: build_dir = ${orchestration_dir}/.build
 build: context = ${build_dir}/context.tar
-build: build_args := --build-arg GIT_COMMIT='${git_version}'
+build: build_args := --build-arg GIT_COMMIT='${git_version}' $(shell grep '^ARG ' orchestration/Dockerfile | sed -e 's/=.*$$//' -e 's/^ARG /--build-arg /')
 build: tag_human = ${cyan}${docker_organization}/${docker_repository}:${git_version}${reset}
 build: latest_tag_human = ${cyan}${docker_organization}/${docker_repository}:latest${reset}
-ifdef BUNDLE_GITHUB__COM
-build: build_args := ${build_args} --build-arg BUNDLE_GITHUB__COM
-endif
-ifdef BUNDLE_BITBUCKET__ORG
-build: build_args := ${build_args} --build-arg BUNDLE_BITBUCKET__ORG
-endif
 build: _create-log-directory check-local-changes
 	@$(call echo,Preparing build context from ${cyan}${git_branch}${reset} (${cyan}${git_version}${reset})${reset})
 	@$(call system,git archive --format "tar" -o "${context}" "${git_branch}")

data/lib/orchestration/templates/Dockerfile.erb

@@ -23,7 +23,7 @@ RUN bundle config set deployment 'true' \
  && bundle config set without 'development test' \
  && bundle install
 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 %>
+<% if defined?(Webpacker) %>RUN . /root/.bashrc ; NODE_ENV=production RAILS_ENV=production yarn install && NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=placeholder-secret bundle exec rake assets:precompile<% elsif Rake::Task.tasks.map(&:name).include?('assets:precompile') %>RUN NODE_ENV=production RAILS_ENV=production SECRET_KEY_BASE=placeholder-secret bundle exec rake assets:precompile<% end %>
 RUN echo "${GIT_COMMIT}" > /app/GIT_COMMIT
 HEALTHCHECK --interval=<%= healthcheck['interval'] %> \
             --timeout=<%= healthcheck['timeout'] %> \

data/lib/orchestration/terminal.rb

@@ -3,9 +3,13 @@
 module Orchestration
   COLOR_MAP = {
     failure: %i[red bright],
+    success: %i[green],
+    info: %i[blue],
     error: %i[red],
     ready: %i[green],
     create: %i[green],
+    delete: %i[red],
+    rename: %i[blue],
     update: %i[yellow],
     backup: %i[blue],
     status: %i[blue],

data/lib/orchestration/version.rb

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

data/lib/orchestration.rb

@@ -3,6 +3,7 @@
 require 'erb'
 require 'pathname'
 require 'socket'
+require 'yaml'
 
 require 'database_url'
 require 'erubis'

data/lib/tasks/orchestration.rake

@@ -19,13 +19,103 @@ namespace :orchestration do
     puts "#{config['docker']['organization']} #{config['docker']['repository']}"
   end
 
+  desc I18n.t('orchestration.rake.upgrade')
+  task :upgrade do
+    terminal = Orchestration::Terminal.new(Orchestration::Environment.new.settings)
+    %w[
+      orchestration/docker-compose.yml
+      orchestration/docker-compose.override.yml
+      orchestration/Makefile
+      orchestration/deploy.mk
+      orchestration/yaml.bash
+      orchestration/healthcheck.rb
+    ].each.map { |path| Pathname.new(path) }.each do |path|
+      next unless path.exist?
+
+      terminal.write(:delete, path)
+      path.unlink
+    end
+
+    src  = 'orchestration/docker-compose.production.yml'
+    dest = 'orchestration/docker-compose.deployment.yml'
+    if File.exist?(src)
+      terminal.write(:rename, "#{src} => #{dest}")
+      File.rename(src, dest)
+    end
+
+    makefile = File.read('Makefile')
+    makefile.gsub!(
+      %r{^include orchestration/Makefile$},
+      %[include $(shell bundle exec ruby -e 'require "orchestration/make"')]
+    )
+    makefile.gsub!(/^test: test-setup$/, 'test:')
+    lines = makefile.lines(chomp: true)
+    post_setup_start = lines.index('ifndef light')
+    if post_setup_start.nil?
+      updated_makefile = lines.join("\n")
+      post_setup = []
+    else
+      post_setup_end = post_setup_start + lines[post_setup_start..].index('endif')
+      post_setup = lines[(post_setup_start + 1)...post_setup_end]
+      updated_makefile = lines.each.with_index.reject do |_line, index|
+        (post_setup_start..post_setup_end).cover?(index)
+      end.map(&:first).join("\n")
+    end
+    if makefile.match(/^post-setup:$/).nil?
+      updated_makefile += %(
+
+.PHONY: post-setup
+post-setup:
+	@# Setup tasks that are not already provided by Orchestration go here.
+#{post_setup.join("\n")}
+)
+    end
+    if updated_makefile != makefile
+      terminal.write(:update, 'Makefile')
+      File.write('Makefile', updated_makefile)
+    end
+
+    %w[orchestration/docker-compose.test.yml orchestration/docker-compose.development.yml].each do |path|
+      terminal.write(:update, path)
+      config = YAML.safe_load(File.read(path))
+      config['networks'] ||= {}
+      config['networks']['local'] = { 'name' => '${COMPOSE_PROJECT_NAME}' }
+      config['services'] ||= {}
+      config['services'].each do |name, service|
+        service['networks'] = { 'local' => { 'aliases' => [name] } }
+      end
+      File.write(path, config.to_yaml)
+    end
+
+    dockerfile_path = 'orchestration/Dockerfile'
+    dockerfile = File.read(dockerfile_path)
+    updated_dockerfile = dockerfile.dup
+    updated_dockerfile.gsub!(
+      'CMD ["ruby","/app/orchestration/healthcheck.rb"]',
+      'CMD ["bundle","exec","rake","orchestration:healthcheck"]'
+    )
+    if updated_dockerfile != dockerfile
+      terminal.write(:update, dockerfile_path)
+      File.write(dockerfile_path, updated_dockerfile)
+    end
+
+    terminal.write(:success, 'Upgrade complete.')
+    terminal.write(:info, '`make test` will now only run tests, skipping setup.')
+    terminal.write(:info, 'Run `make setup test` to load test containers, run migrations, etc.')
+    terminal.write(:info, 'Run `make setup` to load development environment.')
+    terminal.write(:info, 'Run `make setup RAILS_ENV=test` to load test environment without running tests.')
+    terminal.write(:info, 'Edit the `post-setup` recipe in `Makefile` to perform custom setup actions.')
+  end
+
   namespace :db do
     desc I18n.t('orchestration.rake.db.url')
     task :url do
-      config = Rails.application.config_for(:database)
+      config = Rails.application.config_for(:database).transform_keys(&:to_sym)
 
       if config[:adapter] == 'sqlite3'
         puts "sqlite3:#{config[:database]}"
+      elsif !config[:url].nil?
+        puts config[:url]
       else
         puts DatabaseUrl.to_active_record_url(config)
       end

data/orchestration.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
     end
   end
 
-  spec.required_ruby_version = '~> 2.7'
+  spec.required_ruby_version = '>= 2.6'
   spec.bindir = 'bin'
   spec.executables = []
   spec.require_paths = ['lib']
@@ -31,7 +31,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 'rails', '>= 4.1'
   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.6.5
+  version: 0.6.6
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -70,16 +70,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -422,16 +422,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Docker orchestration toolkit