docker-rails 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52b6b65dc737230fe132456a384179de3a42a2c1
-  data.tar.gz: a8cae9865e9b9bc5dbceb954746e32a5b02708ac
+  metadata.gz: d26c8278640216cf598752f489b351eac1528b36
+  data.tar.gz: d6b8073a625aba9bf8a2e8363dc13f88e043b30e
 SHA512:
-  metadata.gz: 4e6c98d4b1bf72679aeb9a1002bb85b4e46434923202dd79ca9366695a4543f67a18e07f05629bdaeb5f3a29f6b261b43c56a0d32e718548252214bf398bfe06
-  data.tar.gz: aec9dd8c82ab3e4922c49b3ce862575463d412f15cf6800b191b9dfdb830bf44a450557fe3e9df5c05895abcd4356e28a5808a80cd3c7165519035f2d0524c62
+  metadata.gz: 968f011b7447d44c7f9d300256092f16bccd3d1cb76a374a56fa96f9e94c8e56e6471b7f49dd6731a167401c4012c4023ed7c0a21a1ee00923a486c158815276
+  data.tar.gz: bb4a69f2f43f141989b8cbea4ba678ed088d14769b2ec7f96248103dc7e43a291cd44b6f9ccdec4a19afa6ad0a45d22bb6711ea784c82737bb70eb092ab6ad12

data/README.md

@@ -7,7 +7,7 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 
 ## Features
 - DRY declarative `docker-rails.yml` allowing multiple environments to be defined with an inherited docker `compose` configuration
-- Provides individual convenience functions `up | bash | stop | cleanup` to easily work with target environment (even in a concurrent situation)
+- Provides individual convenience functions `up | bash | stop | extract | cleanup` to easily work with target environment (even in a concurrent situation)
 - Full workflow for CI usage with automated container, volume, and image cleanup.
 - Automated cached global gems data volume based on ruby version
 - Interpolates variables `docker-compose.yml` making CI builds much easier
@@ -103,6 +103,8 @@ RUN apt-get update -qq && \
     cd /var/lib/apt/lists && rm -fr *Release* *Sources* *Packages* && \
     truncate -s 0 /var/log/*log
 
+    COPY . /project # figure out/automate this as a volume instead https://github.com/alienfast/docker-rails/issues/14
+    
 # https://github.com/docker/docker/issues/4032
 ENV DEBIAN_FRONTEND newt
 ```
@@ -110,11 +112,20 @@ ENV DEBIAN_FRONTEND newt
 ### 2. Add a docker-rails.yml
 
 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 `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
+before_command: bash -c "rm -Rf target && rm -Rf spec/dummy/log"
 
+extractions: &extractions
+  web:
+    extract:
+      - '/project/target'
+      - '/project/vcr'
+      - '/project/tmp'
+      - '/project/spec/dummy/log:spec/dummy'
+      
 # local environments need elasticsearch, staging/production connects to existing running instance.
 elasticsearch: &elasticsearch
   elasticsearch:
@@ -157,7 +168,7 @@ development:
         "
 
 test:
-  before_command: rm -Rf target
+  <<: *extractions
   compose:
     <<: *elasticsearch
     web:
@@ -185,7 +196,7 @@ test:
         "
 
 parallel_tests:
-  before_command: rm -Rf target
+  <<: *extractions
   compose:
     <<: *elasticsearch
     web:
@@ -252,9 +263,6 @@ compose:
     links:
       - db
 
-    volumes:
-      - .:/project
-
     volumes_from:
       # Mount the gems data volume container for cached bundler gem files
       - #{DOCKER_RAILS_GEMS_VOLUME_NAME}

data/bin/docker-rails

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 
 # 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'
 

data/docker-rails.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_dependency 'docker-api'
   s.add_dependency 'dry-config', '>= 1.2.7'
   s.add_dependency 'thor'
+  s.add_dependency 'minitar'
 end

data/lib/docker/rails.rb

@@ -7,6 +7,7 @@ end
 
 require 'thor'
 require 'docker'
+require 'archive/tar/minitar'
 
 require 'docker/rails/core_ext/hash'
 

data/lib/docker/rails/app.rb

@@ -41,6 +41,66 @@ module Docker
         @is_configured || false
       end
 
+      def extract
+
+        # For each container, process extractions
+        #  Containers are defined in compose, extractions are defined at root under container name e.g.:
+        #     web:
+        #         extract:
+        #         - '<from_container>:<to_host>'
+        #         - '/project/target:.'
+        #         - '/project/vcr'      # same as extract to '.'
+        #         - '/project/tmp'
+        #         - '/project/spec/dummy/log:spec/dummy'
+        @compose_config.each_key do |service_name|
+          service_config = @config[service_name]
+          extractions = service_config[:extract] unless service_config.nil?
+          next if extractions.nil?
+
+          puts "Processing extract for #{service_name}:"
+          puts '---------------------------------'
+          container = get_container(service_name)
+          extractions.each do |extraction|
+            if extraction =~ /:/
+              tokens = extraction.split(':')
+              from = tokens[0]
+              to = tokens[1]
+            else
+              from = extraction
+              to = '.'
+            end
+
+            puts "\nExtracting #{service_name} #{from} to #{to}"
+            extract_files(container, from, to)
+          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
@@ -162,6 +222,10 @@ module Docker
         $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)

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

@@ -24,9 +24,9 @@ module Docker
           # init singleton with full options
           App.configured(target, options)
 
-          invoke :compose
+          invoke :before, [target], []
+          invoke :compose, [target], []
           invoke CLI::GemsVolume, :create, [target], options
-          invoke :before
           begin
             invoke :build # on CI - always build to ensure dockerfile hasn't been altered - small price to pay for consistent CI.
             invoke :up
@@ -35,9 +35,20 @@ module Docker
           end
         end
 
+        desc 'extract <target>', 'Invoke extractions', hide: true
+
+        def extract(target)
+          app = App.configured(target, options)
+          invoke :compose, [target], []
+          app.extract
+        end
+
         desc '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'
+        option :extract, aliases: ['-e'], type: :boolean, default: true, desc: 'Extract any directories defined in configuration.'
+
         def cleanup(target)
           invoke :stop
+          invoke :extract if options[:extract]
           invoke :rm_volumes
           invoke :rm_compose
           invoke :rm_dangling
@@ -45,7 +56,6 @@ module Docker
         end
 
         desc 'up <target>', 'Up the docker-compose configuration for the given build/target. Use -d for detached mode. e.g. bundle exec docker-rails up -d --build=222 test'
-
         option :detached, aliases: ['-d'], type: :boolean, desc: 'Detached mode: Run containers in the background'
 
         def up(target)
@@ -53,8 +63,8 @@ module Docker
           app = App.configured(target, options)
           base_options = options.except(:detached)
 
-          invoke CLI::GemsVolume, :create, [target], base_options
           invoke :before, [target], base_options
+          invoke CLI::GemsVolume, :create, [target], base_options
 
           compose_options = ''
           compose_options = '-d' if options[:detached]
@@ -79,8 +89,9 @@ module Docker
         desc 'before <target>', 'Invoke before_command', hide: true
 
         def before(target)
-          invoke :compose, [target]
-          App.configured(target, options).exec_before_command
+          app = App.configured(target, options)
+          invoke :compose, [target], []
+          app.exec_before_command
         end
 
 

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - kevin.ross@alienfast.com