docker-stack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01f617f6f1d85078fa160cf947618cd2e124b0db6ccfba06c1bbbcc1a63d1834
+  data.tar.gz: 7cc64b1dbbed6174443cb16582d2ee5b2d75f9367a5a8ff15baddcb0278a8b7b
+SHA512:
+  metadata.gz: fe00ab2abd2353f8d769ba3c7c96b9cadb39915c98578cf6db2fdb016dc48de34a44b56c00ba833a14fc379198c908f8a8438d183cbf117fe6ef1c230a72079e
+  data.tar.gz: c4b076f7ef25513b9c300142dc3a5f63547ca536128515ed031fd0ba03de3f14202347b9c7fa21c7bb106ff81095e163674e36fb3a6f8c213cb71bc860c2a61a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.internal_test_app
+Gemfile.lock

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from: .rubocop_todo.yml
+
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'lib/generators/docker/stack/service.rb'
+    - 'lib/generators/docker/stack/util.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'docker-stack.gemspec'
+    - 'spec/**/*'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/generators/docker/stack/service.rb'
+    - 'lib/generators/docker/stack/util.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+  Exclude:
+    - 'lib/generators/docker/stack/service.rb'
+    - 'lib/generators/docker/stack/util.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-20 21:56:21 -0500 using RuboCop version 0.53.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/docker/stack.rb'
+    - 'lib/docker/stack/container.rb'
+    - 'lib/docker/stack/controller.rb'
+    - 'lib/generators/docker/stack/util.rb'
+    - 'lib/generators/docker/stack/service.rb'
+    - 'lib/generators/docker/stack/install_generator.rb'
+    - 'lib/generators/docker/stack/service/fedora_generator.rb'
+    - 'lib/generators/docker/stack/service/postgres_generator.rb'
+    - 'lib/generators/docker/stack/service/redis_generator.rb'
+    - 'lib/generators/docker/stack/service/solr_generator.rb'
+    - 'lib/generators/docker/stack/service_generator.rb'

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+cache: bundler
+services:
+  - docker
+before_install:
+  - 'gem update --system'
+  - 'gem update bundler'
+script:
+  - 'bundle exec rake ci'
+rvm:
+  - 2.5

data/Gemfile

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in docker-stack.gemspec
+gemspec
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 1.2.0
+# engine_cart stanza: 0.10.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path('Gemfile', ENV['ENGINE_CART_DESTINATION'] ||
+  ENV['RAILS_ROOT'] || File.expand_path('.internal_test_app', __dir__))
+
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  # rubocop:disable Bundler/DuplicatedGem
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS'] = '--edge --skip-turbolinks'
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  case ENV['RAILS_VERSION']
+  when /^4.2/
+    gem 'coffee-rails', '~> 4.1.0'
+    gem 'responders', '~> 2.0'
+    gem 'sass-rails', '>= 5.0'
+  when /^4.[01]/
+    gem 'sass-rails', '< 5.0'
+  end
+  # rubocop:enable Bundler/DuplicatedGem
+end
+# END ENGINE_CART BLOCK

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2018 Michael B. Klein
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,117 @@
+# Docker::Stack
+
+Rails generators, Rake tasks, and support modules to run dependencies in Docker containers.
+
+Code: [![Version](https://badge.fury.io/rb/docker-stack.png)](http://badge.fury.io/rb/docker-stack)
+[![Build Status](https://travis-ci.org/mbklein/docker-stack.png?branch=master)](https://travis-ci.org/mbklein/docker-stack)
+[![Coverage Status](https://coveralls.io/repos/github/mbklein/docker-stack/badge.svg?branch=master)](https://coveralls.io/github/mbklein/docker-stack?branch=master)
+[![Code Climate](https://codeclimate.com/github/mbklein/docker-stack/badges/gpa.svg)](https://codeclimate.com/github/mbklein/docker-stack)
+[![Dependency Update Status](https://gemnasium.com/mbklein/docker-stack.png)](https://gemnasium.com/mbklein/docker-stack)
+[![Dependency Maintenance Status](https://dependencyci.com/github/mbklein/docker-stack/badge)](https://dependencyci.com/github/mbklein/docker-stack)
+
+Docs: [![Documentation Status](https://inch-ci.org/github/mbklein/docker-stack.svg?branch=master)](https://inch-ci.org/github/mbklein/docker-stack)
+[![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/docker-stack)
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE.txt)
+
+Originally written as a drop-in replacement for [`solr_wrapper`](https://github.com/cbeer/solr_wrapper) and [`fcrepo_wrapper`](https://github.com/cbeer/fcrepo_wrapper) to ease development and testing of [Samvera](https://github.com/mbklein/) applications, but with an eye toward adding support for additional services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docker-stack'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-stack
+
+## Usage
+
+### Initial Setup
+
+From your application root, run:
+
+    $ rails generate docker:stack:install
+
+This creates the Docker configuration files for the development and test environments, and adds `lib/tasks/docker.rake` to provide the Docker-related rake tasks to your application.
+
+Then run the service generator for each support service your application needs:
+
+    $ rails generate docker:stack:service:fedora
+    $ rails generate docker:stack:service:solr
+
+This will create the Docker service definitions for Fedora and Solr and drop the appropriate configuration files to point to them in the `config` directory. The Solr generator also creates a `solr` directory containing default core configuration files.
+
+To do all of the above with one command, you can run:
+
+    $ rails generate docker:stack:install --services fedora,solr
+
+### Controlling the Stack
+
+`Docker::Stack` defines a bunch of rake tasks to control the Docker services (and sometimes do other things). These are defined in your application in `lib/tasks/docker.rake`, and can be customized according to your application's needs. The following descriptions apply to the default tasks installed by the `docker:stack:install` generator.
+
+#### Environment-Specific Tasks
+
+Every `docker:dev` task is also available as a `docker:test` task. The gem forwards different ports to the host in development and test modes, so both stacks can be running at once. The only difference between the two is that the test stack cleans up after itself automatically when it terminates, while the development stack keeps its data around.
+
+##### Spin up the stack in the foreground
+
+    $ rake docker:dev:up
+
+The required Docker machine images will be downloaded and registered the first time you run this command. Subsequent runs will be much faster.
+
+##### Spin up the stack in the background
+
+    $ rake docker:dev:daemon
+
+##### Terminate running services
+
+Even if they're running in the foreground in another tab!
+
+    $ rake docker:dev:down
+
+##### Display the status of all running services
+
+    $ rake docker:dev:status
+
+##### Clean up all persistent data
+
+    $ rake docker:dev:clean
+
+##### Display container logs
+
+    $ rake docker:dev:logs
+
+Similar to `tail -f` on a file.
+Add a `SERVICES` variable to display only specific services' logs (e.g., `rake docker:dev:logs SERVICES=fedora`)
+
+##### Reset the entire stack
+
+    $ rake docker:dev:reset
+
+AKA "The Nuclear Option." Removes all containers, data, and machine images associated with this stack. This will result in Docker images being re-downloaded and initialized the next time you spin things up.
+
+#### Convenience Tasks
+
+##### Run application tests under the test stack
+
+    $ rake docker:spec
+
+1. Spins up the test environment
+2. Invokes the `db:setup` task
+3. Invokes the first task it finds named `spec` or `rspec` or matching the value of the `SPEC_TASK` environment variable
+4. Terminates and cleans up the test environment
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mbklein/docker-stack.
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'engine_cart/rake_task'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :ci
+
+task ci: ['rubocop', 'engine_cart:clean', 'engine_cart:generate', 'spec'] do
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'docker/stack'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-stack.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/stack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docker-stack'
+  spec.version       = Docker::Stack::VERSION
+  spec.authors       = ['Michael Klein']
+  spec.email         = ['mbklein@gmail.com']
+
+  spec.summary       = 'Support code and rake tasks for running Rails on top of Dockerized services.'
+  spec.description   = 'Support code and rake tasks for running Rails on top of Dockerized services.'
+  spec.homepage      = 'https://github.com/mbklein/docker-stack'
+  spec.license       = 'Apache2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'docker-api'
+  spec.add_dependency 'docker-compose'
+  spec.add_dependency 'rails', ['~> 5.0']
+
+  spec.add_development_dependency 'bixby'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'engine_cart'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/docker/stack.rb

@@ -0,0 +1,8 @@
+require 'docker/stack/container'
+require 'docker/stack/controller'
+require 'docker/stack/version'
+
+module Docker
+  module Stack
+  end
+end

data/lib/docker/stack/container.rb

@@ -0,0 +1,45 @@
+require 'action_view'
+
+module Docker
+  module Stack
+    class Container
+      include ::ActionView::Helpers::DateHelper
+
+      def initialize(id)
+        @id = id
+        @container = Docker::Container.get(id)
+      end
+
+      def service
+        info('Config', 'Labels', 'com.docker.compose.service')
+      end
+
+      def status
+        info('State', 'Health', 'Status')
+      end
+
+      def started
+        value = info('State', 'StartedAt')
+        return value if value == 'unknown'
+        Time.parse(value).utc
+      end
+
+      def uptime_in_words
+        return started if started == 'unknown'
+        time_ago_in_words(started)
+      end
+
+      def to_h
+        { id: @id, service: service, status: status, started: started, running: uptime_in_words }
+      end
+
+      private
+
+      def info(*keys)
+        result = @container.info
+        keys.each { |key| result = result[key] }
+        result
+      end
+    end
+  end
+end

data/lib/docker/stack/controller.rb

@@ -0,0 +1,115 @@
+require 'docker/compose'
+require 'docker-api'
+
+module Docker
+  module Stack
+    class Controller
+      attr_reader :dc, :cleanup, :daemon
+
+      def self.default_project_name
+        Rails.application.class.parent_name.underscore
+      end
+
+      def initialize(project: self.class.default_project_name, env: nil, cleanup: false, daemon: false)
+        env = Rails.env if env.nil?
+        project_and_env = [project, env].join('-')
+        @workdir = Rails.root.join('.docker-stack', project_and_env)
+        @dc = ::Docker::Compose::Session.new(dir: @workdir)
+        @cleanup = cleanup
+        @daemon = daemon
+      end
+
+      def reset!
+        down(cleanup: true)
+        images = config['services'].values.map { |conf| conf['image'] }
+        images.each do |image_name|
+          begin
+            image = ::Docker::Image.get(image_name)
+            result = image.remove(prune: true)
+            yield result if block_given?
+          rescue ::Docker::Error::NotFoundError
+            yield %{[{"Skipped":"#{image_name} (image not present)"}]}
+          end
+        end
+        ::Docker::Image.prune
+      end
+
+      def status
+        containers = dc.ps.map(&:id)
+        containers.map do |c|
+          begin
+            container = Container.new(c)
+            container.to_h
+          rescue StandardError
+            { id: c, service: 'unknown', status: 'unknown', started: 'unknown', running: 'unknown' }
+          end
+        end
+      end
+
+      # rubocop:disable Style/StderrPuts
+      def wait_for_services
+        Timeout.timeout(120) do
+          $stderr.print 'Waiting up to two minutes for services to become healthy.' if warn?
+          loop do
+            break if status.all? { |v| v[:status] == 'healthy' }
+            $stderr.print '.' if warn?
+            sleep 2
+          end
+          $stderr.puts if warn?
+        end
+        true
+      rescue Timeout::Error
+        raise 'Timed out waiting for services to become healthy'
+      end
+      # rubocop:enable Style/StderrPuts
+
+      def run
+        dc.up(detached: @daemon || block_given?)
+        return true unless block_given?
+
+        begin
+          wait_for_services
+          yield
+        ensure
+          down
+        end
+      end
+
+      def logs(*services)
+        trap_int(terminate: false) { dc.run!('logs', '-f', services) }
+      end
+
+      def start(&block)
+        trap_int { run(&block) }
+      end
+
+      def with_containers(&block)
+        trap_int { run(&block) }
+      end
+
+      def down(cleanup: @cleanup)
+        dc.run!('down', v: cleanup)
+      end
+
+      private
+
+      def config
+        @config ||= YAML.safe_load(File.read(File.join(dc.dir, dc.file)))
+      end
+
+      def trap_int(terminate: true)
+        old_trap = Signal.trap('INT') do
+          down if terminate
+          raise SystemExit
+        end
+        yield
+      ensure
+        Signal.trap('INT', old_trap)
+      end
+
+      def warn?
+        $-W > 0 # rubocop:disable Style/GlobalVars
+      end
+    end
+  end
+end