orchestration 0.6.2 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d1e16807cf85124c5b8fdd635f24d814bfb425fb822ea2d8cec3386195b1ba
-  data.tar.gz: 64c7b4bc764947b2e9414c81c443e861ee1f7aee2811b0f238b78c3d21ddf879
+  metadata.gz: 22c01beaeb79e418062c87c7d0d8d9fdc472cc479c16a47d9be01ca0278abc04
+  data.tar.gz: 78ad03978e9fcdb0ebf9cf1a02af1395dc356cdf5dac048eb06ab741396f4166
 SHA512:
-  metadata.gz: 1615435866d1991f6aaae1cc0543bf7940f51a18343d5936098282c6ce999790ca6074de818c77b93a4ba8c1e85f1114c0a4a53f620d65326d5d484e4fe2c56b
-  data.tar.gz: 251feb2bb2b317cbb33292b6168833a0cee777a46f0f3d709a6e7dc2d721dbc72a6427962b9562825e1eb5174bc9f6dd6b18dd4a66a3132fc338c9184ffb5620
+  metadata.gz: 94d8bdc996d37ae9b51bfd3a44f945e0f30b466d3bebb753b535c9e63558962d0661905fd4690677e946789bef76d9276f7047c4c990e7d9cfe6518b584e752f
+  data.tar.gz: 9f785e2f76dac85f01c36db3fbc3d24724e52e4f36aaffe95f388e782b98b0d6f351b173383a42950405b3fe427901c4ba49c5a6e64d61f0b88c385e0a581393

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.2'
+gem 'orchestration', '~> 0.6.5'
 ```
 
 Install:

data/config/locales/en.yml

@@ -29,6 +29,7 @@ en:
     rake:
       config: "Parse and output Orchestration config (internal use)"
       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"
       install_makefile: "(Re)create orchestration/Makefile"
       wait: "Wait for development/test dependencies to be available"

data/lib/orchestration/docker_compose/app_service.rb

@@ -3,6 +3,8 @@
 module Orchestration
   module DockerCompose
     class AppService
+      include ComposeHelpers
+
       def initialize(config, environment)
         @environment = environment
         @config = config
@@ -89,19 +91,15 @@ 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' => '/healthcheck',
           'WEB_PORT' => 8080,
           'DATABASE_URL' => database_url
-        }.merge(inherited_environment.map { |key| [key, nil] }.to_h).merge(rabbitmq_urls)
+        }.merge(inherited_environment.to_h { |key| [key, nil] }).merge(rabbitmq_urls)
       end
 
       def rabbitmq_urls
@@ -115,7 +113,7 @@ module Orchestration
           '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)
+        }.fetch(DockerCompose::ComposeConfiguration.database_adapter_name, nil)
       end
 
       def inherited_environment

data/lib/orchestration/docker_compose/compose_configuration.rb

@@ -42,12 +42,16 @@ module Orchestration
         ports(name).find { |mapping| mapping[:remote] == remote_port }
                    .fetch(:local)
                    .to_i
+      rescue NoMethodError
+        nil
       end
 
       private
 
       def config
         @config ||= @env.docker_compose_config
+      rescue Errno::ENOENT
+        {}
       end
 
       def listener?(name)

data/lib/orchestration/docker_compose/compose_helpers.rb

@@ -13,6 +13,12 @@ module Orchestration
         # "3306" (docker will use an ephemeral host port which we will not use)
         "${sidecar-#{port}:}"
       end
+
+      def networks
+        service = self.class.name.rpartition('::').last.partition('Service').first.downcase
+        network_alias = %i[development test].include?(@environment) ? service : "#{service}-local"
+        { 'local' => { 'aliases' => [network_alias] } }
+      end
     end
   end
 end

data/lib/orchestration/docker_compose/database_service.rb

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

data/lib/orchestration/docker_compose/mongo_service.rb

@@ -15,7 +15,7 @@ module Orchestration
       def definition
         return nil unless @config.enabled?
 
-        { 'image' => 'library/mongo' }.merge(ports).merge(volumes)
+        { 'image' => 'library/mongo', 'networks' => networks }.merge(ports).merge(volumes)
       end
 
       private

data/lib/orchestration/docker_compose/rabbitmq_service.rb

@@ -13,7 +13,7 @@ module Orchestration
       def definition
         return nil unless @config.enabled?
 
-        { 'image' => 'library/rabbitmq:management' }.merge(ports)
+        { 'image' => 'library/rabbitmq:management', 'networks' => networks }.merge(ports)
       end
 
       def ports

data/lib/orchestration/environment.rb

@@ -69,12 +69,12 @@ module Orchestration
     end
 
     def default_app_name
-      default = docker_filter(root.basename.to_s)
+      default = docker_filter(root.basename.to_s, underscore: true)
       return default unless defined?(Rails)
       # Edge case if Rails is used as a dependency but we are not a Rails app:
       return default if rails_application == Object
 
-      docker_filter(rails_application.name.underscore)
+      docker_filter(rails_application.name.underscore, underscore: true)
     end
 
     def rabbitmq_url
@@ -126,10 +126,14 @@ module Orchestration
       app_class.parent
     end
 
-    def docker_filter(string)
+    def docker_filter(string, underscore: false)
       # Filter out characters not accepted by Docker Hub
       permitted = [('0'..'9'), ('a'..'z')].map(&:to_a).flatten
-      string.chars.select { |char| permitted.include?(char) }.join
+      string.chars.select do |char|
+        next true if underscore && char == '_'
+
+        permitted.include?(char)
+      end.join
     end
   end
 end

data/lib/orchestration/make/orchestration.mk

@@ -141,6 +141,8 @@ docker_config:=$(shell DEVPACK_DISABLE=1 RAILS_ENV=development ${bundle_cmd} rak
 docker_organization=$(word 1,$(docker_config))
 docker_repository=$(word 2,$(docker_config))
 
+compose_services:=$(shell ${rake} orchestration:compose_services RAILS_ENV=${env})
+
 ifeq (,$(project_name))
   project_base = ${docker_repository}_${env}
 else
@@ -209,6 +211,7 @@ ifndef network
 start: network := ${compose_project_name}
 endif
 start: _create-log-directory _clean-logs
+ifneq (,${compose_services})
 	@$(call system,${compose_human} up --detach)
 ifeq (${env},$(filter ${env},test development))
 	@${compose} up --detach --force-recreate --renew-anon-volumes --remove-orphans ${services} ${log} || ${exit_fail}
@@ -229,10 +232,12 @@ endif
 	@$(call echo,${env_human} containers started ${tick})
 	@$(call echo,Waiting for services to become available)
 	@$(call make,wait) 2>${stderr} || ${exit_fail}
+endif
 
 .PHONY: stop
 stop: network := ${compose_project_name}
 stop:
+ifneq (,${compose_services})
 	@$(call echo,Stopping ${env_human} containers)
 	@$(call system,${compose_human} down)
 	@if docker ps --format "{{.ID}}" | grep -q $(shell hostname) ; \
@@ -244,6 +249,7 @@ stop:
             ${compose} down ${log} || ${exit_fail} ; \
           fi
 	@$(call echo,${env_human} containers stopped ${tick})
+endif
 
 .PHONY: logs
 logs:
@@ -288,7 +294,9 @@ db-console:
 	@${rake} orchestration:db:console RAILS_ENV=${env}
 
 .PHONY: setup
+ifneq (,$(wildcard config/database.yml))
 setup: url = $(shell ${rake} orchestration:db:url RAILS_ENV=${env})
+endif
 setup: _log-notify
 	@$(call echo,Setting up ${env_human} environment)
 	@$(call make,start env=${env})
@@ -306,9 +314,9 @@ ifneq (,$(wildcard config/database.yml))
 	@$(call system,rake db:migrate DATABASE_URL="${url}")
 	@${rake} db:migrate RAILS_ENV=${env}
 endif
-	@$(MAKE) -n post-setup >/dev/null 2>&1 \
-          && $(call system,make post-setup RAILS_ENV=${env}) \
-          && $(MAKE) post-setup RAILS_ENV=${env}
+	@if $(MAKE) -n post-setup >/dev/null 2>&1; then \
+          $(call system,make post-setup RAILS_ENV=${env}) \
+          && $(MAKE) post-setup RAILS_ENV=${env}; fi
 	@$(call echo,${env_human} environment setup complete ${tick})
 
 .PHONY: dump
@@ -437,12 +445,11 @@ endif
 ifdef include
 	@$(call echo,Including files from: ${cyan}${include}${reset})
 	@(while read line; do \
-	    _system "echo '${system_prefix}' $$1 }"; \
             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}"); \
-	    _system "tar rf 'context.tar' '$${line}'"; \
+	    echo "${system_prefix}" "tar rf 'context.tar' '$${line}'"; \
           done < '${include}') ${log} || ${exit_fail}
 	@$(call echo,Build context ${green}ready${reset} ${tick})
 endif

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

@@ -30,11 +30,8 @@ post-setup:
 # Launch all dependencies needed for a development environment and set up the
 # development database.
 #
-.PHONY: setup
+.PHONY: develop
 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
+	@$(MAKE) setup env=test
+	@$(MAKE) setup env=development

data/lib/orchestration/version.rb

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

data/lib/tasks/orchestration.rake

@@ -39,6 +39,12 @@ namespace :orchestration do
     end
   end
 
+  desc I18n.t('orchestration.rake.compose_services')
+  task :compose_services do
+    config = Orchestration::DockerCompose::ComposeConfiguration.new(Orchestration::Environment.new)
+    puts config.services.keys.join(' ') unless config.services.nil? || config.services.empty?
+  end
+
   desc I18n.t('orchestration.rake.healthcheck')
   task :healthcheck do
     Orchestration::DockerHealthcheck.execute

data/orchestration.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |spec|
   spec.summary = 'Docker orchestration toolkit'
   spec.description = 'Tools to help launch apps in Docker'
   spec.homepage = url
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -21,7 +22,7 @@ Gem::Specification.new do |spec|
     end
   end
 
-  spec.required_ruby_version = '~> 2.6'
+  spec.required_ruby_version = '~> 2.7'
   spec.bindir = 'bin'
   spec.executables = []
   spec.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.5
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -414,7 +414,8 @@ files:
 - orchestration.gemspec
 homepage: https://github.com/bobf/orchestration
 licenses: []
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -423,14 +424,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Docker orchestration toolkit