orchestration 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d46427ecb6cb0665a6be31e5e49cd6a01a8c2f5148442f3c1bcc3852c87c83e9
-  data.tar.gz: d622198cebd4619d573f391f9eae23d68bea32606619f4d8965032c1eb096a98
+  metadata.gz: 3423dc31e2b526868cb869c930d6f73039437939aa7b2ceb859e0e8106536344
+  data.tar.gz: 4669fd75876e047f52d256dd2f2e3840ecd42f157b04c6f4f81e315ae96ca6ff
 SHA512:
-  metadata.gz: 89364f65e27bb9f05213a4a6c64351b1fc9e1b2e12eb890d4b90f2b1338cdab7e04b1dc1a43cf155d6fafe1f838c3c8a903dcccc1bf80b557e38a371aee902eb
-  data.tar.gz: 69aca6c30ba0fcbd2a8d1172a8e4904a88e8fe3d0875281f6cd8a2245e601d36c45fcbbd4f784b39935e6195a5d13c87cb5f1a0f8247823e3a2de2e209caf71e
+  metadata.gz: 2a4f0579b2698d30103975b175b8a4cdc1df51c5ce883560f2b11f24b8fd3307fd1e6a35868689f6152d182e07ddbc65b6f081fe4b33ae1114e7957b64338c02
+  data.tar.gz: 380413ccb1b108614ad09247a2435178a042c352775712b287c79e707938aa409290ab42f9b0b5d7cc32184fe73de200a8a551ae5c24ba37b3c08655e4caeaf0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    orchestration (0.7.0)
+    orchestration (0.7.2)
       database_url (~> 0.1.2)
       erubis (~> 2.7)
       i18n
@@ -173,6 +173,7 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     rbtree (0.4.5)
+    redis (4.6.0)
     regexp_parser (2.4.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -248,6 +249,7 @@ DEPENDENCIES
   pg (~> 1.3)
   rails
   rake (~> 13.0)
+  redis (~> 4.6)
   rspec (~> 3.11)
   rspec-its (~> 1.3)
   rubocop (~> 1.28)

data/README.md

@@ -31,7 +31,7 @@ Add _Orchestration_ to your `Gemfile`:
 _Ruby 3.x_:
 
 ```ruby
-gem 'orchestration', '~> 0.7.1'
+gem 'orchestration', '~> 0.7.2'
 ```
 
 _Ruby 2.x_:
@@ -67,6 +67,7 @@ _Orchestration_ generates the following files where appropriate. Backups are cre
 * `config/database.yml`
 * `config/mongoid.yml`
 * `config/rabbitmq.yml` (see [RabbitMQ Configuration](#rabbitmq-configuration) for more details)
+* `config/redis.yml` (see [Redis Configuration](#redis-configuration) for more details)
 * `config/unicorn.rb`
 * `config/puma.rb`
 
@@ -396,13 +397,6 @@ make stop RAILS_ENV=test
 <a name="rabbitmq-configuration"></a>
 ## RabbitMQ Configuration
 
-The [Bunny](https://github.com/ruby-amqp/bunny) _RabbitMQ_ gem does not recognise `config/rabbitmq.yml` or `RABBITMQ_URL`. If your application uses _RabbitMQ_ then you must manually update your code to reference this file, e.g.:
-
-```ruby
-connection = Bunny.new(config_for(:rabbit_mq)['url'])
-connection.start
-```
-
 _Orchestration_ generates the following `config/rabbitmq.yml`:
 
 ```
@@ -419,10 +413,42 @@ production:
   management_url: <%= ENV['RABBITMQ_MANAGEMENT_URL'] %>
 ```
 
+The [Bunny](https://github.com/ruby-amqp/bunny) _RabbitMQ_ gem does not recognise `config/rabbitmq.yml` or `RABBITMQ_URL`. If your application uses _RabbitMQ_ then you must manually update your code to reference this file, e.g.:
+
+```ruby
+connection = Bunny.new(Rails.application.config_for(:rabbit_mq)['url'])
+connection.start
+```
+
 Using this approach, the environment variable `RABBITMQ_URL` can be used to configure _Bunny_ in production (similar to `DATABASE_URL` and `MONGO_URL`).
 
 This is a convention of the _Orchestration_ gem intended to make _RabbitMQ_ configuration consistent with other services.
 
+<a name="redis-configuration"></a>
+## Redis Configuration
+
+_Orchestration_ generates the following `config/redis.yml`:
+
+```
+development:
+  url: redis://127.0.0.1:51071
+
+test:
+  url: redis://127.0.0.1:51069
+```
+
+The [Redis](https://github.com/redis/redis-rb) gem does not recognise `config/redis.yml`. If your application uses _Redis_ then you must manually update your code to reference this file, e.g.:
+
+```ruby
+# config/initializers/redis.rb
+
+ENV['REDIS_URL'] ||= Rails.application.config_for(:redis)['url']
+```
+_Redis_ will then use `REDIS_URL` for all connections.
+
+This allows `development` and `test` environments to auto-load the correct config for the relevant containers while also allowing `production` to use either the auto-generated _Redis_ service or an external _Redis_ instance.
+
+
 ## Alternate Database Configuration Files
 
 If you have multiple databases configured in various `config/database.*.yml` files then the `make wait` command will automatically detect database configurations.

data/lib/orchestration/docker_compose/app_service.rb

@@ -2,6 +2,7 @@
 
 module Orchestration
   module DockerCompose
+    # rubocop:disable Metrics/ClassLength
     class AppService
       include ComposeHelpers
 
@@ -99,13 +100,19 @@ module Orchestration
           'WEB_HEALTHCHECK_PATH' => '/healthcheck',
           'WEB_PORT' => 8080,
           'DATABASE_URL' => database_url
-        }.merge(inherited_environment.to_h { |key| [key, nil] }).merge(rabbitmq_urls)
+        }.merge(inherited_environment.to_h { |key| [key, nil] }).merge(rabbitmq_urls).merge(redis_url)
       end
 
       def rabbitmq_urls
         return {} unless Services::RabbitMQ::Configuration.new(Environment.new).enabled?
 
-        { 'RABBITMQ_URL' => 'amqp://rabbitmq:5672', 'RABBITMQ_MANAGEMENT_URL' => 'http://rabbitmq:15672' }
+        { 'RABBITMQ_URL' => 'amqp://rabbitmq-local:5672', 'RABBITMQ_MANAGEMENT_URL' => 'http://rabbitmq-local:15672' }
+      end
+
+      def redis_url
+        return {} unless Services::Redis::Configuration.new(Environment.new).enabled?
+
+        { 'REDIS_URL' => "redis://redis-local:#{Services::Redis::PORT}" }
       end
 
       def database_url
@@ -124,5 +131,6 @@ module Orchestration
         ['${PUBLISH_PORT:?PUBLISH_PORT must be provided}:8080']
       end
     end
+    # rubocop:enable Metrics/ClassLength
   end
 end

data/lib/orchestration/docker_compose/compose_configuration.rb

@@ -39,7 +39,7 @@ module Orchestration
         return nil unless listener?(name)
         return ports(name).first[:local].to_i if remote_port.nil?
 
-        ports(name).find { |mapping| mapping[:remote] == remote_port }
+        ports(name).find { |mapping| mapping[:remote].to_i == remote_port.to_i }
                    .fetch(:local)
                    .to_i
       rescue NoMethodError

data/lib/orchestration/docker_compose/configuration.rb

@@ -32,7 +32,8 @@ module Orchestration
           app: AppService,
           database: DatabaseService,
           mongo: MongoService,
-          rabbitmq: RabbitMQService
+          rabbitmq: RabbitMQService,
+          redis: RedisService
         }
       end
 

data/lib/orchestration/docker_compose/install_generator.rb

@@ -67,9 +67,9 @@ module Orchestration
       def service_names(environment)
         case environment
         when :test, :development
-          %i[database mongo rabbitmq]
+          %i[database mongo rabbitmq redis]
         when :deployment
-          %i[app database mongo rabbitmq]
+          %i[app database mongo rabbitmq redis]
         when :local, nil
           []
         else
@@ -88,7 +88,8 @@ module Orchestration
           app: Orchestration::Services::App::Configuration,
           database: Orchestration::Services::Database::Configuration,
           mongo: Orchestration::Services::Mongo::Configuration,
-          rabbitmq: Orchestration::Services::RabbitMQ::Configuration
+          rabbitmq: Orchestration::Services::RabbitMQ::Configuration,
+          redis: Orchestration::Services::Redis::Configuration
         }.fetch(service).new(@env)
       end
 

data/lib/orchestration/docker_compose/redis_service.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class RedisService
+      include ComposeHelpers
+
+      def initialize(config, environment)
+        @config = config
+        @environment = environment
+      end
+
+      def definition
+        return nil unless @config.enabled?
+
+        { 'image' => 'library/redis:7.0', 'networks' => networks }.merge(ports)
+      end
+
+      def ports
+        return {} unless %i[development test].include?(@environment)
+
+        container_port = Orchestration::Services::Redis::PORT
+
+        { 'ports' => ["#{sidecar_port(@environment)}#{container_port}"] }
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose.rb

@@ -14,3 +14,4 @@ require 'orchestration/docker_compose/app_service'
 require 'orchestration/docker_compose/database_service'
 require 'orchestration/docker_compose/mongo_service'
 require 'orchestration/docker_compose/rabbitmq_service'
+require 'orchestration/docker_compose/redis_service'

data/lib/orchestration/environment.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Orchestration
+  # rubocop:disable Metrics/ClassLength
   class Environment
     def initialize(options = {})
       @environment = options.fetch(:environment, nil)
@@ -44,6 +45,10 @@ module Orchestration
       root.join('config', 'rabbitmq.yml')
     end
 
+    def redis_configuration_path
+      root.join('config', 'redis.yml')
+    end
+
     def orchestration_configuration_path
       root.join('.orchestration.yml')
     end
@@ -136,4 +141,5 @@ module Orchestration
       end.join
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/orchestration/install_generator.rb

@@ -72,7 +72,7 @@ module Orchestration
     end
 
     def database_yml
-      return unless defined?(ActiveRecord)
+      return unless defined?(::ActiveRecord)
 
       adapter = DockerCompose::ComposeConfiguration.database_adapter_name
       return if adapter == 'sqlite3'
@@ -81,17 +81,23 @@ module Orchestration
     end
 
     def mongoid_yml
-      return unless defined?(Mongoid)
+      return unless defined?(::Mongoid)
 
       service_config('mongoid.yml', Services::Mongo::Configuration)
     end
 
     def rabbitmq_yml
-      return unless defined?(Bunny)
+      return unless defined?(::Bunny)
 
       service_config('rabbitmq.yml', Services::RabbitMQ::Configuration)
     end
 
+    def redis_yml
+      return unless defined?(::Redis)
+
+      service_config('redis.yml', Services::Redis::Configuration)
+    end
+
     def env
       simple_copy('env', @env.root.join('.env'), overwrite: false)
     end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Redis
+      class Configuration
+        include ConfigurationBase
+
+        self.service_name = 'redis'
+
+        def enabled?
+          defined?(::Redis)
+        end
+
+        def friendly_config
+          "[redis] redis://#{host}:#{port}"
+        end
+
+        def host
+          from_url['host'] || super
+        end
+
+        def port
+          from_url['port'] || super
+        end
+
+        private
+
+        def from_url
+          return {} if @env.redis_url.nil?
+
+          uri = URI.parse(@env.redis_url)
+          { 'host' => uri.host, 'port' => uri.port || PORT }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Redis
+      class Healthcheck
+        class NotConnectedError < OrchestrationError; end
+
+        include HealthcheckBase
+
+        dependencies 'redis'
+
+        def connection_errors
+          [NotConnectedError]
+        end
+
+        def connect
+          host = @configuration.host
+          port = @configuration.port
+          return if ::Redis.new(url: "redis://#{host}:#{port}").connected?
+
+          raise NotConnectedError
+        end
+      end
+    end
+  end
+end

data/lib/orchestration/services/redis.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module Services
+    module Redis
+      PORT = 6379
+    end
+  end
+end
+
+require 'orchestration/services/redis/configuration'
+require 'orchestration/services/redis/healthcheck'

data/lib/orchestration/services.rb

@@ -14,3 +14,4 @@ require 'orchestration/services/database'
 require 'orchestration/services/listener'
 require 'orchestration/services/mongo'
 require 'orchestration/services/rabbitmq'
+require 'orchestration/services/redis'

data/lib/orchestration/templates/puma.rb.erb

@@ -1,8 +1,8 @@
-environment ENV.fetch('RAILS_ENV') { 'development' }
+environment ENV.fetch('RAILS_ENV', 'development')
 
-port ENV.fetch('WEB_PORT') { 3000 }
-workers ENV.fetch('WEB_CONCURRENCY') { 4 }
-threads_count = ENV.fetch('RAILS_MAX_THREADS') { 8 }
+port ENV.fetch('WEB_PORT', 3000)
+workers ENV.fetch('WEB_CONCURRENCY', 4)
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 8)
 
 pidfile './tmp/pids/server.pid'
 threads threads_count, threads_count

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

@@ -0,0 +1,9 @@
+<% if compose.call('development').services.key?('redis') %>
+development:
+  url: <%= "#{'<' + '%' + '='} ENV.fetch('REDIS_URL', 'redis://127.0.0.1:#{compose.call('development').local_port('redis', 6379)}') #{'%' + '>'}" %>
+<% end %>
+
+<% if compose.call('test').services.key?('redis') %>
+test:
+  url: <%= "#{'<' + '%' + '='} ENV.fetch('REDIS_URL', 'redis://127.0.0.1:#{compose.call('test').local_port('redis', 6379)}') #{'%' + '>'}" %>
+<% end %>

data/lib/orchestration/version.rb

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

data/orchestration.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg', '~> 1.3'
   spec.add_development_dependency 'rails'
   spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redis', '~> 4.6'
   spec.add_development_dependency 'rspec', '~> 3.11'
   spec.add_development_dependency 'rspec-its', '~> 1.3'
   spec.add_development_dependency 'rubocop', '~> 1.28'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orchestration
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Bob Farrell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-27 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: database_url
@@ -206,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -367,6 +381,7 @@ files:
 - lib/orchestration/docker_compose/install_generator.rb
 - lib/orchestration/docker_compose/mongo_service.rb
 - lib/orchestration/docker_compose/rabbitmq_service.rb
+- lib/orchestration/docker_compose/redis_service.rb
 - lib/orchestration/docker_healthcheck.rb
 - lib/orchestration/environment.rb
 - lib/orchestration/errors.rb
@@ -400,6 +415,9 @@ files:
 - lib/orchestration/services/rabbitmq.rb
 - lib/orchestration/services/rabbitmq/configuration.rb
 - lib/orchestration/services/rabbitmq/healthcheck.rb
+- lib/orchestration/services/redis.rb
+- lib/orchestration/services/redis/configuration.rb
+- lib/orchestration/services/redis/healthcheck.rb
 - lib/orchestration/settings.rb
 - lib/orchestration/templates/Dockerfile.erb
 - lib/orchestration/templates/application.mk.erb
@@ -409,6 +427,7 @@ files:
 - lib/orchestration/templates/mongoid.yml.erb
 - lib/orchestration/templates/puma.rb.erb
 - lib/orchestration/templates/rabbitmq.yml.erb
+- lib/orchestration/templates/redis.yml.erb
 - lib/orchestration/templates/unicorn.rb.erb
 - lib/orchestration/terminal.rb
 - lib/orchestration/version.rb