docker-rails 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5253c80fa206c480db1e56b738ef2fbfe46733
-  data.tar.gz: 0c33db371899c5ec86ef344867ec5e5316f1116c
+  metadata.gz: e0366030b589abebd5315e8fbf308739ed751ab0
+  data.tar.gz: 13156b0a24820cfe5a5be649c6ae00e64a419983
 SHA512:
-  metadata.gz: 5fad7285f5e03e731e3fc382edc7b4ace5da6de9b65de221de1902f7969291509a85b9849fa328df43641f1a493166f9b2641e0137004ca60a09d06f0db6bfbe
-  data.tar.gz: 461bc62fac672e235fc63a2de848b11d2f6a2010f9a4549e160338e7df175e3eec318049fc9099531dced3683da074ee3f278e9d54275790b52e812c4d186187
+  metadata.gz: b6a2232fc2f1574603a87dc42a635a38bd9124b0c4749ad12060210ca499c6192b0d7106949f813963b7073002a345501f392358a5e2aacdedfa0792e751c458
+  data.tar.gz: c97c362d3a8bd2d67157375484902fcedf03e49913bede0d45a8fe7e56c459907103e276a89763c18df14d9ef15379781e4b886fc1ad0229cb1fb6f4e796b81d

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-  - 2.2.0
   - 2.2.2
+  - 2.2.3
   - ruby-head
   - jruby-head
 

data/README.md

@@ -9,7 +9,6 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 - DRY declarative `docker-rails.yml` allowing multiple environments to be defined with an inherited docker `compose` configuration
 - 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 gemset data volume (sets up GEM_HOME and `volumes_from` in all targeted containers)
 - 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)
@@ -28,7 +27,6 @@ CI, the reason this is built. Do it all, do it consistently, do it concurrently,
 
 1. `before_command` - run anything on the host prior to building the docker image e.g. `rm -Rf target`
 1. `compose` - create the resolved `docker-compose.yml`
-1. `gemset_volume create` - find or create the shared global gems volume for this ruby version
 1. `build` - `docker-compose build` the configuration
 1. `up` - `docker-compose up` the configuration
 1. `cleanup`
@@ -79,7 +77,6 @@ Commands:
   docker-rails compose <target>                        # Writes a resolved docker-compose.yml file e.g. docker-rails compose --build=222 test
   docker-rails db_check <db>                           # Runs db_check e.g. bundle exec docker-rails db_check mysql
   docker-rails exec <target> <service_name> <command>  # Run an arbitrary command on a given service container e.g. docker-rails exec --build=222 development db bash
-  docker-rails gemset_volume <command>                 # Gemset volume management e.g. docker-rails gemset_volume create
   docker-rails help [COMMAND]                          # Describe available commands or one specific command
   docker-rails ps <target>                             # List containers for the target compose configuration e.g. docker-rails ps --build=222 development
   docker-rails ps_all                                  # List all remaining containers regardless of state e.g. docker-rails ps_all
@@ -112,30 +109,7 @@ Or install it yourself as:
 ### 1. Add a Dockerfile
 
 ```bash
-FROM atlashealth/ruby:2.2.2
-
-ENV DEBIAN_FRONTEND noninteractive
-
-# For building, nokogiri support, capybara-webkit, mysql client
-# Clean up APT when done.
-RUN apt-get update -qq && \
-    apt-get install -qy build-essential libxml2-dev libxslt1-dev g++ qt5-default libqt5webkit5-dev xvfb libmysqlclient-dev && \
-
-    # cleanup
-    apt-get clean && \
-    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
-
-# 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
+FIXME
 ```
 
 ### 2. Add a docker-rails.yml
@@ -148,24 +122,16 @@ verbose: true
 exit_code: web
 before_command: bash -c "rm -Rf target && rm -Rf spec/dummy/log"
 
-# ---
-# create a global gemset to be shared amongst all ruby 2.2.2 containers.
-gemset:
-  name: 2.2.2
-  # setup GEM_HOME environment variable and `volumes_from` to mount the global gemset container
-  containers:
-    - web
-
 # ---
 # Declare a reusable extract set
 extractions: &extractions
   web:
     extract:
-      - '/project/target'
-      - '/project/vcr'
-      - '/project/spec/dummy/log:spec/dummy'
-      - '/project/tmp/parallel_runtime_cucumber.log:./tmp'
-      - '/project/tmp/parallel_runtime_rspec.log:./tmp'
+      - '/app/target'
+      - '/app/vcr'
+      - '/app/spec/dummy/log:spec/dummy'
+      - '/app/tmp/parallel_runtime_cucumber.log:./tmp'
+      - '/app/tmp/parallel_runtime_rspec.log:./tmp'
 
       
 # ---
@@ -181,7 +147,7 @@ elasticsearch: &elasticsearch
 compose:
   web:
     build: .
-    working_dir: /project/spec/dummy
+    working_dir: /app/spec/dummy
     ports:
       - "3000"
     links:

data/lib/docker/rails.rb

@@ -17,6 +17,5 @@ require 'docker/rails/compose_config'
 require 'docker/rails/app'
 
 require 'docker/rails/cli/db_check'
-require 'docker/rails/cli/gemset_volume'
 
 require 'docker/rails/cli/main'

data/lib/docker/rails/app.rb

@@ -37,6 +37,39 @@ module Docker
         @is_configured = true
       end
 
+      # Create a dockito vault container for serving private keys
+      #     https://github.com/dockito/vault
+      def create_dockito_vault
+        begin
+          Docker::Container.get(dockito_vault_name)
+          puts "Dockito vault container #{dockito_vault_name} already exists."
+        rescue Docker::Error::NotFoundError => e
+
+          # docker run --detach --name vault -p 14242:3000 -v ~/.ssh:/vault/.ssh dockito/vault:latest
+          exec "docker run --detach --name #{dockito_vault_name} -p 14242:3000 -v ~/.ssh:/vault/.ssh dockito/vault:latest"
+          puts "Dockito vault container #{dockito_vault_name} created."
+        end
+      end
+
+      def rm_dockito_vault
+        begin
+          container = Docker::Container.get(dockito_vault_name)
+          rm_v(container)
+        rescue Docker::Error::NotFoundError => e
+          puts "Dockito vault container #{dockito_vault_name} does not exist."
+        end
+      end
+
+      # FIXME this needs to by dynamic to this run?
+      def dockito_vault_name
+        'vault' #@config[:dockito][:vault][:name]
+      end
+
+      def dockito_vault_enabled?
+        @config[:dockito][:vault] || false
+      end
+
+
       def compose
         # Write a docker-compose.yml with interpolated variables
         @compose_filename = compose_filename_from project_name
@@ -118,7 +151,12 @@ module Docker
 
       def before_command
         before_command = @config['before_command']
-        (exec before_command unless before_command.nil?) #unless skip? :before_command
+        (exec before_command unless before_command.nil?)
+      end
+
+      def after_build_command
+        after_build_command = @config['after_build_command']
+        (exec after_build_command unless after_build_command.nil?)
       end
 
       def up(options = '')
@@ -191,6 +229,14 @@ module Docker
         puts 'Done.'
       end
 
+      def rm_exited
+        puts "\n\nCleaning up exited containers..."
+        puts '-----------------------------'
+
+        exec('docker rm -v $(docker ps -a -q -f status=exited)', false, true)
+        puts 'Done.'
+      end
+
       def run_service_command(service_name, command)
         # Run the compose configuration
         exec_compose("run #{service_name} #{command}", false, '', true)
@@ -208,28 +254,6 @@ module Docker
         container
       end
 
-      # Create global gems data volume to cache gems for this version of ruby
-      #     https://docs.docker.com/userguide/dockervolumes/
-      def create_gemset_volume
-        begin
-          Docker::Container.get(gemset_volume_name)
-          puts "Gem data volume container #{gemset_volume_name} already exists."
-        rescue Docker::Error::NotFoundError => e
-
-          exec "docker create -v #{gemset_volume_path} --name #{gemset_volume_name} busybox"
-          puts "Gem data volume container #{gemset_volume_name} created."
-        end
-      end
-
-      def rm_gemset_volume
-        begin
-          container = Docker::Container.get(gemset_volume_name)
-          rm_v(container)
-        rescue Docker::Error::NotFoundError => e
-          puts "Gem data volume container #{gemset_volume_name} does not exist."
-        end
-      end
-
       protected
 
       def exec(cmd, capture = false, ignore_errors = false)
@@ -244,7 +268,7 @@ module Docker
         output
       end
 
-      # convenience to execute docker-compose with file and project params
+# convenience to execute docker-compose with file and project params
       def exec_compose(cmd, capture = false, options = '', ignore_errors = false)
         # in the case of running a bash session, this file may dissappear, just make sure it is there.
         compose unless File.exists?(@compose_filename)
@@ -276,7 +300,7 @@ module Docker
         @verbose ||= (@config['verbose'] unless @config.nil?) || false
       end
 
-      # accessible so that we can delete patterns
+# accessible so that we can delete patterns
       def compose_filename_from(project_name)
         "docker-compose-#{project_name}.yml"
       end
@@ -323,7 +347,7 @@ module Docker
         kill(container)
       end
 
-      # kill container, progressively more forceful from -1, -9, then full Chuck Norris.
+# kill container, progressively more forceful from -1, -9, then full Chuck Norris.
       def kill(container)
         %w(SIGHUP SIGKILL SIGSTOP).each do |signal|
           if container.up?
@@ -345,14 +369,6 @@ module Docker
         container.remove(v: true, force: true)
       end
 
-      def gemset_volume_name
-        @config[:gemset][:volume][:name]
-      end
-
-      def gemset_volume_path
-        @config[:gemset][:volume][:path]
-      end
-
       def project_name
         @config[:project_name]
       end

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

@@ -9,9 +9,6 @@ module Docker
         desc 'db_check <db>', 'Runs db_check e.g. bundle exec docker-rails db_check mysql'
         subcommand 'db_check', Docker::Rails::CLI::DbCheck
 
-        desc 'gemset_volume <command>', 'Gemset volume management e.g. docker-rails gemset_volume create'
-        subcommand 'gemset_volume', Docker::Rails::CLI::GemsetVolume
-
         desc 'ci <target>', 'Execute the works, everything with cleanup included e.g. docker-rails ci --build=222 test'
         long_desc <<-D
 
@@ -26,7 +23,6 @@ module Docker
 
           invoke :before, [target], []
           invoke :compose, [target], []
-          invoke CLI::GemsetVolume, :create, [target], options
           begin
             invoke :build # on CI - always build to ensure dockerfile hasn't been altered - small price to pay for consistent CI.
             invoke :up
@@ -53,7 +49,7 @@ module Docker
           invoke :extract if options[:extract]
           invoke :rm_volumes
           invoke :rm_compose
-          invoke :rm_dangling
+          # invoke :rm_dangling # causes a brand new dockerfile build - don't do that. See https://github.com/alienfast/docker-rails/issues/26
           invoke :ps_all
         end
 
@@ -66,7 +62,6 @@ module Docker
           base_options = options.except(:detached)
 
           invoke :before, [target], base_options
-          invoke CLI::GemsetVolume, :create, [target], base_options
 
           if options[:detached]
             compose_options = '-d'
@@ -81,7 +76,14 @@ module Docker
 
         def build(target)
           invoke :compose
-          App.configured(target, options).compose_build
+          app = App.configured(target, options)
+          app.create_dockito_vault
+          begin
+            app.compose_build
+          ensure
+            app.rm_dockito_vault
+            app.after_build_command
+          end
         end
 
         desc 'compose <target>', 'Writes a resolved docker-compose.yml file e.g. docker-rails compose --build=222 test'
@@ -124,6 +126,12 @@ module Docker
           App.instance.rm_dangling
         end
 
+        desc 'rm_exited', 'Remove exited containers e.g. docker-rails rm_exited'
+
+        def rm_exited(build = nil, target = nil)
+          App.instance.rm_exited
+        end
+
         desc 'ps <target>', 'List containers for the target compose configuration e.g. docker-rails ps --build=222 development'
 
         def ps(target)
@@ -137,7 +145,7 @@ module Docker
           App.instance.ps_all
         end
 
-        desc 'bash_connect <target> <service_name>', 'Open a bash shell to a running container (with automatic cleanup) e.g. 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. docker-rails bash_connect --build=222 development db'
 
         def bash_connect(target, service_name)
           # init singleton with full options
@@ -160,7 +168,6 @@ module Docker
           app = App.configured(target, options)
 
           invoke :compose, [target], []
-          invoke CLI::GemsetVolume, :create, [target], []
 
           app.run_service_command(service_name, command)
         end

data/lib/docker/rails/config.rb

@@ -60,10 +60,6 @@ module Docker
         generated_defaults = {compose: {}}
         compose = generated_defaults[:compose]
 
-        # ----
-        # gemset volume
-        generate_gemset(compose, unpruned_config, generated_defaults, filenames)
-
         # now add the generated to the seeded default configuration
         @default_configuration.merge!(generated_defaults)
 
@@ -73,42 +69,6 @@ module Docker
         # finally, load the config as internal state
         super(environment, *filenames)
       end
-
-      protected
-
-      def generate_gemset(compose, unpruned_config, generated_defaults, filenames)
-        gemset = unpruned_config[:gemset]
-        raise "Expected to find 'gemset:' in #{filenames}" if gemset.nil?
-
-        gemset_name = gemset[:name]
-        raise "Expected to find 'gemset: name' in #{filenames}" if gemset_name.nil?
-
-        # add the generated gemset name/path to the generated defaults
-        gemset_volume_path = "/gemset/#{gemset_name}"
-        gemset_volume_name = "gemset-#{gemset_name}"
-
-        generated_defaults.deeper_merge!(gemset: gemset)
-        generated_defaults[:gemset].deeper_merge!({
-                                                      volume: {
-                                                          name: gemset_volume_name,
-                                                          path: gemset_volume_path
-                                                      }
-
-                                                  })
-
-        raise "Expected to find 'gemset: containers' with at least one entry" if gemset[:containers].nil? || gemset[:containers].length < 1
-        gemset[:containers].each do |container|
-          raise "Unknown container #{container}" if unpruned_config[:compose][container.to_sym].nil?
-          compose[container.to_sym] ||= {}
-          compose[container.to_sym].deeper_merge! ({
-                                                      environment: [
-                                                        "GEM_HOME=#{gemset_volume_path}",
-                                                        "BUNDLE_PATH=#{gemset_volume_path}",
-                                                      ],
-                                                      volumes_from: [gemset_volume_name]
-                                                  })
-        end
-      end
     end
   end
 end

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end
 end

data/spec/docker/rails/config_spec.rb

@@ -81,9 +81,9 @@ describe Docker::Rails::Config do
         compose_config
       }
 
-      it 'web should have gemset' do
-        expect(compose_config[:web][:environment]).to include('GEM_HOME=/gemset/2.2.2')
-        expect(compose_config[:web][:volumes_from]).to include('gemset-2.2.2')
+      it 'web should have env and wd' do
+        expect(compose_config[:web][:environment]).to include('RAILS_ENV=development')
+        expect(compose_config[:web][:working_dir]).to include('/app')
       end
     end
   end

data/spec/docker/rails/docker-rails.yml

@@ -2,53 +2,15 @@ verbose: true
 before_command: bash -c "rm -Rf target && rm -Rf log"
 exit_code: web
 
-# create a global gemset to be shared amongst all ruby 2.2.2 containers.
-gemset:
-  name: 2.2.2
-  # setup GEM_HOME environment variable and `volumes_from` to mount the global gemset container
-  containers:
-    - web
-
-# Generated:
-#compose:
-#  web:
-#    environment:
-#      # Tell bundler where to get the files
-#      - GEM_HOME=/gemset/2.2.2
-#
-#    volumes_from:
-#      # Mount the gems data volume container for cached bundler gem files
-#      - gemset-2.2.2
-
-
-# Make the host user's id_rsa key available to the web container e.g. for cloning from github
-ssh-agent:
-  containers:
-    - web
-  keys:
-    - id_rsa
-
-# Generated:
-#compose:
-#  web:
-#    environment:
-#      # make ssh keys available via ssh forwarding (see volume entry)
-#      - SSH_AUTH_SOCK=/ssh-agent/socket
-#
-#    volumes_from:
-#      # Use configured whilp/ssh-agent long running container for keys
-#      - ssh-agent
-
-
 # shared extractions
 extractions: &extractions
   web:
     extract:
-      - '/project/target'
-      - '/project/vcr'
-      - '/project/tmp/parallel_runtime_cucumber.log:./tmp'
-      - '/project/tmp/parallel_runtime_rspec.log:./tmp'
-      - '/project/log'
+      - '/app/target'
+      - '/app/vcr'
+      - '/app/tmp/parallel_runtime_cucumber.log:./tmp'
+      - '/app/tmp/parallel_runtime_rspec.log:./tmp'
+      - '/app/log'
 
 # local environments need elasticsearch, staging/production connects to existing running instance.
 elasticsearch: &elasticsearch
@@ -192,7 +154,7 @@ compose:
 
   web:
     build: .
-    working_dir: /project
+    working_dir: /app
     ports:
       - "3000"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,7 +158,6 @@ files:
 - lib/docker/rails.rb
 - lib/docker/rails/app.rb
 - lib/docker/rails/cli/db_check.rb
-- lib/docker/rails/cli/gemset_volume.rb
 - lib/docker/rails/cli/main.rb
 - lib/docker/rails/compose_config.rb
 - lib/docker/rails/config.rb
@@ -188,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: A simplified pattern to execute rails applications within Docker (with a

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

@@ -1,17 +0,0 @@
-module Docker
-  module Rails
-    module CLI
-      class GemsetVolume < Thor
-        desc 'create', 'Create a gemset volume'
-        def create(target = nil)
-          App.configured(target, options).create_gemset_volume
-        end
-
-        desc 'rm', 'Remove a gemset volume'
-        def rm(target = nil)
-          App.configured(target, options).rm_gemset_volume
-        end
-      end
-    end
-  end
-end