ecs_helper 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4e40c9c0050075171080514f957eeef76fce51e292c5305d2003005326ad1bb
-  data.tar.gz: f48a33a223c127b561f7e639834fa59c0b7c0ad96f42fc661af062e50ef6f439
+  metadata.gz: 9da09c69b8b7494c861ea3c278a10e86fbdcbf46a91d8b9253f997d899c33d7a
+  data.tar.gz: 4a47644247bd3d6fe9d6a31f58ad3734ea9387f1f70698a4aa89d92d7c64fbee
 SHA512:
-  metadata.gz: 849243dae8979adaf2ee254edbe49142af2a96e32143472653f124030c8f5389d278ae55b26c063b6b05793f544e7d2183424d0630b0680761371e3dfb7b10d6
-  data.tar.gz: e4cc9793f2962554bfa56ccad5d0c4f7045eb098ff5d98be470be58dc97a03fec07966d23601085971baa94594c73698c603796dffdd85e28988717562aec322
+  metadata.gz: 8cab278533bc6ea72f9847e574beb37c731a9e913739e1956b42d50fe0b7fcfb40bef0f74d53f7430b764b0e85b2ab986922d81b8753863ca1f04e9859905838
+  data.tar.gz: a1d216b96efaf72fd04e864d4ba795ed84eb2c429fc3f435098c1347f49e0992b16c6467e6ad6dc761dfb794e19a2208c454f9d8cd1213613a4081cae6c82891

data/lib/ecs_helper.rb

@@ -10,9 +10,10 @@ class ECSHelper
   autoload :CommonHelper, 'ecs_helper/common_helper'
   autoload :ClusterHelper, 'ecs_helper/cluster_helper'
   autoload :ServiceHelper, 'ecs_helper/service_helper'
+  autoload :TaskDefinitionHelper, 'ecs_helper/task_definition_helper'
   autoload :Command, 'ecs_helper/command'
 
-  def_delegators :client, :task_definitions, :clusters, :services, :tasks, :repositories, :repositories, :task_definition
+  def_delegators :client, :task_definitions, :clusters, :services, :tasks, :repositories, :repositories, :task_definition, :run_task
   def_delegators :common_helper, :version, :branch, :environment, :project, :application
   def_delegators :cluster_helper, :current_cluster, :clusters
   def_delegators :service_helper, :current_service, :services, :update_service

data/lib/ecs_helper/client.rb

@@ -48,6 +48,14 @@ class ECSHelper::Client
     ecs.update_service(params)
   end
 
+  def run_task(params = {})
+    ecs.run_task(params).tasks[0]
+  end
+
+  def describe_tasks(params = {})
+    ecs.describe_tasks(params).tasks
+  end
+
   # ECR
   def private_repositories(params = {})
     ecr.describe_repositories(params).repositories

data/lib/ecs_helper/command.rb

@@ -5,12 +5,14 @@ class ECSHelper::Command
   autoload :Deploy, 'ecs_helper/command/deploy'
   autoload :ExportImages, 'ecs_helper/command/export_images'
   autoload :ECRLogin, 'ecs_helper/command/ecr_login'
+  autoload :RunCommand, 'ecs_helper/command/run_command'
 
   CMD_MAPPING  = {
     "build_and_push" => BuildAndPush,
     "deploy" => Deploy,
     "export_images" => ExportImages,
     "ecr_login" => ECRLogin,
+    "run_command" => RunCommand,
   }
   AVAILABLE_COMMANDS = CMD_MAPPING.keys
 

data/lib/ecs_helper/command/deploy.rb

@@ -13,7 +13,7 @@ class ECSHelper::Command::Deploy < ECSHelper::Command::Base
       opts.on("-a VALUE", "--application VALUE", "Set application name, if not specified will look at ENV['APPLICATION'], will be used to detect service and task definition") { |a| options[:application] = processEqual(a) }
       opts.on("-e VALUE", "--environment VALUE", "Set environment, if not specified will look at ENV['ENVIRONMENT'], it there is empty will try to detect based on the branch") { |e| options[:environment] = processEqual(e) }
       opts.on("-v VALUE", "--version VALUE", "Set version which will be applied to all containers in the task if tag is present in the repo") { |t| options[:version] = processEqual(t) }
-      opts.on("-c VALUE", "--cluster VALUE", "Set cluster name, could be autodetected if project and environment are specified") { |c| options[:cluster] = processEqual(c) }
+      opts.on("-cl VALUE", "--cluster VALUE", "Set cluster name, could be autodetected if project and environment are specified") { |c| options[:cluster] = processEqual(c) }
       opts.on("-s VALUE", "--service VALUE", "Set service, could be autodetected if application and environment are specified") { |s| options[:service] = processEqual(s) }
       opts.on("-t VALUE", "--timeout VALUE", "Set timeout how long to wait until deployment finished") { |t| options[:timeout] = processEqual(t) }
     end
@@ -21,22 +21,30 @@ class ECSHelper::Command::Deploy < ECSHelper::Command::Base
   end
 
   def run
+    task_definition_helper = TaskDefinitionHelper.new(helper, service)
+    service_task_definition = task_definition_helper.service_task_definition
+    new_task_definition_hash = task_definition_helper.new_task_definition_hash
+    new_task_definition = task_definition_helper.register_task_definition(new_task_definition_hash)
     log("Command", type)
     log("Options", options)
     log("Environment", environment)
     log("Cluster", cluster_arn)
     log("Service", service_arn)
     log("Version", version)
-    log("Service task definition", task_definition_arn)
-    log("Containers", pretty_container_definitions)
+    log("Service task definition", service_task_definition.task_definition_arn)
+    log("Containers", task_definition_helper.pretty_container_definitions)
     log("New task definition", new_task_definition.task_definition_arn)
-    update_service && log("Update service", "Service task definition was updated")
+    update_service(new_task_definition.task_definition_arn) && log("Update service", "Service task definition was updated")
     log("Waiting for deployment...")
     wait_for_deployment && log("Success", "Application was succesfully deployed", :cyan)
   end
 
+  def update_service(task_definition_arn)
+    helper.update_service(cluster_arn, service_arn, task_definition_arn)
+    helper.client.deregister_task_definition(task_definition: task_definition_arn)
+  end
+
   def wait_for_deployment(time = 0)
-    service = helper.client.describe_service(cluster_arn, service_arn)
     return true if service.deployments.count == 1
     error("Deployment timeout (#{timeout})") if time > timeout
     sleep STEP
@@ -66,84 +74,6 @@ class ECSHelper::Command::Deploy < ECSHelper::Command::Base
   end
 
   def service
-    @service ||= helper.client.describe_service(cluster_arn, service_arn)
-  end
-
-  def task_definition_arn
-    service.task_definition
-  end
-
-  def task_definition
-    @task_definition ||= helper.client.describe_task_definition(task_definition_arn)
-  end
-
-  def container_definitions
-    task_definition.container_definitions
-  end
-
-  def repositories
-    @repositories ||= client.private_repositories
-  end
-
-  def version_image(repo)
-    client.describe_images({repository_name: repo.repository_name, image_ids: [image_tag: version]})
-  rescue
-    nil
-  end
-
-  def new_task_definition
-    @new_task_definition ||= begin
-      attributes_to_remove = list = [:task_definition_arn, :revision, :status, :requires_attributes, :compatibilities, :registered_at, :registered_by]
-      new_task_definition_attributes = task_definition.to_hash
-                    .reject { |k,v| attributes_to_remove.include?(k.to_sym) }
-                    .merge(container_definitions: new_container_definitions)
-      helper.client.register_task_definition(new_task_definition_attributes)
-    end
-  end
-
-  def container_definition_to_ecr(cd)
-    repo = repo_for(cd.name)
-    is_ecr = cd.image.include?(ecr_base)
-    image = repo && version_image(repo)
-    should_update = is_ecr && repo && image
-    [repo, is_ecr, image, should_update]
-  end
-
-  def new_container_definitions
-    container_definitions.map do |cd|
-      repo, is_ecr, image, should_be_updated =  container_definition_to_ecr(cd)
-      cd.image = "#{repo.repository_uri}:#{version}" if should_be_updated
-      cd.to_hash
-    end
-  end
-
-  def pretty_container_definitions
-    container_definitions.map do |cd|
-      repo, is_ecr, image, should_be_updated =  container_definition_to_ecr(cd)
-      [
-        cd.name,
-        cd.image,
-        is_ecr ? "ECR image" : "Not a ECR image",
-        repo ? "Repo #{repo.repository_name}" : "Repo not found",
-        image ? "Image version #{version}" : "Image version #{version} not found",
-        should_be_updated ? "Will be updated" : "Not applicable"
-      ].join(' | ')
-    end.join("\n")
-  end
-
-  def repo_for(name)
-    repositories.find do |r|
-      uri = r.repository_uri
-      uri.include?(helper.application) && uri.include?(helper.project) && uri.include?(name)
-    end
-  end
-
-  def ecr_base
-    repositories.first.repository_uri.split('/').first
-  end
-
-  def update_service
-    helper.update_service(cluster_arn, service_arn, new_task_definition.task_definition_arn)
-    helper.client.deregister_task_definition(task_definition: task_definition.task_definition_arn)
+    helper.client.describe_service(cluster_arn, service_arn)
   end
 end

data/lib/ecs_helper/command/run_command.rb

@@ -0,0 +1,145 @@
+require 'terrapin'
+
+class ECSHelper::Command::RunCommand < ECSHelper::Command::Base
+  attr_accessor :repositories, :task_definition, :new_task_definition, :service
+  DEFAULT_TIMEOUT = 300
+  STEP = 5
+
+  def cmd_option_parser
+    options = {}
+    parser = ::OptionParser.new do |opts|
+      opts.banner = "Usage: ecs_helper run_command [options]"
+      opts.on("-p VALUE", "--project VALUE", "Set project name, if not specified will look at ENV['PROJECT'], will be used to detect cluster") { |p| options[:project] = processEqual(p) }
+      opts.on("-a VALUE", "--application VALUE", "Set application name, if not specified will look at ENV['APPLICATION'], will be used to detect service and task definition") { |a| options[:application] = processEqual(a) }
+      opts.on("-e VALUE", "--environment VALUE", "Set environment, if not specified will look at ENV['ENVIRONMENT'], it there is empty will try to detect based on the branch") { |e| options[:environment] = processEqual(e) }
+      opts.on("-v VALUE", "--version VALUE", "Set version which will be applied to all containers in the task if tag is present in the repo") { |t| options[:version] = processEqual(t) }
+      opts.on("--cluster VALUE", "Set cluster name, could be autodetected if project and environment are specified") { |c| options[:cluster] = processEqual(c) }
+      opts.on("-s VALUE", "--service VALUE", "Set service, could be autodetected if application and environment are specified") { |s| options[:service] = processEqual(s) }
+      opts.on("-t VALUE", "--timeout VALUE", "Set timeout how long to wait until deployment finished") { |t| options[:timeout] = processEqual(t) }
+      opts.on("--command VALUE", "Set command, should not demonize container") { |c| options[:command] = processEqual(c) }
+      opts.on("-n VALUE", "--name VALUE", "Set name (will be used for task definition name and log prefix") { |l| options[:name] = processEqual(l) }
+      opts.on("--container-name VALUE", "Set container name (default is the first container") { |cn| options[:container_name] = processEqual(cn) }
+    end
+    [parser, options]
+  end
+
+  def required
+    [:name, :command]
+  end
+
+  def run
+    task_definition_helper = ECSHelper::TaskDefinitionHelper.new(helper, service)
+    service_task_definition = task_definition_helper.service_task_definition
+    new_task_definition_hash = task_definition_helper.new_task_definition_hash
+    custom_task_definition_hash = custom_task_definition(new_task_definition_hash)
+    custom_task_definition = task_definition_helper.register_task_definition(custom_task_definition_hash)
+
+    log("Command", type)
+    log("Options", options)
+    log("Environment", environment)
+    log("Cluster", cluster_arn)
+    log("Service", service_arn)
+    log("Version", version)
+    log("New task definition", custom_task_definition.task_definition_arn)
+    task = run_task(custom_task_definition.task_definition_arn)
+    log("Start task", "Task #{task.task_arn} was started")
+    log("Waiting for task job...")
+    wait_for_task(task.task_arn) && log("Success", "Task finished successfully", :cyan)
+  end
+
+  def run_task(task_definition_arn)
+    helper.client.run_task({
+      cluster: cluster_arn,
+      task_definition: task_definition_arn,
+      network_configuration: service.network_configuration.to_hash,
+      launch_type: service.launch_type
+    })
+  end
+
+  def task(arn)
+    helper.client.describe_tasks({ cluster: cluster_arn, tasks: [arn] })[0]
+  end
+
+  def wait_for_task(task_arn, time = 0)
+    task = task(task_arn)
+    container = task.containers[0];
+    log("container: #{container.name}, time: #{time}, timeout: #{timeout}, status: #{container.last_status}, exit_code: #{container.exit_code || 'NONE'}")
+    if container.last_status == "STOPPED"
+      return true if container.exit_code == 0
+      error("Task #{task_arn} finished with exit code #{container.exit_code}")
+    end
+
+    error("Task run timeout (#{timeout})") if time > timeout
+    sleep STEP
+    wait_for_task(task_arn, time + STEP)
+  end
+
+  def custom_task_definition(hash)
+    hash.merge({
+      container_definitions: new_container_definition(hash),
+      family: "#{hash[:family]}-#{name}",
+    })
+  end
+
+  private
+
+  def new_container_definition(hash)
+    cds = hash[:container_definitions]
+    cds = [cds] if cds.is_a?(Hash)
+    cd = container_name ? cds.find {|cd| cd[:name] === container_name} : cds.first
+    error("Container not found") unless cd
+    new_cd = cd.merge({
+      command: command,
+      log_configuration: new_log_configuration(cd[:log_configuration]),
+      name: "#{cd[:name]}-#{name}"
+    })
+    [new_cd]
+  end
+
+  def new_log_configuration(log_configuration)
+    options = log_configuration[:options]
+    prefix = options["awslogs-stream-prefix"]
+    new_prefix = "#{prefix}-#{name}"
+    log_configuration.merge(options: options.merge("awslogs-stream-prefix" => new_prefix))
+  end
+
+  def command
+    ['bash', '-c', "#{options[:command]}"]
+  end
+
+  def environment
+    helper.environment
+  end
+
+  def cluster_arn
+    helper.current_cluster
+  end
+
+  def service_arn
+    helper.current_service
+  end
+
+  def version
+    options[:version] || helper.version
+  end
+
+  def timeout
+    options[:timeout] || DEFAULT_TIMEOUT
+  end
+
+  def service
+    helper.client.describe_service(cluster_arn, service_arn)
+  end
+
+  def name
+    options[:name]
+  end
+
+  def service
+    helper.client.describe_service(cluster_arn, service_arn)
+  end
+
+  def container_name
+    options[:container_name]
+  end
+end

data/lib/ecs_helper/task_definition_helper.rb

@@ -0,0 +1,93 @@
+require 'aws-sdk-ecs'
+
+class ECSHelper::TaskDefinitionHelper
+  attr_accessor :helper, :service, :service_task_definition, :repositories, :new_task_definition_hash
+  def initialize(helper, service)
+    @helper = helper
+    @service = service
+  end
+
+  def service_task_definition
+    @service_task_definition ||= helper.client.describe_task_definition(service.task_definition)
+  end
+
+  def container_definitions
+    service_task_definition.container_definitions
+  end
+
+  def pretty_container_definitions
+    container_definitions.map do |cd|
+      repo, is_ecr, image, should_be_updated =  container_definition_to_ecr(cd)
+      [
+        cd.name,
+        cd.image,
+        is_ecr ? "ECR image" : "Not a ECR image",
+        repo ? "Repo #{repo.repository_name}" : "Repo not found",
+        image ? "Image version #{version}" : "Image version #{version} not found",
+        should_be_updated ? "Will be updated" : "Not applicable"
+      ].join(' | ')
+    end.join("\n")
+  end
+
+  def register_task_definition(hash)
+    helper.client.register_task_definition(hash)
+  end
+
+  def new_task_definition_hash
+      attributes_to_remove = list = [:task_definition_arn, :revision, :status, :requires_attributes, :compatibilities, :registered_at, :registered_by]
+      service_task_definition.to_hash
+        .reject { |k,v| attributes_to_remove.include?(k.to_sym) }
+        .merge(container_definitions: new_container_definitions)
+  end
+
+  def container_definition_to_ecr(cd)
+    repo = repo_for(cd.name)
+    is_ecr = cd.image.include?(ecr_base)
+    image = repo && version_image(repo)
+    should_update = is_ecr && repo && image
+    [repo, is_ecr, image, should_update]
+  end
+
+  def new_container_definitions
+    container_definitions.map do |cd|
+      repo, is_ecr, image, should_be_updated =  container_definition_to_ecr(cd)
+      cd.image = "#{repo.repository_uri}:#{version}" if should_be_updated
+      cd.to_hash
+    end
+  end
+
+  private
+
+  def container_definition_to_ecr(cd)
+    repo = repo_for(cd.name)
+    is_ecr = cd.image.include?(ecr_base)
+    image = repo && version_image(repo)
+    should_update = is_ecr && repo && image
+    [repo, is_ecr, image, should_update]
+  end
+
+  def repo_for(name)
+    repositories.find do |r|
+      uri = r.repository_uri
+      uri.include?(helper.application) && uri.include?(helper.project) && uri.include?(name)
+    end
+  end
+
+  def repositories
+    @repositories ||= helper.client.private_repositories
+  end
+
+  def ecr_base
+    repositories.first.repository_uri.split('/').first
+  end
+
+  def version_image(repo)
+    client.describe_images({repository_name: repo.repository_name, image_ids: [image_tag: version]})
+  rescue
+    nil
+  end
+
+  def version
+    helper.options[:version] || helper.version
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - Artem Petrov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ecs
@@ -147,9 +147,11 @@ files:
 - lib/ecs_helper/command/deploy.rb
 - lib/ecs_helper/command/ecr_login.rb
 - lib/ecs_helper/command/export_images.rb
+- lib/ecs_helper/command/run_command.rb
 - lib/ecs_helper/common_helper.rb
 - lib/ecs_helper/logging.rb
 - lib/ecs_helper/service_helper.rb
+- lib/ecs_helper/task_definition_helper.rb
 homepage: https://rubygems.org/gems/ecs_helper
 licenses:
 - MIT