orchestration 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8525fb5a3f6bd07564ec80a6f2663f1ab3157f7e4ad7e3db411844e36ae42d1
-  data.tar.gz: 7828198b463b1e40a0f4b085efe848b742aa04dded4278df485706c358eed618
+  metadata.gz: 90d0d9e479a7b4797751a7a6b457c613813b2c8d2df9a6b17bb11c8b26c379ff
+  data.tar.gz: 7812364e32a9f3289fea6e86591b46d055cfe35ab13244932bf23b8597b2f0c8
 SHA512:
-  metadata.gz: 2ca10bebdc3fc34cda1491dfa694386b591c0f1122c1a2d4a1c16273a6f936cdf49aa7b97b9b91b1ab271ff41b0b881a9a736956ff5d3709c07ee42da96030ea
-  data.tar.gz: 6c86b19c30c5265ed9ad37af22ffab8176c88e815918a62278b2cfe82d4ec9cb4f4237f2202e88423ea1580a112058231e5f5005a4e1c5cf63cf7809e105a3d3
+  metadata.gz: ee3ebbeb61d6be44d819067fb0dfcc4db27ee3a4c5c14510ca5b7313838ce853568365aebe4b7593550738834fadf5f34564c6db5bc9404669aa5f9b2e3dc4b7
+  data.tar.gz: ec9cfbd34b8909e7ff72887301423739c02ec96d86e2e6bece4f25cc27738fe4de6d8486d28e02e72103fadfe408b7b1cc4e61fc8b2b45060352e1ac1a45137f

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.3'
 ```
 
 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
 

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/templates/makefile_macros.mk.erb

@@ -87,17 +87,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

@@ -74,7 +74,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}" \
@@ -107,7 +109,7 @@ ifndef network
 start: network := ${compose_project_name}_default
 endif
 start: _clean-logs
-	@$(call print,'${yellow}Starting containers${reset} ...')
+	@$(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 +140,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 +173,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 +186,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 +212,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}' && ( \
@@ -316,7 +318,8 @@ wait-listener:
 ### Docker build commands ###
 
 .PHONY: build
-build: context = ${orchestration_dir}/.build/context.tar
+build: build_dir = ${orchestration_dir}/.build
+build: context = ${build_dir}/context.tar
 build: check-local-changes
 	@$(call print,'${yellow}Preparing build context from${reset} ${cyan}${git_branch}:${git_version}${reset} ... ')
 	@mkdir -p ${orchestration_dir}/.build ${log} || ${fail}
@@ -330,6 +333,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} ...')

data/lib/orchestration/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url