docker-rails 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec5c1185350ab97e62cf01109148ddf3423d1610
-  data.tar.gz: d0e552e9dba679b392c90ec2bc567332d0b79bcb
+  metadata.gz: 676f2ab08aa5bab4eaa12cd439e73e5b24d05203
+  data.tar.gz: 725d25ce15b195dd2cce0d487198754ab507da5c
 SHA512:
-  metadata.gz: 1da0e5553d88912677d1e7108a3804a014d68ff6d6958c181e18490465323b6bb74ad5cac06754c093972446c52cf9c554a56f372877c4bedaf10fea4e52e8b5
-  data.tar.gz: d9288310748ee68a9477aa009cba469f808bb1d27cd181bb7177574219a71b48d7630d786268d5e1396a73fd835ef5c15f74402191cae8e76769a452861a6b43
+  metadata.gz: dfd7b13048590fd015a9a1bfc2dd574a449007ebc2159f2af15628b04172a29684d418bf728454c40385eb35da1db491c7877328793bbe9209437ff5279a4462
+  data.tar.gz: 22fbca62f1a72eca0cef0fe1aaa64e0de97e46de1b49ad518f0600c2a38815288f95fd0780dbbb19557de7249788c4dd595c4077d369aeda41d2b8a70d55436d

data/README.md

@@ -40,7 +40,7 @@ CI, the reason this is built. Do it all, do it consistently, do it concurrently,
 
 #### CI execution options
   
-**NOTE:** If using `bundle exec`, you'll need to do a `bundle` on both the host and container.  These examples avoid `bundle exec` on the host for that reason (ran inside rvm).  
+**NOTE:** If using `bundle exec`, you'll need to do a `bundle` on both the host and container.  These examples avoid `bundle exec` on the host to avoid the time taken to bundle (it should happen inside your container). 
   
 In your environment, ensure that `docker-rails` is present:
 
@@ -93,13 +93,6 @@ Options:
                        # Default: 1
 ```
 
-## Work in progress - contributions welcome
-Open to pull requests. Open to refactoring. It can be expanded to suit many different configurations.
-
-TODO:
-- **DB versatility** - expand to different db status detection as-needed e.g. postgres. CLI is now modularized to allow for this.
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -114,7 +107,7 @@ Or install it yourself as:
 
     $ gem install docker-rails
 
-## Usage
+## Setup and Configuration
 
 ### 1. Add a Dockerfile
 
@@ -148,7 +141,7 @@ COPY . /project
 ### 2. Add a docker-rails.yml
 
 Environment variables will be interpolated, so feel free to use them. 
-The rails engine example below shows an example with all of the environments `development | test | parallel_tests | staging` to show reuse of the primary `compose` configuration. 
+The _rails engine_ example below shows an example with all of the environments `development | test | parallel_tests | staging` to show reuse of the primary `compose` configuration. 
 
 ```yaml
 verbose: true
@@ -320,15 +313,57 @@ compose:
       - MYSQL_ALLOW_EMPTY_PASSWORD=true
 ```
 
-### 3. Run it
+## CI setup
+
+### Bamboo
+
+The following shows execution within Atlassian Bamboo using an script task and RVM on the host.
+
+#### 1. Add an inline script task
+
+This will run everything, including cleanup.
+
+```bash
+#!/bin/bash
+ 
+# force bash, not bin/sh
+if [ "$(ps -p "$$" -o comm=)" != "bash" ]; then
+    # Taken from http://unix-linux.questionfor.info/q_unix-linux-programming_85038.html
+    bash "$0" "$@"
+    exit "$?"
+fi
+
+source ~/.bash_profile
+rvm gemset list
+echo "Build: $bamboo_buildNumber"
+gem install --no-ri --no-rdoc docker-rails
+
+docker-rails ci --build=$bamboo_buildNumber parallel_tests
+```
+
+#### 2. Add an inline script final task 
 
-`bundle exec docker-rails ci --build=111 test`
+In the _Final tasks_ section, add another inline script task just to ensure cleanup.  If all is well, this is duplicate work (that takes very little time), but we have seen cases where executing `stop` in Bamboo will kill off the process without a chance to cleanup.  This will take care of that scenario.
 
-### 4. Submit pull requests!
+```bash
+#!/bin/bash
+ 
+# force bash, not bin/sh
+if [ "$(ps -p "$$" -o comm=)" != "bash" ]; then
+    # Taken from http://unix-linux.questionfor.info/q_unix-linux-programming_85038.html
+    bash "$0" "$@"
+    exit "$?"
+fi
+
+source ~/.bash_profile
+docker-rails cleanup --build=$bamboo_buildNumber parallel_tests
+```
 
-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.
+## Work in progress - contributions welcome
+Open to pull requests. Open to refactoring. It can be expanded to suit many different configurations.
 
+TODO:
+- **DB versatility** - expand to different db status detection as-needed e.g. postgres. CLI is now modularized to allow for this.
 
 ## Contributing
 

data/lib/docker/rails/app.rb

@@ -6,7 +6,8 @@ module Docker
       attr_reader :config,
                   :compose_config,
                   :ruby_version,
-                  :build,
+                  :build, # given build, usually a number
+                  :project_name, # resolved compose project name
                   :target,
                   :gems_volume_path,
                   :gems_volume_name,
@@ -31,12 +32,20 @@ module Docker
       end
 
       def configure(options)
+        @target = options[:target]
+
         # Allow CLI option `build` to fallback to an env variable DOCKER_RAILS_BUILD.  Note that CLI provides a default build value of 1, so check against the default and existence of the env var.
         build = options[:build]
         build = ENV['DOCKER_RAILS_BUILD'] if build.to_i == 1 && !ENV['DOCKER_RAILS_BUILD'].nil?
-
         ENV['DOCKER_RAILS_BUILD'] = @build = build
-        @target = options[:target]
+
+        # determine project_name
+        dir_name = Dir.pwd.split('/').last
+        @project_name = "#{dir_name}_#{target}_#{build}"
+
+        # FIXME: temporarily sanitize project_name until they loosen restrictions see https://github.com/docker/compose/issues/2119
+        @project_name = @project_name.gsub(/[^a-z0-9]/, '')
+
 
         # load the docker-rails.yml
         @config = Docker::Rails::Config.new
@@ -95,7 +104,7 @@ module Docker
 
       def compose
         # Write a docker-compose.yml with interpolated variables
-        @compose_filename = compose_filename_from @build, @target
+        @compose_filename = compose_filename_from @project_name
 
         rm_compose
 
@@ -114,7 +123,7 @@ module Docker
 
       def rm_compose
         # Delete old docker compose files
-        exec "rm #{compose_filename_from '*', '*'}" rescue ''
+        exec "rm #{compose_filename_from '*'}" rescue ''
       end
 
       def before_command
@@ -148,8 +157,10 @@ module Docker
         puts '-----------------------------'
         containers = Docker::Container.all(all: true)
         containers.each do |container|
-          if is_build_container?(container)
+          if is_project_container?(container)
             printf "#{container.name}.."
+
+            # Stop it
             container.stop
             60.times do |i|
               printf '.'
@@ -160,6 +171,48 @@ module Docker
               sleep 1
             end
 
+            # Kill it #1 - if still up, kill it softly?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
+            if container.up?
+              printf 'killing(-1)'
+              container.kill(signal: 'SIGHUP')
+              10.times do |i|
+                printf '.'
+                if container.down?
+                  printf "done.\n"
+                  break
+                end
+                sleep 1
+              end
+            end
+
+            # Kill it #2 - if still up, kill it with a vengeance?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
+            if container.up?
+              printf 'killing(-9)'
+              container.kill(signal: 'SIGKILL')
+              10.times do |i|
+                printf '.'
+                if container.down?
+                  printf "done.\n"
+                  break
+                end
+                sleep 1
+              end
+            end
+
+            # Kill it #3 - if still up, kill it with a chuck norris?  # http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_12_01.html
+            if container.up?
+              printf 'killing(Chuck Norris)'
+              container.kill(signal: 'SIGSTOP')
+              10.times do |i|
+                printf '.'
+                if container.down?
+                  printf "done.\n"
+                  break
+                end
+                sleep 1
+              end
+            end
+
             service_name = container.compose.service
             if @config['exit_code'].eql?(service_name)
               if container.up?
@@ -181,7 +234,7 @@ module Docker
         # http://docs.docker.com/v1.7/reference/api/docker_remote_api_v1.19/#remove-a-container
         containers = Docker::Container.all(all: true)
         containers.each do |container|
-          if is_build_container?(container)
+          if is_project_container?(container)
             puts container.name
             container.remove(v: true, force: true)
           end
@@ -251,7 +304,7 @@ module Docker
       def get_container(service_name)
         containers = Docker::Container.all(all: true)
         containers.each do |container|
-          if is_build_container?(container) && container.compose.service.eql?(service_name.to_s)
+          if is_project_container?(container) && container.compose.service.eql?(service_name.to_s)
             return container
           end
         end
@@ -259,12 +312,12 @@ module Docker
         nil
       end
 
-      def is_build_container?(container)
+      def is_project_container?(container)
         # labels = container.info['Labels']
         # build = labels['com.docker.compose.project']
 
         return false if container.compose.nil?
-        return true if @build.eql? container.compose.project
+        return true if @project_name.eql? container.compose.project
         false
       end
 
@@ -285,8 +338,8 @@ module Docker
       end
 
       # accessible so that we can delete patterns
-      def compose_filename_from(build, target)
-        "docker-compose-#{target}-#{build}.yml"
+      def compose_filename_from(project_name)
+        "docker-compose-#{project_name}.yml"
       end
 
       def extract_files(container, from, to)

data/lib/docker/rails/ext/container.rb

@@ -9,7 +9,10 @@ class Docker::Container
   end
 
   def up?
-    status =~ /^(up|Up)/
+    #  Up 10 seconds
+    #  Exited (0) 2 seconds ago
+    return true if status =~ /^(up|Up)/
+    false
   end
 
   def down?

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.5.2'
+    VERSION = '0.5.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler