ecs_deployer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5923a19be9af0b8b94e8a3a15ba3ef0f47c97321
+  data.tar.gz: 7fad5d15dde84e2320427e7ac17dec3461037be0
+SHA512:
+  metadata.gz: 43e7796ee3372669de2c36041ee6a71e0f33a3d9ad24c29adda8f5c601d2b429f0cab8909e0c51c0a8b6a905d2affe13f6ef859c153eacfb2d64b1217474b287
+  data.tar.gz: 99d51da9894390e8db85e2bae8fd107f274c4e3da365b29674afbe3c1990ef8e7e936f45641e91f60a57c153da4eb64f0a50d90db4cd691e747c5f16b3bcb1ae

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ecs_deployer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# EcsDeployer
+
+This package provides the service deployment function of ECS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecs_deployer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecs_deployer
+
+## Usage
+
+```
+ecs_deployer = EcsDeployer::Client.new('cluster_name')
+ecs_deployer.register_task('development.yml')
+ecs_deployer.update_service('application')
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ecs_deployer.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ecs_deployer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecs_deployer"
+  spec.version       = EcsDeployer::VERSION
+  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      = ""
+
+  # 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'] = ""
+  else
+    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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'runtime_command'
+  spec.add_dependency 'oj'
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/example/fixtures/task.yml

@@ -0,0 +1,20 @@
+containerDefinitions:
+- name: wordpress
+  links:
+  - mysql
+  image: wordpress
+  essential: true
+  portMappings:
+  - containerPort: 80
+    hostPort: 80
+  memory: 500
+  cpu: 10
+- environment:
+  - name: MYSQL_ROOT_PASSWORD
+    value: password
+  name: mysql
+  image: mysql
+  cpu: 10
+  memory: 500
+  essential: true
+family: hello_world

data/example/sample.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'ecs_deployer'
+
+task_path = File.expand_path('./fixtures/task.yml', File.dirname(File.realpath(__FILE__)))
+
+ecs_deployer = EcsDeployer::Client.new('cluster_name')
+ecs_deployer.register_task(task_path)
+ecs_deployer.update_service('application')

data/lib/ecs_deployer/client.rb

@@ -0,0 +1,128 @@
+require 'yaml'
+require 'runtime_command'
+require 'ecs_deployer/commander'
+
+module EcsDeployer
+  class Client
+    PAULING_INTERVAL = 20
+
+    # @param [String] cluster_name
+    # @param [Hash] options
+    # @option options [String] :profile
+    # @option options [String] :region
+    # @return [EcsDeployer::Client]
+    def initialize(cluster_name, options = {})
+      @cluster_name = cluster_name
+      @ecs_command = Commander.new(cluster_name, options)
+      @family_name = ''
+      @revision = ''
+      @new_task_definition_arn = ''
+    end
+
+    # @param [String] task_path
+    # @return [String]
+    def register_task(task_path)
+      raise IOError.new("File does not exist. [#{task_path}]") if !File.exist?(task_path)
+      register_task_process(YAML.load(File.read(task_path)))
+    end
+
+    # @param [String] service_name
+    # @return [String]
+    def register_clone_task(service_name)
+      detected_service = false
+
+      result = @ecs_command.describe_services(service_name)
+      result['services'].each do |service|
+        if service['serviceName'] == service_name
+          result = @ecs_command.describe_task_definition(service['taskDefinition'])
+          @new_task_definition_arn = register_task_process(result['taskDefinition'])
+          detected_service = true
+          break
+        end
+      end
+
+      raise ServiceNotFoundError.new("'#{service_name}' service is not found.") unless detected_service
+
+      @new_task_definition_arn
+    end
+
+    # @param [String] service_name
+    # @param [Fixnum] timeout
+    def update_service(service_name, wait = true, timeout = 300)
+      register_clone_task(service_name) if @new_task_definition_arn.empty?
+      @ecs_command.update_service(service_name, @family_name, @revision)
+      wait_for_deploy if wait
+    end
+
+    private
+    def wait_for_deploy(service_name, timeout)
+      detected_service = false
+
+      result = @ecs_command.describe_services(service_name)
+      result['services'].each do |service|
+        next unless service['serviceName'] == service_name
+        detected_service = true
+
+        result = @ecs_command.describe_task_definition(service['taskDefinition'])
+
+        if service['desiredCount'] > 0
+          running_new_task = false
+          wait_time = 0
+          puts 'Start deploing...'
+
+          begin
+            sleep(PAULING_INTERVAL)
+            wait_time += PAULING_INTERVAL
+
+            # Get current tasks
+            result = @ecs_command.list_tasks(service_name)
+
+            if result['taskArns'].size > 0
+              success_count = 0
+
+              result = @ecs_command.describe_tasks(result['taskArns'])
+              result['tasks'].each do |task|
+                success_count += 1 if @new_task_definition_arn == task['taskDefinitionArn']
+              end
+
+              if result['tasks'].size == success_count
+                puts 'Service update succeeded.'
+                puts "New task definition: #{@new_task_definition_arn}"
+
+                running_new_task = true
+              end
+            else
+              raise TaskNotFoundError.new('Desired count is 0.')
+            end
+
+            if wait_time > timeout
+              puts "New task definition: #{@new_task_definition_arn}"
+              raise DeployTimeoutError.new('Service is being updating, but process is timed out.')
+            end
+
+            puts "Deploying... (#{wait_time} seconds elapsed)"
+
+          end while !running_new_task
+        end
+
+        break
+      end
+
+      raise ServiceNotFoundError.new("'#{service_name}' service is not found.") unless detected_service
+    end
+
+    # @param [Hash] task_definition
+    # @return [String]
+    def register_task_process(task_definition)
+      result = @ecs_command.register_task_definition(
+        task_definition['family'],
+        task_definition['containerDefinitions']
+      )
+
+      @family_name = result['taskDefinition']['family']
+      @revision = result['taskDefinition']['revision']
+      @new_task_definition_arn = result['taskDefinition']['taskDefinitionArn']
+    end
+  end
+
+end

data/lib/ecs_deployer/commander.rb

@@ -0,0 +1,104 @@
+require 'oj'
+require 'runtime_command'
+
+module EcsDeployer
+  class Commander
+    # @param [String] cluster_name
+    # @param [Hash] options
+    # @return EcsDeployer::Commander
+    def initialize(cluster_name, options = {})
+      @runtime = RuntimeCommand::Builder.new
+      @options = options
+      @cluster_name = cluster_name
+    end
+
+    # @param [String] service_name
+    # @param [String] family_name
+    # @param [Fixnum] revision
+    # @return [Hash]
+    def update_service(service_name, family_name, revision)
+      args = {
+        'cluster': @cluster_name,
+        'service':  service_name,
+        'task-definition': family_name + ':' + revision.to_s
+      }
+
+      exec('update-service', args)
+    end
+
+    # @param [String] service_name
+    # @return [Hash]
+    def list_tasks(service_name)
+      args = {
+        'cluster': @cluster_name,
+        'service-name': service_name,
+        'desired-status': 'RUNNING'
+      }
+      exec('list-tasks', args)
+    end
+
+    # @param [Array] tasks
+    # @return [Hash]
+    def describe_tasks(tasks)
+      args = {
+        'cluster': @cluster_name,
+        'tasks': tasks.join(' ')
+      }
+      exec('describe-tasks', args)
+    end
+
+    # @param [String] task_definition
+    # @return [Hash]
+    def describe_task_definition(task_definition)
+      args = {
+        'task-definition': task_definition
+      }
+      exec('describe-task-definition', args)
+    end
+
+    # @param [String] service_name
+    # @return [Hash]
+    def describe_services(service_name)
+      args = {
+        'cluster': @cluster_name,
+        'services': service_name
+      }
+      exec('describe-services', args)
+    end
+
+    # @param [String] family_name
+    # @param [Hash] container_definitions
+    # @return [Hash]
+    def register_task_definition(family_name, container_definitions)
+      args = {
+        'family': family_name,
+        'container-definitions': '"' + Oj.dump(container_definitions).gsub('"', '\\"') + '"'
+      }
+      exec('register-task-definition', args)
+    end
+
+    private
+    # @param [String] command
+    # @param [Hash] args
+    # @return [Hash]
+    def exec(command, args)
+      arg = ''
+      args.each do |name, value|
+        arg << "--#{name} #{value} "
+      end
+
+      arg << "--profile #{@options[:profile]} " if @options.has_key?(:profile)
+      arg << "--region #{@options[:region]} " if @options.has_key?(:region)
+
+      command = "aws ecs #{command} #{arg}"
+      result = @runtime.exec(command)
+
+      raise EcsCommandError.new unless result.buffered_stderr.empty?
+
+      result = result.buffered_stdout
+      Oj.load(result)
+    end
+  end
+
+  class EcsCommandError < RuntimeError; end
+end

data/lib/ecs_deployer/error.rb

@@ -0,0 +1,4 @@
+module EcsDeployer
+  class Error < RuntimeError
+  end
+end

data/lib/ecs_deployer/version.rb

@@ -0,0 +1,3 @@
+module EcsDeployer
+  VERSION = "0.1.0"
+end

data/lib/ecs_deployer.rb

@@ -0,0 +1,9 @@
+require 'ecs_deployer/version'
+require 'ecs_deployer/client'
+require 'ecs_deployer/error'
+
+module EcsDeployer
+  class ServiceNotFoundError < EcsDeployer::Error; end
+  class TaskNotFoundError < EcsDeployer::Error; end
+  class DeployTimeoutError < EcsDeployer::Error; end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ecs_deployer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- naomichi-y
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runtime_command
+  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: oj
+  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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This package provides the service deployment function of ECS.
+email:
+- n.yamakita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ecs_deployer.gemspec
+- example/fixtures/task.yml
+- example/sample.rb
+- lib/ecs_deployer.rb
+- lib/ecs_deployer/client.rb
+- lib/ecs_deployer/commander.rb
+- lib/ecs_deployer/error.rb
+- lib/ecs_deployer/version.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Deploy application to ECS.
+test_files: []