docker-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 796f9a53d45a20066b265a383d0e649c69f3a870
-  data.tar.gz: c265056920b6b21936b3726b780ceb08b28875b3
+  metadata.gz: 624744c054f732376d581da291aa2a1130e2a95b
+  data.tar.gz: c764f8d565d3ec58200ca31a67164bf6391001f3
 SHA512:
-  metadata.gz: 880934be3caa2524812e4ddf8a18f089cf1333473549c59b49919fd4917912ddc27a93a1fbada92d5b3d5d03c33606163260bfaed647a19817fd50503fb82f0f
-  data.tar.gz: e8c352b19260fc47ace95a562f66a72d43df67dd622f83a50cd23f605e668bd23097a93d713a3cda9d6db242c2957c8d7235e193e21411a4873e874e3f4ad782
+  metadata.gz: b5b11391ff8287cb3b213e19c60d4932eaf613ecb9e03cf24617940e4a5ae339b607e1b5f73a804810930be60efd41a1d45aee3c76b674dda3218b5926e14b48
+  data.tar.gz: 0727cd30a851867474794b0556f8c0064d5d8a79222aa903783a4948813595d84af8c3e741eca15feda654138f93564cfe6fc44af2bd3a05712e6cbf52109320

data/README.md

@@ -15,25 +15,50 @@ A simplified pattern to execute rails applications within Docker (with a CI buil
 
 ## Usage
 
+### CI
+
+CI, the reason this is built. Do it all, do it consistently, do it concurrently, do it easily, and always cleanup after yourself.
+  
+```bash
+bundle exec docker-rails ci --build=222 test
+```
+  
+or with the environment variable option
+
+```bash
+DOCKER_RAILS_BUILD=222 bundle exec docker-rails ci test
+```
+
+or for local testing (uses `1` for build)
+ 
+```bash
+ bundle exec docker-rails ci test
+ ```
+
+### General CLI
+
+Almost all of the commands below are in support of the `ci` command, so why not give access directly to them. Helpful additions include `bash_connect` to connect to a running container and `exec` the equivalent of `docker-compose run` (but thor complained and we can't use reserverd word `run`)
+
 ```bash
 Commands:
-  docker-rails bash <target> <service_name>  # Open a bash shell to a running container e.g. bundle exec docker-rails bash --build=222 development db
-  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
-  docker-rails compose <target>              # Writes a resolved docker-compose.yml file e.g. bundle exec 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 gems_volume <command>         # Gems volume management e.g. bundle exec docker-rails gems_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. bundle exec docker-rails ps --build=222 development
-  docker-rails ps_all                        # List all remaining containers regardless of state e.g. bundle exec docker-rails ps_all
-  docker-rails rm_compose                    # Remove generated docker_compose file e.g. bundle exec docker-rails rm_compose --build=222 development
-  docker-rails rm_dangling                   # Remove danging images e.g. bundle exec docker-rails rm_dangling
-  docker-rails 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
-  docker-rails stop <target>                 # Stop all running containers for the given build/target e.g. bundle exec docker-rails stop --build=222 development
-  docker-rails 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
+  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 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
+  docker-rails compose <target>                        # Writes a resolved docker-compose.yml file e.g. bundle exec 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. bundle exec docker-rails exec --build=222 development db bash
+  docker-rails gems_volume <command>                   # Gems volume management e.g. bundle exec docker-rails gems_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. bundle exec docker-rails ps --build=222 development
+  docker-rails ps_all                                  # List all remaining containers regardless of state e.g. bundle exec docker-rails ps_all
+  docker-rails rm_dangling                             # Remove danging images e.g. bundle exec docker-rails rm_dangling
+  docker-rails 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
+  docker-rails stop <target>                           # Stop all running containers for the given build/target e.g. bundle exec docker-rails stop --build=222 development
+  docker-rails 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
 
 Options:
-  -b, [--build=BUILD]  # Build name e.g. 123
+  -b, [--build=BUILD]  # Build name e.g. 123.  Can also be specified as environment variable DOCKER_RAILS_BUILD
                        # Default: 1
 ```
 

data/docker-rails.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'activerecord'
 
   s.add_dependency 'docker-api'
-  s.add_dependency 'dry-config', '>= 1.2.6'
+  s.add_dependency 'dry-config', '>= 1.2.7'
   s.add_dependency 'thor'
 end

data/lib/docker/rails/app.rb

@@ -23,7 +23,11 @@ module Docker
       end
 
       def configure(options)
-        ENV['DOCKER_RAILS_BUILD'] = @build = options[:build]
+        # 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]
 
         # load the docker-rails.yml
@@ -64,6 +68,11 @@ module Docker
         exec_compose 'up', false, options #unless skip? :up
       end
 
+      def exec_build
+        # Run the compose configuration
+        exec_compose 'build'
+      end
+
       def exec_ps
         # Run the compose configuration
         exec_compose 'ps'
@@ -75,7 +84,7 @@ module Docker
         @compose_config.each_key do |service_name|
           stop(service_name)
         end
-        # puts "\nDone."
+        puts 'Done.'
       end
 
       def exec_remove_volumes
@@ -84,14 +93,17 @@ module Docker
         @compose_config.each_key do |service_name|
           rm_v(service_name)
         end
-        # puts "\nDone."
+        puts 'Done.'
       end
 
       def rm_dangling
         puts "\n\nCleaning up dangling images..."
         puts '-----------------------------'
-        exec 'docker images --filter dangling=true -q | xargs docker rmi'
-        # puts "\nDone."
+
+        list_images_cmd = 'docker images --filter dangling=true -q'
+        output = exec list_images_cmd, true
+        exec "#{list_images_cmd} | xargs docker rmi" if !output.nil? && output.length > 0
+        puts 'Done.'
       end
 
       def show_all_containers
@@ -100,7 +112,12 @@ module Docker
         system 'docker ps -a'
       end
 
-      def exec_bash(service_name)
+      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"

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

@@ -4,7 +4,7 @@ module Docker
       class Main < Thor
         # default_task :help
 
-        class_option :build, aliases: ['-b'], type: :string, desc: 'Build name e.g. 123', default: '1'
+        class_option :build, aliases: ['-b'], type: :string, desc: 'Build name e.g. 123.  Can also be specified as environment variable DOCKER_RAILS_BUILD', default: '1'
 
         desc 'db_check <db>', 'Runs db_check e.g. bundle exec docker-rails db_check mysql'
         subcommand 'db_check', Docker::Rails::CLI::DbCheck
@@ -28,6 +28,7 @@ module Docker
           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
           ensure
             invoke :cleanup
@@ -61,6 +62,14 @@ module Docker
           app.exec_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
+        end
+
+
         desc 'compose <target>', 'Writes a resolved docker-compose.yml file e.g. bundle exec docker-rails compose --build=222 test'
 
         def compose(target)
@@ -89,7 +98,7 @@ module Docker
           App.configured(target, options).exec_remove_volumes
         end
 
-        desc 'rm_compose', 'Remove generated docker_compose file e.g. bundle exec docker-rails rm_compose --build=222 development'
+        desc 'rm_compose', 'Remove generated docker_compose file e.g. bundle exec docker-rails rm_compose --build=222 development', hide: true
 
         def rm_compose(build = nil, target = nil)
           App.instance.rm_compose
@@ -114,15 +123,27 @@ module Docker
           App.instance.show_all_containers
         end
 
-        desc 'bash <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 e.g. bundle exec docker-rails bash --build=222 development db'
+
+        def bash_connect(target, service_name)
+          # init singleton with full options
+          app = App.configured(target, options)
+
+          invoke :compose, [target], []
+
+          app.exec_bash_connect(service_name)
+        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 bash(target, service_name)
+        def exec(target, service_name, command)
           # init singleton with full options
           app = App.configured(target, options)
 
           invoke :compose, [target], []
 
-          app.exec_bash(service_name)
+          app.exec_run(service_name, command)
         end
 
 

data/lib/docker/rails/config.rb

@@ -13,16 +13,21 @@ module Docker
       end
 
       def load!(environment, *filenames)
-        if environment.nil?
-          puts 'Environment unspecified, generating docker-compose.yml based on root :compose yaml key.'
-          environment = 'docker-compose'
-        end
 
+        # reject nil target environments
+        raise 'Target environment unspecified.' if environment.nil?
+
+        # default the filename if unspecified
         if filenames.empty?
           puts 'Using docker-rails.yml'
           filenames = ['docker-rails.yml']
         end
 
+        # reject unknown target environments
+        config = load_unpruned(environment, *filenames)
+        raise "Unknown target environment '#{environment.to_sym}'" if config[environment.to_sym].nil?
+
+        # finally, load the config as internal state
         super(environment, *filenames)
       end
 

data/lib/docker/rails/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Rails
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/docker/rails/config_spec.rb

@@ -19,22 +19,28 @@ describe Docker::Rails::Config do
     expect(config.production).to be_nil
   end
 
-  it 'should read default env and file' do
-    Dir.chdir(File.dirname(__FILE__)) do
-      config.clear
-      config.load!(nil)
-    end
-
-    assert_common_top_level_settings
+  it 'should fail if the target environment does not exist' do
+    expect {
+      Dir.chdir(File.dirname(__FILE__)) do
+        config.clear
+        config.load!(:foo)
+      end
+    }.to raise_error /Unknown target environment/
+  end
 
-    # ensure no unnecessary environments make it into the resolved configuration
-    expect(config.development).to be_nil
-    expect(config.production).to be_nil
+  it 'should fail if the target environment is nil' do
+    expect {
+      Dir.chdir(File.dirname(__FILE__)) do
+        config.clear
+        config.load!(nil)
+      end
+    }.to raise_error /Target environment unspecified/
   end
 
+
   context ':development' do
 
-    before(:each){
+    before(:each) {
       Dir.chdir(File.dirname(__FILE__)) do
         config.clear
         config.load!(:development)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-18 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: 1.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: 1.2.7
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement