orchestration 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ff223f91a5979874db88e7e55a788b9c7a645f5
-  data.tar.gz: d910c778ab54470515efdfa2f514853a91f5f0ea
+  metadata.gz: c7209f425f6556b4cb2ea6747c24f69556faef24
+  data.tar.gz: 6b538236943c3c773221b0c6908b16e4dc89d5ac
 SHA512:
-  metadata.gz: e03236d51bfd3476b89cbe27a3811f2e4455c1c50b741901bd98a9db539cd029df39d8bdd0547228279b532252a1a484e7716f37c0f86a82c162847ff48a293a
-  data.tar.gz: 1538b05bdf17e1ecb6478992aff82ededd06cbfcf23b87dec959f2a8afc66cc408f5171de36539d9ba148b0b66372e57126c7f7023c0b135fbbefff881b6853d
+  metadata.gz: e6a949edc104c97a4b68520e37127ab654c75825505bfe0d8831eb0f786ce2cee75c5a900ecd5c19d0313c2bdaf89ad115632c5b5554344a974f36271439e0c8
+  data.tar.gz: 28ca0e8e45f4109ff081f9581d62fa5466b3dcbba648ebe6c392c4c0d3d45d1375c72e9165e72b0f845a15b9973f7b9dbb3cba8b2a636043242a8c92596585f9

data/.gitignore

@@ -23,4 +23,6 @@ spec/dummy/docker/*
 spec/dummy/docker-compose.yml
 spec/dummy/config/unicorn.rb
 
+orchestration-*.gem
+
 .byebug_history

data/config/locales/en.yml

@@ -16,7 +16,7 @@ en:
       waiting: "Waiting for Mongo: %{config}"
       ready: "Mongo is ready."
 
-    nginxproxy:
+    nginx-proxy:
       waiting: "Waiting for Nginx proxy: %{config}"
       ready: "Nginx proxy is ready."
 
@@ -24,5 +24,34 @@ en:
       waiting: "Waiting for RabbitMQ: %{config}"
       ready: "RabbitMQ is ready."
 
+    custom_service:
+      waiting: "Waiting for [%{service}]: %{config}"
+      ready: "[%{service}] is ready."
+
     docker:
       username_request: "Enter your Docker registry username (used for tagging images)"
+
+    rake:
+      docker:
+        username: "Output configured Docker username"
+
+      application:
+        wait: "Wait for database to become available"
+
+      database:
+        wait: "Wait for database to become available"
+
+      listener:
+        wait: "Wait for a locally-bound service to accept connections (pass `service=NAME`)"
+
+      mongo:
+        wait: "Wait for Mongo to become available"
+
+      nginx-proxy:
+        wait: "Wait for Nginx proxy to become available"
+
+      rabbitmq:
+        wait: "Wait for RabbitMQ to become available"
+
+      rabbitmq:
+        wait: "Initialise boilerplate for adding Docker to your application"

data/lib/orchestration/service_check.rb

@@ -7,7 +7,7 @@ module Orchestration
 
     def initialize(service, terminal, options = {})
       @service = service
-      @service_name = service_name(service)
+      @service_name = service.service_name
       @terminal = terminal
       @attempt_limit = options.fetch(:attempt_limit, ATTEMPT_LIMIT)
       @retry_interval = options.fetch(:retry_interval, RETRY_INTERVAL)
@@ -42,22 +42,42 @@ module Orchestration
     end
 
     def echo_waiting
-      @terminal.write(
-        :waiting,
-        I18n.t(
-          "orchestration.#{@service_name}.waiting",
-          config: @service.configuration.friendly_config
-        )
+      @terminal.write(:waiting, service_waiting)
+    end
+
+    def service_waiting
+      I18n.t(
+        "orchestration.#{@service_name}.waiting",
+        config: friendly_config,
+        default: default_waiting
+      )
+    end
+
+    def default_waiting
+      I18n.t(
+        'orchestration.custom_service.waiting',
+        config: friendly_config,
+        service: @service_name
       )
     end
 
     def echo_ready
-      @terminal.write(
-        :ready,
-        I18n.t(
-          "orchestration.#{@service_name}.ready",
-          config: @service.configuration.friendly_config
-        )
+      @terminal.write(:ready, service_ready)
+    end
+
+    def service_ready
+      I18n.t(
+        "orchestration.#{@service_name}.ready",
+        config: friendly_config,
+        default: default_ready
+      )
+    end
+
+    def default_ready
+      I18n.t(
+        'orchestration.custom_service.ready',
+        config: friendly_config,
+        service: @service_name
       )
     end
 
@@ -72,10 +92,8 @@ module Orchestration
       @terminal.write(:error, "[#{error.class.name}] #{error.message}")
     end
 
-    def service_name(service)
-      # e.g.:
-      # Orchestration::Services::RabbitMQ::Healthcheck => 'rabbitmq'
-      service.class.name.split('::')[-2].downcase
+    def friendly_config
+      @service.configuration.friendly_config
     end
   end
 end

data/lib/orchestration/services.rb

@@ -10,6 +10,7 @@ require 'orchestration/services/healthcheck_base'
 
 require 'orchestration/services/application'
 require 'orchestration/services/database'
+require 'orchestration/services/listener'
 require 'orchestration/services/mongo'
 require 'orchestration/services/nginx_proxy'
 require 'orchestration/services/rabbitmq'

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

@@ -8,8 +8,8 @@ module Orchestration
 
         self.service_name = 'application'
 
-        def initialize(env)
-          @env = env
+        def initialize(env, service_name = nil)
+          super
           @settings = {} # Included for interface consistency; currently unused.
         end
 

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

@@ -6,10 +6,6 @@ module Orchestration
       class Healthcheck
         include HealthcheckBase
 
-        def initialize(env)
-          @configuration = Configuration.new(env)
-        end
-
         def connect
           response = Net::HTTP.get_response(
             URI("http://localhost:#{@configuration.local_port}")

data/lib/orchestration/services/configuration_base.rb

@@ -3,7 +3,7 @@
 module Orchestration
   module Services
     module ConfigurationBase
-      attr_reader :settings
+      attr_reader :settings, :service_name
 
       def self.included(base)
         base.extend(ClassMethods)
@@ -22,13 +22,17 @@ module Orchestration
         end
       end
 
+      def initialize(env, service_name = nil)
+        @env = env
+        @service_name = service_name || self.class.service_name
+      end
+
       def host
         'localhost'
       end
 
       def local_port
-        name = self.class.service_name
-        key = name == 'application' ? 'nginx-proxy' : name
+        key = @service_name == 'application' ? 'nginx-proxy' : @service_name
 
         @env.docker_compose_config
             .fetch('services')

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

@@ -10,8 +10,8 @@ module Orchestration
 
         attr_reader :adapter
 
-        def initialize(env)
-          @env = env
+        def initialize(env, service_name = nil)
+          super
           @adapter = nil
           @settings = nil
           return unless defined?(ActiveRecord)

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

@@ -8,10 +8,6 @@ module Orchestration
 
         dependencies 'active_record'
 
-        def initialize(env)
-          @configuration = Configuration.new(env)
-        end
-
         def connect
           ActiveRecord::Base.establish_connection(@configuration.settings)
           ActiveRecord::Base.connection

data/lib/orchestration/services/healthcheck_base.rb

@@ -16,7 +16,8 @@ module Orchestration
           options.delete(:exit_on_error)
           env ||= Environment.new
           terminal ||= Terminal.new
-          check = ServiceCheck.new(new(env), terminal, options)
+          name = options.delete(:service_name)
+          check = ServiceCheck.new(new(env, name), terminal, options)
 
           exit 1 if !check.run && exit_on_error
         end
@@ -33,6 +34,22 @@ module Orchestration
           @dependencies.map { |dependency| require dependency }
         end
       end
+
+      def initialize(env, service_name = nil)
+        @configuration = configuration_class.new(env, service_name)
+      end
+
+      def service_name
+        @configuration.service_name
+      end
+
+      private
+
+      def configuration_class
+        # Find the relevant `Configuration` class for whatever `Healthcheck`
+        # class we happen to be included in.
+        self.class.parent.const_get(:Configuration)
+      end
     end
   end
 end

data/lib/orchestration/services/listener.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Listener
+    end
+  end
+end
+
+require 'orchestration/services/listener/configuration'
+require 'orchestration/services/listener/healthcheck'

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Listener
+      class Configuration
+        include ConfigurationBase
+
+        def self.service_name
+          raise ArgumentError
+        end
+
+        def friendly_config
+          "[#{@service_name}] #{host}:#{local_port}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Listener
+      class Healthcheck
+        include HealthcheckBase
+
+        def connect
+          Net::HTTP.start('localhost', @configuration.local_port)
+        end
+
+        def connection_errors
+          [Errno::ECONNREFUSED]
+        end
+      end
+    end
+  end
+end

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

@@ -8,8 +8,8 @@ module Orchestration
 
         self.service_name = 'mongo'
 
-        def initialize(env)
-          @env = env
+        def initialize(env, service_name = nil)
+          super
           @settings = nil
           return unless defined?(Mongoid)
           return unless File.exist?(@env.mongoid_configuration_path)

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

@@ -8,10 +8,6 @@ module Orchestration
 
         dependencies 'mongoid'
 
-        def initialize(env)
-          @configuration = Configuration.new(env)
-        end
-
         def connection_errors
           [::Mongo::Error::NoServerAvailable]
         end

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

@@ -8,10 +8,6 @@ module Orchestration
 
         self.service_name = 'nginx-proxy'
 
-        def initialize(env)
-          @env = env
-        end
-
         def friendly_config
           "[nginx-proxy] #{host}:#{local_port}"
         end

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

@@ -6,12 +6,8 @@ module Orchestration
       class Healthcheck
         include HealthcheckBase
 
-        def initialize(env)
-          @configuration = Configuration.new(env)
-        end
-
         def connect
-          Net::HTTP.start('localhost', 3000)
+          Net::HTTP.start('localhost', @configuration.local_port)
         end
 
         def connection_errors

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

@@ -8,8 +8,8 @@ module Orchestration
 
         self.service_name = 'rabbitmq'
 
-        def initialize(env)
-          @env = env
+        def initialize(env, service_name = nil)
+          super
           @settings = nil
           return unless defined?(RabbitMQ)
           return unless File.exist?(@env.rabbitmq_configuration_path)

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

@@ -8,10 +8,6 @@ module Orchestration
 
         dependencies 'bunny'
 
-        def initialize(env)
-          @configuration = Configuration.new(env)
-        end
-
         def connection_errors
           [
             Bunny::TCPConnectionFailedForAllHosts,

data/lib/orchestration/version.rb

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

data/lib/tasks/orchestration.rake

@@ -3,48 +3,48 @@
 require 'orchestration'
 
 namespace :orchestration do
-  desc 'Initialise boilerplate for adding Docker to your application'
+  desc I18n.t('orchestration.rake.install')
   task :install do
     Orchestration::InstallGenerator.start
   end
 
   namespace :application do
-    desc 'Wait for application to become available'
+    desc I18n.t('orchestration.application.wait')
     task :wait do
       Orchestration::Services::Application::Healthcheck.start
     end
   end
 
   namespace :database do
-    desc 'Wait for database to become available'
+    desc I18n.t('orchestration.database.wait')
     task :wait do
       Orchestration::Services::Database::Healthcheck.start
     end
   end
 
   namespace :mongo do
-    desc 'Wait for mongo to become available'
+    desc I18n.t('orchestration.mongo.wait')
     task :wait do
       Orchestration::Services::Mongo::Healthcheck.start
     end
   end
 
   namespace :nginx_proxy do
-    desc 'Wait for Nginx proxy to become available'
+    desc I18n.t('orchestration.nginx-proxy.wait')
     task :wait do
       Orchestration::Services::NginxProxy::Healthcheck.start
     end
   end
 
   namespace :rabbitmq do
-    desc 'Wait for database to become available'
+    desc I18n.t('orchestration.rabbitmq.wait')
     task :wait do
       Orchestration::Services::RabbitMQ::Healthcheck.start
     end
   end
 
   namespace :docker do
-    desc 'Output configured Docker username'
+    desc I18n.t('orchestration.rake.listener.wait')
     task :username do
       STDOUT.write(
         Orchestration::Environment.new.settings.get('docker.username')
@@ -52,4 +52,13 @@ namespace :orchestration do
       STDOUT.flush
     end
   end
+
+  namespace :listener do
+    desc I18n.t('orchestration.rake.listener.wait')
+    task :wait do
+      Orchestration::Services::Listener::Healthcheck.start(
+        nil, nil, service_name: ENV.fetch('service')
+      )
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Bob Farrell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-02 00:00:00.000000000 Z
+date: 2018-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -315,6 +315,9 @@ files:
 - lib/orchestration/services/database/configuration.rb
 - lib/orchestration/services/database/healthcheck.rb
 - lib/orchestration/services/healthcheck_base.rb
+- lib/orchestration/services/listener.rb
+- lib/orchestration/services/listener/configuration.rb
+- lib/orchestration/services/listener/healthcheck.rb
 - lib/orchestration/services/mongo.rb
 - lib/orchestration/services/mongo/configuration.rb
 - lib/orchestration/services/mongo/healthcheck.rb