docker-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4daf7ed396ab33b4baccadbe1a1f888af9a3271d
-  data.tar.gz: 7a38191133060c00417437db6ba84e93d3f936a5
+  metadata.gz: 6052b133ad5e1cdb58cb484baa077de133994fdc
+  data.tar.gz: 33124a13ab2327fbc1dfe2ae28fed2542f2656f5
 SHA512:
-  metadata.gz: 8d8ffca0992dbbbd4edfd75b36de681f018933d497f1b9cd37d05edb0cd59471c06fd15136de6e031867f928904732c8570f45e219c69b714a5e24f94cd2cdd3
-  data.tar.gz: 49cea1c9d37dcb37d519e3db6d0345185f6fc6cb6dac30c0a6f1d17fa708a7de2bf7df8cbd397f5daea0e0555046dc1a3f1a86d8b9df5562e888e148c4f863e7
+  metadata.gz: a9fd4e6b3e13e76beb5f914b9944860101f3ccb7c36792de0de1525372396c719fbff75c4c65d6144b7d3075302c0bb0be2d118cf31ba70746168cc1c2007e19
+  data.tar.gz: 30f5cf9246f18910399c7eb937fdc90ed2816243b1386a0af47c68ced889258f1452a2ede03e731e55d2034aceeca4020d3bc92352bccbc41e822c29ac8e4b0c

data/README.md

@@ -1,21 +1,24 @@
-# Docker::Rails
+# docker-rails
 
 A simplified pattern to execute rails applications within Docker (with a CI build emphasis).
 
-Features:
+## 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
+- starts `db` container first and continues with `web`
+- function provided for docker-compose `command` to check if db is ready, currently executed as script `docker-rails-db-check`
+- cleans up all containers **and** volumes once completed
 
 
-**Very much a work in progress - contributions welcome**
+## 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
+TODO:
 - remove or default hardcoded BUILD_NAME
-- expand to different db status detection as needed
+- expand to different db status detection as needed e.g. postgres
+- move to proper CLI (it's mostly in script form at the moment)
+- (perhaps) provide name based compose configurations, i.e. running `docker-rails development` vs. `docker-rails test` vs. `docker-rails parallel_tests` might be nice to have (and easy) since most of the configuration is the same, sans `command`.
+
 
 ## Installation
 
@@ -43,8 +46,7 @@ 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 && \
+    apt-get install -qy build-essential libxml2-dev libxslt1-dev g++ qt5-default libqt5webkit5-dev xvfb libmysqlclient-dev && \
 
     # cleanup
     apt-get clean && \
@@ -56,7 +58,6 @@ ENV DEBIAN_FRONTEND newt
 
 ADD . /project
 WORKDIR /project
-RUN ["chmod", "+x", "/project/scripts/*"]
 ```
 
 ### 2. Add a docker-compose.yml
@@ -66,8 +67,36 @@ Environment variables will be interpolated, so feel free to use them.
 ```yaml
 web:
   build: .
+  # e.g. engine dummy, otherwise omit.
   working_dir: /project/spec/dummy
-  command: /project/script/start
+  command: >
+    bash -c
+    "
+    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 'Check and wait for database connection'
+    && bundle exec docker-rails-db-check
+     
+    && 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
+     
+    && echo 'Setup and start foreman'
+    && gem install foreman
+    && foreman start
+    "
   ports:
     - "3000:3000"
   links:
@@ -83,6 +112,10 @@ web:
     # Tell bundler where to get the files
     - GEM_HOME=#{GEMS_VOLUME_PATH}
 
+elasticsearch:
+  image: library/elasticsearch:1.7
+  ports:
+    - "9200:9200"
 db:
   image: library/mysql:5.7.6
   ports:
@@ -91,43 +124,13 @@ db:
     - 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
+### 3. Run it
 
 `bundle exec docker-rails`
 
-### 5. Submit pull requests!
+### 4. 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.
+This is starting off simple, but again, we welcome pulls to make this and the process of using docker for rails even easier.
 
 
 ## Contributing

data/bin/docker-rails

@@ -11,13 +11,19 @@
 #   https://docs.docker.com/reference/api/docker_remote_api_v1.20
 
 
+# docker-compose -f docker-compose-build-119.yml -p 119 up -d db
+# docker-compose -f docker-compose-build-119.yml -p 119 up  web
+
+
+SHOW_COMMANDS = true
+
 # 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
+BUILD_NAME = '119' # temp should be passed in
 ENV['BUILD_NAME'] = BUILD_NAME
 
 # Discover ruby version from the Dockerfile image
@@ -30,6 +36,19 @@ GEMS_VOLUME_NAME = "gems-#{BUILD_RUBY_VERSION}"
 ENV['GEMS_VOLUME_PATH'] = GEMS_VOLUME_PATH
 ENV['GEMS_VOLUME_NAME'] = GEMS_VOLUME_NAME
 
+
+def exec(cmd, capture = false)
+  puts "Running `#{cmd}`" if SHOW_COMMANDS
+  if capture
+    output = %x[#{cmd}]
+  else
+    system cmd
+  end
+
+  raise "Failed to execute: `#{cmd}`" unless $?.success?
+  output
+end
+
 # -----------
 # Create global gems data volume to cache gems for this version of ruby
 #
@@ -37,112 +56,84 @@ ENV['GEMS_VOLUME_NAME'] = GEMS_VOLUME_NAME
 #
 require 'docker'
 begin
-  gems_container = Docker::Container.get(GEMS_VOLUME_NAME)
+  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}])
+
+  exec "docker create -v #{GEMS_VOLUME_PATH} --name #{GEMS_VOLUME_NAME} busybox"
   puts "Gem data volume container #{GEMS_VOLUME_NAME} created."
 end
-gems_container.streaming_logs(stdout: true) { |stream, chunk| puts "#{GEMS_VOLUME_NAME}: #{chunk}" }
+# gems_container.streaming_logs(stdout: true) { |stream, chunk| puts "#{GEMS_VOLUME_NAME}: #{chunk}" }
+
+# Delete old docker compose files
+exec 'rm docker-compose-build-*.yml' rescue ''
 
 # 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
+def exec_compose(cmd, capture = false)
+  exec("docker-compose -f #{COMPOSE_FILENAME} -p #{BUILD_NAME} #{cmd}", capture)
 end
 
 # service_name i.e. 'db' or 'web'
 def get_container_name(service_name)
-  output = xc "ps #{service_name}"
+  output = exec_compose "ps #{service_name}", true
+  # puts "get_container(#{service_name}): \n#{output}"
   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}"
+def up(service_name, options = '')
+  exec_compose "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}" }
+  # 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]
+  [container, container_name]
 end
 
-def destroy_container(container, container_name)
-  puts "Stopping and deleting #{container_name}..."
-  container.stop
-  container.delete(force: true)
+def rm_v(service_name)
+  exec_compose "rm -v --force #{service_name}"
 end
 
-# Start the db container
-db_container, db_container_name, db_ip_address = *up_container('db', '-d')
+def stop(service_name)
+  exec_compose "stop #{service_name}"
+end
 
-# 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 ''
+# make sure we are built
+exec_compose 'build'
 
+begin
+  # Start the db container
+  up('db', '-d')
 
-# Start the web containers
-web_container, web_container_name, web_ip_address = *up_container('web')
+  # Start the web container
+  up('web')
 
+ensure
+  puts "\n\n\n\nStopping containers..."
+  puts '-----------------------------'
+  compose_config.configuration.each_key do |service_name|
+    stop(service_name)
+  end
+  puts "\nDone."
 
-puts 'Cleaning up containers...'
-destroy_container(db_container, db_container_name)
-destroy_container(web_container, web_container_name)
-puts "Done.\n\n\n"
+  puts "\n\nRemoving container volumes..."
+  puts '-----------------------------'
+  compose_config.configuration.each_key do |service_name|
+    rm_v(service_name)
+  end
+  puts "\nDone."
+  puts "\n\n\n"
 
 # cleanup build interpolated docker-compose.yml
-# File.delete COMPOSE_FILENAME if File.exists? COMPOSE_FILENAME
+#   File.delete COMPOSE_FILENAME if File.exists? COMPOSE_FILENAME
 
-system 'docker ps -a'
+  system 'docker ps -a'
+end

data/bin/docker-rails-db-check

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+# TODO: make docker-rails CLI and put this in the lib, add optional ! method to raise if failed
+
+# ping db to see if it is ready before continuing
+require 'rubygems'
+require 'active_record'
+require 'mysql2'
+
+LOOP_LIMIT=60
+puts "\n"
+printf 'Waiting for confirmation of db service startup...'
+LOOP_LIMIT.times do |i|
+  if i == LOOP_LIMIT - 1
+    printf 'failed to connect.'
+    raise 'Failed to connect to db service.'
+  end
+
+  ActiveRecord::Base.establish_connection ({
+                                              adapter: 'mysql2',
+                                              host: 'db',
+                                              port: 3306,
+                                              username: 'root'})
+  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 "\n"

data/docker-rails.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'docker-api'
   # s.add_dependency 'parallel_tests'
   s.add_dependency 'dry-config', '>= 1.1.6'
+  s.add_dependency 'mysql2', '~> 0.3.18' # http://stackoverflow.com/a/32466950/2363935
 end

data/lib/docker/rails/compose_config.rb

@@ -7,6 +7,7 @@ module Docker
           compose = ComposeConfig.new(symbolize: false)
           compose.load!(nil, input_filename)
           compose.write_yaml_file(output_filename)
+          compose
         end
       end
     end

data/lib/docker/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,11 +66,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.6
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.18
 description: ''
 email:
 - kevin.ross@alienfast.com
 executables:
 - docker-rails
+- docker-rails-db-check
 extensions: []
 extra_rdoc_files: []
 files:
@@ -82,6 +97,7 @@ files:
 - README.md
 - Rakefile
 - bin/docker-rails
+- bin/docker-rails-db-check
 - docker-rails.gemspec
 - lib/docker/rails.rb
 - lib/docker/rails/compose_config.rb