rake_docker 2.18.0.pre.3 → 2.18.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46278acb600e916d70c94a54563dd1174414b3f84d669dca1ada50727fc45779
-  data.tar.gz: 076cfa6dda33a6a215f88ea9a82f7e1d6ad3bb1654fa99c4b3c684c7d25344af
+  metadata.gz: 4a932921ad25b056f1a6511de649ac1d33001808f709a04f12e4b489da651f9c
+  data.tar.gz: d651071a7bf66207d7fd3f4746f845e6834d768e8710b78e2b0433bc92e0240e
 SHA512:
-  metadata.gz: 46b5aabf9ab0199f3bcb90aa09502182ca5ce4aafae7bd635657e5681e5019d24759e6dfd36c7f2ce91457292db23ba8405d8d8b103cb758d8ac93c1843c5365
-  data.tar.gz: 348a89a1159fe404bc61f151d61d99cb98649f7cfa9d64f96f9231c9d87e69f63349debd4abfcce2c84fd17a29d2b5113d7b379b17fe869dcae7754ed31728c1
+  metadata.gz: 6aa7afc73ba5467db5ef310f504a2700ac780db71c163fa472258acdaf161703cbb722ce2a40ed06d3749dc4eac7f0eba8c7506cdcfccb7116551d967850cd40
+  data.tar.gz: 5649029539578dceb8ffd07dc7e4f73bafd683477c0d4afdbaa3418b52bdb5bbedd3ccf20a44015b0faae584f1c667b57f4fd8fbd8fba9d0d3e26d14162a9978

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake_docker.gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_docker (2.18.0.pre.3)
+    rake_docker (2.18.0.pre.4)
       aws-sdk-ecr (~> 1.2)
       colored2 (~> 3.1)
       docker-api (>= 1.34, < 3.0)
@@ -17,14 +17,15 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.566.0)
+    aws-partitions (1.568.0)
     aws-sdk-core (3.130.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ecr (1.55.0)
+    aws-sdk-ecr (1.56.0)
       aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.4.0)
@@ -77,7 +78,11 @@ GEM
       faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
     public_suffix (4.0.6)
+    rainbow (3.1.1)
     rake (13.0.6)
     rake_circle_ci (0.9.0)
       colored2 (~> 3.1)
@@ -99,6 +104,8 @@ GEM
       colored2 (~> 3.1)
       rake_factory (~> 0.23)
       sshkey (~> 2.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -112,6 +119,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     ruby_gpg2 (0.8.0)
       lino (>= 1.5)
@@ -127,6 +150,7 @@ GEM
     sshkey (2.0.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -143,7 +167,10 @@ DEPENDENCIES
   rake_gpg
   rake_ssh
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   simplecov
 
 BUNDLED WITH
-   2.3.9
+   2.3.10

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'rake_circle_ci'
 require 'rake_github'
@@ -5,17 +7,20 @@ require 'rake_ssh'
 require 'rake_gpg'
 require 'securerandom'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task :default => :spec
-
-RSpec::Core::RakeTask.new(:spec)
+task default: %i[
+  library:fix
+  test:unit
+]
 
 namespace :encryption do
   namespace :passphrase do
+    desc 'Generate encryption passphrase for CI GPG key'
     task :generate do
-      File.open('config/secrets/ci/encryption.passphrase', 'w') do |f|
-        f.write(SecureRandom.base64(36))
-      end
+      FileUtils.mkdir_p('config/secrets/ci/')
+      File.write('config/secrets/ci/encryption.passphrase',
+                 SecureRandom.base64(36))
     end
   end
 end
@@ -23,85 +28,102 @@ end
 namespace :keys do
   namespace :deploy do
     RakeSSH.define_key_tasks(
-        path: 'config/secrets/ci/',
-        comment: 'maintainers@infrablocks.io')
+      path: 'config/secrets/ci/',
+      comment: 'maintainers@infrablocks.io'
+    )
   end
 
   namespace :gpg do
     RakeGPG.define_generate_key_task(
-        output_directory: 'config/secrets/ci',
-        name_prefix: 'gpg',
-        owner_name: 'InfraBlocks Maintainers',
-        owner_email: 'maintainers@infrablocks.io',
-        owner_comment: 'rake_docker CI Key')
+      output_directory: 'config/secrets/ci',
+      name_prefix: 'gpg',
+      owner_name: 'InfraBlocks Maintainers',
+      owner_email: 'maintainers@infrablocks.io',
+      owner_comment: 'rake_docker CI Key'
+    )
   end
 end
 
+RuboCop::RakeTask.new
+
+namespace :library do
+  desc 'Run all checks of the library'
+  task check: [:rubocop]
+
+  desc 'Attempt to automatically fix issues with the library'
+  task fix: [:'rubocop:auto_correct']
+end
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit)
+end
+
 RakeCircleCI.define_project_tasks(
-    namespace: :circle_ci,
-    project_slug: 'github/infrablocks/rake_docker'
+  namespace: :circle_ci,
+  project_slug: 'github/infrablocks/rake_docker'
 ) do |t|
   circle_ci_config =
-      YAML.load_file('config/secrets/circle_ci/config.yaml')
+    YAML.load_file('config/secrets/circle_ci/config.yaml')
 
-  t.api_token = circle_ci_config["circle_ci_api_token"]
+  t.api_token = circle_ci_config['circle_ci_api_token']
   t.environment_variables = {
-      ENCRYPTION_PASSPHRASE:
-          File.read('config/secrets/ci/encryption.passphrase')
-              .chomp
+    ENCRYPTION_PASSPHRASE:
+        File.read('config/secrets/ci/encryption.passphrase')
+            .chomp
   }
   t.checkout_keys = []
   t.ssh_keys = [
-      {
-          hostname: "github.com",
-          private_key: File.read('config/secrets/ci/ssh.private')
-      }
+    {
+      hostname: 'github.com',
+      private_key: File.read('config/secrets/ci/ssh.private')
+    }
   ]
 end
 
 RakeGithub.define_repository_tasks(
-    namespace: :github,
-    repository: 'infrablocks/rake_docker',
+  namespace: :github,
+  repository: 'infrablocks/rake_docker'
 ) do |t, args|
   github_config =
-      YAML.load_file('config/secrets/github/config.yaml')
+    YAML.load_file('config/secrets/github/config.yaml')
 
-  t.access_token = github_config["github_personal_access_token"]
+  t.access_token = github_config['github_personal_access_token']
   t.deploy_keys = [
-      {
-          title: 'CircleCI',
-          public_key: File.read('config/secrets/ci/ssh.public')
-      }
+    {
+      title: 'CircleCI',
+      public_key: File.read('config/secrets/ci/ssh.public')
+    }
   ]
   t.branch_name = args.branch_name
   t.commit_message = args.commit_message
 end
 
 namespace :pipeline do
-  task :prepare => [
-      :'circle_ci:project:follow',
-      :'circle_ci:env_vars:ensure',
-      :'circle_ci:checkout_keys:ensure',
-      :'circle_ci:ssh_keys:ensure',
-      :'github:deploy_keys:ensure'
+  desc 'Prepare CircleCI Pipeline'
+  task prepare: %i[
+    circle_ci:project:follow
+    circle_ci:env_vars:ensure
+    circle_ci:checkout_keys:ensure
+    circle_ci:ssh_keys:ensure
+    github:deploy_keys:ensure
   ]
 end
 
 namespace :version do
-  desc "Bump version for specified type (pre, major, minor, patch)"
+  desc 'Bump version for specified type (pre, major, minor, patch)'
   task :bump, [:type] do |_, args|
     bump_version_for(args.type)
   end
 end
 
-desc "Release gem"
+desc 'Release gem'
 task :release do
-  sh "gem release --tag --push"
+  sh 'gem release --tag --push'
 end
 
 def bump_version_for(version_type)
-  sh "gem bump --version #{version_type} " +
-      "&& bundle install " +
-      "&& export LAST_MESSAGE=\"$(git log -1 --pretty=%B)\" " +
-      "&& git commit -a --amend -m \"${LAST_MESSAGE} [ci skip]\""
+  sh "gem bump --version #{version_type} " \
+     '&& bundle install ' \
+     '&& export LAST_MESSAGE="$(git log -1 --pretty=%B)" ' \
+     '&& git commit -a --amend -m "${LAST_MESSAGE} [ci skip]"'
 end

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rake_docker"
+require 'bundler/setup'
+require 'rake_docker'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rake_docker"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/rake_docker/authentication/ecr.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-ecr'
-require 'ostruct'
 
 module RakeDocker
   module Authentication
     class ECR
-      def initialize &block
-        @config = OpenStruct.new(
-            region: nil,
-            registry_id: nil)
+      def initialize(&block)
+        @config =
+          Struct.new(:region, :registry_id)
+                .new(nil, nil)
         block.call(@config)
 
         @ecr_client = Aws::ECR::Client.new(region: @config.region)
@@ -18,23 +19,47 @@ module RakeDocker
       end
 
       def call
-        registry_id = @config.registry_id.respond_to?(:call) ?
-            @config.registry_id.call :
-            @config.registry_id
-
-        token_response = @ecr_client.get_authorization_token(
-            registry_ids: [registry_id])
-        token_data = token_response.authorization_data[0]
-        proxy_endpoint = token_data.proxy_endpoint
         email = 'none'
-        username, password =
-            Base64.decode64(token_data.authorization_token).split(':')
+        registry_id = resolve_registry_id
+        token = get_authorization_token(registry_id)
+        proxy_endpoint = extract_proxy_endpoint(token)
+        username, password = extract_credentials(token)
+
+        make_credentials_hash(email, password, username, proxy_endpoint)
+      end
 
+      private
+
+      def make_credentials_hash(email, password, username, proxy_endpoint)
         {
-            username: username, password: password, email: email,
-            serveraddress: proxy_endpoint
+          username: username,
+          password: password,
+          email: email,
+          serveraddress: proxy_endpoint
         }
       end
+
+      def resolve_registry_id
+        if @config.registry_id.respond_to?(:call)
+          @config.registry_id.call
+        else
+          @config.registry_id
+        end
+      end
+
+      def get_authorization_token(registry_id)
+        @ecr_client
+          .get_authorization_token(registry_ids: [registry_id])
+          .authorization_data[0]
+      end
+
+      def extract_proxy_endpoint(token)
+        token.proxy_endpoint
+      end
+
+      def extract_credentials(token)
+        Base64.decode64(token.authorization_token).split(':')
+      end
     end
   end
-end
+end

data/lib/rake_docker/authentication.rb

@@ -1 +1,3 @@
-require_relative 'authentication/ecr'
+# frozen_string_literal: true
+
+require_relative 'authentication/ecr'

data/lib/rake_docker/container.rb

@@ -1,34 +1,38 @@
+# frozen_string_literal: true
+
 require 'docker'
 
 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
-    ]
+    REPORTER_MESSAGES = %i[
+      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
+    ].freeze
 
     class NullReporter
-      REPORTER_MESSAGES.each { |message| define_method(message) { |*_| } }
+      REPORTER_MESSAGES.each do |message|
+        define_method(message, proc { |*_| })
+      end
     end
 
     class PrintingReporter
@@ -123,11 +127,9 @@ module RakeDocker
 
     module Utilities
       def find_container(name)
-        begin
-          enhance_with_name(Docker::Container.get(name), name)
-        rescue Docker::Error::NotFoundError
-          nil
-        end
+        enhance_with_name(Docker::Container.get(name), name)
+      rescue Docker::Error::NotFoundError
+        nil
       end
 
       def enhance_with_name(container, name)
@@ -138,6 +140,7 @@ module RakeDocker
       end
     end
 
+    # rubocop:disable Metrics/ClassLength
     class Provisioner
       include Utilities
 
@@ -152,6 +155,7 @@ module RakeDocker
         @reporter = opts[:reporter] || NullReporter.new
       end
 
+      # rubocop:disable Metrics/AbcSize
       def execute
         reporter.checking_if_container_exists(name)
         container = find_container(name)
@@ -160,14 +164,19 @@ module RakeDocker
           ensure_container_running(container)
         else
           reporter.container_does_not_exist(name)
-          ensure_image_available(image)
-          create_and_start_container(name, image, ports, environment)
+          start_new_container(name, image, ports, environment)
         end
         reporter.done
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
+      def start_new_container(name, image, ports, environment)
+        ensure_image_available(image)
+        create_and_start_container(name, image, ports, environment)
+      end
+
       def ensure_image_available(image)
         reporter.checking_if_image_available(image)
         matching_images = Docker::Image.all(filter: image)
@@ -188,11 +197,11 @@ module RakeDocker
       def ensure_container_running(container)
         reporter.checking_if_container_running(container)
         container = find_container(name)
-        if !container_running?(container)
+        if container_running?(container)
+          reporter.container_running(container)
+        else
           reporter.container_not_running(container)
           start_container(container)
-        else
-          reporter.container_running(container)
         end
       end
 
@@ -204,23 +213,32 @@ module RakeDocker
         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)
+          make_container_options(
+            name, image, exposed_ports, port_bindings, environment
+          )
+        )
         container = enhance_with_name(container, name)
         reporter.container_created(container)
         container
       end
 
+      def make_container_options(
+        name, image, exposed_ports, port_bindings, environment
+      )
+        {
+          name: name,
+          Image: image,
+          ExposedPorts: exposed_ports,
+          HostConfig: { PortBindings: port_bindings },
+          Env: environment
+        }
+      end
+
       def start_container(container)
         reporter.starting_container(container)
         container.start
         reporter.container_started(container)
-        if ready && ready.respond_to?(:call)
+        if ready.respond_to?(:call)
           reporter.waiting_for_container_to_be_ready(container)
           ready.call(container)
           reporter.container_ready(container)
@@ -237,19 +255,18 @@ module RakeDocker
       end
 
       def process_ports(ports)
-        port_config = ports.reduce({
-            exposed_ports: {},
-            port_bindings: {}
-        }) do |accumulator, port|
+        port_config = ports.each_with_object(
+          { exposed_ports: {}, port_bindings: {} }
+        ) do |port, accumulator|
           host_port, container_port = port.split(':')
           accumulator[:exposed_ports]["#{container_port}/tcp"] = {}
           accumulator[:port_bindings]["#{container_port}/tcp"] =
-              [{:'HostPort' => host_port}]
-          accumulator
+            [{ HostPort: host_port }]
         end
         [port_config[:exposed_ports], port_config[:port_bindings]]
       end
     end
+    # rubocop:enable Metrics/ClassLength
 
     class Destroyer
       include Utilities
@@ -266,18 +283,24 @@ module RakeDocker
         container = find_container(name)
         if container
           reporter.container_exists(container)
-          reporter.stopping_container(container)
-          container.stop
-          container.wait
-          reporter.container_stopped(container)
-          reporter.deleting_container(container)
-          container.delete
-          reporter.container_deleted(container)
+          destroy_container(container)
         else
           reporter.container_does_not_exist(name)
         end
         reporter.done
       end
+
+      private
+
+      def destroy_container(container)
+        reporter.stopping_container(container)
+        container.stop
+        container.wait
+        reporter.container_stopped(container)
+        reporter.deleting_container(container)
+        container.delete
+        reporter.container_deleted(container)
+      end
     end
   end
 end

data/lib/rake_docker/exceptions.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module RakeDocker
   class ImageNotFound < ::StandardError
   end
-end
+end

data/lib/rake_docker/kernel_extensions.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rake_factory/kernel_extensions'