rake_docker 1.3.0 → 1.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb1abf1d8f06ff0a3db7904ba0f40e2eab9b3ede5c80a9f1e423ed2a94ce3566
-  data.tar.gz: ebf39a86b4d844b08ba767b2724e63e7a33b3db0647fab3b2f166b3f9a58312f
+  metadata.gz: 650cab8353ed0ae26a7d47c29f2c55bd0ba38cb2c92812dcedaeb7df80e20c7d
+  data.tar.gz: ebc16ac740653db24905351ef8d159d4eed114ad962bbeb55eacecac345cfe94
 SHA512:
-  metadata.gz: 0d67f2476415a729b79584fc0d5650065412c12b5686ee027f414f33862e70f84ad2c2b5e8c3c5dadc9798d703a8d8ca44e30c54714f81ad97bf085fca6d89e2
-  data.tar.gz: dc371795298c6ae124665ddc2a6d6e99deceeba8edee012ae72a88c8e6e3a03e26daf77d93ebf3c54aa625bc6110891ce4f463fde0e49d1e15befc4df15172a8
+  metadata.gz: b3d7ee9204d7f5e93e5dd1f66f6524214cadebea69db46ce6ad067e5bc4158d584fcda5529712090cc4a8b3698e9c269b094e9748f3c7c04bd37a09dcaafcb40
+  data.tar.gz: 5f56e5d0166c7c679e1f14771e52c9ea3c4a93fa01eb06d8b5b637c9d909ec5c7e8ae301e993b92b58190bf36cd1502a296392988b0ea0d10fe916a0355e2da4

data/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: .
   specs:
-    rake_docker (1.3.0)
+    rake_docker (1.4.0.pre.1)
       aws-sdk-ecr (~> 1.2)
       colored2 (~> 3.1)
       docker-api (~> 1.34)
-      rake_factory (~> 0.17)
+      rake_factory (~> 0.23)
 
 GEM
   remote: https://rubygems.org/
@@ -16,13 +16,13 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     aws-eventstream (1.0.3)
-    aws-partitions (1.268.0)
-    aws-sdk-core (3.89.1)
+    aws-partitions (1.272.0)
+    aws-sdk-core (3.90.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ecr (1.24.0)
+    aws-sdk-ecr (1.25.0)
       aws-sdk-core (~> 3, >= 3.71.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
@@ -34,7 +34,7 @@ GEM
     docker-api (1.34.2)
       excon (>= 0.47.0)
       multi_json
-    excon (0.71.1)
+    excon (0.72.0)
     gem-release (2.1.1)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
@@ -44,8 +44,8 @@ GEM
     minitest (5.14.0)
     multi_json (1.14.1)
     rake (13.0.1)
-    rake_factory (0.17.0)
-      activesupport (~> 5.2)
+    rake_factory (0.23.0)
+      activesupport (>= 4)
       rake (~> 13.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)

data/lib/rake_docker/container.rb

@@ -0,0 +1,182 @@
+module RakeDocker
+  module Container
+    REPORTER_MESSAGES = [
+        :checking_if_container_exists,
+        :container_exists,
+        :container_does_not_exist,
+        :checking_if_image_available,
+        :image_available,
+        :image_not_available,
+        :pulling_image,
+        :image_pulled,
+        :creating_container,
+        :container_created,
+        :checking_if_container_running,
+        :container_running,
+        :container_not_running,
+        :starting_container,
+        :container_started,
+        :waiting_for_container_to_be_ready,
+        :container_ready,
+        :stopping_container,
+        :container_stopped,
+        :deleting_container,
+        :container_deleted,
+        :done
+    ]
+
+    class NullReporter
+      REPORTER_MESSAGES.each { |message| define_method(message) {} }
+    end
+
+    module Utilities
+      def find_container(name)
+        begin
+          Docker::Container.get(name)
+        rescue Docker::Error::NotFoundError
+          nil
+        end
+      end
+    end
+
+    class Provisioner
+      include Utilities
+
+      attr_reader :name, :image, :ports, :environment, :ready, :reporter
+
+      def initialize(name, image, opts = {})
+        @name = name
+        @image = image
+        @environment = opts[:environment] || {}
+        @ports = opts[:ports] || []
+        @ready = opts[:ready?]
+        @reporter = opts[:reporter] || NullReporter.new
+      end
+
+      def execute
+        reporter.checking_if_container_exists(name)
+        container = find_container(name)
+        if container
+          reporter.container_exists(container)
+          ensure_container_running(container)
+        else
+          reporter.container_does_not_exist(name)
+          ensure_image_available(image)
+          create_and_start_container(name, image, ports, environment)
+        end
+        reporter.done
+      end
+
+      private
+
+      def ensure_image_available(image)
+        reporter.checking_if_image_available(image)
+        matching_images = Docker::Image.all(filter: image)
+        if matching_images.empty?
+          reporter.image_not_available(image)
+          pull_image(image)
+        else
+          reporter.image_available(image)
+        end
+      end
+
+      def pull_image(image)
+        reporter.pulling_image(image)
+        Docker::Image.create(fromImage: image)
+        reporter.image_pulled(image)
+      end
+
+      def ensure_container_running(container)
+        reporter.checking_if_container_running(container)
+        container = Docker::Container.get(name)
+        if !container_running?(container)
+          reporter.container_not_running(container)
+          start_container(container)
+        else
+          reporter.container_running(container)
+        end
+      end
+
+      def create_and_start_container(name, image, ports, environment)
+        start_container(create_container(image, name, ports, environment))
+      end
+
+      def create_container(image, name, ports, environment)
+        exposed_ports, port_bindings = process_ports(ports)
+        reporter.creating_container(name, image)
+        container = Docker::Container.create(
+            name: name,
+            Image: image,
+            ExposedPorts: exposed_ports,
+            HostConfig: {
+                PortBindings: port_bindings
+            },
+            Env: environment)
+        reporter.container_created(container)
+        container
+      end
+
+      def start_container(container)
+        reporter.starting_container(container)
+        container.start
+        reporter.container_started(container)
+        if ready && ready.respond_to?(:call)
+          reporter.waiting_for_container_to_be_ready(container)
+          ready.call(container)
+          reporter.container_ready(container)
+        end
+        container
+      end
+
+      def container_running?(container)
+        container_status(container) == 'running'
+      end
+
+      def container_status(container)
+        container.json['State']['Status']
+      end
+
+      def process_ports(ports)
+        port_config = ports.reduce({
+            exposed_ports: {},
+            port_bindings: {}
+        }) do |accumulator, port|
+          host_port, container_port = port.split(':')
+          accumulator[:exposed_ports]["#{container_port}/tcp"] = {}
+          accumulator[:port_bindings]["#{container_port}/tcp"] =
+              [{:'HostPort' => host_port}]
+          accumulator
+        end
+        [port_config[:exposed_ports], port_config[:port_bindings]]
+      end
+    end
+
+    class Destroyer
+      include Utilities
+
+      attr_reader :name, :reporter
+
+      def initialize(name, opts = {})
+        @name = name
+        @reporter = opts[:reporter] || NullReporter.new
+      end
+
+      def execute
+        reporter.checking_if_container_exists(name)
+        container = find_container(name)
+        if container
+          reporter.container_exists(container)
+          reporter.stopping_container(container)
+          container.stop
+          reporter.container_stopped(container)
+          reporter.deleting_container(container)
+          container.delete
+          reporter.container_deleted(container)
+        else
+          reporter.container_does_not_exist(name)
+        end
+        reporter.done
+      end
+    end
+  end
+end

data/lib/rake_docker/kernel_extensions.rb

@@ -0,0 +1 @@
+require 'rake_factory/kernel_extensions'

data/lib/rake_docker/task_sets/container.rb

@@ -0,0 +1,31 @@
+require 'rake_factory'
+require 'docker'
+
+require_relative '../tasks'
+
+module RakeDocker
+  module TaskSets
+    class Container < RakeFactory::TaskSet
+      prepend RakeFactory::Namespaceable
+
+      parameter :container_name, required: true
+      parameter :image, required: true
+      parameter :ports
+      parameter :environment
+
+      parameter :ready_check
+
+      parameter :reporter
+
+      parameter :provision_task_name, default: :provision
+      parameter :destroy_task_name, default: :destroy
+
+      task Tasks::Provision, name: RakeFactory::DynamicValue.new { |ts|
+        ts.provision_task_name
+      }
+      task Tasks::Destroy, name: RakeFactory::DynamicValue.new { |ts|
+        ts.destroy_task_name
+      }
+    end
+  end
+end

data/lib/rake_docker/task_sets/{all.rb → image.rb}

@@ -5,7 +5,7 @@ require_relative '../tasks'
 
 module RakeDocker
   module TaskSets
-    class All < RakeFactory::TaskSet
+    class Image < RakeFactory::TaskSet
       prepend RakeFactory::Namespaceable
 
       parameter :image_name, required: true
@@ -32,12 +32,24 @@ module RakeDocker
       parameter :push_task_name, default: :push
       parameter :publish_task_name, default: :publish
 
-      task Tasks::Clean, name: ->(ts) { ts.clean_task_name }
-      task Tasks::Prepare, name: ->(ts) { ts.prepare_task_name }
-      task Tasks::Build, name: ->(ts) { ts.build_task_name }
-      task Tasks::Tag, name: ->(ts) { ts.tag_task_name }
-      task Tasks::Push, name: ->(ts) { ts.push_task_name }
-      task Tasks::Publish, name: ->(ts) { ts.publish_task_name }
+      task Tasks::Clean, name: RakeFactory::DynamicValue.new { |ts|
+        ts.clean_task_name
+      }
+      task Tasks::Prepare, name: RakeFactory::DynamicValue.new { |ts|
+        ts.prepare_task_name
+      }
+      task Tasks::Build, name: RakeFactory::DynamicValue.new { |ts|
+        ts.build_task_name
+      }
+      task Tasks::Tag, name: RakeFactory::DynamicValue.new { |ts|
+        ts.tag_task_name
+      }
+      task Tasks::Push, name: RakeFactory::DynamicValue.new { |ts|
+        ts.push_task_name
+      }
+      task Tasks::Publish, name: RakeFactory::DynamicValue.new { |ts|
+        ts.publish_task_name
+      }
     end
   end
 end

data/lib/rake_docker/task_sets.rb

@@ -1 +1,2 @@
-require_relative 'task_sets/all'
+require_relative 'task_sets/image'
+require_relative 'task_sets/container'

data/lib/rake_docker/tasks/build.rb

@@ -7,8 +7,10 @@ module RakeDocker
   module Tasks
     class Build < RakeFactory::Task
       default_name :build
-      default_description ->(t) { "Build #{t.image_name} image" }
-      default_prerequisites ->(t) {
+      default_description RakeFactory::DynamicValue.new { |t|
+        "Build #{t.image_name} image"
+      }
+      default_prerequisites RakeFactory::DynamicValue.new { |t|
         t.prepare_task_name ?
             [Rake.application.current_scope
                 .path_with_task_name(t.prepare_task_name)] :

data/lib/rake_docker/tasks/clean.rb

@@ -4,7 +4,7 @@ module RakeDocker
   module Tasks
     class Clean < RakeFactory::Task
       default_name :clean
-      default_description ->(t) {
+      default_description RakeFactory::DynamicValue.new { |t|
         "Clean #{t.image_name} image directory"
       }
 

data/lib/rake_docker/tasks/destroy.rb

@@ -0,0 +1,26 @@
+require 'rake_factory'
+
+require_relative '../container'
+
+module RakeDocker
+  module Tasks
+    class Destroy < RakeFactory::Task
+      default_name :destroy
+      default_description RakeFactory::DynamicValue.new { |t|
+        "Destroy #{t.container_name ? "#{t.container_name} " : ""}container."
+      }
+
+      parameter :container_name, :required => true
+
+      parameter :reporter, default: Container::NullReporter.new
+
+      action do |t|
+        puts "Destroying #{t.container_name} container"
+        destroyer = Container::Destroyer.new(
+            t.container_name,
+            reporter: t.reporter)
+        destroyer.execute
+      end
+    end
+  end
+end

data/lib/rake_docker/tasks/prepare.rb

@@ -4,7 +4,7 @@ module RakeDocker
   module Tasks
     class Prepare < RakeFactory::Task
       default_name :prepare
-      default_description ->(t) {
+      default_description RakeFactory::DynamicValue.new { |t|
         "Prepare for build of #{t.image_name} image"
       }
 

data/lib/rake_docker/tasks/provision.rb

@@ -0,0 +1,35 @@
+require 'rake_factory'
+
+require_relative '../container'
+
+module RakeDocker
+  module Tasks
+    class Provision < RakeFactory::Task
+      default_name :provision
+      default_description RakeFactory::DynamicValue.new { |t|
+        "Provision #{t.container_name ? "#{t.container_name} " : ""}container."
+      }
+
+      parameter :container_name, :required => true
+      parameter :image, :required => true
+      parameter :ports
+      parameter :environment
+
+      parameter :ready_check
+
+      parameter :reporter, default: Container::NullReporter.new
+
+      action do |t|
+        puts "Provisioning #{t.container_name} container"
+        provisioner = Container::Provisioner.new(
+            t.container_name,
+            t.image,
+            ports: t.ports,
+            environment: t.environment,
+            ready?: t.ready_check,
+            reporter: t.reporter)
+        provisioner.execute
+      end
+    end
+  end
+end

data/lib/rake_docker/tasks/publish.rb

@@ -4,7 +4,9 @@ module RakeDocker
   module Tasks
     class Publish < RakeFactory::Task
       default_name :publish
-      default_description ->(t) { "Publish #{t.image_name} image" }
+      default_description RakeFactory::DynamicValue.new { |t|
+        "Publish #{t.image_name} image"
+      }
 
       parameter :image_name
 

data/lib/rake_docker/tasks/push.rb

@@ -5,7 +5,7 @@ module RakeDocker
   module Tasks
     class Push < RakeFactory::Task
       default_name :push
-      default_description ->(t) {
+      default_description RakeFactory::DynamicValue.new { |t|
         "Push #{t.image_name} image to repository"
       }
 

data/lib/rake_docker/tasks/tag.rb

@@ -5,7 +5,7 @@ module RakeDocker
   module Tasks
     class Tag < RakeFactory::Task
       default_name :tag
-      default_description ->(t) {
+      default_description RakeFactory::DynamicValue.new { |t|
         "Tag #{t.image_name} image for repository"
       }
 

data/lib/rake_docker/tasks.rb

@@ -4,3 +4,5 @@ require_relative 'tasks/build'
 require_relative 'tasks/tag'
 require_relative 'tasks/push'
 require_relative 'tasks/publish'
+require_relative 'tasks/provision'
+require_relative 'tasks/destroy'

data/lib/rake_docker/version.rb

@@ -1,3 +1,3 @@
 module RakeDocker
-  VERSION = '1.3.0'
+  VERSION = '1.4.0.pre.1'
 end

data/lib/rake_docker.rb

@@ -1,5 +1,6 @@
 require 'rake_docker/version'
 require 'rake_docker/output'
+require 'rake_docker/container'
 require 'rake_docker/exceptions'
 require 'rake_docker/tasks'
 require 'rake_docker/task_sets'
@@ -7,6 +8,6 @@ require 'rake_docker/authentication'
 
 module RakeDocker
   def self.define_image_tasks(opts = {}, &block)
-    RakeDocker::TaskSets::All.define(opts, &block)
+    RakeDocker::TaskSets::Image.define(opts, &block)
   end
 end

data/rake_docker.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.6'
 
   spec.add_dependency 'docker-api', '~> 1.34'
-  spec.add_dependency 'rake_factory', '~> 0.17'
+  spec.add_dependency 'rake_factory', '~> 0.23'
   spec.add_dependency 'aws-sdk-ecr', '~> 1.2'
   spec.add_dependency 'colored2', '~> 3.1'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake_docker
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0.pre.1
 platform: ruby
 authors:
 - Toby Clemson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.23'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecr
   requirement: !ruby/object:Gem::Requirement
@@ -202,14 +202,19 @@ files:
 - lib/rake_docker.rb
 - lib/rake_docker/authentication.rb
 - lib/rake_docker/authentication/ecr.rb
+- lib/rake_docker/container.rb
 - lib/rake_docker/exceptions.rb
+- lib/rake_docker/kernel_extensions.rb
 - lib/rake_docker/output.rb
 - lib/rake_docker/task_sets.rb
-- lib/rake_docker/task_sets/all.rb
+- lib/rake_docker/task_sets/container.rb
+- lib/rake_docker/task_sets/image.rb
 - lib/rake_docker/tasks.rb
 - lib/rake_docker/tasks/build.rb
 - lib/rake_docker/tasks/clean.rb
+- lib/rake_docker/tasks/destroy.rb
 - lib/rake_docker/tasks/prepare.rb
+- lib/rake_docker/tasks/provision.rb
 - lib/rake_docker/tasks/publish.rb
 - lib/rake_docker/tasks/push.rb
 - lib/rake_docker/tasks/tag.rb
@@ -237,9 +242,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: