orchestration 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3658b497eae57e7f247ef8f703ddb90ca6c041a2aba5409c61e54291a8e80c22
-  data.tar.gz: 4a7a242492fd376b62ccb30c2dbf6e5e9163aa202e5fefbbb75b1fef4eab315c
+  metadata.gz: 512e1996cb5b673af217cfa7442d7e8e52053de71c86f39babe43986227377a3
+  data.tar.gz: cdd316060790c5ab246f33710673417f5bec82fed16d1ea6a88f2232a3283021
 SHA512:
-  metadata.gz: d855b7c336167af5db5444f96319de4236d7bb19fdb2ad0554b0c1730485ff57f3d1e3e9d8317138fe60797ac4cf4011bf76f168c1e8948ce3e242e0a012d7c6
-  data.tar.gz: 98c840d9cdd7272fa2f167373b5df176f9bb0a6d6b22f4be897dd64290f51c17087a20c8f5765e1fdd68890beae7f9de74fdde839441d014d873dfb1effd1996
+  metadata.gz: 51e4fc3b1e5931f0089502f71d27c21d3801ee802c23c86e9e8876fd129f838f6f39fa0fd868c05ae22d682132265b16b99023f9ba7b38381ee512c8c5ac1dbc
+  data.tar.gz: 3ff522982f74050813537a629aafd15b1dbc45783d47b5ecb44dc17774e856646512d5c9a79fef881b8888e07ffe2987c38b138513804c2c1d953e0d2f291d81

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.8'
+gem 'orchestration', '~> 0.4.9'
 ```
 
 Install:
@@ -199,20 +199,28 @@ Run a production environment locally to simulate your deployment platform:
 make start env=production
 ```
 
-### Deployment to Docker Swarm
+#### Deploy to a remote swarm
 
-To deploy your application to a local _Docker Swarm_ use:
+To connect via _SSH_ to a remote swarm and deploy, pass the `manager` parameter:
 ```
-make deploy
+make deploy manager=user@manager.swarm.example.com
 ```
 
-#### Deploy to a remote swarm
+#### Roll back a deployment
 
-To connect via _SSH_ to a remote swarm and deploy, pass the `manager` parameter:
+Roll back the `app` service of your stack:
 ```
-make deploy manager=user@manager.swarm.example.com
+make rollback manager=user@manager.swarm.example.com
 ```
 
+Roll back a specific service:
+```
+make rollback manager=user@manager.swarm.example.com service=database
+```
+
+The `project_name` parameter is also supported.
+
+
 #### Use a custom stack name
 
 The [_Docker_ stack](https://docs.docker.com/engine/reference/commandline/stack/) name defaults to the name of your repository (as defined in `.orchesration.yml`) and the _Rails_ environment, e.g. `anvil_production`.
@@ -355,6 +363,46 @@ Using this approach, the environment variable `RABBITMQ_URL` can be used to conf
 
 This is a convention of the _Orchestration_ gem intended to make _RabbitMQ_ configuration consistent with other services.
 
+## Alternate Database Configuration Files
+
+If you have multiple databases configured in various (e.g.) `config/database.*.yml` files then the `make wait-database` command can be used directly in continuous integration environments to verify that your database services are available.
+
+Note that all services from the relevant `docker-compose.yml` configuration will be loaded when using the `make start` or `make test-setup` (called by default `make test` command).
+
+Assuming the following configurations:
+```
+# orchestration/docker-compose.test.yml
+version: '3.7'
+services:
+  customdb:
+    image: postgres
+    ports:
+      - "55667:5432"
+  # ...
+```
+
+```
+# config/database.custom.yml
+test:
+  adapter: postgresql
+  host: 127.0.0.1
+  port: 55667
+  username: postgres
+  password: password
+  database: postgres
+```
+
+The following command can be used to ensure that the `customdb` service is available:
+```
+make wait-database service=custom config=config/database.custom.yml env=test
+```
+
+You may wish to extend the example `Makefile` to include something like this:
+```
+test: test-setup
+	$(MAKE) wait-database service=custom config=config/database.custom.yml env=test
+	# ...
+```
 ## License
 
 [MIT License](LICENSE)

data/config/locales/en.yml

@@ -62,3 +62,4 @@ en:
         wait: "Wait for RabbitMQ to become available"
 
       install: "Install Orchestration tools"
+      install_makefile: "(Re)create orchestration/Makefile"

data/lib/orchestration/docker_compose/compose_configuration.rb

@@ -3,6 +3,15 @@
 module Orchestration
   module DockerCompose
     class ComposeConfiguration
+      def self.database_adapter_name
+        return nil unless defined?(ActiveRecord)
+        return 'postgresql' if defined?(::PG)
+        return 'mysql2' if defined?(::Mysql2)
+        return 'sqlite3' if defined?(::SQLite3)
+
+        nil
+      end
+
       def initialize(env)
         @env = env
       end
@@ -12,12 +21,7 @@ module Orchestration
       end
 
       def database_adapter_name
-        return nil unless defined?(ActiveRecord)
-        return 'postgresql' if defined?(::PG)
-        return 'mysql2' if defined?(::Mysql2)
-        return 'sqlite3' if defined?(::SQLite3)
-
-        nil
+        self.class.database_adapter_name
       end
 
       def database_adapter
@@ -32,7 +36,7 @@ module Orchestration
       end
 
       def local_port(name, remote_port = nil)
-        return nil if ports(name).empty?
+        return nil unless listener?(name)
         return ports(name).first[:local].to_i if remote_port.nil?
 
         ports(name).find { |mapping| mapping[:remote] == remote_port }
@@ -46,6 +50,10 @@ module Orchestration
         @config ||= @env.docker_compose_config
       end
 
+      def listener?(name)
+        services.key?(name.to_s) && !ports(name).empty?
+      end
+
       def ports(name)
         services
           .fetch(name.to_s)

data/lib/orchestration/install_generator.rb

@@ -92,6 +92,9 @@ module Orchestration
     def database_yml
       return unless defined?(ActiveRecord)
 
+      adapter = DockerCompose::ComposeConfiguration.database_adapter_name
+      return if adapter == 'sqlite3'
+
       service_config('database.yml', Services::Database::Configuration)
     end
 

data/lib/orchestration/service_check.rb

@@ -3,7 +3,7 @@
 module Orchestration
   class ServiceCheck
     ATTEMPT_LIMIT = ENV.fetch('ORCHESTRATION_RETRY_LIMIT', '10').to_i
-    RETRY_INTERVAL = ENV.fetch('ORCHESTRATION_RETRY_INTERVAL', '5').to_i
+    RETRY_INTERVAL = ENV.fetch('ORCHESTRATION_RETRY_INTERVAL', '6').to_i
 
     def initialize(service, terminal, options = {})
       @service = service

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

@@ -12,7 +12,7 @@ module Orchestration
           true
         end
 
-        def initialize(env, service_name = nil)
+        def initialize(env, service_name = nil, options = {})
           super
           @settings = {}
         end

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

@@ -13,7 +13,7 @@ module Orchestration
         end
 
         def friendly_config
-          return "[#{adapter.name}]" if adapter.name == 'sqlite3'
+          return "[#{adapter.name}]" if sqlite?
 
           "[#{adapter.name}] #{host}:#{port}"
         end
@@ -29,6 +29,10 @@ module Orchestration
           }.transform_keys(&:to_s)
         end
 
+        def configured?
+          sqlite? || super
+        end
+
         def adapter
           url_adapter = url_config['adapter']
           file_adapter = file_config['adapter']
@@ -42,10 +46,20 @@ module Orchestration
 
         private
 
+        def custom?
+          !@options[:config_path].nil?
+        end
+
+        def database_configuration_path
+          return @env.database_configuration_path unless custom?
+
+          @options[:config_path]
+        end
+
         def file_config
-          return {} unless File.exist?(@env.database_configuration_path)
+          return {} unless File.exist?(database_configuration_path) || custom?
 
-          yaml = ERB.new(File.read(env.database_configuration_path)).result
+          yaml = ERB.new(File.read(database_configuration_path)).result
           YAML.safe_load(yaml, [], [], true)[@env.environment] || {}
         end
 
@@ -67,6 +81,8 @@ module Orchestration
         end
 
         def port
+          return nil if sqlite?
+
           url_config['port'] || file_config['port'] || super
         end
 
@@ -109,6 +125,10 @@ module Orchestration
         def adapters
           Orchestration::Services::Database::Adapters
         end
+
+        def sqlite?
+          adapter.name == 'sqlite3'
+        end
       end
     end
   end

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

@@ -9,6 +9,8 @@ module Orchestration
         dependencies 'active_record'
 
         def connect
+          return if settings[:adapter] == 'sqlite3'
+
           ActiveRecord::Base.establish_connection(settings)
           ActiveRecord::Base.connection
         end
@@ -24,12 +26,7 @@ module Orchestration
         end
 
         def settings
-          return @configuration.settings unless @options[:init]
-
-          {
-            adapter: @configuration.adapter.name,
-            port: DockerCompose::DatabaseService::PORT
-          }.merge(@configuration.adapter.credentials)
+          @configuration.settings
         end
       end
     end

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

@@ -22,8 +22,9 @@ module Orchestration
         end
       end
 
-      def initialize(env, service_name = nil)
+      def initialize(env, service_name = nil, options = {})
         @env = env
+        @options = options
         @service_name = service_name || self.class.service_name
       end
 

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

@@ -37,7 +37,7 @@ module Orchestration
 
       def initialize(env, service_name = nil, options = {})
         @options = options
-        @configuration = configuration_class.new(env, service_name)
+        @configuration = configuration_class.new(env, service_name, options)
       end
 
       def service_name

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

@@ -208,14 +208,14 @@ endif
 	@bundle_path="${path}" ; tar -C '${orchestration_dir}/.deploy' -cf "$${bundle_path:-./bundle.tar}" ./${docker_repository}
 
 .PHONY: deploy
-ifndef manager
-	@$(call println_error,'Missing `manager` parameter: `make deploy manager=swarm-manager.example.com`')
-endif
 deploy: path := $(shell mktemp -d)
 deploy: RAILS_ENV := ${env}
 deploy: RACK_ENV := ${env}
 deploy: DOCKER_TAG = ${git_version}
 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 make,_verify_compose env_file=${env_file} env=${env}) && \
@@ -238,6 +238,18 @@ deploy:
 
 	@$(call println,'${yellow}Deployment${reset} ${green}complete${reset}. ${tick}')
 
+.PHONY: rollback
+ifndef service
+rollback: service = app
+endif
+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}Rollback request${reset} ${green}complete${reset}. ${tick}')
+
 ### Service healthcheck commands ###
 
 .PHONY: wait
@@ -261,8 +273,14 @@ wait-listener:
 <% services.each do |service| %>
 <% next if service.to_sym == :app %>
 .PHONY: wait-<%= service %>
+ifdef config
+wait-<%= service %>: configvar := config=$(config)
+endif
+ifdef service
+wait-<%= service %>: servicevar := service=$(service)
+endif
 wait-<%= service %>:
-	@${rake} orchestration:<%= service %>:wait
+	@${rake} orchestration:<%= service %>:wait $(configvar) $(servicevar)
 
 <% end %>
 

data/lib/orchestration/version.rb

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

data/lib/tasks/orchestration.rake

@@ -8,10 +8,19 @@ namespace :orchestration do
     Orchestration::InstallGenerator.start
   end
 
+  namespace :install do
+    desc I18n.t('orchestration.rake.install_makefile')
+    task :makefile do
+      Orchestration::InstallGenerator.new.orchestration_makefile
+    end
+  end
+
   namespace :app do
     desc I18n.t('orchestration.rake.app.wait')
     task :wait do
-      Orchestration::Services::App::Healthcheck.start
+      Orchestration::Services::App::Healthcheck.start(
+        nil, nil, config_path: ENV['config'], service_name: ENV['service']
+      )
     end
   end
 
@@ -19,7 +28,7 @@ namespace :orchestration do
     desc I18n.t('orchestration.rake.database.wait')
     task :wait do
       Orchestration::Services::Database::Healthcheck.start(
-        nil, nil, init: ENV.key?('init')
+        nil, nil, config_path: ENV['config'], service_name: ENV['service']
       )
     end
   end
@@ -27,14 +36,18 @@ namespace :orchestration do
   namespace :mongo do
     desc I18n.t('orchestration.rake.mongo.wait')
     task :wait do
-      Orchestration::Services::Mongo::Healthcheck.start
+      Orchestration::Services::Mongo::Healthcheck.start(
+        nil, nil, config_path: ENV['config'], service_name: ENV['service']
+      )
     end
   end
 
   namespace :rabbitmq do
     desc I18n.t('orchestration.rake.rabbitmq.wait')
     task :wait do
-      Orchestration::Services::RabbitMQ::Healthcheck.start
+      Orchestration::Services::RabbitMQ::Healthcheck.start(
+        nil, nil, config_path: ENV['config'], service_name: ENV['service']
+      )
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url