orchestration 0.4.10 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e3a1c23b6511daf4d79650fb8cbae39b697f7f70ae9924ac69c69cc58f5f39
-  data.tar.gz: b41de78b238b8663070651b20e36f40c8d430a89c5173ce28042c434ddcf6898
+  metadata.gz: 9f875ac821552fa3fb97823f27d3883b9d3ac93305a5adb42eedc10322930bf3
+  data.tar.gz: fbe1fd7262d71100122faa46f98ad27bcf94f3cb02b8894b9cf23af11bc0abae
 SHA512:
-  metadata.gz: 5facd62ea505866177a36e837e93244e3314909b71091f6bca63aed73d37f8bb1b7f4837ee7824bad659da660cb5ec862750ff84550769025a868f35bf2fd338
-  data.tar.gz: e8da0ea3bd75f817735e67604299ee93058bc7900f37bceb17b2f25b9228cd5e77c8a5503239ad6105bbf8dc097341ecef086448e16e5ba36975ea461116f875
+  metadata.gz: a7650ee86ba929d95a4cfdc1eb6324b053c36acdd9e3e9eab105a85dd763485643855eb3b4a458292cdb5b68f35a83447d4e057477f2f326c416e4044a06db17
+  data.tar.gz: 640be0c857fbcadeb6eac07852b7255b2c67a0591efb9195537f942ad9be80163b386dba5b2147fe65e46769a399149bbf2088cfcc34493dbcff0344ac946db5

data/.gitignore

@@ -21,6 +21,7 @@ spec/dummy/Makefile
 spec/dummy/orchestration/*
 spec/dummy/config/unicorn.rb
 spec/dummy/config/*.bak
+spec/dummy/tmp/*
 
 orchestration-*.gem
 
@@ -32,3 +33,5 @@ docker/.build/
 docker/.context.tar
 
 .DS_Store
+
+.ruby-version

data/MANIFEST

@@ -21,6 +21,7 @@ lib/orchestration.rb
 lib/orchestration/docker_compose.rb
 lib/orchestration/docker_compose/app_service.rb
 lib/orchestration/docker_compose/compose_configuration.rb
+lib/orchestration/docker_compose/compose_helpers.rb
 lib/orchestration/docker_compose/configuration.rb
 lib/orchestration/docker_compose/database_service.rb
 lib/orchestration/docker_compose/install_generator.rb

data/Makefile

@@ -1,8 +1,8 @@
 .PHONY: test
 test:
-	./bin/rspec
-	./bin/rubocop
-	./bin/strong_versions
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions
 
 .PHONY: manifest
 manifest:

data/README.md

@@ -35,7 +35,7 @@ The below screenshot demonstrates _Orchestration_ being installed in a brand new
 Add _Orchestration_ to your Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.4.10'
+gem 'orchestration', '~> 0.4.12'
 ```
 
 Install:
@@ -336,6 +336,20 @@ To do this automatically, pass the `sidecar` parameter to the `start` or `test`
 make test sidecar=1
 ```
 
+When running in sidecar mode container-to-container networking is used so there is no benefit to binding dependency containers to a specific port on the host machine (only the target port will be used). For this reason a random, ephemeral port (chosen by _Docker_) will be used to allow multiple instances of each dependency to run alongside one another.
+
+The _Docker Compose_ project name (and derived network name) is also suffixed with a random token to avoid container/network name conflicts.
+
+Note that a temporary file `orchestration/.sidecar` containing the random project name suffix will be created when sidecar mode is used. If this file exists then sidecar mode is always assumed to be _on_. This is to allow (e.g.) stopping services that have been started separately with another command, for example:
+
+```bash
+# Start dependencies and run tests in sidecar mode
+make test sidecar=1
+
+# Stop test dependencies in sidecar mode
+make stop env=test
+```
+
 <a name="rabbitmq-configuration"></a>
 ## RabbitMQ Configuration
 

data/lib/orchestration/docker_compose/compose_helpers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    module ComposeHelpers
+      def sidecar_port(environment)
+        port = Orchestration.random_local_port
+        return "#{port}:" unless environment == :test
+
+        # If env var `sidecar` is not set then ports will be configured as e.g.:
+        # "50123:3306"
+        # otherwise it will be:
+        # "3306" (docker will use an ephemeral host port which we will not use)
+        "${#{port}\:-sidecar}"
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/database_service.rb

@@ -3,6 +3,8 @@
 module Orchestration
   module DockerCompose
     class DatabaseService
+      include ComposeHelpers
+
       def initialize(config, environment)
         @environment = environment
         @config = config
@@ -33,7 +35,7 @@ module Orchestration
       def ports
         return {} unless %i[development test].include?(@environment)
 
-        { 'ports' => ["#{Orchestration.random_local_port}:#{remote_port}"] }
+        { 'ports' => ["#{sidecar_port(@environment)}#{remote_port}"] }
       end
 
       def volumes

data/lib/orchestration/docker_compose/mongo_service.rb

@@ -3,6 +3,8 @@
 module Orchestration
   module DockerCompose
     class MongoService
+      include ComposeHelpers
+
       PORT = 27_020
 
       def initialize(config, environment)
@@ -21,7 +23,7 @@ module Orchestration
       def ports
         return {} unless %i[development test].include?(@environment)
 
-        { 'ports' => ["#{local_port}:#{remote_port}"] }
+        { 'ports' => ["#{sidecar_port(@environment)}#{remote_port}"] }
       end
 
       def volumes

data/lib/orchestration/docker_compose/rabbitmq_service.rb

@@ -3,6 +3,8 @@
 module Orchestration
   module DockerCompose
     class RabbitMQService
+      include ComposeHelpers
+
       def initialize(config, environment)
         @config = config
         @environment = environment
@@ -19,7 +21,7 @@ module Orchestration
 
         container_port = Orchestration::Services::RabbitMQ::PORT
 
-        { 'ports' => ["#{Orchestration.random_local_port}:#{container_port}"] }
+        { 'ports' => ["#{sidecar_port(@environment)}#{container_port}"] }
       end
     end
   end

data/lib/orchestration/docker_compose.rb

@@ -5,6 +5,7 @@ module Orchestration
   end
 end
 
+require 'orchestration/docker_compose/compose_helpers'
 require 'orchestration/docker_compose/install_generator'
 require 'orchestration/docker_compose/configuration'
 require 'orchestration/docker_compose/compose_configuration'

data/lib/orchestration/install_generator.rb

@@ -57,11 +57,11 @@ module Orchestration
     def gitignore
       path = @env.root.join('.gitignore')
       globs = %w[.build/ .deploy/ Gemfile Gemfile.lock docker-compose.local.yml]
-      entries = %w[.env deploy.tar] + globs.map do |entry|
-        "#{@env.orchestration_dir_name}/#{entry}"
+      lines = %w[orchestration/.sidecar .env deploy.tar] + globs.map do |line|
+        "#{@env.orchestration_dir_name}/#{line}"
       end
 
-      ensure_lines_in_file(path, entries)
+      ensure_lines_in_file(path, lines)
     end
 
     def docker_compose

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

@@ -73,10 +73,14 @@ module Orchestration
           # A quirk of DatabaseUrl is that if no "/path" is present then the
           # `database` component is an empty string. In this unique case, we
           # want `nil` instead so that we can delegate to a default.
-          config['database'] = nil if config['database']&.empty?
+          config['database'] = nil if database_missing?(config)
           config
         end
 
+        def database_missing?(config)
+          config.key?('database') && config['database'].empty?
+        end
+
         def host
           url_config['host'] || file_config['host'] || super
         end

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

@@ -37,8 +37,8 @@ module Orchestration
       def configured?
         port
         true
-      rescue KeyError => error
-        @error = error
+      rescue KeyError => e
+        @error = e
         false
       end
 

data/lib/orchestration/templates/database.yml.erb

@@ -9,6 +9,9 @@ development:
   username: <%= compose.call(nil).database_adapter.credentials['username'] %>
   password: <%= compose.call(nil).database_adapter.credentials['password'] %>
   database: <%= compose.call(nil).database_adapter.credentials['database'] %>
+  <%% if ENV.key?('DEVELOPMENT_DATABASE_URL') %>
+  url: <%%= ENV['DEVELOPMENT_DATABASE_URL'] %>
+  <%% end %>
 <% end %>
 
 <% if compose.call('test').services.key?('database') %>

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

@@ -49,7 +49,7 @@ 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}' ] \
              || \

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

@@ -40,13 +40,36 @@ docker_organization=$(shell bash ${orchestration_dir}/yaml.bash docker_organizat
 docker_repository=$(shell bash ${orchestration_dir}/yaml.bash docker_repository)
 
 ifeq (,$(project_name))
-  project_name = ${docker_repository}_${env}
+  project_base = ${docker_repository}_${env}
+else
+  project_base := $(project_name)
+endif
+
+sidecar_suffix := $(shell test -f ${orchestration_dir}/.sidecar && cat ${orchestration_dir}/.sidecar)
+ifneq (,${sidecar_suffix})
+  sidecar := 1
+endif
+
+ifdef sidecar
+  sidecar_compose = sidecar=1
+  ifeq (,${sidecar_suffix})
+    sidecar_suffix := $(call token)
+    _ignore := $(shell echo ${sidecar_suffix} > ${orchestration_dir}/.sidecar)
+  endif
+
+  ifeq (,${sidecar_suffix})
+    $(warning Unable to generate project suffix; project name collisions may occur.)
+  endif
+  compose_project_name = ${project_base}_${sidecar_suffix}
+else
+  compose_project_name = ${project_base}
 endif
 
 compose_base=env HOST_UID=$(shell id -u) \
              DOCKER_ORGANIZATION="${docker_organization}" \
              DOCKER_REPOSITORY="${docker_repository}" \
-             COMPOSE_PROJECT_NAME="${project_name}" \
+             COMPOSE_PROJECT_NAME="${compose_project_name}" \
+	     ${sidecar_compose} \
              docker-compose \
              -f "${orchestration_dir}/docker-compose.yml"
 
@@ -67,7 +90,7 @@ all: build
 
 .PHONY: start
 ifndef network
-start: network := ${docker_repository}_${env}_default
+start: network := ${compose_project_name}_default
 endif
 start: _clean-logs
 	@$(call print,'${yellow}Starting containers${reset} ...')
@@ -75,9 +98,13 @@ ifeq (${env},$(filter ${env},test development))
 	@${compose} up --detach --force-recreate --renew-anon-volumes ${services} ${log} || ${fail}
 	@[ -n '${sidecar}' ] && \
          ( \
+           $(call printraw,' ${yellow}(joining dependency network ${green}${network}${yellow})${reset} ... ') ; \
            docker network connect '${network}' '$(shell hostname)' ${log} \
-           || \
-           $(call println,'${yellow}Warning${reset}: Unable to join network: "${yellow}${network}${reset}". Container will not be able to connect to dependency services.') \
+           || ( \
+           $(call println,'') ; \
+           $(call println,'${yellow}Warning${reset}: Unable to join network: "${yellow}${network}${reset}". Container will not be able to connect to dependency services.') ; \
+           $(call print,'You may need to delete "${yellow}orchestration/.sidecar${reset}" to disable sidecar mode if this file was added by mistake.\n...') ; \
+           ) \
          ) \
          || ( [ -z '${sidecar}' ] || ${fail} )
 else
@@ -99,13 +126,14 @@ start-<%= service %>:
 <% end %>
 
 .PHONY: stop
+stop: network := ${compose_project_name}_default
 stop: _clean-logs
 	@$(call print,'${yellow}Stopping containers${reset} ...')
 	@if docker ps --format "{{.ID}}" | grep -q $(shell hostname) ; \
           then \
-            ( ${compose} down ${log} || ${fail} ) \
+            ( docker network disconnect ${network} $(shell hostname) ${log} || : ) \
             && \
-            ( docker network connect ${docker_repository}_${env}_default $(shell hostname) ${log} || : ) ; \
+            ( ${compose} down ${log} || ${fail} ) ; \
           else \
             ${compose} down ${log} || ${fail} ; \
           fi
@@ -231,7 +259,7 @@ endif
                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_name}"' ${log} && \
+               ${compose} config 2>${stderr} | ssh "${manager}" 'docker stack deploy --prune --with-registry-auth -c - "${project_base}"' ${log} && \
             ( [ -z "${path}" ] || rm -rf "${path}" ${log} ) \
           ) \
           || ${fail}
@@ -246,8 +274,8 @@ rollback:
 ifndef manager
 	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`') ; exit 1
 endif
-	@$(call println,'${yellow}Rolling back${reset} ${green}${project_name}_${service}${reset} ${yellow}via${reset} ${green}${manager}${reset} ...')
-	@ssh "${manager}" 'docker service rollback --detach "${project_name}_${service}"' ${log} || ${fail}
+	@$(call println,'${yellow}Rolling back${reset} ${green}${compose_project_name}_${service}${reset} ${yellow}via${reset} ${green}${manager}${reset} ...')
+	@ssh "${manager}" 'docker service rollback --detach "${compose_project_name}_${service}"' ${log} || ${fail}
 	@$(call println,'${yellow}Rollback request${reset} ${green}complete${reset}. ${tick}')
 
 ### Service healthcheck commands ###

data/lib/orchestration/version.rb

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

data/lib/orchestration.rb

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

data/orchestration.gemspec

@@ -40,7 +40,7 @@ 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.59.2'
+  spec.add_development_dependency 'rubocop', '~> 0.77.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'strong_versions', '~> 0.3.1'
   spec.add_development_dependency 'webmock', '~> 3.4'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.12
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -254,14 +254,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -339,6 +339,7 @@ files:
 - lib/orchestration/docker_compose.rb
 - lib/orchestration/docker_compose/app_service.rb
 - lib/orchestration/docker_compose/compose_configuration.rb
+- lib/orchestration/docker_compose/compose_helpers.rb
 - lib/orchestration/docker_compose/configuration.rb
 - lib/orchestration/docker_compose/database_service.rb
 - lib/orchestration/docker_compose/install_generator.rb
@@ -411,8 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Docker orchestration toolkit