docker-rails 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6052b133ad5e1cdb58cb484baa077de133994fdc
-  data.tar.gz: 33124a13ab2327fbc1dfe2ae28fed2542f2656f5
+  metadata.gz: bd13b3e449ebecf3beeeaf1ccce34d9d8a4d82ad
+  data.tar.gz: ef722489bc87dd8c6078d470360289456633f0f7
 SHA512:
-  metadata.gz: a9fd4e6b3e13e76beb5f914b9944860101f3ccb7c36792de0de1525372396c719fbff75c4c65d6144b7d3075302c0bb0be2d118cf31ba70746168cc1c2007e19
-  data.tar.gz: 30f5cf9246f18910399c7eb937fdc90ed2816243b1386a0af47c68ced889258f1452a2ede03e731e55d2034aceeca4020d3bc92352bccbc41e822c29ac8e4b0c
+  metadata.gz: 5a166ca39b19deacf676c1794066b51c05ff3885f76398785c3d28f2d95d2d977926cec5fbb11ed3703925df04b5ae676debe4d0a2a3ac1a6a4e64c6529a8ee8
+  data.tar.gz: 51f1969e15638ecdd42f8cf20d2c8838d7e947c19158a7af6ed41b4406f28ecc91ee24b72f2d92905e2b0146eef8df14216e79a60a3b106721edc945dd2d0706

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -3,21 +3,36 @@
 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`
-- 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
+- Provides individual functions for development/test usage, or a full workflow for CI usage (with automated container, volume, and image cleanup).
+- Automated cached global gems data volume (automatic) based on ruby version
+- DRY declarative `docker-rails.yml` allowing multiple environments to be defined with an inherited `docker-compose` configuration
+- Interpolates `docker-compose.yml` making CI builds much easier
+- DB check CLI function provided for docker-compose `command` to check if db is ready
 
 
+## Usage
+
+```bash
+Commands:
+  docker-rails ci <build_name> <environment_name>          # Execute the works, everything with cleanup included i.e. bundle exec docker-rails ci 222 test
+  docker-rails compose <build_name> <environment_name>     # Writes a resolved docker-compose.yml file
+  docker-rails db_check <db>                               # Runs db_check
+  docker-rails gems_volume <command>                       # Gems volume management
+  docker-rails help [COMMAND]                              # Describe available commands or one specific command
+  docker-rails rm_compose                                  # Remove generated docker_compose file
+  docker-rails rm_dangling                                 # Remove danging images
+  docker-rails rm_volumes <build_name> <environment_name>  # Stop all running containers and remove corresponding volumes for the given build_name/environment_name
+  docker-rails show_all_containers                         # Show all remaining containers regardless of state
+  docker-rails stop <build_name> <environment_name>        # Stop all running containers for the given build_name/environment_name
+  docker-rails up <build_name> <environment_name>          # Up the docker-compose configuration for the given build_name/environment_name
+```
+
 ## 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.
+Open to pull requests. It can be expanded to suit many different configurations.
 
 TODO:
-- remove or default hardcoded BUILD_NAME
-- 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`.
+- **Permissions** - [Shared volume for project has files written as root](https://github.com/alienfast/docker-rails/issues/5)
+- **DB versatility** - expand to different db status detection as-needed e.g. postgres. CLI is now modularized to allow for this.
 
 
 ## Installation
@@ -55,82 +70,183 @@ RUN apt-get update -qq && \
 
 # https://github.com/docker/docker/issues/4032
 ENV DEBIAN_FRONTEND newt
-
-ADD . /project
-WORKDIR /project
 ```
 
-### 2. Add a docker-compose.yml
+### 2. Add a docker-rails.yml
 
-Environment variables will be interpolated, so feel free to use them.
+Environment variables will be interpolated, so feel free to use them. 
+Below shows an example with all of the environments `development | test | parallel_tests | staging' to show reuse of the primary `docker-compose' configuration. 
 
 ```yaml
-web:
-  build: .
-  # e.g. engine dummy, otherwise omit.
-  working_dir: /project/spec/dummy
-  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:
-    - 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}
-
-elasticsearch:
-  image: library/elasticsearch:1.7
-  ports:
-    - "9200:9200"
-db:
-  image: library/mysql:5.7.6
-  ports:
-    - "3306:3306"
-  environment:
-    - MYSQL_ALLOW_EMPTY_PASSWORD=true
+verbose: true
+
+# local environments need elasticsearch, staging/production connects to existing running instance.
+elasticsearch: &elasticsearch
+  elasticsearch:
+    image: library/elasticsearch:1.7
+    ports:
+      - "9200"
+
+development:
+  docker-compose:
+    <<: *elasticsearch
+    web:
+      links:
+        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+      environment:
+        - RAILS_ENV=development
+      command: >
+        bash -c "
+
+        echo 'Bundling gems'
+        && bundle install --jobs 4 --retry 3
+
+        && echo 'Generating Spring binstubs'
+        && bundle exec spring binstub --all
+
+        && echo 'Clearing logs and tmp dirs'
+        && bundle exec rake log:clear tmp:clear
+
+        && echo 'Check and wait for database connection'
+        && bundle exec docker-rails db_check mysql
+
+        && echo 'Setting up new db if one doesn't exist'
+        && bundle exec rake db:version || { bundle exec rake db:setup; }
+
+        && echo "Starting app server"
+        && bundle exec rails s -p 3000
+
+        && echo 'Setup and start foreman'
+        && gem install foreman
+        && foreman start
+        "
+
+test:
+  before_command: rm -Rf target
+  docker-compose:
+    <<: *elasticsearch
+    web:
+      links:
+        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+      environment:
+        - RAILS_ENV=test
+      command: >
+        bash -c "
+        echo 'Bundling gems'
+        && bundle install --jobs 4 --retry 3
+
+        && echo 'Clearing logs and tmp dirs'
+        && bundle exec rake log:clear tmp:clear
+
+        && echo 'Check and wait for database connection'
+        && bundle exec docker-rails db_check mysql
+
+        && echo 'Setting up new db if one doesn't exist'
+        && bundle exec rake db:version || { bundle exec rake db:setup; }
+
+        && echo 'Tests'
+        && cd ../..
+        && xvfb-run -a bundle exec rake spec cucumber
+        "
+
+parallel_tests:
+  before_command: rm -Rf target
+  docker-compose:
+    <<: *elasticsearch
+    web:
+      links:
+        - elasticsearch # standard yaml doesn't merge arrays so we have to add this explicitly
+      environment:
+        - RAILS_ENV=test
+      command: >
+        bash -c "
+
+        echo 'Bundling gems'
+        && bundle install --jobs 4 --retry 3
+
+        && echo 'Clearing logs and tmp dirs'
+        && bundle exec rake log:clear tmp:clear
+
+        && echo 'Check and wait for database connection'
+        && bundle exec docker-rails db_check mysql
+
+        && echo 'Setting up new db if one doesn't exist'
+        && bundle exec rake parallel:drop parallel:create parallel:migrate parallel:seed
+
+        && echo 'Tests'
+        && cd ../..
+        && xvfb-run -a bundle exec rake parallel:spec parallel:features
+        "
+
+staging:
+  docker-compose:
+    web:
+      environment:
+        - RAILS_ENV=staging
+      command: >
+        bash -c "
+
+        echo 'Bundling gems'
+        && bundle install --jobs 4 --retry 3
+
+        && echo 'Clearing logs and tmp dirs'
+        && bundle exec rake log:clear tmp:clear
+
+        && echo 'Check and wait for database connection'
+        && bundle exec docker-rails db_check mysql
+
+        && echo 'Setting up new db if one doesn't exist'
+        && bundle exec rake db:migrate
+
+        && echo "Starting app server"
+        && bundle exec rails s -p 3000
+
+        && echo 'Setup and start foreman'
+        && gem install foreman
+        && foreman start
+        "
+
+docker-compose:
+  web:
+    build: .
+    working_dir: /project/spec/dummy
+    ports:
+      - "3000"
+
+    links:
+      - db
+
+    volumes:
+      - .:/project
+
+    volumes_from:
+      # Mount the gems data volume container for cached bundler gem files
+      - #{GEMS_VOLUME_NAME}
+
+    # https://docs.docker.com/v1.6/docker-compose/cli/#environment-variables
+    environment:
+      # Tell bundler where to get the files
+      - GEM_HOME=#{GEMS_VOLUME_PATH}
+
+  db:
+    # https://github.com/docker-library/docs/tree/master/mysql
+    image: library/mysql:5.7.6
+    ports:
+      - "3306"
+
+    # https://github.com/docker-library/docs/tree/master/mysql#environment-variables
+    environment:
+      - MYSQL_ALLOW_EMPTY_PASSWORD=true
 ```
 
 ### 3. Run it
 
-`bundle exec docker-rails`
+`bundle exec docker-rails ci 111 test`
 
 ### 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 even easier.
+The intent for this is to make rails with docker a snap.  The code should be modular enough that adding a check for a different database etc should be quite simple.
+We are open to expanding functionality beyond what is already provided.
 
 
 ## Contributing

data/Rakefile

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

data/bin/docker-rails

@@ -1,139 +1,9 @@
 #!/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
-
-
-# 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")
+# root = File.expand_path('../..', __FILE__)
+# $LOAD_PATH << "#{root}/lib" if File.exist?("#{root}/Gemfile")
 
 require 'docker/rails'
 
-BUILD_NAME = '119' # 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
-
-
-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
-#
-#   Docker::Container.create('name' => 'foo-gems-2.2.2', 'Image' => 'busybox', 'Mounts' => [ { 'Destination' => '/gems/2.2.2' } ])
-#
-require 'docker'
-begin
-  Docker::Container.get(GEMS_VOLUME_NAME)
-  puts "Gem data volume container #{GEMS_VOLUME_NAME} already exists."
-rescue Docker::Error::NotFoundError => e
-
-  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}" }
-
-# 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 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 = 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
-
-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}" }
-  # puts container
-
-  [container, container_name]
-end
-
-def rm_v(service_name)
-  exec_compose "rm -v --force #{service_name}"
-end
-
-def stop(service_name)
-  exec_compose "stop #{service_name}"
-end
-
-
-# make sure we are built
-exec_compose 'build'
-
-begin
-  # Start the db container
-  up('db', '-d')
-
-  # 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 "\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
-
-  system 'docker ps -a'
-end
+Docker::Rails::CLI::Main.start( ARGV )