docker-rails 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac658d93c92f059a526791a850f110b58c3c7d02
-  data.tar.gz: e477c9bacda7849798dfaa22c1f0da71358cc810
+  metadata.gz: ec5c1185350ab97e62cf01109148ddf3423d1610
+  data.tar.gz: d0e552e9dba679b392c90ec2bc567332d0b79bcb
 SHA512:
-  metadata.gz: 4e4cac1643b60c5d3e0f373042da97bac01b340881fa6d302f276ee16df12a91bc7fe7dc111622cb057312110baebb5ab605c0c1a8788fcd12d33a489a1390ad
-  data.tar.gz: 67754dd535eb6030733decd8c8f5dc3d46ce577cea9e7da33d49887e5596b28f75f988f7125c47d25e18c668d2fc5223e62a9f018e0b81572d232c395ec919d0
+  metadata.gz: 1da0e5553d88912677d1e7108a3804a014d68ff6d6958c181e18490465323b6bb74ad5cac06754c093972446c52cf9c554a56f372877c4bedaf10fea4e52e8b5
+  data.tar.gz: d9288310748ee68a9477aa009cba469f808bb1d27cd181bb7177574219a71b48d7630d786268d5e1396a73fd835ef5c15f74402191cae8e76769a452861a6b43

data/README.md

@@ -12,6 +12,7 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 - Automated cached global gems data volume based on ruby version
 - Interpolates variables `docker-compose.yml` making CI builds much easier
 - DB check CLI function provided for docker-compose `command` to check if db is ready
+- Configurable exit_code for `ci` - determine which container's exit code will be the result of the process (useful for CI tests)
 
 ## Usage
 
@@ -19,7 +20,7 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 
 CI, the reason this is built. Do it all, do it consistently, do it concurrently, do it easily, and always cleanup after yourself.
 
-`bundle exec ci test`
+`docker-rails ci test`
 
 #### CI workflow
 
@@ -39,20 +40,30 @@ 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).  
+  
+In your environment, ensure that `docker-rails` is present:
+
+```bash
+gem install --no-ri --no-rdoc docker-rails
+```
+
+Then run it:
+  
 ```bash
-bundle exec docker-rails ci --build=222 test
+docker-rails ci --build=222 test
 ```
   
 or with the environment variable option
 
 ```bash
-DOCKER_RAILS_BUILD=222 bundle exec docker-rails ci test
+DOCKER_RAILS_BUILD=222 docker-rails ci test
 ```
 
 or for local testing (uses `1` for build)
  
 ```bash
- bundle exec docker-rails ci test
+ docker-rails ci test
 ```
 
 ### General CLI
@@ -86,7 +97,6 @@ Options:
 Open to pull requests. Open to refactoring. It can be expanded to suit many different configurations.
 
 TODO:
-- **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.
 
 
@@ -142,6 +152,7 @@ The rails engine example below shows an example with all of the environments `de
 
 ```yaml
 verbose: true
+exit_code: web
 before_command: bash -c "rm -Rf target && rm -Rf spec/dummy/log"
 
 extractions: &extractions

data/lib/docker/rails/app.rb

@@ -3,7 +3,15 @@ module Docker
     require 'singleton'
     class App
       include Singleton
-      attr_reader :config, :compose_config, :ruby_version, :build, :target, :gems_volume_path, :gems_volume_name, :compose_filename
+      attr_reader :config,
+                  :compose_config,
+                  :ruby_version,
+                  :build,
+                  :target,
+                  :gems_volume_path,
+                  :gems_volume_name,
+                  :compose_filename,
+                  :exit_code
 
       class << self
         def configured(target, options)
@@ -95,6 +103,13 @@ module Docker
 
         @compose_config = Docker::Rails::ComposeConfig.new
         @compose_config.load!(nil, @compose_filename)
+
+        # check the exit_code
+        if @config['exit_code'].nil?
+          first_defined_service = @compose_config.keys[0]
+          puts "exit_code not set in configuration, using exit code from first defined service: #{first_defined_service}"
+          @config['exit_code'] = first_defined_service
+        end
       end
 
       def rm_compose
@@ -102,46 +117,64 @@ module Docker
         exec "rm #{compose_filename_from '*', '*'}" rescue ''
       end
 
-      def exec_before_command
+      def before_command
         before_command = @config['before_command']
         (exec before_command unless before_command.nil?) #unless skip? :before_command
       end
 
-      def exec_up(options = '')
+      def up(options = '')
         # Run the compose configuration
         exec_compose 'up', false, options #unless skip? :up
       end
 
-      def exec_build
+      def build
         # Run the compose configuration
         exec_compose 'build'
       end
 
-      def exec_ps
+      def ps
         # Run the compose configuration
         exec_compose 'ps'
       end
 
-      def exec_ps_all
+      def ps_all
         puts "\n\nAll remaining containers..."
         puts '-----------------------------'
         exec 'docker ps -a'
       end
 
-      def exec_stop
+      def stop
         puts "\n\n\n\nStopping containers..."
         puts '-----------------------------'
         containers = Docker::Container.all(all: true)
         containers.each do |container|
           if is_build_container?(container)
-            puts container.compose
+            printf "#{container.name}.."
             container.stop
+            60.times do |i|
+              printf '.'
+              if container.down?
+                printf "done.\n"
+                break
+              end
+              sleep 1
+            end
+
+            service_name = container.compose.service
+            if @config['exit_code'].eql?(service_name)
+              if container.up?
+                puts "Unable to determine exit code, the #{service_name} is still up, current status: #{container.status}"
+                @exit_code = -999
+              else
+                @exit_code = container.exit_code
+              end
+            end
           end
         end
         puts 'Done.'
       end
 
-      def exec_remove_volumes
+      def rm_volumes
         puts "\n\nRemoving container volumes..."
         puts '-----------------------------'
 
@@ -149,7 +182,7 @@ module Docker
         containers = Docker::Container.all(all: true)
         containers.each do |container|
           if is_build_container?(container)
-            puts container.compose
+            puts container.name
             container.remove(v: true, force: true)
           end
         end
@@ -166,12 +199,12 @@ module Docker
         puts 'Done.'
       end
 
-      def exec_run(service_name, command)
+      def run_service_command(service_name, command)
         # Run the compose configuration
         exec_compose "run #{service_name} #{command}"
       end
 
-      def exec_bash_connect(service_name)
+      def bash_connect(service_name)
         # docker exec -it 2ed97d0bb938 bash
         container = get_container(service_name)
         if container.nil?

data/lib/docker/rails/cli/main.rb

@@ -22,7 +22,7 @@ module Docker
 
         def ci(target)
           # init singleton with full options
-          App.configured(target, options)
+          app = App.configured(target, options)
 
           invoke :before, [target], []
           invoke :compose, [target], []
@@ -33,6 +33,8 @@ module Docker
           ensure
             invoke :cleanup
           end
+
+          exit app.exit_code
         end
 
         desc 'extract <target>', 'Invoke extractions', hide: true
@@ -69,17 +71,16 @@ module Docker
           compose_options = ''
           compose_options = '-d' if options[:detached]
 
-          app.exec_up(compose_options)
+          app.up(compose_options)
         end
 
         desc 'build <target>', 'Build for the given build/target e.g. bundle exec docker-rails build --build=222 development'
 
         def build(target)
           invoke :compose
-          App.configured(target, options).exec_build
+          App.configured(target, options).build
         end
 
-
         desc 'compose <target>', 'Writes a resolved docker-compose.yml file e.g. bundle exec docker-rails compose --build=222 test'
 
         def compose(target)
@@ -91,22 +92,21 @@ module Docker
         def before(target)
           app = App.configured(target, options)
           invoke :compose, [target], []
-          app.exec_before_command
+          app.before_command
         end
 
-
         desc 'stop <target>', 'Stop all running containers for the given build/target e.g. bundle exec docker-rails stop --build=222 development'
 
         def stop(target)
           invoke :compose
-          App.configured(target, options).exec_stop
+          App.configured(target, options).stop
         end
 
         desc 'rm_volumes <target>', 'Stop all running containers and remove corresponding volumes for the given build/target e.g. bundle exec docker-rails rm_volumes --build=222 development'
 
         def rm_volumes(target)
           invoke :stop
-          App.configured(target, options).exec_remove_volumes
+          App.configured(target, options).rm_volumes
         end
 
         desc 'rm_compose', 'Remove generated docker_compose file e.g. bundle exec docker-rails rm_compose --build=222 development', hide: true
@@ -125,13 +125,13 @@ module Docker
 
         def ps(target)
           invoke :compose
-          App.configured(target, options).exec_ps
+          App.configured(target, options).ps
         end
 
         desc 'ps_all', 'List all remaining containers regardless of state e.g. bundle exec docker-rails ps_all'
 
         def ps_all(build = nil, target = nil)
-          App.instance.exec_ps_all
+          App.instance.ps_all
         end
 
         desc 'bash_connect <target> <service_name>', 'Open a bash shell to a running container (with automatic cleanup) e.g. bundle exec docker-rails bash --build=222 development db'
@@ -142,7 +142,7 @@ module Docker
 
           invoke :compose, [target], []
 
-          container = app.exec_bash_connect(service_name)
+          container = app.bash_connect(service_name)
 
           # Automatically cleanup any remnants of a simple bash session.
           return if container.nil?
@@ -150,7 +150,6 @@ module Docker
           container.remove(v: true, force: true)
         end
 
-
         desc 'exec <target> <service_name> <command>', 'Run an arbitrary command on a given service container e.g. bundle exec docker-rails exec --build=222 development db bash'
 
         def exec(target, service_name, command)
@@ -159,16 +158,8 @@ module Docker
 
           invoke :compose, [target], []
 
-          app.exec_run(service_name, command)
+          app.run_service_command(service_name, command)
         end
-
-
-        protected
-
-        # invoke with an empty set of options
-        # def invoke_new(command, options=[])
-        #   invoke command, nil, options
-        # end
       end
     end
   end

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

@@ -1,12 +1,38 @@
 class Docker::Container
 
+  def name
+    info['Names'][0].gsub(/^\//, '')
+  end
+
+  def status
+    info['Status']
+  end
+
+  def up?
+    status =~ /^(up|Up)/
+  end
+
+  def down?
+    !up?
+  end
+
+  def exit_code
+    return nil if up?
+    return nil unless (status =~ /xited/)
+
+    #  Up 10 seconds
+    #  Exited (0) 2 seconds ago
+    status =~ /^.* \((\w+)\)/
+    $1.to_i
+  end
+
   def compose
     return nil unless Compose.is_compose_container?(self)
     @_compose ||= Compose.new(self)
   end
 
   class Compose
-    attr_reader :number, :oneoff, :project, :service, :version, :name
+    attr_reader :number, :oneoff, :project, :service, :version
 
     def initialize(container)
       labels = container.info['Labels']
@@ -15,11 +41,6 @@ class Docker::Container
       @oneoff = !!labels['com.docker.compose.oneoff']
       @number = labels['com.docker.compose.container-number'].to_i
       @version = labels['com.docker.compose.version']
-      @name = container.info['Names'][0].gsub(/^\//, '')
-    end
-
-    def to_s
-      @name
     end
 
     class << self

data/lib/docker/rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Kevin Ross