traut 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brian L. Troutwine
+
+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,44 @@
+Traut -- a real-time notification automaton
+===========================================
+
+It's not uncommon that an event will happen in a computer cluster for
+which a system administrator is needed to execute a program or two: a
+database goes down and it's time to switch to a hot-standby or there's
+a vital configuration fix that needs to go out faster than the ususal
+Puppet update interval. Maybe you have a specific human process that's
+kicked off when a 5xx HTTP error gets recorded by your
+httpd. Heretofore someone scans the logs periodically, though it could
+be done by a machine. In fact, all of this could be done by a machine.
+
+Traut is a program which listens to an AMQP queue and executes scripts
+found in local `/usr/local/bin/traut/` based on the message route. It
+is presumed that traut will be supported by a small legion of log
+watchers, daemon prodders and otherwise. Here at CarePilot, we have a
+daemon hooked up to Gerrit's ssh stream-events so that we might turn
+'change-merged' events into immediate project deployments, for
+example. See `samples/kili`. All payloads are delivered to the
+scripts' stdin.
+
+Traut cannot daemonize itself. We use [supervisord](http://supervisord.org/) to daemonize Traut;
+the code needed to achieve self-daemonization is outside of the core
+focus of this program.
+
+Installation
+------------
+
+Traut is distributed through the RubyGems
+
+    gem install traut
+
+You're tasked with providing your own init scripts and configuration
+files. See the contents of etc/ for an example traut.conf. Note that
+`traut.conf.sample` defines a script `deploy/app` to be run in
+response to `com.carepilot.event.code.review.app` events, making its
+full path `/tmp/traut/scripts/deploy/app`.
+
+Known Issues
+------------
+
+* traut has no ability to reload its configuration or restart. It must
+  be killed and started.
+* traut doesn't do log rotation. Run logrotate on your system.

data/Rakefile

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

data/bin/traut

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# Traut command line interface script.
+# Run <tt>traut -h</tt> to get more usage.
+
+require 'traut'
+Traut::Runner.new(ARGV).run!

data/etc/traut.conf.sample

@@ -0,0 +1,10 @@
+amqp:
+    :host: localhost
+    :port: 5672
+logs: /tmp/traut.log
+pid:  /tmp/traut.pid
+scripts: /tmp/traut/scripts
+daemon: true
+
+actions:
+    com.carepilot.event.code.review.app: deploy/app

data/lib/traut/runner.rb

@@ -0,0 +1,115 @@
+require 'optparse'
+require 'yaml'
+require 'logger'
+
+module Traut
+  trap(:INT) { puts; exit }
+
+  # CLI runner. Parse options, run program.
+  class Runner
+    COMMANDS = %w(start stop restart status)
+
+    attr_accessor :options   # parsed options
+
+    def initialize(argv)
+      @argv = argv
+
+      # Default options
+      @options = {
+        :amqp => {
+          :host => 'localhost',
+          :port => '5672'
+        },
+        :logs      => '/var/log/traut.log',
+        :config    => '/etc/traut/traut.conf',
+        :scripts   => '/usr/local/bin/traut',
+        :debug     => false,
+        :actions   => nil,
+      }
+
+      parse!
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: traut [options]"
+        opts.separator ""
+        opts.on("-A", "--amqp [HOST]", "The AMQP server host") {
+          |host| @options[:amqp_host] = host
+        }
+        opts.on("-P", "--amqp_port [PORT]", "The AMQP server host port") {
+          |port| @options[:amqp_host] = port
+        }
+        opts.on("-S", "--subscriptions", "The server AMQP subscriptions.") {
+          |subscriptions| @options[:subscriptions] = subscriptions || '*'
+        }
+        opts.on("-C", "--config [FILE]", "Load options from config file") {
+          |file| @options[:config] = file
+        }
+        opts.on("-s", "--scripts", "Location of traut scripts directory") {
+          |scripts| @options[:scripts] = scripts
+        }
+        opts.on('-l', '--logs [LOG]', "Location of log directory location") {
+          |log| @options[:logs] = log
+        }
+        opts.on('--debug', 'Enable debug logging') {
+          |debug| @options[:debug] = true
+        }
+        opts.on_tail("-h", "--help", "Show this message.") do
+          puts opts
+          exit
+        end
+        opts.on_tail("-v", "--version", "Show version") {
+          puts Traut::VERSION; exit
+        }
+      end
+    end
+
+    # Parse command options out of @argv
+    def parse!
+      parser.parse! @argv
+      @command   = @argv.shift
+      @arguments = @argv
+    end
+
+    # Parse the arguments and run the program. Exit on error.
+    def run!
+      load_options_from_config_file!
+
+      log = Logger.new(@options[:logs])
+      log.level = @options[:debug] ? Logger::DEBUG : Logger::INFO
+
+      actions = @options[:actions]
+      actions = actions.merge(actions) { |k,v|
+        File.join(@options[:scripts], v)
+      }
+
+      actions.each { |route, script|
+        if ! File.exists?(script)
+          log.error("#{script} does not exist on disk")
+          exit 1
+        elsif ! File.executable?(script)
+          log.error("#{script} exists on disk but is not executable.")
+          exit 1
+        else
+          log.info("#{script} recognized on disk and executable.")
+        end
+      }
+
+      server = Server.new(@options[:amqp], actions, log)
+
+      server.loop
+    end
+
+    private
+
+    def load_options_from_config_file!
+      if file = @options.delete(:config)
+        YAML.load_file(file).each {
+          |key, value| @options[key.to_sym] = value
+        }
+      end
+    end
+
+  end
+end

data/lib/traut/server.rb

@@ -0,0 +1,41 @@
+require 'amqp'
+require 'systemu'
+
+module Traut
+
+  class Server
+    def initialize(amqp, actions, log)
+      @amqp = amqp
+      @actions = actions
+      @log  = log
+    end
+
+    def loop
+      EventMachine.run do
+        AMQP.connect(:host => @amqp[:host]) do |connection|
+          @log.info "Connected to AMQP at #{@amqp[:host]}:#{@amqp[:port]}"
+          channel  = AMQP::Channel.new(connection)
+          exchange = channel.topic("traut", :auto_delete => true)
+
+          @actions.each { |route, script|
+            @log.info("Registering #{script} for route #{route}")
+            channel.queue("").bind(exchange, :routing_key => route).subscribe do |headers, payload|
+              status, stdout, stderr = systemu script, 'stdin' => payload
+              if status.exitstatus != 0
+                @log.error("[#{script}] exit status: #{status.exitstatus}")
+                @log.error("[#{script}] stdout: #{stdout.strip}")
+                @log.error("[#{script}] stderr: #{stderr.strip}")
+              else
+                @log.info("[#{script}] exit status: #{status.exitstatus}")
+                @log.info("[#{script}] stdout: #{stdout.strip}")
+                @log.info("[#{script}] stderr: #{stderr.strip}")
+              end
+            end
+          }
+
+        end
+      end
+    end
+
+  end
+end

data/lib/traut/version.rb

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

data/lib/traut.rb

@@ -0,0 +1,11 @@
+require "traut/version"
+
+module Traut
+  ROOT = File.expand_path(File.dirname(__FILE__))
+
+  autoload :Runner,             "#{ROOT}/traut/runner"
+  autoload :Server,             "#{ROOT}/traut/server"
+  autoload :Daemon,             "#{ROOT}/traut/daemon"
+end
+
+require "#{Traut::ROOT}/traut/version"

data/samples/kili

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'net/ssh'
+require 'json'
+require 'yaml'
+require 'amqp'
+require 'logger'
+
+trap(:INT) { puts; exit }
+
+options = {
+  :logs => 'kili.log',
+  :amqp => {
+    :host => 'localhost',
+    :port => '5672',
+  },
+  :ssh => {
+    :host => 'localhost',
+    :port => '22',
+    :user => 'nobody',
+    :keys => '~/.ssh/id_rsa',
+  }
+}
+optparse = OptionParser.new do|opts|
+  opts.banner = "Usage: kili [options]"
+  opts.on( '--amqp_host HOST', 'The AMQP host kili will connect to.') do |a|
+    options[:amqp][:host] = a
+  end
+  opts.on( '--amqp_port PORT', 'The port for the AMQP host.') do |ap|
+    options[:amqp][:port] = ap
+  end
+  opts.on( '--ssh_host HOST', 'The SSH host kili will connect to.') do |s|
+    options[:ssh][:host] = s
+  end
+  opts.on( '--ssh_port PORT', 'The SSH port kili will connect on.') do |sp|
+    options[:ssh][:port] = sp
+  end
+  opts.on( '--ssh_keys KEYS', 'Comma delimeted SSH keys for user.') do |sk|
+    options[:ssh][:keys] = sk
+  end
+  opts.on( '--ssh_user USER', 'SSH user for host.') do |su|
+    options[:ssh][:user] = su
+  end
+  opts.on( '-l', '--log', 'The log location of Kili') do |log|
+    options[:logs] = log
+  end
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+log = Logger.new(options[:logs])
+log.level = Logger::INFO
+
+amqp = options[:amqp]
+sshd = options[:ssh]
+
+loop do
+  begin
+    EventMachine.run do
+      AMQP.connect(:host => amqp[:host]) do |connection|
+        log.info "Connected to AMQP at #{amqp[:host]}:#{amqp[:port]}"
+        channel  = AMQP::Channel.new(connection)
+        exchange = channel.topic("traut", :auto_delete => true)
+
+        Net::SSH.start(sshd[:host], sshd[:user],
+          :port => sshd[:port], :keys => sshd[:keys].split(',')) do |ssh|
+          channel = ssh.open_channel do |ch|
+            ch.exec "gerrit stream-events" do |ch, success|
+              abort "could not stream gerrit events" unless success
+
+              # "on_data" is called when the process writes something to
+              # stdout
+              ch.on_data do |c, data|
+                json = JSON.parse(data)
+                if json['type'] == 'change-merged'
+                  log.info("Received change-merged event.")
+                  project = json['change']['project']
+                  exchange.publish(json, "com.carepilot.event.code.review.#{project}")
+                else
+                  log.info("Ignoring event of type #{json['type']}")
+                end
+              end
+
+              # "on_extended_data" is called when the process writes
+              # something to stderr
+              ch.on_extended_data do |c, type, data|
+                log.error(data)
+              end
+
+              ch.on_close { log.info('Connection closed') }
+            end
+          end
+
+          channel.wait
+        end
+      end
+    end
+  rescue Net::SSH::Exception => e
+    log.error("Connection died with exception #{e}. Restarting...")
+  end
+end

data/traut.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "traut/version"
+
+Gem::Specification.new do |s|
+  s.name        = "traut"
+  s.version     = Traut::VERSION
+  s.authors     = ["Brian L. Troutwine"]
+  s.email       = ["brian.troutwine@carepilot.com"]
+  s.homepage    = "https://github.com/CarePilot/Traut"
+  s.summary     = %q{Turns AMQP events to system command execution}
+  s.description = %q{Traut is a configurable daemon for running localhost commands in response to events generated elsewhere. AMQP is used as the interchange. Traut can make application deployments in response to code checkins, automate database failover and anything else that can be scripted. It needs only companions to pump events through the 'traut' exchange.}
+
+  s.rubyforge_project = "traut"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "daemons", '~> 1.1'
+  s.add_runtime_dependency "amqp", '>= 0.8.0'
+  s.add_runtime_dependency "systemu", '~> 2.4'
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: traut
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian L. Troutwine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-27 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: &87052460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *87052460
+- !ruby/object:Gem::Dependency
+  name: amqp
+  requirement: &87052200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *87052200
+- !ruby/object:Gem::Dependency
+  name: systemu
+  requirement: &87051970 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *87051970
+description: Traut is a configurable daemon for running localhost commands in response
+  to events generated elsewhere. AMQP is used as the interchange. Traut can make application
+  deployments in response to code checkins, automate database failover and anything
+  else that can be scripted. It needs only companions to pump events through the 'traut'
+  exchange.
+email:
+- brian.troutwine@carepilot.com
+executables:
+- traut
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/traut
+- etc/traut.conf.sample
+- lib/traut.rb
+- lib/traut/runner.rb
+- lib/traut/server.rb
+- lib/traut/version.rb
+- samples/kili
+- traut.gemspec
+homepage: https://github.com/CarePilot/Traut
+licenses: []
+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: traut
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Turns AMQP events to system command execution
+test_files: []