skyrunner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8928e9988b2964b41819825a1b47adf1a458338d
+  data.tar.gz: cfbd389efd794094ce4be1f465dfff0252b976d4
+SHA512:
+  metadata.gz: befca88f0e29654d83dafb5539a973c5b9f39fd52db3e72edf34e2ce55e529e738691835701c308dc62ebb9057133998c41ffd710c806e72e238df53bf8e3400
+  data.tar.gz: e180a3849b4f5b1891eb681e1786826464612be54dbc523328b2c442c9390e23b9bacc869ba9049ac4bf9fbbf2ca7ab54353fc35fb7cdbd01b245fe304bfca8f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in skyrunner.gemspec
+gemspec
+
+gem "aws-sdk"
+gem "activesupport"
+gem "log4r"
+gem "trollop"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Greg Fodor
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+skyrunner
+=========
+
+Skyrunner lets you run logical jobs using AWS SQS and DynamoDB

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/skyrunner

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+$: << File.dirname(__FILE__) + "/../lib"
+
+require "skyrunner"
+require "trollop"
+
+logger = Log4r::Logger.new("sky")
+logger.outputters << Log4r::StdoutOutputter.new("out")
+logger.level = Log4r::DEBUG
+
+SkyRunner.logger = logger
+
+trap("INT") do
+  SkyRunner.stop_consuming!
+end
+
+trap("TERM") do
+  SkyRunner.stop_consuming!
+end
+
+opts = Trollop::options do
+  banner <<-END
+  Runs logical jobs (made up of tasks) coordinated via AWS SQS & DynamoDB.
+
+  Usage:
+      skyrunner [options] <command>
+
+      Valid commands:
+
+      consume - Starts consuming tasks.
+      init - Creates DynamoDB table and SQS queue for SkyRunner.
+      purge - Purges and re-creates DynamoDB table and SQS queue for SkyRunner. (Destructive!)
+  END
+
+  opt :dynamo_db_table_name, "DynamoDB table to use for job state.", default: "skyrunner_jobs", type: :string
+  opt :sqs_queue_name, "SQS queue use for tasks.", default: "skyrunner_tasks", type: :string
+  opt :namespace, "Namespace of jobs to consume.", default: "default", type: :string
+  opt :batch_size, "Number of tasks to consume per batch.", default: 10
+end
+
+SkyRunner.dynamo_db_table_name = opts[:dynamo_db_table_name]
+SkyRunner.sqs_queue_name = opts[:sqs_queue_name]
+SkyRunner.job_namespace = opts[:namespace]
+SkyRunner.consumer_batch_size = opts[:batch_size].to_i
+
+COMMANDS = ["init", "purge", "consume"]
+
+Trollop::die "Must specify command" unless COMMANDS.include?(ARGV[0])
+
+command = ARGV[0]
+
+case command
+when "init"
+  SkyRunner.init!
+when "purge"
+  SkyRunner.init!(purge: true)
+when "consume"
+  SkyRunner.consume!
+end

data/jobs/example_job.rb

@@ -0,0 +1,28 @@
+require "skyrunner"
+
+module ExampleJobModule
+  class ExampleJob
+    include SkyRunner::Job
+
+    on_completed :print_completed
+    on_failed :print_failed
+
+    def run(number_of_tasks: nil)
+      1.upto(number_of_tasks).each do |n|
+        yield :print_number, task_number: n
+      end
+    end
+
+    def print_number(task_number: nil)
+      puts "Ran rask #{task_number}"
+    end
+
+    def print_completed(number_of_tasks: nil)
+      puts "Completed with #{number_of_tasks}"
+    end
+
+    def print_failed(number_of_tasks: nil)
+      puts "Failed with #{number_of_tasks}"
+    end
+  end
+end

data/lib/skyrunner/job.rb

@@ -0,0 +1,145 @@
+module SkyRunner::Job
+  attr_accessor :skyrunner_job_id
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def on_completed(methods)
+      add_job_event_methods(methods, :completed)
+    end
+
+    def on_failed(methods)
+      add_job_event_methods(methods, :failed)
+    end
+
+    def job_event_methods
+      @_job_event_methods ||= {}
+    end
+
+    private 
+
+    def add_job_event_methods(methods, type)
+      methods = Array(methods)
+      job_event_methods[type] ||= []
+      job_event_methods[type].concat(methods.map(&:to_sym))
+    end
+  end
+
+  def execute!(args = {})
+    job_id = SecureRandom.hex
+    self.skyrunner_job_id = job_id
+
+    table = SkyRunner.dynamo_db_table
+    queue = SkyRunner.sqs_queue
+
+    record = table.items.put(job_id: job_id, namespace: SkyRunner.job_namespace, class: self.class.name, args: args.to_json, total_tasks: 1, completed_tasks: 0, done: 0, failed: 0)
+
+    pending_args = []
+
+    flush = lambda do
+      messages = pending_args.map do |task_args|
+        { job_id: job_id, task_id: SecureRandom.hex, task_args: task_args }.to_json
+      end
+
+      dropped_message_count = 0
+      pending_args.clear
+
+      begin
+        queue.batch_send(messages)
+      rescue AWS::SQS::Errors::BatchSendError => e
+        dropped_message_count = e.errors.size
+
+        # Re-add dropped args
+        e.errors.each do |error|
+          pending_args << JSON.parse(error[:message_body])["task_args"]
+        end
+      end
+
+      record.attributes.add({ total_tasks: messages.size - dropped_message_count })
+    end
+
+    self.run(args) do |*task_args|
+      pending_args << task_args
+
+      if pending_args.size >= SkyRunner::SQS_MAX_BATCH_SIZE
+        1.upto(5) do
+          flush.()
+          sleep 5 if pending_args.size > 0
+        end
+      end
+    end
+
+    1.upto(5) do
+      flush.() if pending_args.size > 0
+      sleep 5 if pending_args.size > 0
+    end
+
+    handle_task_completed!
+  end
+
+  def consume!(task_args)
+    begin
+      self.send(task_args[0].to_sym, task_args[1].symbolize_keys)
+      handle_task_completed!
+    rescue Exception => e
+      handle_task_failed! rescue nil
+      raise
+    end
+  end
+
+  private 
+
+  def dynamo_db_record
+    SkyRunner.dynamo_db_table.items[self.skyrunner_job_id]
+  end
+
+  def handle_task_failed!
+    return false unless self.skyrunner_job_id
+
+    begin
+      record = dynamo_db_record
+      record.attributes.add({ failed: 1 })
+
+      (self.class.job_event_methods[:failed] || []).each do |method|
+        if self.method(method).arity == 0 && self.method(method).parameters.size == 0
+          self.send(method)
+        else
+          self.send(method, JSON.parse(record.attributes["args"]).symbolize_keys)
+        end
+      end
+    rescue Exception => e
+    end
+  end
+
+  def handle_task_completed!
+    return false unless self.skyrunner_job_id
+
+    record = dynamo_db_record
+
+    new_attributes = record.attributes.add({ completed_tasks: 1 }, return: :all_new)
+
+    if new_attributes["total_tasks"] == new_attributes["completed_tasks"]
+      begin
+        if_condition = { completed_tasks: new_attributes["total_tasks"], done: 0 }
+
+        record.attributes.update(if: if_condition) do |u|
+          u.add(done: 1)
+        end
+
+        (self.class.job_event_methods[:completed] || []).each do |method|
+          if self.method(method).arity == 0 && self.method(method).parameters.size == 0
+            self.send(method)
+          else
+            self.send(method, JSON.parse(record.attributes["args"]).symbolize_keys)
+          end
+        end
+      rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException => e
+        # This is OK, we had a double finisher.
+      end
+    end
+
+    true
+  end
+end

data/lib/skyrunner/version.rb

@@ -0,0 +1,3 @@
+module Skyrunner
+  VERSION = "0.0.1"
+end

data/lib/skyrunner.rb

@@ -0,0 +1,187 @@
+require "skyrunner/version"
+require "aws-sdk"
+require "active_support"
+require "active_support/core_ext"
+require "log4r"
+require "json"
+require "set"
+
+module SkyRunner
+  SQS_MAX_BATCH_SIZE = 10 # Constant defined by AWS
+
+  def self.setup
+    yield self
+  end
+
+  def self.init!(params = {})
+    table = self.dynamo_db_table
+
+    if !table.exists? || params[:purge]
+      table_name = SkyRunner.dynamo_db_table_name
+
+      if table.exists? && params[:purge]
+        SkyRunner.log :warn, "Purging DynamoDB table #{table_name}."
+        table.delete
+
+        sleep 1 while table.exists?
+      end
+
+      SkyRunner.log :info, "Creating DynamoDB table #{table_name}."
+
+      table = dynamo_db.tables.create(table_name, 
+                                     SkyRunner.dynamo_db_read_capacity, 
+                                     SkyRunner.dynamo_db_write_capacity,
+                                     hash_key: { job_id: :string })
+
+      sleep 1 while table.status == :creating
+    end
+
+    queue = self.sqs_queue
+
+    if !queue || params[:purge]
+      queue_name = SkyRunner.sqs_queue_name
+
+      if queue && params[:purge]
+        SkyRunner.log :warn, "Purging SQS queue #{queue_name}. Waiting 65 seconds to re-create."
+        queue.delete
+
+        sleep 65
+      end
+
+      SkyRunner.log :info, "Creating SQS queue #{queue_name}."
+
+      queue = sqs.queues.create(queue_name, 
+                                visibility_timeout: SkyRunner.sqs_visibility_timeout,
+                                message_retention_period: SkyRunner.sqs_message_retention_period)
+    end
+
+    true
+  end
+
+  def self.consume!(&block)
+    queue = sqs_queue
+    table = dynamo_db_table
+
+    raise "Queue #{SkyRunner::sqs_queue_name} not found. Try running 'skyrunner init'" unless queue
+    raise "DynamoDB table #{SkyRunner::dynamo_db_table_name} not found. Try running 'skyrunner init'" unless table && table.exists?
+
+    log :info, "Consumer started."
+
+    loop do
+      return true if stop_consuming
+
+      received_messages = []
+
+      queue.receive_messages(limit: [1, [SkyRunner.consumer_batch_size, SQS_MAX_BATCH_SIZE].min].max, wait_time_seconds: 15) do |message|
+        received_messages << [message, JSON.parse(message.body)]
+      end
+
+      next unless received_messages.size > 0
+
+      failed = false
+
+      table.batch_get(:all, received_messages.map { |m| m[1]["job_id"] }.uniq, consistent_read: true) do |record|
+        break if stop_consuming
+
+        received_messages.select { |m| m[1]["job_id"] == record["job_id"] }.each_with_index do |received_message|
+          break if stop_consuming
+
+          message = received_message[1]
+          job_id = message["job_id"]
+
+          if record["namespace"] == SkyRunner.job_namespace && record["failed"] == 0 && !failed
+            start_time = Time.now
+
+            begin
+              klass = Kernel.const_get(record["class"])
+
+              task_args = message["task_args"]
+              log :info, "Run Task: #{task_args} Job: #{job_id}"
+
+              job = klass.new
+              job.skyrunner_job_id = job_id
+
+              begin
+                job.consume!(task_args)
+                received_message[0].delete
+
+                yield false if block_given?
+              rescue Exception => e
+                failed = true
+                log :error, "Task Failed: #{task_args} Job: #{job_id} #{e.message} #{e.backtrace.join("\n")}"
+                yield e if block_given?
+              end
+            rescue NameError => e
+              failed = true
+              log :error, "Task Failed: No such class #{record["class"]} #{e.message}"
+              yield e if block_given?
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def self.dynamo_db_table
+    dynamo_db.tables[SkyRunner.dynamo_db_table_name].tap do |table|
+      table.load_schema if table && table.exists?
+    end
+  end
+
+  def self.sqs_queue
+    begin
+      sqs.queues.named(SkyRunner.sqs_queue_name)
+    rescue AWS::SQS::Errors::NonExistentQueue => e
+      return nil
+    end
+  end
+
+  def self.log(type, message)
+    SkyRunner.logger.send(type, "[SkyRunner] #{message}")
+  end
+
+  mattr_accessor :dynamo_db_table_name
+  @@dynamo_db_table_name = "skyrunner_jobs"
+
+  mattr_accessor :dynamo_db_read_capacity
+  @@dynamo_db_read_capacity = 10
+
+  mattr_accessor :dynamo_db_write_capacity
+  @@dynamo_db_write_capacity = 10
+
+  mattr_accessor :sqs_queue_name
+  @@sqs_queue_name = "skyrunner_tasks"
+
+  mattr_accessor :sqs_visibility_timeout
+  @@sqs_visibility_timeout = 90
+
+  mattr_accessor :sqs_message_retention_period
+  @@sqs_message_retention_period = 345600
+
+  mattr_accessor :job_namespace
+  @@job_namespace = "default"
+
+  mattr_accessor :consumer_batch_size
+  @@consumer_batch_size = 10
+
+  mattr_accessor :logger
+  @@logger = Log4r::Logger.new("skyrunner")
+
+  mattr_accessor :stop_consuming
+
+  def self.stop_consuming!
+    SkyRunner::stop_consuming = true
+  end
+
+  private
+
+  def self.dynamo_db
+    @dynamo_db ||= AWS::DynamoDB.new
+  end
+
+  def self.sqs
+    @sqs ||= AWS::SQS.new
+  end
+end
+
+require "skyrunner/job"

data/skyrunner.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'skyrunner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skyrunner"
+  spec.version       = Skyrunner::VERSION
+  spec.authors       = ["Greg Fodor"]
+  spec.email         = ["gfodor@gmail.com"]
+  spec.description   = %q{SkyRunner runs logical jobs that are broken up into tasks via Amazon SQS and DynamoDB.}
+  spec.summary       = %q{SkyRunner runs logical jobs that are broken up into tasks via Amazon SQS and DynamoDB.}
+  spec.homepage      = "http://github.com/gfodor/skyrunner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "aws-sdk"
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "log4r"
+  spec.add_runtime_dependency "trollop"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: skyrunner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Greg Fodor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SkyRunner runs logical jobs that are broken up into tasks via Amazon
+  SQS and DynamoDB.
+email:
+- gfodor@gmail.com
+executables:
+- skyrunner
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/skyrunner
+- jobs/example_job.rb
+- lib/skyrunner.rb
+- lib/skyrunner/job.rb
+- lib/skyrunner/version.rb
+- skyrunner.gemspec
+homepage: http://github.com/gfodor/skyrunner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: SkyRunner runs logical jobs that are broken up into tasks via Amazon SQS
+  and DynamoDB.
+test_files: []
+has_rdoc: