ecs_deployer 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f39f6fb29ced22c5963b3de48db83c401289d556
-  data.tar.gz: 6088d0a59625590d39742ab54898427ca51150a7
+  metadata.gz: e60347cf25748e10ebd8fb31c60a16bcb7c744f0
+  data.tar.gz: 70df50d8c38bafe0637bc36baf59dff095faeb92
 SHA512:
-  metadata.gz: 33720d4303bc71e4b47ab5ee364513a323a3c847399e19ef3a6a734724a0d9bb43f193723e64b76516b81087e32a5c1f67524f7a92a853c2f82500abaf896371
-  data.tar.gz: adcea48cfb981cc8743105667bb48cdfb285e763ba84c40290d402c8aeb6283d296c0e86b14d69f41e57d7d9b53724c781bf0a3e163ef28828da75f91b5bcf62
+  metadata.gz: 96b2e854dc1c9dbf9a789ceba7e24fc97913fdaed3fdc54f85616e7fe159acaa44e63a9a3211a2961d911e744b7189683f29912fc9a36e859463f50da3aa6d77
+  data.tar.gz: 927248da5b5c2aaee7f92012455155fb6f3a8380ce28ae05b4afac6dc88e81d858b5b336e55296813f4f75bebf80893500c44eb827f24a1fa278bcfd26c73ebe

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+Style/Documentation:
+  Enabled: false
+Style/ExtraSpacing:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 20
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  CountComments: false
+  Max: 64
+Metrics/ModuleLength:
+  Enabled: false
+Security/YAMLLoad:
+  Enabled: false
+Style/SpaceAroundOperators:
+  Enabled: false

data/README.md

@@ -59,9 +59,11 @@ Encrypted values must be enclosed in `${XXX}`.
 
 Values are decrypted when task is created.
 
-## Usage (API)
+## Usage
 
-This sample file is in `example/fixtures/task.yml`.
+### API
+
+This sample file is in `spec/fixtures/task.yml`.
 
 ```
 ecs_deployer = EcsDeployer::Client.new
@@ -69,29 +71,29 @@ ecs_deployer.register_task('development.yml')
 ecs_deployer.update_service('cluster', 'development')
 ```
 
-## Usage (CLI)
+### CLI
 
-### Register a new task
+#### Register new task
 
 ```
 $ bundle exec ecs_deployer task-register --path=example/fixtures/task.yml
 ```
 
-### Encrypt environment value
+#### Encrypt environment value
 
 ```
 $ bundle exec ecs_deployer encrypt --master-key=master --value='test'
 Encrypted value: ${xxx}
 ```
 
-### Decrypt encironment value
+#### Decrypt encironment value
 
 ```
 $ bundle exec ecs_deployer decrypt --value='${xxx}'
 Decrypted value: xxx
 ```
 
-### Update a service
+#### Update service
 
 ```
 $ bundle exec ecs_deployer update-service --cluster=xxx --service=xxx --wait --timeout=600

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ecs_deployer"
+require 'bundler/setup'
+require 'ecs_deployer'
 
 # 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 +10,5 @@ require "ecs_deployer"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/ecs_deployer.gemspec

@@ -4,38 +4,40 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ecs_deployer/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ecs_deployer"
+  spec.name          = 'ecs_deployer'
   spec.version       = EcsDeployer::VERSION
-  spec.authors       = ["naomichi-y"]
-  spec.email         = ["n.yamakita@gmail.com"]
+  spec.authors       = ['naomichi-y']
+  spec.email         = ['n.yamakita@gmail.com']
 
-  spec.summary       = %q{Deploy application to ECS.}
-  spec.description   = %q{This package provides the service deployment function of ECS.}
-  spec.homepage      = "https://github.com/naomichi-y/ecs_deployer"
+  spec.summary       = 'Deploy application to ECS.'
+  spec.description   = 'This package provides the service deployment function of ECS.'
+  spec.homepage      = 'https://github.com/naomichi-y/ecs_deployer'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = ""
+    # spec.metadata['allowed_push_host'] = ''
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "runtime_command"
-  spec.add_dependency "oj"
-  spec.add_dependency "thor"
-  spec.add_dependency "aws-sdk"
-  spec.add_dependency "aws_config"
-  spec.add_dependency "json_spec"
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'runtime_command'
+  spec.add_dependency 'oj'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'aws_config'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'json_spec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
 end

data/example/sample.rb

@@ -5,4 +5,4 @@ path = File.expand_path('../spec/fixtures/task.yml', File.dirname(File.realpath(
 
 deployer = EcsDeployer::Client.new
 deployer.register_task(path)
-#deployer.update_service('sandbox', 'production')
+# deployer.update_service('sandbox', 'production')

data/lib/ecs_deployer/client.rb

@@ -2,9 +2,11 @@ require 'yaml'
 require 'oj'
 require 'aws-sdk'
 require 'runtime_command'
+require 'base64'
 
 module EcsDeployer
   class Client
+    LOG_SEPARATOR = '-' * 96
     PAULING_INTERVAL = 20
     DEPLOY_TIMEOUT = 600
     ENCRYPT_PATTERN = /^\${(.+)}$/
@@ -25,32 +27,29 @@ module EcsDeployer
     # @param [String] value
     # @return [String]
     def encrypt(master_key, value)
-      begin
-        encode = @kms.encrypt(key_id: "alias/#{master_key}", plaintext: value)
-        "${#{Base64.strict_encode64(encode.ciphertext_blob)}}"
-      rescue => e
-        raise KmsEncryptError.new(e.to_s)
-      end
+      encode = @kms.encrypt(key_id: "alias/#{master_key}", plaintext: value)
+      "${#{Base64.strict_encode64(encode.ciphertext_blob)}}"
+    rescue => e
+      raise KmsEncryptError, e.to_s
     end
 
     # @param [String] value
     # @return [String]
     def decrypt(value)
-      if match = value.match(ENCRYPT_PATTERN)
-        begin
-          @kms.decrypt(ciphertext_blob: Base64.strict_decode64(match[1])).plaintext
-        rescue => e
-          raise KmsDecryptError.new(e.to_s)
-        end
-      else
-        raise KmsDecryptError.new('Encrypted string is invalid.')
+      match = value.match(ENCRYPT_PATTERN)
+      raise KmsDecryptError, 'Encrypted string is invalid.' unless match
+
+      begin
+        @kms.decrypt(ciphertext_blob: Base64.strict_decode64(match[1])).plaintext
+      rescue => e
+        raise KmsDecryptError, e.to_s
       end
     end
 
     # @param [String] path
     # @return [String]
     def register_task(path)
-      raise IOError.new("File does not exist. [#{path}]") if !File.exist?(path)
+      raise IOError, "File does not exist. [#{path}]" unless File.exist?(path)
 
       register_task_hash(YAML.load(File.read(path)))
     end
@@ -61,11 +60,11 @@ module EcsDeployer
       task_definition = Oj.load(Oj.dump(task_definition), symbol_keys: true)
       decrypt_environment_variables!(task_definition)
 
-      result = @cli.register_task_definition({
+      result = @cli.register_task_definition(
         container_definitions: task_definition[:container_definitions],
         family: task_definition[:family],
         task_role_arn: task_definition[:task_role_arn]
-      })
+      )
 
       @family = result[:task_definition][:family]
       @revision = result[:task_definition][:revision]
@@ -78,23 +77,23 @@ module EcsDeployer
     def register_clone_task(cluster, service)
       detected_service = false
 
-      result = @cli.describe_services({
+      result = @cli.describe_services(
         cluster: cluster,
         services: [service]
-      })
+      )
 
       result[:services].each do |svc|
-        if svc[:service_name] == service
-          result = @cli.describe_task_definition({
-            task_definition: svc[:task_definition]
-          })
-          @new_task_definition_arn = register_task_hash(result[:task_definition].to_hash)
-          detected_service = true
-          break
-        end
+        next unless svc[:service_name] == service
+
+        result = @cli.describe_task_definition(
+          task_definition: svc[:task_definition]
+        )
+        @new_task_definition_arn = register_task_hash(result[:task_definition].to_hash)
+        detected_service = true
+        break
       end
 
-      raise ServiceNotFoundError.new("'#{service}' service is not found.") unless detected_service
+      raise ServiceNotFoundError, "'#{service}' service is not found." unless detected_service
 
       @new_task_definition_arn
     end
@@ -106,101 +105,118 @@ module EcsDeployer
     def update_service(cluster, service, wait = true, timeout = DEPLOY_TIMEOUT)
       register_clone_task(cluster, service) if @new_task_definition_arn.nil?
 
-      result = @cli.update_service({
+      result = @cli.update_service(
         cluster: cluster,
         service: service,
         task_definition: @family + ':' + @revision.to_s
-      })
+      )
       wait_for_deploy(cluster, service, timeout) if wait
       result.service.service_arn
     end
 
     private
+
     # @param [Hash] task_definition
     def decrypt_environment_variables!(task_definition)
-      raise TaskDefinitionValidateError.new('\'container_definition\' is undefined.') unless task_definition.has_key?(:container_definitions)
+      raise TaskDefinitionValidateError, '\'container_definition\' is undefined.' unless task_definition.key?(:container_definitions)
       task_definition[:container_definitions].each do |container_definition|
-        next unless container_definition.has_key?(:environment)
+        next unless container_definition.key?(:environment)
 
         container_definition[:environment].each do |environment|
-          if match = environment[:value].match(ENCRYPT_PATTERN)
-            environment[:value] = decrypt(match[0])
-          end
+          match = environment[:value].match(ENCRYPT_PATTERN)
+          environment[:value] = decrypt(match[0]) if match
         end
       end
     end
 
     # @param [String] cluster
     # @param [String] service
-    # @param [Fixnum] timeout
-    def wait_for_deploy(cluster, service, timeout)
-      detected_service = false
-
-      result = @cli.describe_services({
+    # @return [Aws::ECS::Types::Service]
+    def service_status(cluster, service)
+      status = nil
+      result = @cli.describe_services(
         cluster: cluster,
         services: [service]
-      })
+      )
       result[:services].each do |svc|
         next unless svc[:service_name] == service
-        detected_service = true
+        status = svc
+        break
+      end
 
-        result = @cli.describe_task_definition({
-          task_definition: svc[:task_definition]
-        })
-
-        if svc[:desired_count] > 0
-          running_new_task = false
-          wait_time = 0
-          @command.puts 'Start deploing...'
-
-          begin
-            sleep(PAULING_INTERVAL)
-            wait_time += PAULING_INTERVAL
-
-            # Get current tasks
-            result = @cli.list_tasks({
-              cluster: cluster,
-              service_name: service,
-              desired_status: 'RUNNING'
-            })
-
-            raise TaskNotFoundError.new('Desired count is 0.') if result[:task_arns].size == 0
-
-            new_running_count = 0
-            result = @cli.describe_tasks({
-              tasks: result[:task_arns],
-              cluster: cluster
-            })
-
-            result[:tasks].each do |task|
-              new_running_count += 1 if @new_task_definition_arn == task[:task_definition_arn]
-            end
-
-            current_running_count = result[:tasks].size
-
-            if current_running_count == new_running_count
-              @command.puts "Service update succeeded. [#{new_running_count}/#{current_running_count}]"
-              @command.puts "New task definition: #{@new_task_definition_arn}"
-
-              running_new_task = true
-
-            else
-              @command.puts "Deploying... [#{new_running_count}/#{current_running_count}] (#{wait_time} seconds elapsed)"
-              @command.puts "New task: #{@new_task_definition_arn}"
-              @command.puts 'You can stop process with Ctrl+C. Deployment will continue.'
-
-              if wait_time > timeout
-                @command.puts "New task definition: #{@new_task_definition_arn}"
-                raise DeployTimeoutError.new('Service is being updating, but process is timed out.')
-              end
-            end
-          end while !running_new_task
-        end
+      raise ServiceNotFoundError, "'#{service}' service is not found." if status.nil?
 
-        break
+      status
+    end
+
+    # @param [String] cluster
+    # @param [String] service
+    # @return [Hash]
+    def deploy_status(cluster, service)
+      # Get current tasks
+      result = @cli.list_tasks(
+        cluster: cluster,
+        service_name: service,
+        desired_status: 'RUNNING'
+      )
+
+      raise TaskRunningError, 'Running task not found.' if result[:task_arns].size.zero?
+
+      result = @cli.describe_tasks(
+        cluster: cluster,
+        tasks: result[:task_arns]
+      )
+
+      new_running_count = 0
+      task_status_logs = ''
+
+      result[:tasks].each do |task|
+        new_running_count += 1 if @new_task_definition_arn == task[:task_definition_arn]
+        task_status_logs << "  #{task[:task_definition_arn]} [#{task[:last_status]}]\n"
       end
 
-      raise ServiceNotFoundError.new("'#{service}' service is not found.") unless detected_service
+      {
+        current_running_count: result[:tasks].size,
+        new_running_count: new_running_count,
+        task_status_logs: task_status_logs
+      }
+    end
+
+    # @param [String] cluster
+    # @param [String] service
+    # @param [Fixnum] timeout
+    def wait_for_deploy(cluster, service, timeout)
+      service_status = service_status(cluster, service)
+      raise TaskDesiredError, 'Task desired by service is 0.' if service_status[:desired_count].zero?
+
+      wait_time = 0
+      @command.puts 'Start deploing...'
+
+      loop do
+        sleep(PAULING_INTERVAL)
+        wait_time += PAULING_INTERVAL
+        result = deploy_status(cluster, service)
+
+        if result[:new_running_count] == result[:current_running_count]
+          @command.puts "Service update succeeded. [#{result[:new_running_count]}/#{result[:current_running_count]}]"
+          @command.puts "New task definition: #{@new_task_definition_arn}"
+
+          break
+
+        else
+          @command.puts "Deploying... [#{result[:new_running_count]}/#{result[:current_running_count]}] (#{wait_time} seconds elapsed)"
+          @command.puts "New task: #{@new_task_definition_arn}"
+          @command.puts LOG_SEPARATOR
+          @command.puts result[:task_status_logs]
+          @command.puts LOG_SEPARATOR
+          @command.puts 'You can stop process with Ctrl+C. Deployment will continue.'
+
+          if wait_time > timeout
+            @command.puts "New task definition: #{@new_task_definition_arn}"
+            raise DeployTimeoutError, 'Service is being updating, but process is timed out.'
+          end
+        end
+      end
     end
   end
 end

data/lib/ecs_deployer/version.rb

@@ -1,3 +1,3 @@
 module EcsDeployer
-  VERSION = "0.1.11"
+  VERSION = '0.1.12'.freeze
 end

data/lib/ecs_deployer.rb

@@ -5,8 +5,9 @@ require 'ecs_deployer/cli'
 
 module EcsDeployer
   class ServiceNotFoundError < EcsDeployer::Error; end
-  class TaskNotFoundError < EcsDeployer::Error; end
+  class TaskRunningError < EcsDeployer::Error; end
   class TaskDefinitionValidateError < EcsDeployer::Error; end
+  class TaskDesiredError < EcsDeployer::Error; end
   class KmsEncryptError < EcsDeployer::Error; end
   class KmsDecryptError < EcsDeployer::Error; end
   class DeployTimeoutError < EcsDeployer::Error; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_deployer
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - naomichi-y
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-13 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runtime_command
@@ -80,34 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: json_spec
-  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +122,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This package provides the service deployment function of ECS.
 email:
 - n.yamakita@gmail.com
@@ -146,7 +174,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - Gemfile
 - README.md
 - Rakefile

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.14.5