docker-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4daf7ed396ab33b4baccadbe1a1f888af9a3271d
+  data.tar.gz: 7a38191133060c00417437db6ba84e93d3f936a5
+SHA512:
+  metadata.gz: 8d8ffca0992dbbbd4edfd75b36de681f018933d497f1b9cd37d05edb0cd59471c06fd15136de6e031867f928904732c8570f45e219c69b714a5e24f94cd2cdd3
+  data.tar.gz: 49cea1c9d37dcb37d519e3db6d0345185f6fc6cb6dac30c0a6f1d17fa708a7de2bf7df8cbd397f5daea0e0555046dc1a3f1a86d8b9df5562e888e148c4f863e7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+docker-rails

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kevin Ross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Docker::Rails
+
+A simplified pattern to execute rails applications within Docker (with a CI build emphasis).
+
+Features:
+- cached global bundler data volume (automatic) based on ruby version
+- interpolates `docker-compose.yml` making CI builds much easier
+- starts `db` container first, and continues with `web` once `db` is ready
+- cleans up `db` and `web` containers once completed
+
+
+**Very much a work in progress - contributions welcome**
+Open to pull requests, while this starts off as one-person's environment, it can be expanded to suit many different configurations.
+
+Needs:
+- remove hardcoded ip for db ip resolution
+- remove or default hardcoded BUILD_NAME
+- expand to different db status detection as needed
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docker-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-rails
+
+## Usage
+
+### 1. Add a Dockerfile
+
+```bash
+FROM atlashealth/ruby:2.2.2
+
+ENV DEBIAN_FRONTEND noninteractive
+
+# For building, nokogiri support, capybara-webkit, mysql client
+# Clean up APT when done.
+RUN apt-get update -qq && \
+    apt-get install -qy build-essential libxml2-dev libxslt1-dev \
+            g++ qt5-default libqt5webkit5-dev xvfb libmysqlclient-dev && \
+
+    # cleanup
+    apt-get clean && \
+    cd /var/lib/apt/lists && rm -fr *Release* *Sources* *Packages* && \
+    truncate -s 0 /var/log/*log
+
+# https://github.com/docker/docker/issues/4032
+ENV DEBIAN_FRONTEND newt
+
+ADD . /project
+WORKDIR /project
+RUN ["chmod", "+x", "/project/scripts/*"]
+```
+
+### 2. Add a docker-compose.yml
+
+Environment variables will be interpolated, so feel free to use them.
+
+```yaml
+web:
+  build: .
+  working_dir: /project/spec/dummy
+  command: /project/script/start
+  ports:
+    - "3000:3000"
+  links:
+    - db
+  volumes:
+    - .:/project
+  links:
+    - db
+  volumes_from:
+    # Mount the gems data volume container for cached bundler gem files
+    - #{GEMS_VOLUME_NAME}
+  environment:
+    # Tell bundler where to get the files
+    - GEM_HOME=#{GEMS_VOLUME_PATH}
+
+db:
+  image: library/mysql:5.7.6
+  ports:
+    - "3306:3306"
+  environment:
+    - MYSQL_ALLOW_EMPTY_PASSWORD=true
+```
+
+### 3. Add a startup script
+
+TODO: verify a good sample
+
+```bash
+#!/usr/bin/env bash
+
+echo "Bundling gems"
+bundle install --jobs 4 --retry 3
+
+echo "Generating Spring binstubs"
+bundle exec spring binstub --all
+
+echo "Clearing logs"
+bin/rake log:clear
+
+echo "Setting up new db if one doesn't exist"
+bin/rake db:version || { bundle exec rake db:setup; }
+
+echo "Removing contents of tmp dirs"
+bin/rake tmp:clear
+
+echo "Starting app server"
+bundle exec rails s -p 3000
+
+# or use foreman
+# gem install foreman
+# foreman start
+```
+
+### 4. Run it
+
+`bundle exec docker-rails`
+
+### 5. Submit pull requests!
+
+This is starting off simple, but again, we welcome pulls to make this and the process of using docker for rails much easier.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/docker-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License and Attributions
+MIT license, inspired by many but certainly a [useful blog post by AtlasHealth](http://www.atlashealth.com/blog/2014/09/persistent-ruby-gems-docker-container). 

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/docker-rails

@@ -0,0 +1,148 @@
+#!/usr/bin/env ruby
+
+
+# compose cli
+#   https://docs.docker.com/v1.6/compose/cli/#environment-variables
+
+# compose yml
+#   https://docs.docker.com/v1.6/compose/yml/
+
+# remote api
+#   https://docs.docker.com/reference/api/docker_remote_api_v1.20
+
+
+# enable local usage from cloned repo
+root = File.expand_path('../..', __FILE__)
+$LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
+
+require 'docker/rails'
+
+BUILD_NAME = '113' # temp should be passed in
+ENV['BUILD_NAME'] = BUILD_NAME
+
+# Discover ruby version from the Dockerfile image
+IO.read('Dockerfile') =~ /^FROM \w+\/ruby:(\d+.\d+(?:.\d+))/
+BUILD_RUBY_VERSION = $1
+
+# Set as variable for interpolation
+GEMS_VOLUME_PATH = "/gems/#{BUILD_RUBY_VERSION}"
+GEMS_VOLUME_NAME = "gems-#{BUILD_RUBY_VERSION}"
+ENV['GEMS_VOLUME_PATH'] = GEMS_VOLUME_PATH
+ENV['GEMS_VOLUME_NAME'] = GEMS_VOLUME_NAME
+
+# -----------
+# Create global gems data volume to cache gems for this version of ruby
+#
+#   Docker::Container.create('name' => 'foo-gems-2.2.2', 'Image' => 'busybox', 'Mounts' => [ { 'Destination' => '/gems/2.2.2' } ])
+#
+require 'docker'
+begin
+  gems_container = Docker::Container.get(GEMS_VOLUME_NAME)
+  puts "Gem data volume container #{GEMS_VOLUME_NAME} already exists."
+rescue Docker::Error::NotFoundError => e
+  gems_container = Docker::Container.create('name' => GEMS_VOLUME_NAME, 'Image' => 'busybox', 'Mounts' => [{'Destination' => GEMS_VOLUME_PATH}])
+  puts "Gem data volume container #{GEMS_VOLUME_NAME} created."
+end
+gems_container.streaming_logs(stdout: true) { |stream, chunk| puts "#{GEMS_VOLUME_NAME}: #{chunk}" }
+
+# Read docker-compose.yml and rewrite with interpolated variables and BUILD_NAME
+COMPOSE_FILENAME = "docker-compose-build-#{BUILD_NAME}.yml"
+compose_config = Docker::Rails::ComposeConfig.interpolate_file(COMPOSE_FILENAME)
+
+# convenience to execute docker-compose with file and project params
+def xc(cmd)
+  cmd = "docker-compose -f #{COMPOSE_FILENAME} -p #{BUILD_NAME} #{cmd}"
+  puts "Running `#{cmd}`"
+  output =`#{cmd}`
+  result=$?.success?
+  output
+end
+
+# service_name i.e. 'db' or 'web'
+def get_container_name(service_name)
+  output = xc "ps #{service_name}"
+  output =~ /^(\w+)/ # grab the name, only thing that is at the start of the line
+  $1
+end
+
+# http://blog.oddbit.com/2014/08/11/four-ways-to-connect-a-docker/
+def get_ip_address(container_name)
+  cmd = "docker inspect --format '{{ .NetworkSettings.IPAddress }}' #{container_name}"
+  puts "Running `#{cmd}`"
+  output = `#{cmd}`
+  result=$?.success?
+  output
+end
+
+def up_container(service_name, options = '')
+  xc "up #{options} #{service_name}"
+  container_name = get_container_name(service_name)
+  puts "#{service_name}: container_name #{container_name}"
+
+  container = Docker::Container.get(container_name)
+  container.streaming_logs(stdout: true) { |stream, chunk| puts "#{service_name}: #{chunk}" }
+  # puts container
+
+  ip_address = get_ip_address(container_name)
+  [container, container_name, ip_address]
+end
+
+def destroy_container(container, container_name)
+  puts "Stopping and deleting #{container_name}..."
+  container.stop
+  container.delete(force: true)
+end
+
+# Start the db container
+db_container, db_container_name, db_ip_address = *up_container('db', '-d')
+
+# ping db to see if it is ready before continuing
+require 'rubygems'
+require 'active_record'
+
+LOOP_LIMIT=60
+puts "=> Waiting for confirmation of #{db_container_name} db service startup at #{db_ip_address}..."
+LOOP_LIMIT.times do |i|
+  if i == LOOP_LIMIT - 1
+    puts 'Time out waiting for db to be up.'
+    #docker logs --follow=false $DB_CONTAINER
+    break
+  end
+
+  ActiveRecord::Base.establish_connection ({
+                                              adapter: 'mysql2',
+                                              # host: db_ip_address,
+                                              host: '192.168.99.100',
+                                              port: 3306,
+                                              username: 'root'})
+  # connected = ActiveRecord::Base.connection_pool.with_connection { |con| con.active? }  rescue false
+  connected =
+      begin
+        ActiveRecord::Base.connection_pool.with_connection { |con| con.active? }
+      rescue => e
+        # puts "#{e.class.name}: #{e.message}"
+        false
+      end
+  printf '.'
+  if connected
+    printf 'connected.'
+    break
+  end
+  sleep 1
+end
+puts ''
+
+
+# Start the web containers
+web_container, web_container_name, web_ip_address = *up_container('web')
+
+
+puts 'Cleaning up containers...'
+destroy_container(db_container, db_container_name)
+destroy_container(web_container, web_container_name)
+puts "Done.\n\n\n"
+
+# cleanup build interpolated docker-compose.yml
+# File.delete COMPOSE_FILENAME if File.exists? COMPOSE_FILENAME
+
+system 'docker ps -a'

data/docker-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/rails/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'docker-rails'
+  s.version       = Docker::Rails::VERSION
+  s.authors       = ['Kevin Ross']
+  s.email         = ['kevin.ross@alienfast.com']
+  s.summary       = %q{A simplified pattern to execute rails applications within Docker (with a CI build emphasis)}
+  s.description   = %q{}
+  s.homepage      = ''
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.6'
+  s.add_development_dependency 'rake'
+
+  s.add_dependency 'docker-api'
+  # s.add_dependency 'parallel_tests'
+  s.add_dependency 'dry-config', '>= 1.1.6'
+end

data/lib/docker/rails.rb

@@ -0,0 +1,8 @@
+require 'docker/rails/version'
+
+module Docker
+  module Rails
+  end
+end
+
+require 'docker/rails/compose_config'

data/lib/docker/rails/compose_config.rb

@@ -0,0 +1,14 @@
+module Docker
+  module Rails
+    require 'dry/config'
+    class ComposeConfig < Dry::Config::Base
+      class << self
+        def interpolate_file(output_filename, input_filename = 'docker-compose.yml')
+          compose = ComposeConfig.new(symbolize: false)
+          compose.load!(nil, input_filename)
+          compose.write_yaml_file(output_filename)
+        end
+      end
+    end
+  end
+end

data/lib/docker/rails/version.rb

@@ -0,0 +1,5 @@
+module Docker
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: docker-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.6
+description: ''
+email:
+- kevin.ross@alienfast.com
+executables:
+- docker-rails
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/docker-rails
+- docker-rails.gemspec
+- lib/docker/rails.rb
+- lib/docker/rails/compose_config.rb
+- lib/docker/rails/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simplified pattern to execute rails applications within Docker (with a
+  CI build emphasis)
+test_files: []