ecs_oneshot 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d35d3d137141ecc4b2bac0e823a5ca74d598b80093f0e6e87deb50e9ad7f492
-  data.tar.gz: 40d2a17b0f05018d506cf715a21f8799b2af1386b764c1d886368d53e71623d4
+  metadata.gz: 9f55e1bf5ed436b6b9a39d8dd9ee6946b475a060e8f50560d64ddef12326b8cc
+  data.tar.gz: 9056ca0a22315281d41e87a55e046d35164595475cae7fce4bd6b47c22c965f7
 SHA512:
-  metadata.gz: a03c2b215c42c42a29a50a4c229009db52a8f493226bc7c902adacb5645540ceac3a1b60cebf85906270cdb31c997cdea3ca5a1dfcbba293e0c4df4b4eaafbca
-  data.tar.gz: 9a54537e2bf20043ebf739908eb7cdf3a6460f547d65b3b39d59403ad1804b9bf898e7fae68d9d9dba4b0a2f7aad6db6fe8d6f485a230ba54f199afb75f593df
+  metadata.gz: 9c449cd8b03b692ce89a12d2a98ee769b498ef5b5b0282d2266421e50c404ffbb474cc3ed3749b8d4a4218d9a7bb07ff1520d6a4cf8b115afb14525de526eade
+  data.tar.gz: db60aab1c7dc48e7e9a9116358c3e60b925a7245727b6d942a333c492b47eb49705d4e3498cdf1d0d3faba03569fc2669f348399af33bc91414ac8ab081fa57d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ecs_oneshot (0.1.1)
+    ecs_oneshot (1.0.0)
       aws-sdk-cloudwatchlogs
       aws-sdk-ecs
 

data/README.md

@@ -3,7 +3,7 @@
 ![Ruby](https://github.com/sinsoku/ecs_oneshot/workflows/Ruby/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/ecs_oneshot.svg)](https://badge.fury.io/rb/ecs_oneshot)
 
-A CLI tool that simply executes tasks on AWS ECS.
+Provides a simple way to run one-shot tasks using the ECS runTask API.
 
 ## Installation
 
@@ -23,12 +23,21 @@ Or install it yourself as:
 
 ## Usage
 
-### Quickstart
+```
+Usage: ecs_oneshot [options] -- <commmand>
+    -c, --config FILE                Specify configuration file. (default: .ecs_oneshot.yml)
+    -e, --environment ENVIRONMENT    Specify environment. (default: production)
+        --cluster CLUSTER
+        --service SERVICE
+        --task-definition TASK_DEFINITION
+        --container CONTAINER
+```
 
-Run any command with the same configurations as your existing ECS service.
+## Example
 
 ```console
-$ ecs_oneshot --cluster <mycluster> --service <myservice> --container <mycontainer> -- bin/rails -T
+$ ecs_oneshot --cluster mycluster --service myservice --task-definition rails-app:1 --container app -- bin/rails -T
+Task started. Watch this task's details in the Amazon ECS console: https://console.aws.amazon.com/ecs/home?ap-northeast-1#/clusters/default/tasks/00000000-1234-5678-9000-aaaaaaaaaaaa/details
 === Wait for Task Starting...
 === Following Logs...
 rails about                              # List versions of all Rails frameworks and the environment
@@ -49,6 +58,7 @@ If the configuration file exists, it will be loaded.
 production:
   cluster: mycluster
   service: myservice
+  task_definition: task-def
   container: mycontainer
 ```
 

data/lib/ecs_oneshot/cli.rb

@@ -9,11 +9,7 @@ module EcsOneshot
     def run(args = ARGV)
       options = parse_options(args)
 
-      if options[:init]
-        init_config(options)
-      else
-        run_task(options)
-      end
+      run_task(options)
     rescue Error => e
       warn e.message
       exit 1
@@ -36,6 +32,7 @@ module EcsOneshot
 
       t = Task.new(config)
       t.run
+      puts "Task started. Watch this task's details in the Amazon ECS console: #{t.console_url}\n\n"
       puts "=== Wait for Task Starting..."
       t.wait_running
       puts "=== Following Logs..."
@@ -43,14 +40,7 @@ module EcsOneshot
       puts "\n=== Task Stopped."
     end
 
-    def init_config(options)
-      path = options[:config]
-      env = options[:environment]
-
-      Config.safe_build(options).save(path, env)
-    end
-
-    def parse_options(args) # rubocop:disable Metrics/MethodLength
+    def parse_options(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       opts = OptionParser.new
       opts.banner = "Usage: ecs_oneshot [options] -- <commmand>"
       opts.version = VERSION
@@ -59,13 +49,14 @@ module EcsOneshot
       opts.on("-e", "--environment ENVIRONMENT", "Specify environment. (default: production)")
       opts.on("--cluster CLUSTER")
       opts.on("--service SERVICE")
+      opts.on("--task-definition TASK_DEFINITION")
       opts.on("--container CONTAINER")
-      opts.on("--init", "Generate a configuration file.")
 
       {}.tap do |h|
         h[:command] = opts.parse(args, into: h)
         h[:config] ||= ".ecs_oneshot.yml"
         h[:environment] ||= "production"
+        h[:task_definition] = h.delete(:"task-definition")
       end
     end
   end

data/lib/ecs_oneshot/config.rb

@@ -3,7 +3,7 @@
 require "yaml"
 
 module EcsOneshot
-  Config = Struct.new(:cluster, :service, :container, :command, keyword_init: true)
+  Config = Struct.new(:cluster, :service, :container, :task_definition, :command, keyword_init: true)
 
   class Config
     class << self
@@ -23,14 +23,6 @@ module EcsOneshot
       end
     end
 
-    def save(path, env)
-      raise Error, "already exists at '#{path}'." if File.exist?(path)
-
-      File.open(path, "w") do |f|
-        YAML.dump({ env => to_h.transform_keys(&:to_s) }, f)
-      end
-    end
-
     def merge(other)
       new_options = to_h.merge(other.to_h.compact)
       Config.new(**new_options)

data/lib/ecs_oneshot/task.rb

@@ -20,6 +20,10 @@ module EcsOneshot
       @id = @arn.split("/").last
     end
 
+    def console_url
+      "https://console.aws.amazon.com/ecs/home?#{ecs.config.region}#/clusters/#{config.cluster}/tasks/#{@id}/details"
+    end
+
     def wait_running
       ecs.wait_until(:tasks_running, cluster: config.cluster, tasks: [arn])
     rescue Aws::Waiters::Errors::WaiterFailed
@@ -68,8 +72,7 @@ module EcsOneshot
     def task_definition
       return @task_definition if @task_definition
 
-      # NOTE: Delete a version to use latest task definition
-      task_definition = service.task_definition.sub(/:\d+$/, "")
+      task_definition = config.task_definition || service.task_definition
       @task_definition = ecs.describe_task_definition(task_definition: task_definition)
                             .task_definition
     end

data/lib/ecs_oneshot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EcsOneshot
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecs_oneshot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Takumi Shotoku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs