elastic_whenever 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2acb9a47149651251063b2f1bcd457067f75cfd603db66ec252bfc367c923d3b
-  data.tar.gz: e6588eb7b07de1e9aa3b252c2da6858637346e8334a179d3dfbbc4a87d13211e
+SHA1:
+  metadata.gz: 221091fd69b334eb2e1a29e0d98f5bd8154d3a6c
+  data.tar.gz: ed62915c7e06921b264dc21b9646a367cc747e13
 SHA512:
-  metadata.gz: 7f5497d55ce4b2c6f8a62742f4902c291009fe3d60ed630f61a37a8088939dbc93e4d5072849f4dc87e61218572ac88cd19f551e45b4b166f56086cf6c8a5b4f
-  data.tar.gz: 68df187c4e639557fec8a3ecb22f19832cea79976bdae70d4107eaa65df965e45ab7e30f9b2b8192c84c05284b5c5cf5fad9f409275ac098c2cc8fc390a2786c
+  metadata.gz: 9173b91d178b252b455dd833e9d0bfdabf2dc730f593ac156c58ddc8bb55c268fcaf38614b7eda8402c8163b66a21a3caf15d114dd9b0b235b3c661853faae1d
+  data.tar.gz: 3bbf59e2d2265073a59159f941555f5b6b8d27934eeb6363cc692eb52172ad4f7bff4d667ef64f852d7bee1f2d00a5291967d38f8d27d7a37ed7b9e5bbc4f87a

data/.travis.yml

@@ -1,7 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.2
-  - 2.5.0
+  - 2.4.5
+  - 2.5.3
 before_install:
   - gem update --system

data/CHANGELOG.md

@@ -1,16 +1,45 @@
-# v0.3.2 (2018-06-25)
+## v0.4.0 (2018-12-19)
 
-## BugFix
+Elastic Whenever now supports Fargate launch type. Thanks @avinson.
+
+From this release, ECS parameters must be passed as arguments. Previously, it supported schedule file variables, but it will be ignored.
+
+```
+# Before
+$ elastic_whenever --set 'cluster=ecs-test&task_definition=oneoff-application:2&container=oneoff'
+
+# After
+$ elastic_whenever --cluster ecs-test --task-definition oneoff-application:2 --container oneoff
+```
+
+### Enhancements
+
+- update elastic_whenever for FARGATE launch type ([#34](https://github.com/wata727/elastic_whenever/pull/34))
+
+### Changes
+
+- Bump aws-sdk-cloudwatchevents dependency ([#36](https://github.com/wata727/elastic_whenever/pull/36))
+- Pass ECS params as an argument ([#37](https://github.com/wata727/elastic_whenever/pull/37))
+
+### Chore
+
+- CI against Ruby 2.4.5 and 2.5.3 ([#35](https://github.com/wata727/elastic_whenever/pull/35))
+- Set nil as verbose mode ([#38](https://github.com/wata727/elastic_whenever/pull/38))
+- Revise task's target ([#39](https://github.com/wata727/elastic_whenever/pull/39))
+
+## v0.3.2 (2018-06-25)
+
+### BugFix
 
 - fix: `Task::Role#exists?` always return true ([#33](https://github.com/wata727/elastic_whenever/pull/33))
 
-# v0.3.1 (2018-06-25)
+## v0.3.1 (2018-06-25)
 
-## BugFix
+### BugFix
 
 - add `attr_reader :enviroment` ([#32](https://github.com/wata727/elastic_whenever/pull/32))
 
-## Others
+### Others
 
 - CI against Ruby 2.5 ([#30](https://github.com/wata727/elastic_whenever/pull/30))
 - Use `File.exist?` instead of `File.exists?` ([#31](https://github.com/wata727/elastic_whenever/pull/31))

data/README.md

@@ -3,7 +3,7 @@
 [![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.txt)
 [![Gem Version](https://badge.fury.io/rb/elastic_whenever.svg)](https://badge.fury.io/rb/elastic_whenever)
 
-Manage ECS scheduled tasks like whenever gem.
+Manage ECS scheduled tasks like [Whenever](https://github.com/javan/whenever) gem.
 
 ## Installation
 
@@ -23,7 +23,7 @@ Or install it yourself as:
 
 ## Usage
 
-You can use it almost like whenever :)
+You can use it almost like Whenever. However, please be aware that you must specify an identifier.
 
 ```
 $ elastic_whenever --help
@@ -31,7 +31,16 @@ Usage: elastic_whenever [options]
     -i, --update identifier          Clear and create scheduled tasks by schedule file
     -c, --clear identifier           Clear scheduled tasks
     -l, --list identifier            List scheduled tasks
-    -s, --set variables              Example: --set 'environment=staging&cluster=ecs-test'
+    -s, --set variables              Example: --set 'environment=staging'
+        --cluster cluster            ECS cluster to run tasks
+        --task-definition task_definition
+                                     Task definition name, If omit a revision, use the latest revision of the family automatically. Example: --task-deifinition oneoff-application:2
+        --container container        Container name defined in the task definition
+        --launch-type launch_type    Launch type. EC2 or FARGATE. Defualt: EC2
+        --assign-public-ip           Assign a public IP. Default: DISABLED (FARGATE only)
+        --security-groups groups     Example: --security-groups 'sg-2c503655,sg-72f0cb0a' (FARGATE only)
+        --subnets subnets            Example: --subnets 'subnet-4973d63f,subnet-45827d1d' (FARGATE only)
+        --platform-version version   Optionally specify the platform version. Default: LATEST (FARGATE only)
     -f, --file schedule_file         Default: config/schedule.rb
         --profile profile_name       AWS shared profile name
         --access-key aws_access_key_id
@@ -40,30 +49,13 @@ Usage: elastic_whenever [options]
                                      AWS secret access key
         --region region              AWS region
     -v, --version                    Print version
+    -V, --verbose                    Run rake jobs without --silent
 ```
 
-However, please be aware that you must specify an identifier. Also, you must specify the cluster, task definition and container name in schedule file.
-
-```ruby
-set :cluster, 'ecs-test' # ECS cluster name
-set :task_definition, 'oneoff-application:2' # Task definition name, If omit the revision, use the latest revision of family automatically.
-set :container, 'oneoff' # Container name of task definition
-
-every :day, at: '03:00am' do
-  runner 'Hoge.run'
-end
-```
-
-If you do not write it in the schedule file, specify it with arguments.
+NOTE: Currently, Elastic Whenever supports the Whenever syntax partially. We strongly encourage to use dry-run mode for verifying tasks to be created.
 
 ```
-$ elastic_whenever -i test --set 'environment=staging&cluster=ecs-test&task_definition=oneoff-application:2&container=oneoff'
-```
-
-NOTE: Currently, it supports only the syntax of whenever partially. We recommend to check what happens beforehand with the `elastic_whenever` command.
-
-```
-$ elastic_whenever
+$ elastic_whenever --cluster ecs-test --task-definition example:2 --container cron
 cron(0 3 * * ? *) ecs-test example:2 cron bundle exec rake hoge:run
 
 ## [message] Above is your schedule file converted to scheduled tasks; your scheduled tasks was not updated.
@@ -71,7 +63,7 @@ cron(0 3 * * ? *) ecs-test example:2 cron bundle exec rake hoge:run
 ```
 
 ## How it works
-Elastic Whenever creates CloudWatch Events as many as `every` block. The number of jobs declared in it corresponds to the target.
+Elastic Whenever creates CloudWatch Events as many as `every` block. Each event has as many targets as there are commands in the block.
 
 ```ruby
 every '0 0 * * *' do # scheduled task (identifier_68237a3b152a6c44359e1cf5cd8e7cf0def303d7)
@@ -80,20 +72,21 @@ every '0 0 * * *' do # scheduled task (identifier_68237a3b152a6c44359e1cf5cd8e7c
 end
 ```
 
-The name of the scheduled task is the identifier passed in CLI and the digest value calculated from the command etc.
-Because CloudWatch Events rule names are unique across all clusters, you should not use the same identifier across different clusters.
+The scheduled task's name is a digest value calculated from an identifier, commands, and so on.
+
+NOTE: You should not use the same identifier across different clusters because CloudWatch Events rule names are unique across all clusters.
 
 ## Compatible with Whenever
-### `job_type` method is not supported
-Whenever supports custom job type using `job_type` method, but Elastic Whenever does not support it.
+### `job_type`
+Whenever supports custom job type with `job_type` method, but Elastic Whenever doesn't support it.
 
 ```ruby
 # [warn] Skipping unsupported method: job_type
 job_type :awesome, '/usr/local/bin/awesome :task :fun_level'
 ```
 
-### `env` method is not supported
-Whenever supports environment variables using `env` method, but Elastic Whenever does not support it.
+### `env`
+Whenever supports environment variables with `env` method, but Elastic Whenever doesn't support it.
 You should use task definitions to set environment variables.
 
 ```ruby
@@ -101,16 +94,16 @@ You should use task definitions to set environment variables.
 env "VERSION", "v1"
 ```
 
-### `:job_template` option is not supported.
-Whenever has a template to describe as cron, but Elastic Whenever does not have the template.
+### `:job_template`
+Whenever has a template to describe as cron, but Elastic Whenever doesn't have the template.
 Therefore, `:job_template` option is ignored.
 
 ```ruby
 set :job_template, "/bin/zsh -l -c ':job'" # ignored
 ```
 
-### Behavior of frequency
-Elastic Whenever processes the frequency received by `every` block almost like whenever.
+### Frequency
+Elastic Whenever processes frequency passed to `every` block almost like Whenever.
 
 ```ruby
 # Whenever
@@ -134,7 +127,7 @@ every 10.minutes do
 end
 ```
 
-However, handling of the day of week is partially different because it follows the scheduled expression.
+However, handling of the day of week is partially different because it follows scheduled expression.
 
 ```ruby
 # Whenever
@@ -148,7 +141,7 @@ every :monday do
 end
 ```
 
-Therefore, the cron syntax is converted to scheduled tasks.
+Therefore, cron syntax is converted to scheduled expression like the following:
 
 ```ruby
 # cron(0 0 ? * 2 *) ecs-test myapp:2 web awesome
@@ -157,7 +150,7 @@ every "0 0 * * 1" do
 end
 ```
 
-Of course, you can write the scheduled expression.
+Absolutely, you can also write scheduled expression.
 
 ```ruby
 # cron(0 0 ? * 2 *) ecs-test myapp:2 web awesome
@@ -166,8 +159,8 @@ every "0 0 ? * 2 *" do
 end
 ```
 
-#### `:reboot` option is not supported
-Whenever supports `:reboot` which is a function of cron, but Elastic Whenever does not support it.
+#### `:reboot`
+Whenever supports `:reboot` as a cron option, but Elastic Whenever doesn't support it.
 
 ```ruby
 # [warn] `reboot` is not supported option. Ignore this task.
@@ -176,9 +169,9 @@ every :reboot do
 end
 ```
 
-### Behavior of bundle commands
-Whenever checks if the application uses bundler and automatically adds the prefix to commands.
-However, Elastic Whenever always adds the prefix on the premise that the application is using bundler.
+### Bundle commands
+Whenever checks if the application uses bundler and automatically adds a prefix to commands.
+However, Elastic Whenever always adds a prefix on a premise that the application is using bundler.
 
 ```ruby
 # Whenever
@@ -197,8 +190,8 @@ If you don't want to add the prefix, set `bundle_command` to empty as follows:
 set :bundle_command, ""
 ```
 
-### Drop support for for Rails 3 or below
-Whenever supports `runner` job with old Rails version, but Elastic Whenever supports Rails 4 and above only.
+### Rails
+Whenever supports `runner` job with old Rails versions, but Elastic Whenever supports Rails 4 and above only.
 
 ```ruby
 # Whenever

data/elastic_whenever.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "aws-sdk-ecs", "~> 1.0"
-  spec.add_dependency "aws-sdk-cloudwatchevents", "~> 1.0"
+  spec.add_dependency "aws-sdk-cloudwatchevents", "~> 1.5"
   spec.add_dependency "aws-sdk-iam", "~> 1.0"
   spec.add_dependency "chronic", "~> 0.10"
 end

data/lib/elastic_whenever/cli.rb

@@ -36,7 +36,6 @@ module ElasticWhenever
         ERROR_EXIT_CODE
       rescue OptionParser::MissingArgument,
         Option::InvalidOptionException,
-        Schedule::InvalidScheduleException,
         Task::Target::InvalidContainerException => exn
 
         Logger.instance.fail(exn.message)
@@ -46,11 +45,10 @@ module ElasticWhenever
       private
 
       def update_tasks(option, dry_run:)
-        schedule = Schedule.new(option.schedule_file, option.variables)
-        schedule.validate!
+        schedule = Schedule.new(option.schedule_file, option.verbose, option.variables)
 
-        cluster = Task::Cluster.new(option, schedule.cluster)
-        definition = Task::Definition.new(option, schedule.task_definition)
+        cluster = Task::Cluster.new(option, option.cluster)
+        definition = Task::Definition.new(option, option.task_definition)
         role = Task::Role.new(option)
         if !role.exists? && !dry_run
           role.create
@@ -64,7 +62,7 @@ module ElasticWhenever
               option,
               cluster: cluster,
               definition: definition,
-              container: schedule.container,
+              container: option.container,
               commands: command,
               rule: rule,
               role: role,

data/lib/elastic_whenever/option.rb

@@ -8,7 +8,16 @@ module ElasticWhenever
 
     attr_reader :identifier
     attr_reader :mode
+    attr_reader :verbose
     attr_reader :variables
+    attr_reader :cluster
+    attr_reader :task_definition
+    attr_reader :container
+    attr_reader :assign_public_ip
+    attr_reader :launch_type
+    attr_reader :platform_version
+    attr_reader :security_groups
+    attr_reader :subnets
     attr_reader :schedule_file
 
     class InvalidOptionException < StandardError; end
@@ -16,7 +25,16 @@ module ElasticWhenever
     def initialize(args)
       @identifier = nil
       @mode = DRYRUN_MODE
+      @verbose = false
       @variables = []
+      @cluster = nil
+      @task_definition = nil
+      @container = nil
+      @assign_public_ip = 'DISABLED'
+      @launch_type = 'EC2'
+      @platform_version = 'LATEST'
+      @security_groups = []
+      @subnets = []
       @schedule_file = 'config/schedule.rb'
       @profile = nil
       @access_key = nil
@@ -36,7 +54,7 @@ module ElasticWhenever
           @identifier = identifier
           @mode = LIST_MODE
         end
-        opts.on('-s' ,'--set variables', "Example: --set 'environment=staging&cluster=ecs-test'") do |set|
+        opts.on('-s' ,'--set variables', "Example: --set 'environment=staging'") do |set|
           pairs = set.split('&')
           pairs.each do |pair|
             unless pair.include?('=')
@@ -47,6 +65,30 @@ module ElasticWhenever
             @variables << { key: key, value: value }
           end
         end
+        opts.on('--cluster cluster', 'ECS cluster to run tasks') do |cluster|
+          @cluster = cluster
+        end
+        opts.on('--task-definition task_definition', 'Task definition name, If omit a revision, use the latest revision of the family automatically. Example: --task-deifinition oneoff-application:2') do |definition|
+          @task_definition = definition
+        end
+        opts.on('--container container', 'Container name defined in the task definition') do |container|
+          @container = container
+        end
+        opts.on('--launch-type launch_type', 'Launch type. EC2 or FARGATE. Defualt: EC2') do |launch_type|
+          @launch_type = launch_type
+        end
+        opts.on('--assign-public-ip', 'Assign a public IP. Default: DISABLED (FARGATE only)') do
+          @assign_public_ip = 'ENABLED'
+        end
+        opts.on('--security-groups groups', "Example: --security-groups 'sg-2c503655,sg-72f0cb0a' (FARGATE only)") do |groups|
+          @security_groups = groups.split(',')
+        end
+        opts.on('--subnets subnets', "Example: --subnets 'subnet-4973d63f,subnet-45827d1d' (FARGATE only)") do |subnets|
+          @subnets = subnets.split(',')
+        end
+        opts.on('--platform-version version', "Optionally specify the platform version. Default: LATEST (FARGATE only)") do |version|
+          @platform_version = version
+        end
         opts.on('-f', '--file schedule_file', 'Default: config/schedule.rb') do |file|
           @schedule_file = file
         end
@@ -65,6 +107,9 @@ module ElasticWhenever
         opts.on('-v', '--version', 'Print version') do
           @mode = PRINT_VERSION_MODE
         end
+        opts.on('-V', '--verbose', 'Run rake jobs without --silent') do
+          @verbose = true
+        end
       end.parse(args)
 
       @credentials = if profile
@@ -80,6 +125,9 @@ module ElasticWhenever
 
     def validate!
       raise InvalidOptionException.new("Can't find file: #{schedule_file}") unless File.exist?(schedule_file)
+      raise InvalidOptionException.new("You must set cluster") unless cluster
+      raise InvalidOptionException.new("You must set task definition") unless task_definition
+      raise InvalidOptionException.new("You must set container") unless container
     end
 
     private

data/lib/elastic_whenever/schedule.rb

@@ -1,14 +1,10 @@
 module ElasticWhenever
   class Schedule
     attr_reader :tasks
-    attr_reader :cluster
-    attr_reader :task_definition
-    attr_reader :container
     attr_reader :chronic_options
     attr_reader :bundle_command
     attr_reader :environment
 
-    class InvalidScheduleException < StandardError; end
     class UnsupportedFrequencyException < StandardError; end
 
     module WheneverNumeric
@@ -51,12 +47,10 @@ module ElasticWhenever
     end
     using WheneverNumeric
 
-    def initialize(file, variables)
+    def initialize(file, verbose, variables)
       @environment = "production"
+      @verbose = verbose
       @tasks = []
-      @cluster = nil
-      @task_definition = nil
-      @container = nil
       @chronic_options = {}
       @bundle_command = "bundle exec"
 
@@ -69,19 +63,13 @@ module ElasticWhenever
     end
 
     def every(frequency, options = {}, &block)
-      @tasks << Task.new(@environment, @bundle_command, schedule_expression(frequency, options)).tap do |task|
+      @tasks << Task.new(@environment, @verbose, @bundle_command, schedule_expression(frequency, options)).tap do |task|
         task.instance_eval(&block)
       end
     rescue UnsupportedFrequencyException => exn
       Logger.instance.warn(exn.message)
     end
 
-    def validate!
-      raise InvalidScheduleException.new("You must set cluster") unless cluster
-      raise InvalidScheduleException.new("You must set task definition") unless task_definition
-      raise InvalidScheduleException.new("You must set container") unless container
-    end
-
     def schedule_expression(frequency, options)
       opts =  { :now => Time.new(2017, 12, 1, 0, 0, 0) }.merge(@chronic_options)
       time = Chronic.parse(options[:at], opts) || Time.new(2017, 12, 1, 0, 0, 0)

data/lib/elastic_whenever/task.rb

@@ -3,8 +3,9 @@ module ElasticWhenever
     attr_reader :commands
     attr_reader :expression
 
-    def initialize(environment, bundle_command, expression)
+    def initialize(environment, verbose, bundle_command, expression)
       @environment = environment
+      @verbose_mode = verbose ? nil : "--silent"
       @bundle_command = bundle_command.split(" ")
       @expression = expression
       @commands = []
@@ -15,7 +16,7 @@ module ElasticWhenever
     end
 
     def rake(task)
-      @commands << [@bundle_command, "rake", task, "--silent"].flatten
+      @commands << [@bundle_command, "rake", task, @verbose_mode].flatten.compact
     end
 
     def runner(src)

data/lib/elastic_whenever/task/target.rb

@@ -5,6 +5,11 @@ module ElasticWhenever
       attr_reader :definition
       attr_reader :container
       attr_reader :commands
+      attr_reader :assign_public_ip
+      attr_reader :launch_type
+      attr_reader :platform_version
+      attr_reader :security_groups
+      attr_reader :subnets
 
       class InvalidContainerException < StandardError; end
 
@@ -37,6 +42,11 @@ module ElasticWhenever
         @commands = commands
         @rule = rule
         @role = role
+        @assign_public_ip = option.assign_public_ip
+        @launch_type = option.launch_type
+        @platform_version = option.platform_version
+        @security_groups = option.security_groups
+        @subnets = option.subnets
         @client = Aws::CloudWatchEvents::Client.new(option.aws_config)
       end
 
@@ -49,10 +59,7 @@ module ElasticWhenever
               arn: cluster.arn,
               input: input_json(container, commands),
               role_arn: role.arn,
-              ecs_parameters: {
-                task_definition_arn: definition.arn,
-                task_count: 1,
-              }
+              ecs_parameters: ecs_parameters,
             }
           ]
         )
@@ -71,6 +78,30 @@ module ElasticWhenever
         }.to_json
       end
 
+      def ecs_parameters
+        if launch_type == "FARGATE"
+          {
+            launch_type: launch_type,
+            task_definition_arn: definition.arn,
+            task_count: 1,
+            network_configuration: {
+              awsvpc_configuration: {
+                subnets: subnets,
+                security_groups: security_groups,
+                assign_public_ip: assign_public_ip,
+              }
+            },
+            platform_version: platform_version,
+          }
+        else
+          {
+            launch_type: launch_type,
+            task_definition_arn: definition.arn,
+            task_count: 1,
+          }
+        end
+      end
+
       attr_reader :rule
       attr_reader :role
       attr_reader :client

data/lib/elastic_whenever/version.rb

@@ -1,3 +1,3 @@
 module ElasticWhenever
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_whenever
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Kazuma Watanabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-iam
   requirement: !ruby/object:Gem::Requirement
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Manage ECS Scheduled Tasks like Whenever