docker-rails 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201c27258faf2fd7c7e3da8be4ef103692af5d3d
-  data.tar.gz: 2cddc4422dd2fbde906a8b3eebeae4fe5659b4f8
+  metadata.gz: 285dc77cef10695d9e17976de3d0d4ce48191422
+  data.tar.gz: f8e2eca7b132eb6b97dced3fe8a04b64512d5dd8
 SHA512:
-  metadata.gz: 10b164b7176bc7bc04fbf1aafe8700c108bc5916be22ee49ff961d253cadc39be6b6ae5f755dde04f6bbd469c694a9cccb9f535ba71cbbcd7800d36a0b7b2660
-  data.tar.gz: fcaf8df78943d829d525c630d71517c28bf47d681d85d65ea6401d9b470ae0d2568979c1a13eb1c9b6728109055b71af27c4583bd9b8f8a45bb5e9ac04c08096
+  metadata.gz: 8ab35a4c1b39129157b8962f383e02eb4004a37c798c2512aa49ad993e97f39e7fb5229a7b5901175a767b057d5d2ab38fbd20ba385534530cde0df53cb25a3a
+  data.tar.gz: a9f88b10b75cdf755de564ed85479d6eee098ec522d98415fdc4211e23b57c092d83fb299fdd2dd697c8cfd6af5c4a41a980d5c3ef1b0f1bd0f0e2059935aed5

data/.travis.yml

@@ -10,4 +10,9 @@ matrix:
     - rvm: ruby-head
     - rvm: jruby-head
 
-script: rake
+script: rake
+
+notifications:
+  email:
+    on_success: change
+    on_failure: change

data/README.md

@@ -18,6 +18,26 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 ### CI
 
 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`
+
+#### CI workflow
+
+`ci` executes: 
+
+1. `before_command` - run anything on the host prior to building the docker image e.g. `rm -Rf target`
+2. `compose` - create the resolved `docker-compose.yml`
+3. `gems_volume` - find or create the shared global gems volume for this ruby version
+4. `build` - `docker-compose build` the configuration
+5. `up` - `docker-compose up` the configuration
+6. `cleanup`
+    1. `stop` - stop all containers for this configuration (including one-off sessions)
+    2. `extract` - extract any defined files from any container
+    3. `rm_volumes` - `docker-compose rm -v --force` to cleanup any container volumes (excluding the gems volume)
+    4. `rm_compose` - cleanup the generated compose.yml file for the `build`
+    5. `rm_dangling` - cleanup any dangling images
+
+#### CI execution options
   
 ```bash
 bundle exec docker-rails ci --build=222 test
@@ -33,7 +53,7 @@ or for local testing (uses `1` for build)
  
 ```bash
  bundle exec docker-rails ci test
- ```
+```
 
 ### General CLI
 
@@ -41,7 +61,7 @@ Almost all of the commands below are in support of the `ci` command, so why not
 
 ```bash
 Commands:
-  docker-rails bash_connect <target> <service_name>    # Open a bash shell to a running container e.g. bundle exec docker-rails bash --build=222 development db
+  docker-rails 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
   docker-rails build <target>                          # Build for the given build/target e.g. bundle exec docker-rails build --build=222 development
   docker-rails ci <target>                             # Execute the works, everything with cleanup included e.g. bundle exec docker-rails ci --build=222 test
   docker-rails cleanup <target>                        # Runs container cleanup functions stop, rm_volumes, rm_compose, rm_dangling, ps_all e.g. bundle exec docker-rails cleanup --build=222 development
@@ -107,6 +127,12 @@ RUN apt-get update -qq && \
     
 # https://github.com/docker/docker/issues/4032
 ENV DEBIAN_FRONTEND newt
+
+# Bypass the union file system for better performance https://docs.docker.com/userguide/dockervolumes/
+VOLUME /project
+
+# Copy the project files into the container (again, better performance).  Use `extract` in the docker-rails.yml to obtain files such as test results.
+COPY . /project
 ```
 
 ### 2. Add a docker-rails.yml

data/lib/docker/rails.rb

@@ -9,7 +9,8 @@ require 'thor'
 require 'docker'
 require 'archive/tar/minitar'
 
-require 'docker/rails/core_ext/hash'
+require 'docker/rails/ext/hash'
+require 'docker/rails/ext/container'
 
 require 'docker/rails/config'
 require 'docker/rails/compose_config'

data/lib/docker/rails/app.rb

@@ -76,36 +76,15 @@ module Docker
             end
 
             puts "\nExtracting #{service_name} #{from} to #{to}"
-            extract_files(container, from, to)
+            begin
+              extract_files(container, from, to)
+            rescue => e
+              puts e.message
+            end
           end
         end
       end
 
-
-      def extract_files(container, from, to)
-        # or something like
-        tar_stringio = StringIO.new
-        container.copy(from) do |chunk|
-          tar_stringio.write(chunk)
-        end
-
-        tar_stringio.rewind
-
-        input = Archive::Tar::Minitar::Input.new(tar_stringio)
-        input.each { |entry|
-
-          # Need to check the file name length to prevent some very bad things from happening.
-          if entry.full_name.length > 255
-            puts "ERROR - file name length is > 255 characters: #{entry.full_name}"
-          elsif entry.full_name.length <= 0
-            puts "ERROR - file name length is too small: #{entry.full_name}"
-          else
-            puts "Extracting #{entry.full_name}"
-            input.extract_entry(to, entry)
-          end
-        }
-      end
-
       def compose
         # Write a docker-compose.yml with interpolated variables
         @compose_filename = compose_filename_from @build, @target
@@ -143,11 +122,21 @@ module Docker
         exec_compose 'ps'
       end
 
+      def exec_ps_all
+        puts "\n\nAll remaining containers..."
+        puts '-----------------------------'
+        exec 'docker ps -a'
+      end
+
       def exec_stop
         puts "\n\n\n\nStopping containers..."
         puts '-----------------------------'
-        @compose_config.each_key do |service_name|
-          stop(service_name)
+        containers = Docker::Container.all(all: true)
+        containers.each do |container|
+          if is_build_container?(container)
+            puts container.compose
+            container.stop
+          end
         end
         puts 'Done.'
       end
@@ -155,8 +144,14 @@ module Docker
       def exec_remove_volumes
         puts "\n\nRemoving container volumes..."
         puts '-----------------------------'
-        @compose_config.each_key do |service_name|
-          rm_v(service_name)
+
+        # 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)
+            puts container.compose
+            container.remove(v: true, force: true)
+          end
         end
         puts 'Done.'
       end
@@ -171,21 +166,21 @@ module Docker
         puts 'Done.'
       end
 
-      def show_all_containers
-        puts "\n\nAll remaining containers..."
-        puts '-----------------------------'
-        system 'docker ps -a'
-      end
-
       def exec_run(service_name, command)
         # Run the compose configuration
         exec_compose "run #{service_name} #{command}"
       end
 
       def exec_bash_connect(service_name)
-        # docker exec -it 222_db_1 bash
-        container_name = get_container_name(service_name)
-        exec "docker exec -it #{container_name} bash"
+        # docker exec -it 2ed97d0bb938 bash
+        container = get_container(service_name)
+        if container.nil?
+          puts "#{service_name} does not appear to be running for build #{@build}"
+          return
+        end
+
+        exec "docker exec -it #{container.id} bash"
+        container
       end
 
       # Create global gems data volume to cache gems for this version of ruby
@@ -220,46 +215,25 @@ module Docker
         exec("docker-compose -f #{@compose_filename} -p #{@build} #{cmd} #{options}", 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 get_container(service_name)
-        Docker::Container.get(get_container_name(service_name))
-      end
-
-      # def up_service(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
-      #
-      #   {service_name => {'container' => container, 'container_name' => container_name}}
-      # end
-
-      def rm_v(service_name)
-        exec_compose "rm -v --force #{service_name}"
-      end
+        containers = Docker::Container.all(all: true)
+        containers.each do |container|
+          if is_build_container?(container) && container.compose.service.eql?(service_name)
+            return container
+          end
+        end
 
-      def stop(service_name)
-        exec_compose "stop #{service_name}"
+        nil
       end
 
-      # def skip?(command)
-      #   skips = @config[:skip]
-      #   return false if skips.nil?
-      #   skip = skips.include? command.to_s
-      #   puts "Skipping #{command}" if skip && verbose?
-      #   skip
-      # end
+      def is_build_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
+        false
+      end
 
       def verbose?
         @verbose ||= (@config['verbose'] unless @config.nil?) || false
@@ -281,6 +255,30 @@ module Docker
       def compose_filename_from(build, target)
         "docker-compose-#{target}-#{build}.yml"
       end
+
+      def extract_files(container, from, to)
+        # or something like
+        tar_stringio = StringIO.new
+        container.copy(from) do |chunk|
+          tar_stringio.write(chunk)
+        end
+
+        tar_stringio.rewind
+
+        input = Archive::Tar::Minitar::Input.new(tar_stringio)
+        input.each { |entry|
+
+          # Need to check the file name length to prevent some very bad things from happening.
+          if entry.full_name.length > 255
+            puts "ERROR - file name length is > 255 characters: #{entry.full_name}"
+          elsif entry.full_name.length <= 0
+            puts "ERROR - file name length is too small: #{entry.full_name}"
+          else
+            puts "Extracting #{entry.full_name}"
+            input.extract_entry(to, entry)
+          end
+        }
+      end
     end
   end
 end

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

@@ -131,10 +131,10 @@ module Docker
         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.show_all_containers
+          App.instance.exec_ps_all
         end
 
-        desc 'bash_connect <target> <service_name>', 'Open a bash shell to a running container e.g. bundle exec docker-rails bash --build=222 development db'
+        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'
 
         def bash_connect(target, service_name)
           # init singleton with full options
@@ -142,7 +142,12 @@ module Docker
 
           invoke :compose, [target], []
 
-          app.exec_bash_connect(service_name)
+          container = app.exec_bash_connect(service_name)
+
+          # Automatically cleanup any remnants of a simple bash session.
+          return if container.nil?
+          container.stop
+          container.remove(v: true, force: true)
         end
 
 

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

@@ -0,0 +1,33 @@
+class Docker::Container
+
+  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
+
+    def initialize(container)
+      labels = container.info['Labels']
+      @service = labels['com.docker.compose.service']
+      @project = labels['com.docker.compose.project']
+      @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
+      def is_compose_container?(container)
+        labels = container.info['Labels']
+        (!labels.nil? && !labels['com.docker.compose.version'].nil?)
+      end
+    end
+  end
+end
+

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.4.1'
+    VERSION = '0.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,7 +162,8 @@ files:
 - lib/docker/rails/cli/main.rb
 - lib/docker/rails/compose_config.rb
 - lib/docker/rails/config.rb
-- lib/docker/rails/core_ext/hash.rb
+- lib/docker/rails/ext/container.rb
+- lib/docker/rails/ext/hash.rb
 - lib/docker/rails/version.rb
 - spec/docker/rails/config_spec.rb
 - spec/docker/rails/docker-rails.yml