orchestration 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e49d1834028ab1854b554f998dcd5779e5af3474
-  data.tar.gz: 35185f308b9bc16794a906f9b7e4bfec8b790355
+SHA256:
+  metadata.gz: 416fd08805e2ce12b2397a91f5baf894130f26d1ddf047f11a6b788b89783f16
+  data.tar.gz: 7b2f05787d2173d2e160a4ec40a4359e12f9e0d108384c7bd13c6fba43118692
 SHA512:
-  metadata.gz: 9f1b206a4458192418ef09dcac765fc1fc3c85b94b0f724f6009eadd20732f8e08cd9415395ce349740857a1a9f87a236f585f6dda77e03ba1838fe52bb200bd
-  data.tar.gz: e76e69bdf49ec909149510d8664776c1ff0c91e92a7f26eabeff70969bf987fc9910896127d9eac6ae7bca94c48fcee9fca6eed1e8a68150ecb261b98e6a1030
+  metadata.gz: 7a48ebb75ada7116256385d8bcf4d7db9a3bc6a9236b56b641078148a79b4fbb60cf75d4a488d0141415857d85f1d222d99adfd1212dd6346f7a7f6f14c7dbbc
+  data.tar.gz: f9df0d2800ea58090177d05b146236c44aff5e7cbbdd407b10f99214bea3fb8ae5de69f3893fd52eafa996491132cba9a25ecd7119c24320a4d420400e469396

data/README.md

@@ -18,7 +18,7 @@ Containers are automatically created for the following dependencies:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'orchestration', '~> 0.3.3'
+gem 'orchestration', '~> 0.3.4'
 ```
 
 And then build your bundle:

data/TODO

@@ -1,5 +1,3 @@
-Provide volumes for databases and mount appropriate directories for adapter
-
 Refactor docker-compose services - these really belong in
 lib/orchestration/services/<service-name>/docker_compose.rb
 
@@ -7,13 +5,5 @@ Standardise on log formats - by policy or recommendation ?
 
 Redis support
 
-Stop supporting development mode. Provide a docker-compose.yml for loading
-development and test dependencies and expect user to run Rails application
-locally.
-
-Build a docker-compose.production.yml for running application in
-production (i.e. including application as a service and removing local port
-bindings).
-
-Make docker-compose file additive - detect existing services and add new ones
-rather than overwriting.
+Use `Paint` instead of `Colorize` for colouring output - better licensing and no
+monkeypatching `String` etc.

data/config/locales/en.yml

@@ -3,20 +3,21 @@ en:
     attempt_limit: "Unable to reconnect after %{limit} attempts. Aborting."
     default: "default"
 
-    application:
-      waiting: "Waiting for application: %{config}"
-      ready: "Application is ready."
-      connection_error: "Error attempting to connect to application: received status code %{code}"
+    app:
+      waiting: "Waiting for app: %{config}"
+      ready: "App is ready."
+      connection_error: "Error attempting to connect to app: received status code %{code}"
 
     database:
       waiting: "Waiting for database: %{config}"
       ready: "Database is ready."
+      unknown_environment: "Environment not defined in database configuration: %{environment}"
 
     mongo:
       waiting: "Waiting for Mongo: %{config}"
       ready: "Mongo is ready."
 
-    nginx-proxy:
+    nginx_proxy:
       waiting: "Waiting for Nginx proxy: %{config}"
       ready: "Nginx proxy is ready."
 
@@ -39,11 +40,8 @@ en:
           prompt: "project name"
 
     rake:
-      docker:
-        username: "Output configured Docker username"
-
-      application:
-        wait: "Wait for database to become available"
+      app:
+        wait: "Wait for app to become available"
 
       database:
         wait: "Wait for database to become available"
@@ -54,11 +52,10 @@ en:
       mongo:
         wait: "Wait for Mongo to become available"
 
-      nginx-proxy:
+      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"
+      install: "Install Orchestration tools"

data/lib/orchestration/docker_compose/{application_service.rb → app_service.rb}

@@ -2,8 +2,9 @@
 
 module Orchestration
   module DockerCompose
-    class ApplicationService
-      def initialize(config)
+    class AppService
+      def initialize(config, environment)
+        @environment = environment
         @config = config
       end
 
@@ -27,8 +28,7 @@ module Orchestration
           'UNICORN_PRELOAD_APP' => '1',
           'UNICORN_TIMEOUT' => '60',
           'UNICORN_WORKER_PROCESSES' => '8',
-          'VIRTUAL_PORT' => '8080',
-          'VIRTUAL_HOST' => 'localhost'
+          'VIRTUAL_PORT' => '8080'
         }.merge(inherited_environment)
       end
 
@@ -36,7 +36,8 @@ module Orchestration
         {
           'HOST_UID' => nil,
           'RAILS_ENV' => nil,
-          'SECRET_KEY_BASE' => nil
+          'SECRET_KEY_BASE' => nil,
+          'VIRTUAL_HOST' => nil
         }
       end
     end

data/lib/orchestration/docker_compose/configuration.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class Configuration
+      def initialize(env, environment, selected_services)
+        @env = env # Global environment
+        @environment = environment # Current build environment
+        @selected_services = selected_services
+      end
+
+      def version
+        @env.docker_api_version
+      end
+
+      def services
+        Hash[services_enabled]
+      end
+
+      def volumes
+        public_volume.merge(database_volume).merge(mongo_volume)
+      end
+
+      private
+
+      def services_available
+        {
+          app: AppService,
+          database: DatabaseService,
+          mongo: MongoService,
+          rabbitmq: RabbitMQService,
+          nginx_proxy: NginxProxyService
+        }
+      end
+
+      def services_enabled
+        @selected_services.map do |service, config|
+          definition = service_definition(service, config)
+          next if definition.nil?
+
+          [service.to_s, definition]
+        end.compact
+      end
+
+      def public_volume
+        { @env.public_volume => {} }
+      end
+
+      def database_volume
+        return {} unless services.key?('database')
+
+        { @env.database_volume => {} }
+      end
+
+      def mongo_volume
+        return {} unless services.key?('mongo')
+
+        { @env.mongo_volume => {} }
+      end
+
+      def service_definition(service, config)
+        services_available
+          .fetch(service)
+          .new(config, @environment)
+          .definition
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/database_service.rb

@@ -7,44 +7,37 @@ module Orchestration
       # container to simplify port mapping.
       PORT = 3354
 
-      def initialize(config)
+      def initialize(config, environment)
+        @environment = environment
         @config = config
       end
 
       def definition
         return nil if @config.settings.nil?
+        return nil if @config.adapter.name == 'sqlite3'
 
-        adapter = @config.settings.fetch('adapter')
-        return nil if adapter == 'sqlite3'
-
-        port = @config.settings.fetch('port')
         {
-          'image' => image_from_adapter(adapter),
-          'environment' => environment_from_adapter(adapter),
-          'ports' => ["#{port}:#{PORT}"]
-        }
+          'image' => @config.adapter.image,
+          'environment' => @config.adapter.environment
+        }.merge(ports).merge(volumes)
       end
 
       private
 
-      def image_from_adapter(adapter)
-        {
-          'postgresql' => 'library/postgres',
-          'mysql2' => 'library/mysql'
-        }.fetch(adapter)
+      def volume
+        @config.env.database_volume
       end
 
-      def environment_from_adapter(adapter)
-        {
-          'postgresql' => {
-            'PGPORT' => PORT.to_s,
-            'POSTGRES_PASSWORD' => 'password'
-          },
-          'mysql2' => {
-            'MYSQL_ROOT_PASSWORD' => 'password',
-            'MYSQL_TCP_PORT' => PORT.to_s
-          }
-        }.fetch(adapter)
+      def ports
+        return {} unless %i[development test].include?(@environment)
+
+        { 'ports' => ["#{@config.settings.fetch('port')}:#{PORT}"] }
+      end
+
+      def volumes
+        return {} if @environment == :test
+
+        { 'volumes' => ["#{volume}:#{@config.adapter.data_dir}"] }
       end
     end
   end

data/lib/orchestration/docker_compose/install_generator.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class InstallGenerator
+      include FileHelpers
+
+      def initialize(env, terminal)
+        @env = env
+        @terminal = terminal
+      end
+
+      def docker_compose_yml
+        create_compose_file
+      end
+
+      def docker_compose_test_yml
+        create_compose_file(:test)
+      end
+
+      def docker_compose_development_yml
+        create_compose_file(:development)
+      end
+
+      def docker_compose_production_yml
+        create_compose_file(:production)
+      end
+
+      def docker_compose_override_yml
+        simple_copy(
+          'docker-compose.override.yml',
+          @env.docker_compose_path(:override),
+          overwrite: false
+        )
+      end
+
+      def enabled_services(environment)
+        service_names(environment).select { |name| service_enabled?(name) }
+      end
+
+      private
+
+      def create_compose_file(environment = nil)
+        path = @env.docker_compose_path(environment)
+        create_file(
+          path,
+          structure(environment).to_yaml,
+          overwrite: false
+        )
+      end
+
+      def structure(environment = nil)
+        {
+          'version' => compose_config(environment).version,
+          'services' => services(environment)
+        }.merge('volumes' => volumes(environment))
+      end
+
+      def services(environment)
+        compose_config(environment).services
+      end
+
+      def volumes(environment)
+        return {} if environment.nil? || environment == :test
+
+        compose_config(environment).volumes
+      end
+
+      def compose_config(environment)
+        DockerCompose::Configuration.new(
+          @env,
+          environment,
+          Hash[configurations(environment)]
+        )
+      end
+
+      def service_names(environment)
+        case environment
+        when :test, :development
+          %i[database mongo rabbitmq]
+        when :production
+          %i[nginx_proxy app database mongo rabbitmq]
+        when nil
+          []
+        else
+          raise ArgumentError, environment.inspect
+        end
+      end
+
+      def configurations(environment)
+        service_names(environment).map do |key|
+          [key, configuration(key)]
+        end
+      end
+
+      def configuration(service)
+        {
+          app: Orchestration::Services::App::Configuration,
+          database: Orchestration::Services::Database::Configuration,
+          mongo: Orchestration::Services::Mongo::Configuration,
+          rabbitmq: Orchestration::Services::RabbitMQ::Configuration,
+          nginx_proxy: Orchestration::Services::NginxProxy::Configuration
+        }.fetch(service).new(@env)
+      end
+
+      def service_enabled?(service_name)
+        return false if configuration(service_name).settings.nil?
+
+        true
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/mongo_service.rb

@@ -5,21 +5,31 @@ module Orchestration
     class MongoService
       PORT = 27_020
 
-      def initialize(config)
+      def initialize(config, environment)
         @config = config
+        @environment = environment
       end
 
       def definition
         return nil if @config.settings.nil?
 
-        {
-          'image' => 'library/mongo',
-          'ports' => ["#{local_port}:#{remote_port}"]
-        }
+        { 'image' => 'library/mongo' }.merge(ports).merge(volumes)
       end
 
       private
 
+      def ports
+        return {} unless %i[development test].include?(@environment)
+
+        { 'ports' => ["#{local_port}:#{remote_port}"] }
+      end
+
+      def volumes
+        return {} if @environment == :test
+
+        { 'volumes' => ["#{@config.env.mongo_volume}:/data/db"] }
+      end
+
       def local_port
         _host, _, port = clients.fetch('default')
                                 .fetch('hosts')

data/lib/orchestration/docker_compose/nginx_proxy_service.rb

@@ -3,14 +3,15 @@
 module Orchestration
   module DockerCompose
     class NginxProxyService
-      def initialize(config)
+      def initialize(config, environment)
+        @environment = environment
         @config = config
       end
 
       def definition
         {
           'image' => 'rubyorchestration/nginx-proxy',
-          'ports' => %w[3000:80],
+          'ports' => %w[${LISTEN_PORT}:80],
           'volumes' => [
             '/var/run/docker.sock:/tmp/docker.sock:ro',
             "#{@config.env.public_volume}:/var/www/public/:ro"

data/lib/orchestration/docker_compose/rabbitmq_service.rb

@@ -3,20 +3,24 @@
 module Orchestration
   module DockerCompose
     class RabbitMQService
-      def initialize(config)
+      def initialize(config, environment)
         @config = config
+        @environment = environment
       end
 
       def definition
         return nil if @config.settings.nil?
 
+        { 'image' => 'library/rabbitmq' }.merge(ports)
+      end
+
+      def ports
+        return {} unless %i[development test].include?(@environment)
+
         host_port = @config.settings.fetch('port', 5672)
         container_port = Orchestration::Services::RabbitMQ::PORT
 
-        {
-          'image' => 'library/rabbitmq',
-          'ports' => ["#{host_port}:#{container_port}"]
-        }
+        { 'ports' => ["#{host_port}:#{container_port}"] }
       end
     end
   end

data/lib/orchestration/docker_compose.rb

@@ -5,9 +5,10 @@ module Orchestration
   end
 end
 
-require 'orchestration/docker_compose/services'
+require 'orchestration/docker_compose/install_generator'
+require 'orchestration/docker_compose/configuration'
 
-require 'orchestration/docker_compose/application_service'
+require 'orchestration/docker_compose/app_service'
 require 'orchestration/docker_compose/database_service'
 require 'orchestration/docker_compose/mongo_service'
 require 'orchestration/docker_compose/nginx_proxy_service'

data/lib/orchestration/environment.rb

@@ -32,23 +32,36 @@ module Orchestration
       root.join('.orchestration.yml')
     end
 
-    def docker_compose_configuration_path
-      orchestration_root.join('docker-compose.yml')
+    def docker_api_version
+      '3.7'
     end
 
-    def docker_compose_config
-      YAML.safe_load(File.read(docker_compose_configuration_path))
+    def docker_compose_path(env = nil)
+      return orchestration_root.join('docker-compose.yml') if env.nil?
+
+      orchestration_root.join("docker-compose.#{env}.yml")
+    end
+
+    def docker_compose_config(env = nil)
+      env ||= environment
+      YAML.safe_load(File.read(docker_compose_path(env)))
     end
 
-    def docker_compose_config?
-      docker_compose_configuration_path.file?
+    def docker_compose_config?(env = nil)
+      env ||= environment
+      docker_compose_path(env).file?
     end
 
-    def default_application_name
+    def default_app_name
+      default = root.basename.to_s
+      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.class.parent == Object
+
       Rails.application.class.parent.name.underscore
     end
 
-    def application_name
+    def app_name
       settings.get('docker.repository')
     end
 
@@ -57,8 +70,8 @@ module Orchestration
     end
 
     def root
-      return Rails.root if defined?(Rails) && Rails.root
-
+      defined?(Rails) && Rails.root ? Rails.root : Pathname.new(Dir.pwd)
+    rescue NoMethodError
       Pathname.new(Dir.pwd)
     end
 
@@ -71,7 +84,15 @@ module Orchestration
     end
 
     def public_volume
-      "#{application_name}_public"
+      "#{app_name}_public"
+    end
+
+    def database_volume
+      "#{app_name}_database"
+    end
+
+    def mongo_volume
+      "#{app_name}_mongo"
     end
   end
 end

data/lib/orchestration/errors.rb

@@ -3,7 +3,9 @@
 module Orchestration
   class OrchestrationError < StandardError; end
 
-  class ApplicationConnectionError < OrchestrationError; end
+  class AppConnectionError < OrchestrationError; end
   class DatabaseConfigurationError < OrchestrationError; end
   class MongoConfigurationError < OrchestrationError; end
+
+  class UnknownEnvironmentError < DatabaseConfigurationError; end
 end

data/lib/orchestration/file_helpers.rb

@@ -27,11 +27,15 @@ module Orchestration
     end
 
     def relative_path(path)
-      path.relative_path_from(Rails.root).to_s
+      path.relative_path_from(@env.root).to_s
     end
 
-    def simple_copy(template_name, dest)
-      update_file(dest, template(template_name))
+    def simple_copy(template_name, dest, options = {})
+      update_file(
+        dest,
+        template(template_name, env: @env),
+        overwrite: options.fetch(:overwrite, true)
+      )
     end
 
     def create_file(path, content, options = {})
@@ -44,12 +48,13 @@ module Orchestration
       @terminal.write(:create, relative_path(path))
     end
 
-    def update_file(path, content)
+    def update_file(path, content, options = {})
       present = File.exist?(path)
       return create_file(path, content) unless present
 
+      overwrite = options.fetch(:overwrite, true)
       previous_content = File.read(path) if present
-      if present && previous_content == content
+      if present && (!overwrite || previous_content == content)
         return @terminal.write(:skip, relative_path(path))
       end