jflow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8525329c288e5a0027699c40ad1539367224ec2
+  data.tar.gz: 3545904aeda9e29048224b2983e55a805fbaec39
+SHA512:
+  metadata.gz: cdae9e071195443da31a403513674b2cf69378d4b59afde71f5f22d113ed99f9aa9a764d067ebc78a54dd5e5bc7828e4d29a2f8c31d94f091bf54c7c28fac57c
+  data.tar.gz: 0b9d85ff36b13e3bd6bee7568b8a622927ae5b9d0cb87b41e25b956215835a98c11f686051e4fe6650fa1fbf7c503009eeffee701367724bad2d93e6438c2d98

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jflow.gemspec
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+# Jflow
+
+JFlow is a gem that aims to let you start SWF flow activity workers for JRuby.
+
+The official framework uses Forking and thus not compatible with the JVM. This aims to give an alternative for Jruby.
+
+*For now this only works for Activities and not workflows*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jflow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jflow
+
+## Usage
+
+### Create an Activity
+
+```ruby
+Class FooActivity
+  include JFlow::ActivityMixin
+
+  activity "policy_scan.run" do
+    {
+      domain: "alexandria-development",
+      default_task_list: {
+        name: "xray_activity_tasklist"
+      },
+      version: "1.4",
+      default_task_schedule_to_start_timeout: "600",
+      default_task_schedule_to_close_timeout: "600",
+      default_task_start_to_close_timeout: "600",
+      default_task_heartbeat_timeout: "600"
+    }
+  end
+
+  def run
+    "foo"
+  end
+end
+```
+
+### Launch the workers
+
+This gem provides you with a binary called jflow_worker. This binary requires a json configuration file.
+
+```bash
+jflow_worker -f worker.json
+```
+
+Example of a worker.json
+```json
+{
+  "domain": "foodomain",
+  "tasklist": "footasklist",
+  "number_of_workers": 100,
+  "activities_path": ["/home/pate/git/foobar/lib/flow/activities"]
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jflow.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jflow"
+
+require "irb"
+IRB.start

data/bin/jflow_worker

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jflow"
+require "slop"
+
+opts = Slop.parse do |o|
+  o.string '-f', '--file', 'worker configuration file'
+end
+
+configuration = JSON.parse(File.read(opts[:file]))
+
+configuration_validator = {
+  "number_of_workers" => "integer",
+  "domain"            => "string",
+  "tasklist"          => "string",
+  "activities_path"   => "array"
+}
+
+validator = HashValidator.validate(configuration, configuration_validator)
+raise "configuration is invalid! #{validator.errors}" unless validator.valid?
+
+JFlow.configure do |c|
+  c.load_paths = configuration["activities_path"]
+end
+
+JFlow.load_activities
+
+threads = []
+
+configuration["number_of_workers"].times do |i|
+  threads << Thread.new do
+    domain   = configuration["domain"]
+    tasklist = configuration["tasklist"]
+    JFlow::ActivityWorker.new(domain, tasklist)
+                         .start!
+  end
+end
+
+threads.each { |thr| thr.join }
+
+

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jflow.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jflow"
+  spec.version       = JFlow::VERSION
+  spec.authors       = ["Christophe Verbinnen"]
+  spec.email         = ["christophe.verbinnen@lookout.com"]
+
+  spec.summary       = %q{SWF Flow framework for jRuby}
+  spec.description   = %q{you know, for flow}
+  spec.homepage      = "https://github.com/djpate/jflow"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "aws-sdk", "~> 2"
+  spec.add_dependency "hash_validator"
+  spec.add_dependency "slop", "~> 4"
+end

data/lib/jflow.rb

@@ -0,0 +1,36 @@
+require "jflow/version"
+require "jflow/activity.rb"
+require "jflow/activity_mixin.rb"
+require "jflow/activity_worker.rb"
+require "jflow/configuration.rb"
+require "yaml"
+require "json"
+require "hash_validator"
+require 'aws-sdk'
+
+module JFlow
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.load_activities
+    configuration.load_paths.each do |path|
+      Dir["#{path}/*.rb"].each do |file|
+        configuration.logger.debug "found #{file}"
+        require file
+      end
+    end
+  end
+end

data/lib/jflow/activity.rb

@@ -0,0 +1,81 @@
+module JFlow
+  class Activity
+
+    DEFAULT_OPTIONS = {}
+
+    OPTIONS_VALIDATOR = {
+      :version => "string",
+      :domain  => "string",
+      :name    => "string",
+      :default_task_list => {
+        :name => "string"
+      }
+    }
+
+    attr_reader :options, :klass
+
+    # Possible options are :
+    # domain: "DomainName", # required
+    # name: "Name", # required
+    # version: "Version", # required
+    # description: "Description",
+    # default_task_start_to_close_timeout: "DurationInSecondsOptional",
+    # default_task_heartbeat_timeout: "DurationInSecondsOptional",
+    # default_task_list: {
+    #   name: "Name", # required
+    # },
+    # default_task_priority: "TaskPriority",
+    # default_task_schedule_to_start_timeout: "DurationInSecondsOptional",
+    # default_task_schedule_to_close_timeout: "DurationInSecondsOptional",
+    def initialize(klass, options = {})
+      @klass = klass
+      @options = DEFAULT_OPTIONS.merge(options)
+      @options[:name] = name
+      validate_activity!
+      register_activity unless registered?
+      add_to_activity_mapping
+    end
+
+    def register_activity
+      JFlow.configuration.swf_client.register_activity_type(options)
+      JFlow.configuration.logger.info "Activity #{name} was registered successfuly"
+    end
+
+    def add_to_activity_mapping
+      $activity_map ||= {}
+      $activity_map[name] ||= {}
+      $activity_map[name][options[:version]] = {:class => klass, :options => options}
+    end
+
+    def name
+      @options[:name] || klass.name.to_s.split('::').last.scan(/[A-Z][a-z]*/).join("_").downcase
+    end
+
+    def version
+      @options[:version]
+    end
+
+    def validate_activity!
+      validator = HashValidator.validate(@options, OPTIONS_VALIDATOR)
+      raise "Activity #{options[:name]}definition is invalid! #{validator.errors}" unless validator.valid?
+    end
+
+    def registered?
+      response = JFlow.configuration.swf_client.list_activity_types({
+        domain: options[:domain],
+        name: name,
+        registration_status: "REGISTERED"
+      })
+
+      response.type_infos.each do |type_info|
+        if type_info.activity_type.name == name && type_info.activity_type.version == version
+          JFlow.configuration.logger.info "Activity #{name} #{version} is already registered"
+          return true
+        end
+      end
+
+      return false
+    end
+
+  end
+end

data/lib/jflow/activity_mixin.rb

@@ -0,0 +1,18 @@
+module JFlow
+  module ActivityMixin
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def activity(name = nil)
+        options = {}
+        options = yield if block_given?
+        options[:name] = name
+        JFlow.configuration.logger.debug "loading #{name}"
+        JFlow::Activity.new(self, options)
+      end
+    end
+  end
+end

data/lib/jflow/activity_worker.rb

@@ -0,0 +1,81 @@
+module JFlow
+  class ActivityWorker
+
+    attr_reader :domain, :tasklist
+
+    def initialize(domain, tasklist)
+      @domain = domain
+      @tasklist = tasklist
+    end
+
+    def start!
+      loop do
+        log "Polling for task on #{domain} - #{tasklist}"
+        poll
+      end
+    end
+
+    private
+
+    def poll
+      response = JFlow.configuration.swf_client.poll_for_activity_task(poll_params)
+      if response.task_token
+        process_task(response)
+      else
+        log "Got no task"
+      end
+    end
+
+    def process_task(response)
+      log "Got task #{response.task_token}"
+
+      klass = class_for_activity(response.activity_type)
+      raise "Could not find code to run for given activity" unless klass
+
+      begin
+        JFlow.configuration.logger.debug "Started #{klass}#process with #{YAML.load(response.input)}"
+        if response.activity_type.name.split('.').size > 1
+          method = response.activity_type.name.split('.').last
+        else
+          method = "process"
+        end
+        result = klass.new.send(method, YAML.load(response.input)) || true
+        JFlow.configuration.logger.debug "Done #{klass}##{method}"
+        JFlow.configuration.swf_client.respond_activity_task_completed({
+          task_token: response.task_token,
+          result: result,
+        })
+      rescue => e
+        JFlow.configuration.swf_client.respond_activity_task_failed({
+          task_token: response.task_token,
+          reason: e.message,
+          details: e.backtrace.join("\n"),
+        })
+      end
+
+    end
+
+    def identity
+      @identity ||= "#{`hostname`.chomp}-#{Thread.current.object_id}"
+    end
+
+    def log(str)
+      JFlow.configuration.logger.info "[#{Thread.current.object_id}] #{str}"
+    end
+
+    def poll_params
+      {
+        domain: domain,
+        task_list: {
+          name: tasklist,
+        },
+        identity: identity,
+      }
+    end
+
+    def class_for_activity(activity_type)
+      $activity_map[activity_type.name][activity_type.version][:class]
+    end
+
+  end
+end

data/lib/jflow/configuration.rb

@@ -0,0 +1,12 @@
+module JFlow
+  class Configuration
+
+    attr_accessor :swf_client, :load_paths, :logger
+
+    def initialize
+      @swf_client = Aws::SWF::Client.new
+      @load_paths = []
+      @logger     = Logger.new(STDOUT)
+    end
+  end
+end

data/lib/jflow/version.rb

@@ -0,0 +1,3 @@
+module JFlow
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: jflow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christophe Verbinnen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: hash_validator
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: slop
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4'
+  prerelease: false
+  type: :runtime
+description: you know, for flow
+email:
+- christophe.verbinnen@lookout.com
+executables:
+- console
+- jflow_worker
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/jflow_worker
+- bin/setup
+- jflow.gemspec
+- lib/jflow.rb
+- lib/jflow/activity.rb
+- lib/jflow/activity_mixin.rb
+- lib/jflow/activity_worker.rb
+- lib/jflow/configuration.rb
+- lib/jflow/version.rb
+homepage: https://github.com/djpate/jflow
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5
+signing_key:
+specification_version: 4
+summary: SWF Flow framework for jRuby
+test_files: []