orchestration 0.5.2 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8525fb5a3f6bd07564ec80a6f2663f1ab3157f7e4ad7e3db411844e36ae42d1
-  data.tar.gz: 7828198b463b1e40a0f4b085efe848b742aa04dded4278df485706c358eed618
+  metadata.gz: a9dd4904167052dde3f1cbf5f441225f2719c42467204077d943534f73bb2873
+  data.tar.gz: 873bea476a74979aa917e87449c0da23a1c63128c1257a6c0ab40414e464a2ef
 SHA512:
-  metadata.gz: 2ca10bebdc3fc34cda1491dfa694386b591c0f1122c1a2d4a1c16273a6f936cdf49aa7b97b9b91b1ab271ff41b0b881a9a736956ff5d3709c07ee42da96030ea
-  data.tar.gz: 6c86b19c30c5265ed9ad37af22ffab8176c88e815918a62278b2cfe82d4ec9cb4f4237f2202e88423ea1580a112058231e5f5005a4e1c5cf63cf7809e105a3d3
+  metadata.gz: bf66b2842c17ed6cb43d7a02045f9c35f7a4bf6fe70e8c7d4425ddee8c72c24a810ab64175fa00430da2c38b3c9e66dde62cedc31b65a68b5b51ba65e53c87c9
+  data.tar.gz: 4e3aa0a3ba1f8b2f9b7bd58e6a553a86924cbf0805657de8b5b6c63eeefc8ee38bea13a560f093410778690c5c0d9228359e9d8a0f38bd6e600b1c42e80bd253

data/.rubocop.yml

@@ -13,6 +13,7 @@ Metrics/ModuleLength:
     - 'lib/orchestration/file_helpers.rb'
 
 AllCops:
+  NewCops: enable
   Exclude:
     - 'bin/**/*'
     - 'db/schema.rb'

data/README.md

@@ -1,13 +1,5 @@
 # Orchestration
 
-```
-I've got two tickets to the game
-It'd be great if I could take you to it this Sunday
-                                       --Nickelback
-```
-
-## Overview
-
 _Orchestration_ aims to provide a convenient and consistent process for working with _Rails_ and _Docker_ without obscuring underlying components.
 
 At its core _Orchestration_ is simply a `Makefile` and a set of `docker-compose.yml` files with sensible, general-purpose default settings. Users are encouraged to tailor the generated build-out to suit their application; once the build-out has been generated it belongs to the application.
@@ -35,7 +27,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.5.2'
+gem 'orchestration', '~> 0.5.7'
 ```
 
 Install:
@@ -143,7 +135,20 @@ Note that `git archive` is used to generate the build context. Any uncommitted c
 make build
 ```
 
-See [build environment](#build-environment) for more details.
+The `include` option can also be passed to provide a manifest file. Any files listed in this file will also be built into the _Docker_ image. Files **must** be located within the project directory.
+
+```bash
+make build include=manifest.txt
+```
+
+```bash
+# manifest.txt
+doc/api/swagger.json
+doc/api/soap.xml
+doc/api/doc.html
+```
+
+See also [build environment](#build-environment) if you use gems hosted on private _GitHub_/_Bitbucket_ repositories.
 
 #### Push latest image
 
@@ -222,6 +227,8 @@ To connect via _SSH_ to a remote swarm and deploy, pass the `manager` parameter:
 make deploy manager=user@manager.swarm.example.com
 ```
 
+The file `orchestration/docker-compose.production.yml` is created automatically. If your `RAILS_ENV` is set to something other than `production` then another file will need to be created (e.g. `orchestration/docker-compose.staging.yml`). In most cases this file can be a _symlink_ to the original `production` configuration and environment variables can be used to customise the content.
+
 #### Roll back a deployment
 
 Roll back the `app` service of your stack:
@@ -265,7 +272,7 @@ Note that the following two variables _must_ be set in the relevant `.env` file
 
 ```
 # Published port for your application service:
-CONTAINER_PORT=3000
+PUBLISH_PORT=3000
 
 # Number of replicas of your application service:
 REPLICAS=5
@@ -320,7 +327,7 @@ See related documentation:
 | `WEB_HEALTHCHECK_PATH` | Path expected to return a successful response | `/` |
 | `WEB_HEALTHCHECK_READ_TIMEOUT` | Number of seconds to wait for data before failing healthcheck | `10` |
 | `WEB_HEALTHCHECK_OPEN_TIMEOUT` | Number of seconds to wait for connection before failing healthcheck | `10` |
-| `WEB_HEALTHCHECK_SUCCESS_CODES` | Comma-separated list of HTTP status codes that will be deemed a success | `200,202,204` |
+| `WEB_HEALTHCHECK_SUCCESS_CODES` | Comma-separated list of HTTP status codes that will be deemed a success | `200,201,202,204` |
 
 If your application does not have a suitable always-available route to use as a healthcheck, the following one-liner may be useful:
 

data/lib/orchestration.rb

@@ -11,7 +11,7 @@ require 'paint'
 begin
   require 'rails'
 rescue LoadError
-  warn('[orchestration] Rails not detected; skipping.')
+  warn('[orchestration] Running in non-Rails mode.')
 end
 
 I18n.load_path += Dir[File.join(File.expand_path('..', __dir__),
@@ -42,7 +42,7 @@ module Orchestration
 
   def self.error(key, options = {})
     warn('# Orchestration Error')
-    warn('# ' + I18n.t("orchestration.#{key}", options))
+    warn("# #{I18n.t("orchestration.#{key}", options)}")
   end
 
   def self.random_local_port

data/lib/orchestration/docker_compose/app_service.rb

@@ -64,7 +64,8 @@ module Orchestration
           'environment' => environment,
           'ports' => ports,
           'deploy' => deploy,
-          'logging' => logging
+          'logging' => logging,
+          'networks' => networks
         }
       end
 
@@ -75,10 +76,7 @@ module Orchestration
       end
 
       def deploy
-        {
-          'mode' => 'replicated',
-          'replicas' => '${REPLICAS}'
-        }
+        { 'mode' => 'replicated', 'replicas' => '${REPLICAS:-3}' }
       end
 
       def logging
@@ -91,29 +89,34 @@ module Orchestration
         }
       end
 
+      def networks
+        { 'local' => {} }
+      end
+
       def environment
         {
           'RAILS_LOG_TO_STDOUT' => '1',
           'RAILS_SERVE_STATIC_FILES' => '1',
           'WEB_PRELOAD_APP' => '1',
-          'WEB_HEALTHCHECK_PATH' => '/'
+          'WEB_HEALTHCHECK_PATH' => '/',
+          'DATABASE_URL' => database_url
         }.merge(Hash[inherited_environment.map { |key| [key, nil] }])
       end
 
+      def database_url
+        {
+          'postgresql' => 'postgresql://postgres:password@database-local:5432/production',
+          'mysql2' => 'mysql2://root:password@database-local:3306/production',
+          'sqlite3' => 'sqlite3:db/production.sqlite3'
+        }.fetch(DockerCompose::ComposeConfiguration.database_adapter_name)
+      end
+
       def inherited_environment
-        %w[
-          DATABASE_URL
-          HOST_UID
-          RAILS_ENV
-          SECRET_KEY_BASE
-          WEB_CONCURRENCY
-          WEB_TIMEOUT
-          WEB_WORKER_PROCESSES
-        ]
+        %w[HOST_UID RAILS_ENV SECRET_KEY_BASE WEB_CONCURRENCY WEB_TIMEOUT WEB_WORKER_PROCESSES]
       end
 
       def ports
-        ['${CONTAINER_PORT:?CONTAINER_PORT must be provided}:8080']
+        ['${PUBLISH_PORT:?PUBLISH_PORT must be provided}:8080']
       end
     end
   end

data/lib/orchestration/docker_compose/configuration.rb

@@ -21,6 +21,10 @@ module Orchestration
         {}.merge(database_volume).merge(mongo_volume)
       end
 
+      def networks
+        { 'local' => { 'name' => '${COMPOSE_PROJECT_NAME}' } }
+      end
+
       private
 
       def services_available

data/lib/orchestration/docker_compose/database_service.rb

@@ -16,7 +16,8 @@ module Orchestration
 
         {
           'image' => adapter.image,
-          'environment' => adapter.environment
+          'environment' => adapter.environment,
+          'networks' => networks
         }.merge(ports).merge(volumes)
       end
 
@@ -32,6 +33,12 @@ module Orchestration
         adapter.default_port
       end
 
+      def networks
+        return {} unless @environment == :production
+
+        { 'local' => { 'aliases' => ['database-local'] } }
+      end
+
       def ports
         return {} unless %i[development test].include?(@environment)
 

data/lib/orchestration/docker_compose/install_generator.rb

@@ -41,7 +41,8 @@ module Orchestration
         {
           'version' => compose_config(environment).version,
           'services' => services(environment),
-          'volumes' => volumes(environment)
+          'volumes' => volumes(environment),
+          'networks' => networks(environment)
         }
       end
 
@@ -55,6 +56,12 @@ module Orchestration
         compose_config(environment).volumes
       end
 
+      def networks(environment)
+        return {} unless environment == :production
+
+        compose_config(environment).networks
+      end
+
       def compose_config(environment)
         DockerCompose::Configuration.new(
           @env,

data/lib/orchestration/docker_healthcheck.rb

@@ -35,12 +35,12 @@ module Orchestration
       client.open_timeout = ENV.fetch('WEB_HEALTHCHECK_OPEN_TIMEOUT', '10').to_i
 
       client.start do |request|
-        request.get(ENV.fetch('WEB_HEALTHCHECK_PATH') { '/' })
+        request.get(ENV.fetch('WEB_HEALTHCHECK_PATH', '/'))
       end
     end
 
     def success_codes
-      ENV.fetch('WEB_HEALTHCHECK_SUCCESS_CODES', '200,202,204').split(',')
+      ENV.fetch('WEB_HEALTHCHECK_SUCCESS_CODES', '200,201,202,204').split(',')
     end
 
     def success?(code)

data/lib/orchestration/environment.rb

@@ -82,7 +82,7 @@ module Orchestration
     end
 
     def app_port
-      ENV.fetch('CONTAINER_PORT', ENV.fetch('WEB_PORT', '3000')).to_i
+      ENV.fetch('PUBLISH_PORT', ENV.fetch('WEB_PORT', '3000')).to_i
     end
 
     def app_name

data/lib/orchestration/file_helpers.rb

@@ -18,9 +18,7 @@ module Orchestration
 
     def inject_if_missing(path, content, index = 0)
       lines = File.exist?(path) ? File.readlines(path).map(&:chomp) : []
-      if lines.any? { |line| line == content }
-        return @terminal.write(:skip, relative_path(path))
-      end
+      return @terminal.write(:skip, relative_path(path)) if lines.any? { |line| line == content }
 
       lines.insert(index, content)
       update_file(path, lines.join("\n"))
@@ -56,9 +54,7 @@ module Orchestration
       return create_file(path, content) unless present
 
       previous_content = File.read(path) if present
-      if skip?(present, content, previous_content, options)
-        return @terminal.write(:skip, relative_path(path))
-      end
+      return @terminal.write(:skip, relative_path(path)) if skip?(present, content, previous_content, options)
 
       backup(path, previous_content) if options.fetch(:backup, false)
       File.write(path, content)

data/lib/orchestration/install_generator.rb

@@ -27,7 +27,7 @@ module Orchestration
       @terminal.write(:skip, relpath)
     end
 
-    def verify_makefile(skip = true)
+    def verify_makefile(skip: true)
       # Only run when called explicitly [from Rake tasks].
       # (I know this is hacky).
       return if skip
@@ -127,10 +127,6 @@ module Orchestration
       ensure_lines_in_file(path, lines)
     end
 
-    def deploy_mk
-      simple_copy('deploy.mk')
-    end
-
     private
 
     def t(key)

data/lib/orchestration/service_check.rb

@@ -16,7 +16,7 @@ module Orchestration
     end
 
     def run
-      return echo_missing unless @service.configuration.configured?
+      return unless @service.configuration.configured?
 
       echo_start
       success = attempt_connection
@@ -39,14 +39,6 @@ module Orchestration
       false
     end
 
-    def echo_missing
-      @terminal.write(
-        @service_name.to_sym,
-        "#{@service.configuration.error} (skipping)",
-        :error
-      )
-    end
-
     def echo_start
       @terminal.write(@service_name.to_sym, '', :status)
     end

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

@@ -42,9 +42,7 @@ module Orchestration
 
         def url_config
           uri = URI.parse(@env.mongo_url)
-          unless uri.scheme == 'mongodb'
-            raise ArgumentError, 'MONGO_URL protocol must be mongodb://'
-          end
+          raise ArgumentError, 'MONGO_URL protocol must be mongodb://' unless uri.scheme == 'mongodb'
 
           url_config_structure(uri)
         end

data/lib/orchestration/templates/Dockerfile.erb

@@ -13,7 +13,9 @@ 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.11.0 \
+ && nvm install 10.13.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 ./

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

@@ -15,8 +15,10 @@ test: test-setup
 
 # Start development containers and create/migrate/seed database
 .PHONY: develop
-develop: start
+develop:
 	bundle install
+	@$(MAKE) start env=test
+	@$(MAKE) start env=development
 	bundle exec rake db:create
 	bundle exec rake db:migrate
 	bundle exec rake db:seed

data/lib/orchestration/templates/env.erb

@@ -1,7 +1,6 @@
-# Configure which port your `app` service will listen on:
-CONTAINER_PORT=3000
+# Set any development environment variables here
+# e.g.:
+#
+# DISABLE_SPRING=1
 
-# Use `make deploy` to deploy your application stack to a Docker Swarm.
-# Use this setting to control the number of replicas to create for your
-# application service:
-REPLICAS=1
+PUBLISH_PORT=3000

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

@@ -31,6 +31,7 @@ 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})
@@ -87,17 +88,19 @@ restore_env:=( \
 
 key_chars:=[a-zA-Z0-9_]
 censored:=**********
-censor=sed 's/\(^${key_chars}*$(1)${key_chars}*\)=\(.*\)$$/\1=${censored}/'
-censor_urls:=sed 's|\([a-zA-Z0-9_+]\+://.*:\).*\(@.*\)$$|\1${censored}\2|'
-format_env:=$(call censor,SECRET) | \
-            $(call censor,PASSWORD) | \
-            $(call censor,TOKEN) | \
-            $(call censor,PRIVATE) | \
-            $(call censor,KEY) | \
-            ${censor_urls} | \
-            sed 's/\(^[a-zA-Z0-9_]\+\)=/${blue}\1${reset}=/' | \
-            sed 's/^/  /' | \
-            sed 's/=\(.*\)$$/=${yellow}\1${reset}/'
+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}') ; \

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

@@ -38,9 +38,15 @@ ifneq (,$(wildcard ${env_file}))
   rake=. ${env_file} && ${rake_cmd}
 endif
 
-docker_config:=$(shell ${rake} orchestration:config)
-docker_organization=$(word 1,$(docker_config))
-docker_repository=$(word 2,$(docker_config))
+ifeq (,$(findstring serve,$(MAKECMDGOALS)))
+ifeq (,$(findstring console,$(MAKECMDGOALS)))
+ifeq (,$(findstring test,$(MAKECMDGOALS)))
+  docker_config:=$(shell RAILS_ENV=development bundle exec rake orchestration:config)
+  docker_organization=$(word 1,$(docker_config))
+  docker_repository=$(word 2,$(docker_config))
+endif
+endif
+endif
 
 ifeq (,$(project_name))
   project_base = ${docker_repository}_${env}
@@ -74,7 +80,9 @@ else
   compose_project_name = ${project_base}
 endif
 
-compose_base=env HOST_UID=$(shell id -u) \
+compose_base=env -i \
+             PATH=$(PATH) \
+             HOST_UID=$(shell id -u) \
              DOCKER_ORGANIZATION="${docker_organization}" \
              DOCKER_REPOSITORY="${docker_repository}" \
              COMPOSE_PROJECT_NAME="${compose_project_name}" \
@@ -106,8 +114,8 @@ all: build
 ifndef network
 start: network := ${compose_project_name}_default
 endif
-start: _clean-logs
-	@$(call print,'${yellow}Starting containers${reset} ...')
+start: _create-log-directory _clean-logs
+	@$(call print,'${yellow}Starting ${cyan}${env}${yellow} containers${reset} ...')
 ifeq (${env},$(filter ${env},test development))
 	@${compose} up --detach --force-recreate --renew-anon-volumes --remove-orphans ${services} ${log} || ${fail}
 	@[ -n '${sidecar}' ] && \
@@ -138,7 +146,7 @@ start-<%= service %>:
 .PHONY: stop
 stop: network := ${compose_project_name}_default
 stop:
-	@$(call print,'${yellow}Stopping containers${reset} ...')
+	@$(call print,'${yellow}Stopping ${cyan}${env}${yellow} containers${reset} ...')
 	@if docker ps --format "{{.ID}}" | grep -q $(shell hostname) ; \
           then \
             ( docker network disconnect ${network} $(shell hostname) ${log} || : ) \
@@ -171,7 +179,7 @@ serve:
          then ( \
                 $(call println,'${yellow}Environment${reset}: ${green}${env_file}${reset}') && \
                 cat '${env_file}' | ${format_env} && \
-                $(call println,'') \
+                $(call printrawln,'') \
             ) ; \
         fi
 	${rails}
@@ -184,7 +192,7 @@ console:
          then ( \
                 $(call println,'${yellow}Environment${reset}: ${green}${env_file}${reset}') && \
                 cat '${env_file}' | ${format_env} && \
-                $(call println,'') \
+                $(call printrawln,'') \
             ) ; \
         fi
 	${rails} console
@@ -210,7 +218,7 @@ endif
 dump:
 ifndef verbose
 	@$(call println)
-	@$(call println,'${yellow}Captured${reset} ${green}stdout${reset} ${yellow}and${reset} ${red}stderr${reset} ${yellow}log data${reset}:')
+	@$(call println,'${yellow}Captured${reset} ${green}stdout${reset} ${yellow}and${reset} ${red}stderr${reset} ${yellow}log data [${cyan}${env}${yellow}]${reset}:')
 	@$(call println)
 	@echo
 	@test -f '${stdout}' && ( \
@@ -230,6 +238,7 @@ ifndef verbose
           $(call hr,${red}) ; \
         )
 endif
+ifneq (,$(findstring deploy,$(MAKECMDGOALS)))
 	@echo ; \
         $(call hr,${yellow}) ; \
         $(call println,'${gray}docker-compose logs${reset}') ; \
@@ -238,6 +247,8 @@ endif
 	@${compose} logs
 	@echo ; \
         $(call hr,${yellow})
+endif
+	@$(NOOP)
 
 .PHONY: image
 image:
@@ -245,45 +256,40 @@ image:
 
 ### Deployment utility commands ###
 
-.PHONY: bundle
-bundle:
-ifndef path
-	@$(warning Missing `path` parameter; using `./bundle.tar`. Set a custom path with `make bundle path=/tmp/bundle.tar`)
-endif
-	@rm -rf ${orchestration_dir}/.deploy/
-	@mkdir -p ${orchestration_dir}/.deploy/${docker_repository}/
-	@sed -e "s/%%VERSION%%/${git_version}/g" \
-             -e "s/%%REPOSITORY%%/${docker_repository}/g" \
-             -e "s/%%ORGANIZATION%%/${docker_organization}/g" \
-             ${orchestration_dir}/deploy.mk > \
-             ${orchestration_dir}/.deploy/${docker_repository}/Makefile
-	@bundle_path="${path}" ; tar -C '${orchestration_dir}/.deploy' -cf "$${bundle_path:-./bundle.tar}" ./${docker_repository}
-
 .PHONY: deploy
-deploy: path := $(shell mktemp -d)
+ifdef env_file
+deploy: env_file_option = --env-file ${env_file}
+endif
 deploy: RAILS_ENV := ${env}
 deploy: RACK_ENV := ${env}
 deploy: DOCKER_TAG = ${git_version}
+deploy: base_vars = DOCKER_ORGANIZATION=${docker_organization} DOCKER_REPOSITORY=${docker_repository} DOCKER_TAG=${git_version}
+deploy: compose_deploy := ${base_vars} COMPOSE_PROJECT_NAME=${project_base} HOST_UID=$(shell id -u) docker-compose ${env_file_option} --project-name ${project_base} -f orchestration/docker-compose.${env}.yml
+deploy: compose_config := ${compose_deploy} config
+deploy: deploy_cmd := echo "$${config}" | ssh "${manager}" "/bin/bash -lc 'cat | docker stack deploy --prune --with-registry-auth -c - ${project_base}'"
+deploy: out_of_sequence_error := rpc error: code = Unknown desc = update out of sequence
+deploy: retry_message := ${yellow}Detected Docker RPC error: ${red}${out_of_sequence_error}${yellow}. Retrying in
 deploy:
 ifndef manager
 	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`') ; exit 1
 endif
-	@$(call println,'${yellow}Deploying stack via${reset} ${green}${manager}${reset} ...') && \
+	@$(call println,'${yellow}Deploying ${green}${env} ${yellow}stack via ${green}${manager} ${yellow}as ${green}${project_base}${reset} ...') && \
           ( \
-            $(call make,bundle path='${path}/bundle.tar') ${log} && \
-            cd '${path}' ${log} && \
-            tar xf 'bundle.tar' ${log} && \
-            cd '${docker_repository}' ${log} && \
-               ( [ -z '${env_file}' ] || cp '${env_file}' './.env' ${log} ) && \
-               $(call println,'${yellow}Deployment environment${reset}:') && \
-               ( test -f '.env' && cat '.env' | ${format_env} || : ) && \
-               echo 'DOCKER_ORGANIZATION=${docker_organization}' >> './.env' && \
-               echo 'DOCKER_REPOSITORY=${docker_repository}' >> './.env' && \
-               echo 'DOCKER_TAG=${git_version}' >> ./.env && \
-               $(call println,'') && \
-               $(call println,'${yellow}Application image${reset}: ${cyan}${docker_image}${reset}') && \
-               ${compose} config 2>${stderr} | ssh "${manager}" 'docker stack deploy --prune --with-registry-auth -c - "${project_base}"' ${log} && \
-            ( [ -z "${path}" ] || rm -rf "${path}" ${log} ) \
+             $(call println,'${yellow}Deployment environment${reset}:') && \
+             ( test -f '${env_file}' && cat '${env_file}' | ${format_env} || : ) && \
+             $(call println,'') && \
+             $(call println,'${yellow}Application image${reset}: ${cyan}${docker_image}${reset}') && \
+             export config="$$(${compose_config} 2>${stderr})" ; \
+             config_exit_code=$$? ; \
+             if [[ "$${config_exit_code}" != "0" ]]; then exit ${config_exit_code}; fi ; \
+             output="$$(${deploy_cmd} | tee /dev/tty)" ; \
+             deploy_exit_code=$$? ; \
+             if [[ "$${deploy_exit_code}" == 0 ]] ; then exit 0 ; fi ; \
+             if ! echo "$${output}" | grep -q '${out_of_sequence_error}' ; then exit ${deploy_exit_code} ; fi ; \
+             retry_in="$$(( 10 + RANDOM % 50 ))" ; \
+             echo "${retry_message} ${green}$${retry_in} ${yellow}seconds.${reset}" ; \
+             sleep "$${retry_in}" ; \
+             ${deploy_cmd} \
           ) \
           || ${fail}
 
@@ -316,8 +322,9 @@ wait-listener:
 ### Docker build commands ###
 
 .PHONY: build
-build: context = ${orchestration_dir}/.build/context.tar
-build: check-local-changes
+build: build_dir = ${orchestration_dir}/.build
+build: context = ${build_dir}/context.tar
+build: _create-log-directory check-local-changes
 	@$(call print,'${yellow}Preparing build context from${reset} ${cyan}${git_branch}:${git_version}${reset} ... ')
 	@mkdir -p ${orchestration_dir}/.build ${log} || ${fail}
 ifndef dev
@@ -330,6 +337,16 @@ else
 	@tar -cvf '${context}' . ${log} || ${fail}
 endif
 	@$(call printrawln,'${green}complete.${reset} ${tick}')
+ifdef include
+	@$(call print,'${yellow}Including files from:${reset} ${cyan}${include}${reset} ...')
+	@(while read line; do \
+            export line; \
+            include_dir="${build_dir}/$$(dirname "$${line}")/" && \
+            mkdir -p "$${include_dir}" && cp "$${line}" "$${include_dir}" \
+            && (cd '${orchestration_dir}/.build/' && tar rf 'context.tar' "$${line}"); \
+          done < '${include}') ${log} || ${fail}
+	@$(call printrawln,' ${green}complete.${reset} ${tick}')
+endif
 ifdef sidecar
         # Assume we are in a line-buffered environment (e.g. Jenkins)
 	@$(call println,'${yellow}Building image${reset} ...')
@@ -348,7 +365,7 @@ endif
 	@$(call println,'[${green}tag${reset}] ${cyan}${docker_organization}/${docker_repository}:${git_version}${reset}')
 
 .PHONY: push
-push:
+push: _create-log-directory
 	@$(call print,'${yellow}Pushing${reset} ${cyan}${docker_image}${reset} ...')
 	@docker push ${docker_image} ${log_progress} || ${fail}
 	@$(call printrawln,' ${green}complete${reset}. ${tick}')
@@ -370,3 +387,7 @@ endif
 _clean-logs:
 	@rm -f '${stdout}' '${stderr}'
 	@touch '${stdout}' '${stderr}'
+
+.PHONY: _create-log-directory
+_create-log-directory:
+	@mkdir -p log

data/lib/orchestration/terminal.rb

@@ -20,15 +20,15 @@ module Orchestration
       @settings = settings
     end
 
-    def write(desc, message, color_name = nil, newline = true)
+    def write(desc, message, color_name = nil, newline: true)
       output = newline ? "#{message}\n" : message.to_s
-      STDOUT.print colorize(desc, output, color_name)
-      STDOUT.flush
+      $stdout.print colorize(desc, output, color_name)
+      $stdout.flush
     end
 
     def read(message, default = nil)
-      write(:input, prompt(message, default), nil, false)
-      result = STDIN.gets.chomp.strip
+      write(:input, prompt(message, default), nil, newline: false)
+      result = $stdin.gets.chomp.strip
       return default if result.empty?
 
       result
@@ -57,7 +57,7 @@ module Orchestration
                 COLOR_MAP.fetch(color_name)
               end
 
-      Paint[desc.to_s.rjust(15), *color] + ' ' + message
+      "#{Paint[desc.to_s.rjust(15), *color]} #{message}"
     end
 
     def t(key)

data/lib/orchestration/version.rb

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

data/lib/tasks/orchestration.rake

@@ -28,7 +28,7 @@ namespace :orchestration do
 
   desc I18n.t('orchestration.rake.wait')
   task :wait do
-    Orchestration::InstallGenerator.new.verify_makefile(false)
+    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

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.name = 'orchestration'
   spec.version = Orchestration::VERSION
   spec.authors = ['Bob Farrell']
-  spec.email = ['robertanthonyfarrell@gmail.com']
+  spec.email = ['git@bob.frl']
 
   spec.summary = 'Docker orchestration toolkit'
   spec.description = 'Tools to help launch apps in Docker'
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
     end
   end
 
+  spec.required_ruby_version = '~> 2.6'
   spec.bindir = 'bin'
   spec.executables = []
   spec.require_paths = ['lib']
@@ -32,10 +33,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'thor', '~> 1.0'
 
   spec.add_development_dependency 'activerecord', '~> 6.0'
-  spec.add_development_dependency 'betterp', '~> 0.1.3'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'bunny', '~> 2.12'
-  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'devpack', '~> 0.3.0'
   spec.add_development_dependency 'mongoid', '~> 7.0'
   spec.add_development_dependency 'mysql2', '~> 0.5.2'
   spec.add_development_dependency 'pg', '~> 1.1'
@@ -43,8 +43,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 0.77.0'
+  spec.add_development_dependency 'rubocop', '~> 0.90.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'strong_versions', '~> 0.3.1'
+  spec.add_development_dependency 'strong_versions', '~> 0.4.5'
   spec.add_development_dependency 'webmock', '~> 3.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.7
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: betterp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,19 +123,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: devpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -254,14 +240,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.90.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.90.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -282,14 +268,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -306,7 +292,7 @@ dependencies:
         version: '3.4'
 description: Tools to help launch apps in Docker
 email:
-- robertanthonyfarrell@gmail.com
+- git@bob.frl
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -322,10 +308,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/rspec
-- bin/rubocop
 - bin/setup
-- bin/strong_versions
 - config/locales/en.yml
 - doc/images/example.png
 - lib/Rakefile
@@ -373,7 +356,6 @@ files:
 - lib/orchestration/templates/Dockerfile.erb
 - lib/orchestration/templates/application.mk.erb
 - lib/orchestration/templates/database.yml.erb
-- lib/orchestration/templates/deploy.mk.erb
 - lib/orchestration/templates/entrypoint.sh.erb
 - lib/orchestration/templates/env.erb
 - lib/orchestration/templates/makefile_macros.mk.erb
@@ -395,9 +377,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/bin/rspec

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rubocop' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rubocop", "rubocop")

data/bin/strong_versions

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'strong_versions' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
-
-bundle_binstub = File.expand_path("../bundle", __FILE__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("strong_versions", "strong_versions")

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

@@ -1,69 +0,0 @@
--include .env
-export
-
-ifneq (,$(RAILS_ENV))
-  env:=$(RAILS_ENV)
-else ifneq (,$(RACK_ENV))
-  env:=$(RACK_ENV)
-endif
-
-verify-environment:
-ifndef CONTAINER_PORT
-  @$(error `CONTAINER_PORT` must be defined in environment)
-endif
-
-ifndef env
-  @$(error Either `env`, `RACK_ENV` or `RAILS_ENV` must be defined in environment)
-endif
-
-project_name:=%%REPOSITORY%%_${env}
-compose_base:=env HOST_UID=$(shell id -u) \
-              DOCKER_ORGANIZATION=%%ORGANIZATION%% \
-              DOCKER_REPOSITORY=%%REPOSITORY%%:%%VERSION%% \
-              docker-compose \
-              -p ${project_name} \
-              -f docker-compose.production.yml
-
-.PHONY: deploy
-deploy:
-ifndef manager
-	@$(error Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`)
-else
-	@tar -cf - . | ssh ${manager} 'cd $$(mktemp -d) ; chmod 0700 . ; cat - | tar -x ; make deploy-stack ; rm -r $$(pwd)'
-endif
-
-.PHONY: deploy-stack
-deploy-stack:
-	${compose} config | docker stack deploy --prune --with-registry-auth -c - ${project_name}
-
-.PHONY: console
-service := app
-command := /bin/bash
-console:
-	@echo "Creating temporary container..."
-	@${compose} run --rm ${service} ${command}
-
-.PHONY: config
-config:
-	@${compose} config
-
-.PHONY: pull
-pull:
-	@${compose} pull
-
-.PHONY: logs
-logs: service := app
-logs:
-ifndef manager
-	@$(error Missing `manager` parameter: `make logs manager=swarm-manager.example.com`)
-else
-	ssh ${manager} "docker service logs -f ${project_name}_${service}"
-endif
-
-.PHONY: migrate
-migrate:
-	@${compose} run --rm app bundle exec rake db:migrate
-
-.PHONY: compose
-compose:
-	@echo ${compose}