orchestration 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8341c788d09b97b9679317cadfd0d97056c7622
-  data.tar.gz: a859667a0521d233dc4b9d98329e0953678fe180
+  metadata.gz: 9c1480a6241a2ea71eaa7a9c9fc3ad4d098a180b
+  data.tar.gz: 352354aef228f577185908ea06f9aa332cee5ec9
 SHA512:
-  metadata.gz: 4f7ae8f5336e2640da45e54430119be8ba79fe9177aebda2303f3f67bdccdca0abc21a62844f40a70d86757fe39bdc159461036614a8108c2118e41af1863343
-  data.tar.gz: d81362e8476fa65c56c801da6a9d9fb23bcaf7650833ee921a62da31a77b72ab2a0e03a68920f4d6bf2bd04c49692fee12bbb7676c4fa31ac5c3e1e6c9849e49
+  metadata.gz: 9c0ac0ad8b6f5a780a8f9dce28f528175b1d4894b9d18db365035efdb5088b98d6d4665dc327a43dfd8030d278ec4dfbecc88877a080b2e12fda513427ab2316
+  data.tar.gz: 985e17427df0c2347892f628ae14fccb144aa6a1767d5a0f0351d73b4cb7f23faf24072d1fd8f924db83a47fcf8333232c2968b506ae5181f541507b1a4ca4a2

data/.gitignore

@@ -9,3 +9,17 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock
+
+*.swp
+*.swo
+
+spec/dummy/log/*
+!spec/dummy/log/.keep
+spec/dummy/.gitignore
+spec/dummy/Makefile
+spec/dummy/docker/*
+spec/dummy/docker-compose.yml
+
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'lib/tasks/orchestration.rake'
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'db/schema.rb'
+    - 'spec/dummy/**/*'

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in orchestration.gemspec
 gemspec

data/Makefile

@@ -0,0 +1,5 @@
+.PHONY: test
+
+test:
+	./bin/rspec
+	./bin/rubocop

data/README.md

@@ -1,39 +1,105 @@
 # Orchestration
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/orchestration`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Overview
 
-TODO: Delete this and the text above, and describe your gem
+_Orchestration_ provides a toolkit for building and launching _Rails_ applications and dependencies in _Docker_.
+
+A suite of tools is provided to assist in creating configuration files, launching service dependencies, verifying that dependencies have launched successfully (e.g. for running tests in contiuous integration tools), and building, tagging, and pushing _Docker_ images.
+
+Containers are automatically created for the following dependencies:
+
+* MySQL
+* MongoDB
+* PostgreSQL
+* RabbitMQ
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'orchestration'
+gem 'orchestration', '~> 0.2.0'
 ```
 
-And then execute:
+And then build your bundle:
+``` bash
+$ bundle install
+```
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+### Generating configuration files
 
-    $ gem install orchestration
+A _Rake_ task is provided to generate the following files:
 
-## Usage
+* `Makefile` - provides easy access to all _Orchestration_ utilities.
+* `.gitignore` - ensures any unwanted files created by _Orchestration_ do not clutter your project's version control system.
+* `docker/Dockerfile` - a ready-to-use _Docker_ build script which should need minimal (if any) modification to build your _Rails_ project.
+* `docker-compose.yml` - a custom-made set of services to allow you to run your application's dependencies locally.
+* `.orchestration.yml` - _Orchestration_ internal configuration, e.g. _Docker_ username.
 
-TODO: Write usage instructions here
+### Building and pushing your project as a _Docker_ image
 
-## Development
+#### Private Git repository authentication
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+If your project has any dependencies on private  _Git_ repositories then you will need to create an authentication token. See the relevant documentation for your _Git_ host:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* [GitHub](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/)
+* [Bitbucket](https://confluence.atlassian.com/bitbucket/app-passwords-828781300.html)
 
-## Contributing
+Create a file named `.env` in the same directory as your `docker-compose.yml` and add one or both of the following (note that _Bitbucket_ and _GitHub_ use a different format):
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/orchestration. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```bash
+BUNDLE_BITBUCKET__ORG=<bitbucket-username>:<app-password>
+BUNDLE_GITHUB__COM=x-oauth-basic:<auth-token>
+```
 
-## Code of Conduct
+#### Docker installation
+_Docker_ must be installed on your system. See the [_Docker_ getting started guide](https://www.docker.com/get-started) for instructions.
+
+#### DockerHub account
+
+You will need an account with _Docker Hub_ (or your preferred _Docker_ image host) to push your images. Visit the [_Docker Hub_ webpage](https://hub.docker.com/) to sign up, then run the following command and enter your credentials when prompted to log in to your new account:
+```bash
+$ docker login
+```
+
+#### Using provided `Makefile`
+
+To build and push your image run:
+```bash
+$ make docker
+```
+
+Or run the two steps separately:
+```bash
+$ make docker-build
+$ make docker-push
+```
+
+### Starting and waiting for services when running your tests
+
+To start services:
+
+```bash
+$ make start
+```
+
+This will launch any dependencies your project needs (e.g. _MySQL_, _MongoDB_, etc.).
+
+To wait for all services to be ready:
+```bash
+$ make wait
+```
+
+It is recommended that you create a `test` command in your `Makefile` which will launch all dependencies and wait for them to be ready before running all tests. For example:
+
+```Makefile
+test: start wait
+	bundle exec rspec
+	yarn test app/javascript
+	bundle exec rubocop
+	yarn run eslint app/javascript
+```
 
-Everyone interacting in the Orchestration project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/orchestration/blob/master/CODE_OF_CONDUCT.md).
+This is especially useful for continuous integration as it provides a uniform command (`make test`) that can be run by your CI tool without any extra setup.

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/TODO

@@ -0,0 +1,2 @@
+Be aware of yarn and include build steps in Dockerfile if present. Use dashboard
+front end as a reference.

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  orchestration:
+    unknown_scheme: "Unrecognised database adapter for URL scheme: %{scheme}"
+    attempt_limit: "Unable to reconnect after %{limit} attempts. Aborting."
+    database:
+      waiting: "Waiting for database: %{config}"
+      ready: "Database is ready."
+      missing_default: "database.yml must define a `default` section."
+    mongo:
+      waiting: "Waiting for Mongo: %{config}"
+      ready: "Mongo is ready."
+    rabbitmq:
+      waiting: "Waiting for RabbitMQ: %{config}"
+      ready: "RabbitMQ is ready."
+    docker:
+      username_request: "Enter your Docker registry username (used for tagging images)"

data/lib/orchestration/docker_compose/database_service.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class DatabaseService
+      # We dictate which port all database services will run on in their
+      # container to simplify port mapping.
+      PORT = 3354
+
+      def initialize(config)
+        @config = config
+      end
+
+      def definition
+        return nil if @config.settings.nil?
+
+        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}"]
+        }
+      end
+
+      private
+
+      def image_from_adapter(adapter)
+        {
+          'postgresql' => 'library/postgres',
+          'mysql2' => 'library/mysql'
+        }.fetch(adapter)
+      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)
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/mongo_service.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class MongoService
+      def initialize(config)
+        @config = config
+      end
+
+      def definition
+        return nil if @config.settings.nil?
+
+        # REVIEW: If the host application defines multiple mongo hosts then we
+        # create one service instance and point them all at the same service.
+        # Instead we should probably create a separate service for each.
+        ports = @config.ports.map do |port|
+          "#{port}:#{Orchestration::Services::Mongo::PORT}"
+        end
+
+        {
+          'image' => 'library/mongo',
+          'ports' => ports
+        }
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/rabbitmq_service.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class RabbitMQService
+      def initialize(config)
+        @config = config
+      end
+
+      def definition
+        return nil if @config.settings.nil?
+
+        host_port = @config.settings.fetch('port', 5672)
+        container_port = Orchestration::Services::RabbitMQ::PORT
+
+        {
+          'image' => 'library/rabbitmq',
+          'ports' => ["#{host_port}:#{container_port}"]
+        }
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose/services.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+    class Services
+      def initialize(options = {})
+        @configurations = {
+          'database' => options.fetch(:database, nil),
+          'mongo' => options.fetch(:mongo, nil),
+          'rabbitmq' => options.fetch(:rabbitmq, nil)
+        }
+      end
+
+      def structure
+        { 'version' => '3.7', 'services' => services }
+      end
+
+      def services
+        Hash[filtered_services]
+      end
+
+      private
+
+      def filtered_services
+        services_enabled.compact.reject { |_name, definition| definition.nil? }
+      end
+
+      def services_available
+        [
+          { name: 'database', class: DatabaseService },
+          { name: 'mongo', class: MongoService },
+          { name: 'rabbitmq', class: RabbitMQService }
+        ]
+      end
+
+      def services_enabled
+        services_available.map do |service|
+          config = @configurations[service[:name]]
+          # REVIEW: This is mostly here for testing - we may not need it once
+          # everything's implemented.
+          next if config.nil?
+
+          [service[:name], service[:class].new(config).definition]
+        end
+      end
+    end
+  end
+end

data/lib/orchestration/docker_compose.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Orchestration
+  module DockerCompose
+  end
+end
+
+require 'orchestration/docker_compose/services'
+require 'orchestration/docker_compose/database_service'
+require 'orchestration/docker_compose/mongo_service'
+require 'orchestration/docker_compose/rabbitmq_service'