elastic_whenever 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b08fd8f4fb4826af5a1863a42cb29c9ece9ec66a
-  data.tar.gz: d3030170100ddaa8d00480e0985e14853503ef78
+  metadata.gz: 279fa293930adedd6b35d4fbf629c8b647c09b35
+  data.tar.gz: d2949e35f69c75489f38fc9e9b45a655c06de5b4
 SHA512:
-  metadata.gz: c9e571272b10b3f871773d3326a1bfc16a9fb0fb96a14a2316bfa635840189b176d58244020f696daff20004079f4c00686671b1cdca71e256f4392f4a814370
-  data.tar.gz: 593d852b48bd44d977379750c9154e65e88218c58ca7fecd28a2701c6e428a01dc82d490a7349fb94c28ef46a8e630dd5186b2748c315c257e08968734789524
+  metadata.gz: bdd1cf72a17f318c78ad1e27fb6340761e064ace66c4a45b8942437dc302a8a06b984a0cf16b95afad9199c13b9d650c8d56be5fbb29471d7afc33d2d5599301
+  data.tar.gz: 74528044ab14b01dfdf3c40910b2049ffae4b06c56476033d2374910e3a5c58e45793bb7a5f06f70f41a314d1dd6ecd2b2dc56414a5a8500489c30080c10ae6b

data/.travis.yml

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

data/README.md

@@ -39,7 +39,23 @@ Usage: elastic_whenever [options]
     -v, --version                    Print version
 ```
 
-However, please be aware that you must specify an identifier.
+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.
+
+```
+$ 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.
 

data/lib/elastic_whenever/cli.rb

@@ -28,10 +28,15 @@ module ElasticWhenever
         end
 
         SUCCESS_EXIT_CODE
+      rescue Aws::Errors::MissingRegionError
+        Logger.instance.fail("missing region error occurred; please use `--region` option or export `AWS_REGION` environment variable.")
+        ERROR_EXIT_CODE
+      rescue Aws::Errors::MissingCredentialsError
+        Logger.instance.fail("missing credential error occurred; please specify it with arguments, use shared credentials, or export `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variable.")
+        ERROR_EXIT_CODE
       rescue OptionParser::MissingArgument,
         Option::InvalidOptionException,
-        Schedule::InvalidScheduleException,
-        Aws::Errors::MissingCredentialsError => exn
+        Schedule::InvalidScheduleException => exn
 
         Logger.instance.fail(exn.message)
         ERROR_EXIT_CODE
@@ -40,10 +45,7 @@ module ElasticWhenever
       private
 
       def update_tasks(option, dry_run:)
-        schedule = Schedule.new(option.schedule_file)
-        option.variables.each do |var|
-          schedule.set(var[:key], var[:value])
-        end
+        schedule = Schedule.new(option.schedule_file, option.variables)
         schedule.validate!
 
         cluster = Task::Cluster.new(option, schedule.cluster)
@@ -55,7 +57,12 @@ module ElasticWhenever
 
         clear_tasks(option) unless dry_run
         schedule.tasks.each do |task|
-          rule = Task::Rule.convert(option, task)
+          begin
+            rule = Task::Rule.convert(option, task, schedule.chronic_options)
+          rescue Task::Rule::UnsupportedOptionException => exn
+            Logger.instance.warn(exn.message)
+            next
+          end
           targets = task.commands.map do |command|
             Task::Target.new(
               option,
@@ -71,7 +78,12 @@ module ElasticWhenever
           if dry_run
             print_task(rule, targets)
           else
-            rule.create
+            begin
+              rule.create
+            rescue Aws::CloudWatchEvents::Errors::ValidationException => exn
+              Logger.instance.warn("#{exn.message} Ignore this task: name=#{rule.name} expression=#{rule.expression}")
+              next
+            end
             targets.each(&:create)
           end
         end
@@ -83,8 +95,8 @@ module ElasticWhenever
 
       def list_tasks(option)
         Task::Rule.fetch(option).each do |rule|
-          target = Task::Target.fetch(option, rule)
-          print_task(rule, target)
+          targets = Task::Target.fetch(option, rule)
+          print_task(rule, targets)
         end
       end
 

data/lib/elastic_whenever/logger.rb

@@ -3,11 +3,11 @@ module ElasticWhenever
     include Singleton
 
     def fail(message)
-      puts "[fail] #{message}"
+      STDERR.puts "[fail] #{message}"
     end
 
     def warn(message)
-      puts "[warn] #{message}"
+      STDERR.puts "[warn] #{message}"
     end
 
     def log(event, message)
@@ -18,4 +18,4 @@ module ElasticWhenever
       puts "## [message] #{message}"
     end
   end
-end
+end

data/lib/elastic_whenever/schedule.rb

@@ -4,15 +4,21 @@ module ElasticWhenever
     attr_reader :cluster
     attr_reader :task_definition
     attr_reader :container
+    attr_reader :chronic_options
+    attr_reader :bundle_command
 
     class InvalidScheduleException < StandardError; end
 
-    def initialize(file, environment: "production")
-      @environment = environment
+    def initialize(file, variables)
+      @environment = "production"
       @tasks = []
       @cluster = nil
       @task_definition = nil
       @container = nil
+      @chronic_options = {}
+      @bundle_command = "bundle exec"
+
+      variables.each { |var| set(var[:key], var[:value]) }
       instance_eval(File.read(file), file)
     end
 
@@ -21,7 +27,7 @@ module ElasticWhenever
     end
 
     def every(frequency, options = {}, &block)
-      @tasks << Task.new(@environment, frequency, options).tap do |task|
+      @tasks << Task.new(@environment, @bundle_command, frequency, options).tap do |task|
         task.instance_eval(&block)
       end
     end
@@ -31,5 +37,9 @@ module ElasticWhenever
       raise InvalidScheduleException.new("You must set task definition") unless task_definition
       raise InvalidScheduleException.new("You must set container") unless container
     end
+
+    def method_missing(name, *args)
+      Logger.instance.warn("Skipping unsupported method: #{name}")
+    end
   end
 end

data/lib/elastic_whenever/task.rb

@@ -4,33 +4,32 @@ module ElasticWhenever
     attr_reader :frequency
     attr_reader :options
 
-    def initialize(environment, frequency, options = {})
+    def initialize(environment, bundle_command, frequency, options = {})
       @environment = environment
+      @bundle_command = bundle_command.split(" ")
       @frequency = frequency
       @options = options
       @commands = []
     end
 
-    def runner(src)
-      @commands << [
-        "bundle",
-        "exec",
-        "bin/rails",
-        "runner",
-        "-e",
-        @environment,
-        src
-      ]
+    def command(task)
+      @commands << task.split(" ")
     end
 
     def rake(task)
-      @commands << [
-        "bundle",
-        "exec",
-        "rake",
-        task,
-        "--silent"
-      ]
+      @commands << [@bundle_command, "rake", task, "--silent"].flatten
+    end
+
+    def runner(src)
+      @commands << [@bundle_command, "bin/rails", "runner", "-e", @environment, src].flatten
+    end
+
+    def script(script)
+      @commands << [@bundle_command, "script/#{script}"].flatten
+    end
+
+    def method_missing(name, *args)
+      Logger.instance.warn("Skipping unsupported method: #{name}")
     end
   end
 end

data/lib/elastic_whenever/task/rule.rb

@@ -4,6 +4,8 @@ module ElasticWhenever
       attr_reader :name
       attr_reader :expression
 
+      class UnsupportedOptionException < StandardError; end
+
       def self.fetch(option)
         client = Aws::CloudWatchEvents::Client.new(option.aws_config)
         client.list_rules(name_prefix: option.identifier).rules.map do |rule|
@@ -15,11 +17,11 @@ module ElasticWhenever
         end
       end
 
-      def self.convert(option, task)
+      def self.convert(option, task, chronic_options)
         self.new(
           option,
           name: rule_name(option.identifier, task.commands),
-          expression: schedule_expression(task.frequency, task.options)
+          expression: schedule_expression(task.frequency, task.options, chronic_options)
         )
       end
 
@@ -39,7 +41,7 @@ module ElasticWhenever
 
       def delete
         targets = client.list_targets_by_rule(rule: name).targets
-        client.remove_targets(rule: name, ids: targets.map(&:id))
+        client.remove_targets(rule: name, ids: targets.map(&:id)) unless targets.empty?
         client.delete_rule(name: name)
       end
 
@@ -49,19 +51,53 @@ module ElasticWhenever
         "#{identifier}_#{Digest::SHA1.hexdigest(commands.map { |command| command.join("-") }.join("-"))}"
       end
 
-      def self.schedule_expression(frequency, options)
-        time = Chronic.parse(options[:at]) || Time.new(2017, 9, 9, 0, 0, 0)
+      def self.schedule_expression(frequency, options, chronic_options)
+        time = Chronic.parse(options[:at], chronic_options) || Time.new(2017, 12, 1, 0, 0, 0)
 
         case frequency
         when :hour
-          "cron(#{time.hour} * * * ? *)"
+          "cron(#{time.min} * * * ? *)"
         when :day
           "cron(#{time.min} #{time.hour} * * ? *)"
-        else
+        when :month
+          "cron(#{time.min} #{time.hour} #{time.day} * ? *)"
+        when :year
+          "cron(#{time.min} #{time.hour} #{time.day} #{time.month} ? *)"
+        when :sunday
+          "cron(#{time.min} #{time.hour} ? * 1 *)"
+        when :monday
+          "cron(#{time.min} #{time.hour} ? * 2 *)"
+        when :tuesday
+          "cron(#{time.min} #{time.hour} ? * 3 *)"
+        when :wednesday
+          "cron(#{time.min} #{time.hour} ? * 4 *)"
+        when :thursday
+          "cron(#{time.min} #{time.hour} ? * 5 *)"
+        when :friday
+          "cron(#{time.min} #{time.hour} ? * 6 *)"
+        when :saturday
+          "cron(#{time.min} #{time.hour} ? * 7 *)"
+        when :weekend
+          "cron(#{time.min} #{time.hour} ? * 1,7 *)"
+        when :weekday
+          "cron(#{time.min} #{time.hour} ? * 2-6 *)"
+        # cron syntax
+        when /^((\*?[\d\/,\-]*)\s*){5}$/
           min, hour, day, mon, week, year = frequency.split(" ")
-          week.gsub!("*", "?")
+          # You can't specify the Day-of-month and Day-of-week fields in the same Cron expression.
+          # If you specify a value in one of the fields, you must use a ? (question mark) in the other.
+          week.gsub!("*", "?") if day != "?"
+          day.gsub!("*", "?") if week != "?"
+          # cron syntax:          sunday -> 0
+          # scheduled expression: sunday -> 1
+          week.gsub!(/(\d)/) { (Integer($1) + 1) % 7 }
           year = year || "*"
           "cron(#{min} #{hour} #{day} #{mon} #{week} #{year})"
+        # schedule expression syntax
+        when /^((\*?\??L?W?[\d\/,\-]*)\s*){6}$/
+          "cron(#{frequency})"
+        else
+          raise UnsupportedOptionException.new("`#{frequency}` is not supported option. Ignore this task.")
         end
       end
 

data/lib/elastic_whenever/version.rb

@@ -1,3 +1,3 @@
 module ElasticWhenever
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic_whenever
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kazuma Watanabe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,9 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Manage ECS Scheduled Tasks like Whenever
 test_files: []
-has_rdoc: