elastic_whenever 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3f6314849f075346152b2b861572f3d6cc9830044c7410a9dcbfdca08c13ecc
-  data.tar.gz: db5b26247b18515ba576853fbdb826872b0ba7b6a7df68e329ac2e0eb05ae76d
+  metadata.gz: 448f6e4c937fdc568cf15f2bd0c488f89c2d65fc83396f5cec02f7b8cdb791a7
+  data.tar.gz: 0d48b483b1dfc7991398ce6b499426b21657466c62588235ed155ab3acf7fecd
 SHA512:
-  metadata.gz: a1cf65a4cfe1a0af4cde63bb839bb44aab6aa875121145662bb5284148bd7879ee7544af14c280a65fb865c7e604fa615e97f21cc3c695300895af94d53117dc
-  data.tar.gz: 8a06af3797352eb946e87b415c7eb40aed31a59bb6a3ff11b347f03a94fe88dab58305bc0fed2dbe9c01909aedfe1d9ce6f1a65065e8fcabfbf76b0e266dddc7
+  metadata.gz: 05a39822bd08957051d973ab2ca2fe1f39a976962bcb73e4381831b2c18660c9880f0034ba491749618601429494bb53ba1877bc07501d495f2f3304c3b1c139
+  data.tar.gz: 8a3ca786d459492a724a9cfe65e9616d009ad5ffd7982e8517a2e44ddbed3d8a6892f89aef879fc8a8f6369d18c3d44c69a8d606135eedeb7cc2e2f9b141d27c

data/.github/workflows/build.yml

@@ -0,0 +1,30 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  spec:
+    name: Ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: ['2.5.x', '2.6.x', '2.7.x']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Run spec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+## v0.6.1 (2020-11-08)
+
+### BugFixes
+
+- [#51](https://github.com/wata727/elastic_whenever/pull/51): Avoid hitting rate limits fetching credentials when running under ECS or with an IAM profile  ([@stevenwilliamson](https://github.com/stevenwilliamson))
+
+### Chores
+
+- [#53](https://github.com/wata727/elastic_whenever/pull/53): Migrate CI to GitHub Actions from Travis CI
+
+## v0.6.0 (2019-10-16)
+
+### Enhancements
+
+- [#46](https://github.com/wata727/elastic_whenever/pull/46): Add option to disable rule ([@tobscher](https://github.com/tobscher))
+
+## v0.5.1 (2019-10-09)
+
+### Enhancements
+
+- [#45](https://github.com/wata727/elastic_whenever/pull/45): Add description to CloudWatch rule ([@tobscher](https://github.com/tobscher))
+
+## v0.5.0 (2019-09-19)
+
+### Enhancements
+
+- [#44](https://github.com/wata727/elastic_whenever/pull/44): Make CloudWatch Events IAM role name configurable ([@domcleal](https://github.com/domcleal))
+
+## v0.4.2 (2019-09-17)
+
+### BugFixes
+
+- [#43](https://github.com/wata727/elastic_whenever/pull/43): Add expression to task rule name hash computation ([@korbin](https://github.com/korbin))
+
+### Chore
+
+- [#42](https://github.com/wata727/elastic_whenever/pull/42): Fix typo in clear task log line ([@HistoireDeBabar](https://github.com/HistoireDeBabar))
+
 ## v0.4.1 (2019-07-23)
 
 ### BugFixes

data/README.md

@@ -1,5 +1,5 @@
 # Elastic Whenever
-[![Build Status](https://travis-ci.org/wata727/elastic_whenever.svg?branch=master)](https://travis-ci.org/wata727/elastic_whenever)
+[![Build Status](https://github.com/wata727/elastic_whenever/workflows/build/badge.svg?branch=master)](https://github.com/wata727/elastic_whenever/actions)
 [![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)
 
@@ -42,6 +42,8 @@ Usage: elastic_whenever [options]
         --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
+        --iam-role name              IAM role name used by CloudWatch Events. Default: ecsEventsRole
+        --rule-state state           The state of the CloudWatch Events Rule (ENABLED or DISABLED), default: ENABLED
         --profile profile_name       AWS shared profile name
         --access-key aws_access_key_id
                                      AWS access key ID
@@ -62,6 +64,27 @@ cron(0 3 * * ? *) ecs-test example:2 cron bundle exec rake hoge:run
 ## [message] Run `elastic_whenever --help' for more options.
 ```
 
+### Setting variables
+Elastic Whenever supports setting variables via the `--set` option [as Whenever does](https://github.com/javan/whenever/wiki/Setting-variables-on-the-fly).
+
+Example:
+
+`elastic_whenever --set 'environment=staging&some_var=foo'`
+
+```ruby
+if @environment == 'staging'
+  every '0 1 * * *' do
+    rake 'some_task_on_staging'
+  end
+elsif @some_var == 'foo'
+  every '0 10 * * *' do
+    rake 'some_task'
+  end
+end
+```
+
+Especially, `@environment` defaults to `"production"`.
+
 ## How it works
 Elastic Whenever creates CloudWatch Events as many as `every` block. Each event has as many targets as there are commands in the block.
 

data/elastic_whenever.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_dependency "aws-sdk-ecs", "~> 1.0"

data/lib/elastic_whenever/cli.rb

@@ -22,7 +22,7 @@ module ElasticWhenever
           with_concurrent_modification_handling do
             clear_tasks(option)
           end
-          Logger.instance.log("write", "shceduled tasks cleared")
+          Logger.instance.log("write", "scheduled tasks cleared")
         when Option::LIST_MODE
           list_tasks(option)
           Logger.instance.message("Above is your scheduled tasks.")

data/lib/elastic_whenever/option.rb

@@ -1,5 +1,7 @@
 module ElasticWhenever
   class Option
+    POSSIBLE_RULE_STATES = %w[ENABLED DISABLED].freeze
+
     DRYRUN_MODE = 1
     UPDATE_MODE = 2
     CLEAR_MODE = 3
@@ -19,6 +21,8 @@ module ElasticWhenever
     attr_reader :security_groups
     attr_reader :subnets
     attr_reader :schedule_file
+    attr_reader :iam_role
+    attr_reader :rule_state
 
     class InvalidOptionException < StandardError; end
 
@@ -36,6 +40,8 @@ module ElasticWhenever
       @security_groups = []
       @subnets = []
       @schedule_file = 'config/schedule.rb'
+      @iam_role = 'ecsEventsRole'
+      @rule_state = 'ENABLED'
       @profile = nil
       @access_key = nil
       @secret_key = nil
@@ -92,6 +98,12 @@ module ElasticWhenever
         opts.on('-f', '--file schedule_file', 'Default: config/schedule.rb') do |file|
           @schedule_file = file
         end
+        opts.on('--iam-role name', 'IAM role name used by CloudWatch Events. Default: ecsEventsRole') do |role|
+          @iam_role = role
+        end
+        opts.on('--rule-state state', 'The state of the CloudWatch Events Rule. Default: ENABLED') do |state|
+          @rule_state = state
+        end
         opts.on('--profile profile_name', 'AWS shared profile name') do |profile|
           @profile = profile
         end
@@ -128,6 +140,7 @@ module ElasticWhenever
       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
+      raise InvalidOptionException.new("Invalid rule state. Possible values are #{POSSIBLE_RULE_STATES.join(", ")}") unless POSSIBLE_RULE_STATES.include?(rule_state)
     end
 
     private

data/lib/elastic_whenever/task/role.rb

@@ -1,17 +1,16 @@
 module ElasticWhenever
   class Task
     class Role
-      NAME = "ecsEventsRole"
-
       def initialize(option)
         client = Aws::IAM::Client.new(option.aws_config)
         @resource = Aws::IAM::Resource.new(client: client)
-        @role = resource.role(NAME)
+        @role_name = option.iam_role
+        @role = resource.role(@role_name)
       end
 
       def create
         @role = resource.create_role(
-          role_name: NAME,
+          role_name: @role_name,
           assume_role_policy_document: role_json,
         )
         role.attach_policy(

data/lib/elastic_whenever/task/rule.rb

@@ -1,8 +1,10 @@
 module ElasticWhenever
   class Task
     class Rule
+      attr_reader :option
       attr_reader :name
       attr_reader :expression
+      attr_reader :description
 
       class UnsupportedOptionException < StandardError; end
 
@@ -13,6 +15,8 @@ module ElasticWhenever
             option,
             name: rule.name,
             expression: rule.schedule_expression,
+            description: rule.description,
+            client: client
           )
         end
       end
@@ -20,22 +24,31 @@ module ElasticWhenever
       def self.convert(option, task)
         self.new(
           option,
-          name: rule_name(option.identifier, task.commands),
-          expression: task.expression
+          name: rule_name(option.identifier, task.expression, task.commands),
+          expression: task.expression,
+          description: rule_description(option.identifier, task.expression, task.commands)
         )
       end
 
-      def initialize(option, name:, expression:)
+      def initialize(option, name:, expression:, description:, client: nil)
+        @option = option
         @name = name
         @expression = expression
-        @client = Aws::CloudWatchEvents::Client.new(option.aws_config)
+        @description = description
+        if client != nil
+          @client = client
+        else
+          @client = Aws::CloudWatchEvents::Client.new(option.aws_config)
+        end
       end
 
       def create
+        # See https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutRule.html#API_PutRule_RequestSyntax
         client.put_rule(
           name: name,
           schedule_expression: expression,
-          state: "ENABLED",
+          description: truncate(description, 512),
+          state: option.rule_state,
         )
       end
 
@@ -47,8 +60,16 @@ module ElasticWhenever
 
       private
 
-      def self.rule_name(identifier, commands)
-        "#{identifier}_#{Digest::SHA1.hexdigest(commands.map { |command| command.join("-") }.join("-"))}"
+      def self.rule_name(identifier, expression, commands)
+        "#{identifier}_#{Digest::SHA1.hexdigest([expression, commands.map { |command| command.join("-") }.join("-")].join("-"))}"
+      end
+
+      def self.rule_description(identifier, expression, commands)
+        "#{identifier} - #{expression} - #{commands.map { |command| command.join(" ") }.join(" - ")}"
+      end
+
+      def truncate(string, max)
+        string.length > max ? string[0...max] : string
       end
 
       attr_reader :client

data/lib/elastic_whenever/version.rb

@@ -1,3 +1,3 @@
 module ElasticWhenever
-  VERSION = "0.4.1"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_whenever
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.1
 platform: ruby
 authors:
 - Kazuma Watanabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2020-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,9 +130,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage ECS Scheduled Tasks like Whenever

data/.travis.yml

@@ -1,9 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-before_install:
-  - gem update --system
-  - gem install bundler