task-orchestrator.gemspec 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alexander Piavlo
+
+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,29 @@
+# Task Orchestrator
+
+Simple task orchestration framework driven by Yaml config files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'task-orchestrator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install task-orchestrator
+
+## Usage
+
+    $ orchestrator -h
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/orchestrator.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+unless $:.include?(File.dirname(__FILE__) + '/../lib/')
+  $: << File.dirname(__FILE__) + '/../lib'
+end
+
+require 'orchestrator'
+
+options = Orchestrator::Cli.parse(ARGV)
+task = Orchestrator::Task.new(options)
+task.run

data/examples/dependencies

@@ -0,0 +1,21 @@
+orchestrator:
+  statedir: states
+  dependencies:
+    description: lalalalal
+    save: true
+    steps:
+      - type: parallel
+        parallel: 2
+        scripts:
+          - command: sleep 5
+            timeout: 10
+            tags: [ zopa, popa ]
+          - command: sleep 5
+            timeout: 2
+            tags: [ kaka, popa ]            
+          - command: sleep 5
+            depends: zopa
+          - command: sleep 5
+            depends: kaka
+          - command: sleep 5
+            depends: [ zopa, kaka ]

data/examples/interpolation

@@ -0,0 +1,15 @@
+orchestrator:
+  statedir: states
+  interpolation:
+    description: command interpolation test
+    save: true
+    steps:
+      - type: sequential
+        scripts:
+          - command: "echo :::ARG.name:::"
+          - command: "echo :::ARG.arg1:::"
+          - command: "echo :::ARG.arg2:::"
+          - command: "echo :::ENV.DNS:::"
+          - command: "echo :::EXEC.date:::"
+          - command: "echo :::EXEC./bin/date +%s:::"
+#          - command: "echo :::EXEC./dasdfsd:::"

data/examples/multistep

@@ -0,0 +1,23 @@
+orchestrator:
+  statedir: states
+  multistep:
+    description: multiple steps test
+    save: true
+    steps:
+      - type: parallel
+        parallel: 2
+        sleep: 0.1
+        scripts:
+          - command: sleep 5
+          - command: echo parallel 1
+          - command: echo parallel 2
+          - command: echo parallel 3
+          - command: echo parallel 4
+          - command: echo parallel 5
+      - type: sequential
+        scripts:
+          - command: echo sequential 1
+          - command: echo sequential 2
+          - command: echo sequential 3
+          - command: echo sequential 4
+          - command: echo sequential 5

data/examples/parallel

@@ -0,0 +1,16 @@
+orchestrator:
+  statedir: states
+  parallel:
+    description: parallel step test
+    save: true
+    steps:
+      - type: parallel
+        parallel: 2
+        sleep: 0.1
+        scripts:
+          - command: sleep 5
+          - command: echo 1
+          - command: echo 2
+          - command: echo 3
+          - command: echo 4
+          - command: echo 5

data/examples/sequential

@@ -0,0 +1,13 @@
+orchestrator:
+  statedir: states
+  sequential:
+    description: lalalalal
+    save: true
+    steps:
+      - type: sequential
+        scripts:
+          - command: echo 1
+          - command: echo 2
+          - command: echo 3
+          - command: echo 4
+          - command: echo 5

data/examples/timeouts

@@ -0,0 +1,40 @@
+orchestrator:
+  statedir: states
+  timeouts1:
+    description: timeouts test 1
+    save: true
+    steps:
+      - type: sequential
+#        on_failure: die
+        on_failure: ignore
+        scripts:
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 5
+             timeout: 2
+  timeouts2:
+    description: timeouts test 2
+    save: true
+    steps:
+      - type: parallel
+        parallel: 2
+        sleep: 0.1
+#        on_failure: die
+#        on_failure: wait
+#        on_failure: finish
+        on_failure: ignore
+        scripts:
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 5
+             timeout: 2
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 1
+             timeout: 2
+           - command: sleep 1
+             timeout: 2

data/lib/orchestrator.rb

@@ -0,0 +1,7 @@
+module Orchestrator
+  Settings = File.expand_path('.settings')
+
+  require 'orchestrator/version.rb'
+  require 'orchestrator/cli.rb'
+  require 'orchestrator/task.rb'
+end

data/lib/orchestrator/cli.rb

@@ -0,0 +1,67 @@
+require 'formatador'
+require 'optparse'
+require 'ostruct'
+
+module Orchestrator
+
+  class Cli
+
+    def self.parse(args)
+      options = OpenStruct.new
+      options.args = Object.new
+
+      parser = OptionParser.new
+      parser.banner = "Usage: #{$0} [options]"
+
+      options.config = Orchestrator::Settings
+      parser.on( '--config [PATH]', 'Path to settings yaml' ) do |config|
+        options.config = config
+        options.args.instance_variable_set(:@config,config)
+      end
+
+      options.statefile = nil
+      options.name = nil
+      parser.on( '--name NAME', 'Name of the cron job to run' ) do |name|
+        options.name = name
+        options.args.instance_variable_set(:@name,name)
+      end
+
+      parser.on( '--statefile PATH', 'Path to state file yaml' ) do |statefile|
+        options.statefile = statefile
+        options.args.instance_variable_set(:@statefile,statefile)
+      end
+
+      options.reset = false
+      parser.on( '--reset', 'Do not use state file if it exists' ) { |reset| options.reset = true }
+
+      parser.on( '--args ARGS,', 'extra args for interpolation as arg1=val1[,arg2=val2[]]' ) do |a|
+        a.split(',').each do |x|
+          arg,val = x.split('=')
+          options.args.instance_variable_set("@#{arg}".to_sym,val)
+        end
+      end
+
+      options.verbose = false
+      parser.on( '--verbose') { options.verbose = true }
+
+      options.email = true
+      parser.on( '--no-email') { options.email = false }
+
+      options.sms = true
+      parser.on( '--no-sms') { options.sms = false }
+
+      parser.on( '-h', '--help', 'Display this screen' ) { puts parser; exit }
+
+      parser.parse!(args)
+
+      unless options.name
+        puts opts
+        exit 1 
+      end
+
+      options
+    end
+
+  end
+
+end

data/lib/orchestrator/task.rb

@@ -0,0 +1,301 @@
+require 'popen4'
+require 'pony'
+require 'yaml'
+require 'timeout'
+require 'formatador'
+require 'fileutils'
+
+module Orchestrator
+
+  class Task
+
+    def initialize(options)
+      @mutex = Mutex.new
+      Thread.abort_on_exception = true
+      @log = ''
+
+      @options = options
+
+      invalid("config file #{config} does not exists") unless File.exist?(@options.config)
+
+      @settings = YAML.load_file(@options.config)
+      invalid("no task job #{@options.name} is defined in settings file") unless @settings['orchestrator'].has_key?(@options.name)
+
+      invalid("no statedir is defined in settings file") if @settings['orchestrator'][@options.name]['save'] && !@settings['orchestrator'].has_key?('statedir')
+      unless @options.statefile
+        if @settings['orchestrator'][@options.name]['save']
+          @options.statefile = @settings['orchestrator']['statedir'] + "/" + @options.name
+          FileUtils.mkdir_p(@settings['orchestrator']['statedir'])
+        end
+      end
+      @state = (@options.statefile && File.exist?(@options.statefile) && !@options.reset) ? YAML.load_file(@options.statefile) : @settings['orchestrator'][@options.name]
+
+      @options.email = false unless @state.has_key?('email')
+      @options.email_on_success = false if @options.email and @state['email'].has_key?('on_success') and not @state['email']['on_success']
+
+      @options.sms = false unless @state.has_key?('sms')
+      @options.sms_on_success = true if @options.sms and @state['sms'].has_key?('on_success') and @state['sms']['on_success']
+    end
+
+    def invalid(reason)
+      Formatador.display_line("[red]ERROR[/]: #{reason}")
+      exit 1
+    end
+
+    def save_state
+      if @options.statefile
+        @mutex.synchronize do
+          File.open(@options.statefile, "w") {|f| YAML.dump(@state, f)}
+        end
+      end
+    end
+
+    def interpolate_command(command)
+      command.gsub(/:::([^:]*):::/) do
+        match = $1
+        case match
+        when /^ENV\./
+          env = match["ENV.".length..-1]
+          invalid("command interpolation failed no such env variable - #{env}") unless ENV[env]
+          ENV[env]
+        when /^ARG\./
+          arg = match["ARG.".length..-1]
+          invalid("command interpolation failed no such arg - #{arg}") unless @options.args.instance_variable_defined?("@#{arg}".to_sym)
+          @options.args.instance_variable_get("@#{arg}".to_sym)
+        when /^EXEC\./
+          exec = match["EXEC.".length..-1]
+          result = nil
+          begin
+            result = IO.popen(exec)
+          rescue
+            invalid("command interpolation failed to exec - #{exec}")
+          end
+          invalid("command interpolation exec exit with non zero status - #{exec}") unless $?.to_i == 0
+          result.readline.delete("\n")
+        else
+          invalid("command interpolation failed not valid parameter - :::#{match}:::")
+        end
+      end
+    end
+
+    def validate_config
+      if @state.has_key?('email')
+        invalid("config email recipients is missing or invalid") unless @state['email'].has_key?('recipients') && @state['email']['recipients'].is_a?(String) || @state['email']['recipients'].is_a?(Array)
+        invalid("config email from is missing or invalid") unless @state['email'].has_key?('from') && @state['email']['from'].is_a?(String)
+      end
+      if @state.has_key?('sms')
+        invalid("task sms recipients is missing") unless @state['sms'].has_key?('recipients') && @state['sms']['recipients'].is_a?(String) || @state['sms']['recipients'].is_a?(Array)
+        invalid("task sms from is missing") unless @state['sms'].has_key?('from') && @state['sms']['from'].is_a?(String)
+      end
+      invalid("task description is missing or invalid") unless @state.has_key?('description') && @state['description'].is_a?(String)
+      invalid("task save must be boolean") if @state.has_key?('save') && !!@state['save'] != @state['save']
+      @state['save'] = false unless @state.has_key?('save')
+      invalid("task steps is missing") unless @state.has_key?('steps')
+      invalid("task steps must be array") unless @state['steps'].is_a?(Array)
+      @state['steps'].each do |step|
+        invalid("task step is not hash") unless step.is_a?(Hash)
+        invalid("task step has no type") unless step.has_key?('type') && step['type'].is_a?(String)
+        invalid("task step type #{step['type']} is invalid") unless [:parallel,:sequential].find_index(step['type'].to_sym)
+        invalid("task step scripts is missing or invalid") unless step.has_key?('scripts') && step['scripts'].is_a?(Array)
+        step['scripts'].each_index do |index|
+          if step['scripts'][index].is_a?(String)
+            step['scripts'][index] = { 'command' => interpolate_command(step['scripts'][index]) }
+          elsif step['scripts'][index].is_a?(Hash)
+            invalid("task step script command is invalid") unless step['scripts'][index].has_key?('command') && step['scripts'][index]['command'].is_a?(String)
+            step['scripts'][index]['command'] = interpolate_command(step['scripts'][index]['command'])
+          else
+            invalid("task script is invalid")
+          end
+        end
+      end
+    end
+
+    def fail
+      system "#{@state['failure_handler']} #{@state['failure_handler_args']}" if @state.has_key?('failure_handler')
+
+      Pony.mail(
+        :to => @state['email']['recipients'],
+        :from => @state['email']['from'],
+        :subject => "#{@state['description']} - [FAILED]",
+        :body => @log
+      ) if @options.email
+
+      Pony.mail(
+        :to => @state['sms']['recipients'],
+        :from => @state['sms']['from'],
+        :subject => "#{@state['description']} - [FAILED]",
+       :body => @state['sms']['auth']
+      ) if @options.sms
+
+      exit 1
+    end
+
+    def notify
+      Pony.mail(
+        :to => @state['email']['recipients'],
+        :from => @state['email']['from'],
+        :subject => "#{@state['description']} - [OK]",
+        :body => @log
+      ) if @options.email and @options.email_on_success
+
+      Pony.mail(
+        :to => @state['sms']['recipients'],
+        :from => @state['sms']['from'],
+        :subject => "#{@state['description']} - [OK]",
+        :body => @state['sms']['auth']
+      ) if @options.sms and @options.sms_on_success
+    end
+
+    def run_script(script)
+      result = ""
+      error = ""
+
+      timeout = script.has_key?('timeout') ? script['timeout'].to_i : @timeout
+
+      script['status'] = 'STARTED'
+      save_state
+
+      #  start = Time.now
+
+      begin
+        Timeout::timeout(timeout) do
+          status = POpen4::popen4(script['command']) do |stdout, stderr, stdin, pid|
+            result = stdout.read.strip
+            error = stderr.read.strip
+          end
+          script['status'] = (status.nil? or status.exitstatus != 0) ? 'FAILED' : 'OK'
+        end
+      rescue Timeout::Error
+        script['status'] = 'TIMEOUT'
+      end
+
+      save_state
+
+      #  runtime = Time.now - start
+      #  runtime = runtime > 60 ? runtime/60 : runtime
+
+      @mutex.synchronize do
+        output = <<-EOF
+
+Running: #{script['command']} - #{script['status']}
+============ STDOUT ============
+#{result}
+============ STDERR ============
+#{error}
+================================
+EOF
+
+        @log += output
+        puts output if @options.verbose
+      end
+
+      script['status'] == 'OK'
+    end
+
+    def thread_wrapper(i,script)
+      failures = 0
+
+      loop do
+        begin
+          @statuses[i] = run_script(script)
+        rescue Exception => e
+          script['status'] = 'EXCEPTION'
+          save_state
+          @statuses[i] = false
+          @mutex.synchronize do
+            output = <<-EOF
+
+Thread - (#{script['command']})
+Died due to following exception:
+#{e.inspect}
+#{e.backtrace}
+EOF
+            @log += output
+            puts output if @options.verbose
+          end
+        end
+
+        break if @statuses[i]
+
+        failures += 1
+        break if @retries < failures
+        sleep @retry_delay
+      end
+
+      @threads.delete(i)
+      fail if @on_failure == :die and not @statuses[i]
+    end
+
+    def run
+      validate_config
+      save_state
+
+      @state['steps'].each do |step|
+        @statuses = Array.new
+
+        @timeout = step.has_key?('timeout') ? step['timeout'].to_i : 0
+        @retries = step.has_key?('retries') ? step['retries'].to_i : 0
+        @retry_delay = step.has_key?('retry_delay') ? step['retry_delay'] : 0
+        @on_week_days = step.has_key?('on_week_days') ? step['on_week_days'].map{|d| "#{d}?".downcase.to_sym} : [ :sunday?, :monday?, :tuesday?, :wednesday?, :thursday?, :friday?, :saturday? ]
+        @on_month_days = step.has_key?('on_month_days') ? step['on_month_days'] : (1..31).to_a
+
+        if step['type'].to_sym == :parallel and @on_week_days.map {|d| Time.now.send(d) }.find_index(true) and @on_month_days.find_index(Time.now.mday)
+          #Parallel
+          interval = step.has_key?('sleep') ? step['sleep'] : 1
+          @on_failure = step.has_key?('on_failure') ? step['on_failure'].to_sym : :finish
+          parallel_factor = step.has_key?('parallel') ? step['parallel'] : 1
+
+          @threads = Hash.new
+          index = 0
+          running_threads = 0
+
+          step['scripts'].each_index do |index|
+            next if step['scripts'][index].has_key?('status') and step['scripts'][index]['status'] == 'OK'
+            loop do
+              @mutex.synchronize do
+                running_threads = @threads.length
+              end
+              break if @on_failure == :wait and @statuses.find_index(false)
+              if parallel_factor > running_threads
+                @threads[index] = Thread.new { thread_wrapper(index, step['scripts'][index]) }
+                break
+              end
+              sleep interval
+            end
+          end
+          loop do
+            @mutex.synchronize do
+              running_threads = @threads.length
+            end
+            break if running_threads == 0
+            sleep interval
+          end
+          fail if @on_failure != :ignore and @statuses.find_index(false)
+
+        elsif step['type'].to_sym == :sequential and @on_week_days.map {|d| Time.now.send(d) }.find_index(true) and @on_month_days.find_index(Time.now.mday)
+          #Sequential
+          @on_failure = step.has_key?('on_failure') ? step['on_failure'].to_sym : :die
+
+          step['scripts'].each_index do |index|
+            failures = 0
+            next if step['scripts'][index].has_key?('status') and step['scripts'][index]['status'] == 'OK'
+            loop do
+              @statuses[index] = run_script(step['scripts'][index])
+              break if @statuses[index]
+              failures += 1
+              break if failures > @retries
+              sleep @retry_delay
+            end
+            fail if not @statuses[index] and @on_failure == :die
+          end
+          fail if @on_failure != :ignore and @statuses.find_index(false)
+        end
+      end
+
+      FileUtils.rm_f(@options.statefile) if @options.statefile
+      notify
+    end
+
+  end
+
+end

data/lib/orchestrator/version.rb

@@ -0,0 +1,3 @@
+module Orchestrator
+  VERSION ||= '0.0.1'
+end

data/task-orchestrator.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "orchestrator/version"
+ 
+Gem::Specification.new do |s|
+  s.name        = "task-orchestrator.gemspec"
+  s.version     = Orchestrator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alexander Piavlo"]
+  s.email       = ["lolitushka@gmail.com"]
+  s.homepage    = "http://github.com/piavlo/task-orchestrator"
+  s.summary     = "Simple task orchestration framework"
+  s.description = "Simple task orchestration framework driven by Yaml config files"
+  s.license     = 'MIT'
+  s.has_rdoc    = false 
+
+
+  s.add_dependency('pony')
+  s.add_dependency('popen4')
+  s.add_dependency('formatador')
+
+  s.add_development_dependency('rake')
+
+  s.files         = Dir.glob("{bin,lib,examples}/**/*") + %w(task-orchestrator.gemspec LICENSE README.md)
+  s.executables   = Dir.glob('bin/**/*').map { |file| File.basename(file) }
+  s.test_files    = nil
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: task-orchestrator.gemspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Piavlo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pony
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: popen4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: formatador
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple task orchestration framework driven by Yaml config files
+email:
+- lolitushka@gmail.com
+executables:
+- orchestrator.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/orchestrator.rb
+- lib/orchestrator.rb
+- lib/orchestrator/task.rb
+- lib/orchestrator/version.rb
+- lib/orchestrator/cli.rb
+- examples/sequential
+- examples/multistep
+- examples/parallel
+- examples/interpolation
+- examples/timeouts
+- examples/dependencies
+- task-orchestrator.gemspec
+- LICENSE
+- README.md
+homepage: http://github.com/piavlo/task-orchestrator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple task orchestration framework
+test_files: []