gush 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee767bd97e343cac8bf395a65d2d19c63abd638b
+  data.tar.gz: d5a41126c1895e505871ae108613955466724829
+SHA512:
+  metadata.gz: ce471a04c947ff17fc3864644223463da25ca52aa59e34cc2118bcb607526db2b394c79b6b708af23bc29a7ae4efb5647e5bd19a09e51d9df253e1b8442fac42
+  data.tar.gz: dda4e7862751f8c7a7cc625f7bdafaca54dc6718a96689346d010d4ae8f6b3350dff9cd07cf461ad369930eb90f75e0bf33242f685be85ed0482065e8f8f367d

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+workflows/
+tmp
+test.rb
+/Gushfile.rb
+dump.rdb

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gush.gemspec
+gemspec
+
+gem 'pry'
+gem 'yajl-ruby'
+gem 'bbq-spawn', git: 'git@github.com:drugpl/bbq-spawn.git'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Piotrek Okoński
+
+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,128 @@
+# Gush
+
+Gush is a parallel workflow runner using only Redis as its message broker and Sidekiq for workers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gush'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gush
+
+## Usage
+
+Your project should contain a file called `Gushfile.rb` which loads all the necessary workflows for Sidekiq to use.
+
+Example:
+
+```ruby
+require_relative './lib/your_project'
+
+Dir[Rowlf.root.join("workflows/**/*.rb")].each do |file|
+  require file
+end
+```
+
+### Defining workflows
+
+The DSL for defining jobs consists of a single `run` method. 
+Here is a complete example of a workflow you can create:
+
+```ruby
+# workflows/sample_workflow.rb
+class SampleWorkflow < Gush::Workflow
+  def configure
+    run FetchJob1
+    run FetchJob2
+
+    run PersistJob1, after: FetchJob1
+    run PersistJob2, after: FetchJob2
+
+    run Normalize,
+        after: [PersistJob1, PersistJob2],
+        before: Index
+
+    run Index
+  end
+end
+```
+
+**Hint:** For debugging purposes you can vizualize the graph using `viz` command:
+
+```
+bundle exec gush viz SampleWorkflow
+```
+
+For the Workflow above, the graph will look like this:
+
+![SampleWorkflow](http://i.imgur.com/SmeRRVT.png)
+### Defining jobs
+
+Jobs are classes inheriting from `Gush::Job`:
+
+```ruby
+#workflows/sample/fetch_job1.rb
+class FetchJob1 < Gush::Job
+  def work
+    # do some fetching from remote APIs
+  end
+end
+```
+
+### Running
+
+#### 1. Register workflow
+
+After you define your workflows and jobs, all you have to do is register them:
+
+```
+bundle exec gush create SampleWorkflow
+```
+
+the command will return a unique workflow id you will use in later commands.
+
+#### 2. Run workers
+
+This will start Sidekiq workers responsible for processing jobs
+
+```
+bundle exec gush workers
+```
+
+#### 3. Start the workflow
+
+Use your workflow_id returned by `create` command.
+
+```
+bundle gush start <workflow_id>
+```
+
+### 5. Check the status
+
+- of a specific workflow:
+
+  ```
+  bundle gush show <workflow_id>
+  ```
+
+- of all created workflows:
+  
+  ```
+  bundle gush list
+  ```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/lonelyplanet/gush/fork )
+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/Rakefile

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

data/bin/gush

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "pathname"
+require "bundler"
+Bundler.require
+
+bin_file = Pathname.new(__FILE__).realpath
+# add self to libpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require 'gush'
+
+Gush::CLI.start(ARGV)

data/gush.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gush"
+  spec.version       = Gush::VERSION
+  spec.authors       = ["Piotrek Okoński"]
+  spec.email         = ["piotrek@okonski.org"]
+  spec.summary       = "Fast and distributed workflow runner using only Sidekiq and Redis"
+  spec.homepage      = "https://github.com/pokonski/gush"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = "gush"
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 3.2.2"
+  spec.add_dependency "yajl-ruby"
+  spec.add_dependency "redis", "~> 3.0.0"
+  spec.add_dependency "hiredis", "~> 0.5.2"
+  spec.add_dependency "ruby-graphviz"
+  spec.add_dependency "terminal-table"
+  spec.add_dependency "colorize"
+  spec.add_dependency "thor"
+  spec.add_dependency "launchy"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0.0'
+end

data/lib/gush.rb

@@ -0,0 +1,47 @@
+require "bundler/setup"
+
+require "graphviz"
+require "hiredis"
+require "pathname"
+require "redis"
+require "securerandom"
+require "sidekiq"
+
+require "gush/cli"
+require "gush/client"
+require "gush/configuration"
+require "gush/errors"
+require "gush/job"
+require "gush/logger_builder"
+require "gush/metadata"
+require "gush/null_logger"
+require "gush/version"
+require "gush/worker"
+require "gush/workflow"
+
+module Gush
+  def self.gushfile
+    configuration.gushfile
+  end
+
+  def self.root
+    Pathname.new(__FILE__).parent.parent
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+    reconfigure_sidekiq_server
+  end
+
+  def self.reconfigure_sidekiq_server
+    Sidekiq.configure_server do |config|
+      config.redis = { url: configuration.redis_url, queue: configuration.namespace}
+    end
+  end
+end
+
+Gush.reconfigure_sidekiq_server

data/lib/gush/cli.rb

@@ -0,0 +1,245 @@
+require 'terminal-table'
+require 'colorize'
+require 'thor'
+require 'launchy'
+require 'sidekiq'
+require 'sidekiq/api'
+
+module Gush
+  class CLI < Thor
+    class_option :gushfile, desc: "configuration file to use", aliases: "-f"
+    class_option :concurrency, desc: "concurrency setting for Sidekiq", aliases: "-c"
+    class_option :redis, desc: "Redis URL to use", aliases: "-r"
+    class_option :namespace, desc: "namespace to run jobs in", aliases: "-n"
+    class_option :env, desc: "Sidekiq environment", aliases: "-e"
+
+    def initialize(*)
+      super
+      Gush.configure do |config|
+        config.gushfile    = options.fetch("gushfile",    config.gushfile)
+        config.concurrency = options.fetch("concurrency", config.concurrency)
+        config.redis_url   = options.fetch("redis",       config.redis_url)
+        config.namespace   = options.fetch("namespace",   config.namespace)
+        config.environment = options.fetch("environment", config.environment)
+      end
+    end
+
+    desc "create [WorkflowClass]", "Registers new workflow"
+    def create(name)
+      workflow = client.create_workflow(name)
+      puts "Workflow created with id: #{workflow.id}"
+      puts "Start it with command: gush start #{workflow.id}"
+    rescue
+      puts "Workflow not found."
+    end
+
+    desc "start [workflow_id]", "Starts Workflow with given ID"
+    def start(*args)
+      id = args.shift
+      client.start_workflow(id, args)
+    rescue WorkflowNotFound
+      puts "Workflow not found."
+    rescue DependencyLevelTooDeep
+      puts "Dependency level too deep. Perhaps you have a dependency cycle?"
+    end
+
+    desc "create_and_start [WorkflowClass]", "Create and instantly start the new workflow"
+    def create_and_start(name, *args)
+      workflow = client.create_workflow(name)
+      client.start_workflow(workflow.id, args)
+      puts "Created and started workflow with id: #{workflow.id}"
+    rescue WorkflowNotFound
+      puts "Workflow not found."
+    rescue DependencyLevelTooDeep
+      puts "Dependency level too deep. Perhaps you have a dependency cycle?"
+    end
+
+    desc "stop [workflow_id]", "Stops Workflow with given ID"
+    def stop(*args)
+      id = args.shift
+      client.stop_workflow(id)
+    rescue WorkflowNotFound
+      puts "Workflow not found."
+    end
+
+    desc "clear", "Clears all jobs from Sidekiq queue"
+    def clear
+      Sidekiq::Queue.new(client.configuration.namespace).clear
+    end
+
+    desc "show [workflow_id]", "Shows details about workflow with given ID"
+    option :skip_overview, type: :boolean
+    option :skip_jobs, type: :boolean
+    option :jobs, default: :all
+    def show(workflow_id)
+      workflow = client.find_workflow(workflow_id)
+
+      display_overview_for(workflow) unless options[:skip_overview]
+
+      display_jobs_list_for(workflow, options[:jobs]) unless options[:skip_jobs]
+    rescue WorkflowNotFound
+      puts "Workflow not found."
+    end
+
+    desc "rm [workflow_id]", "Delete workflow with given ID"
+    def rm(workflow_id)
+      workflow = client.find_workflow(workflow_id)
+      client.destroy_workflow(workflow)
+    rescue WorkflowNotFound
+      puts "Workflow not found."
+    end
+
+    desc "list", "Lists all workflows with their statuses"
+    def list
+      workflows = client.all_workflows
+      rows = workflows.map do |workflow|
+        [workflow.id, workflow.class, {alignment: :center, value: status_for(workflow)}]
+      end
+      headers = [
+        {alignment: :center, value: 'id'},
+        {alignment: :center, value: 'name'},
+        {alignment: :center, value: 'status'}
+      ]
+      puts Terminal::Table.new(headings: headers, rows: rows)
+    end
+
+    desc "workers", "Starts Sidekiq workers"
+    def workers
+      config = client.configuration
+      Kernel.exec "bundle exec sidekiq -r #{config.gushfile} -c #{config.concurrency} -q #{config.namespace} -e #{config.environment} -v"
+    end
+
+    desc "viz [WorkflowClass]", "Displays graph, visualising job dependencies"
+    def viz(name)
+      client
+      workflow = name.constantize.new("start")
+      GraphViz.new(:G, type: :digraph, dpi: 200, compound: true) do |g|
+        g[:compound] = true
+        g[:rankdir] = "LR"
+        g[:center] = true
+        g.node[:shape] = "ellipse"
+        g.node[:style] = "filled"
+        g.node[:color] = "#555555"
+        g.node[:fillcolor] = "white"
+        g.edge[:dir] = "forward"
+        g.edge[:penwidth] = 1
+        g.edge[:color] = "#555555"
+        start = g.start(shape: 'diamond', fillcolor: '#CFF09E')
+        end_node = g.end(shape: 'diamond', fillcolor: '#F56991')
+
+
+        workflow.nodes.each do |job|
+          name = job.class.to_s
+          g.add_nodes(name)
+
+          if job.incoming.empty?
+            g.add_edges(start, name)
+          end
+
+
+          if job.outgoing.empty?
+            g.add_edges(name, end_node)
+          else
+            job.outgoing.each do |out|
+              g.add_edges(name, out)
+            end
+          end
+        end
+
+        g.output(png: Pathname.new(Dir.tmpdir).join("graph.png"))
+      end
+
+      Launchy.open(Pathname.new(Dir.tmpdir).join("graph.png").to_s)
+    end
+
+    private
+
+    def client
+      @client ||= Client.new
+    end
+
+    def display_overview_for(workflow)
+      rows = []
+      columns  = {
+        "id" => workflow.id,
+        "name" => workflow.class.to_s,
+        "jobs" => workflow.nodes.count,
+        "failed jobs" => workflow.nodes.count(&:failed?).to_s.red,
+        "succeeded jobs" => workflow.nodes.count(&:succeeded?).to_s.green,
+        "enqueued jobs" => workflow.nodes.count(&:enqueued?).to_s.yellow,
+        "running jobs" => workflow.nodes.count(&:running?).to_s.blue,
+        "remaining jobs" => workflow.nodes.count{|j| [j.finished, j.failed, j.enqueued].all? {|b| !b} },
+        "status" => status_for(workflow)
+      }
+
+      columns.each_pair do |name, value|
+        rows << [{alignment: :center, value: name}, value]
+        rows << :separator if name != "status"
+      end
+
+      puts Terminal::Table.new(rows: rows)
+    end
+
+    def status_for(workflow)
+      if workflow.failed?
+        status = "failed".light_red
+        status += "\n#{workflow.nodes.find(&:failed).name} failed"
+      elsif workflow.running?
+        status = "running".yellow
+        finished = workflow.nodes.count {|job| job.finished }
+        total = workflow.nodes.count
+        status += "\n#{finished}/#{total} [#{(finished*100)/total}%]"
+      elsif workflow.finished?
+        status = "done".green
+      elsif workflow.stopped?
+        status = "stopped".red
+      else
+        status = "pending".light_white
+      end
+    end
+
+    def display_jobs_list_for(workflow, jobs)
+      puts "\nJobs list:\n"
+
+      jobs_by_type(workflow, jobs).each do |job|
+        name = job.name
+        puts case
+        when job.failed?
+          "[✗] #{name.red}"
+        when job.finished?
+          "[✓] #{name.green}"
+        when job.enqueued?
+          "[•] #{name.yellow}"
+        when job.running?
+          "[•] #{name.blue}"
+        else
+          "[ ] #{name}"
+        end
+      end
+    end
+
+    def jobs_by_type(workflow, type)
+      jobs = workflow.nodes.sort_by do |job|
+        case
+        when job.failed?
+          0
+        when job.finished?
+          1
+        when job.enqueued?
+          2
+        when job.running?
+          3
+        else
+          4
+        end
+      end
+
+      jobs.select!{|j| j.public_send("#{type}?") } unless type == :all
+      jobs
+    end
+
+    def gushfile
+      Pathname.pwd.join(options[:gushfile])
+    end
+  end
+end