auger 1.3.8 → 1.4.0

data/README.md

@@ -8,21 +8,21 @@ The primary goal of Auger is test-driven operations: unit testing for
 application admins. The library can also be used as a framework for
 implmenting automated tests.
 
-* these are the sorts of questions auger can answer:
+These are the sorts of questions auger can answer:
 
-  * is port :80 on my application webservers open? does /index.html
+* is port :80 on my application webservers open? does /index.html
     contain a response tag that we know should be served from a given
     backend data source?
 
-  * is redis running? is it configured as a master? a slave?
+* is redis running? is it configured as a master? a slave?
 
-  * is elasticsearch responding on all my hosts it should be? what's
+* is elasticsearch responding on all my hosts it should be? what's
     the cluster state? do I have the number of data nodes responding
     that we're supposed to have?
 
-* clearly a lot of this information includes things you should be
-  graphing. What auger wants to do is give you a quick overview
-  of current status: green == good, red == ruh roh!
+Clearly a lot of this information includes things you should be
+graphing. What auger wants to do is give you a quick overview
+of current status: green == good, red == ruh roh!
 
 ## Plugins
 
@@ -30,43 +30,38 @@ Specific protocols are implemented using plugins, which are designed
 to be easy to write wrappers on existing gems. Auger currently includes
 the following plugins:
 
-* http - http and https requests using `net/http`
-* telnet - send arbitrary commands to a port using `net/telnet`
 * socket - test whether a port is open
+* telnet - send arbitrary commands to a port using `net/telnet`
+* http - http and https requests using `net/http`
+* redis - query redis db info, keys, etc
+* dns - domain and query requests for testing a DNS server
 
 ## Installation
 
-* gem install auger
+    gem install auger
 
 ### If you want to run the latest source:
 
-* `git clone git@github.com/blah/auger` TODO => fix github url
-* `cd auger; bundle install && rake install`
+    git clone git@github.com/brewster/auger
+    cd auger; bundle install && rake install
 
 ## Command-line client usage
 
-* sample configs included in cfg/examples/ can be moved into cfg/ and
-  then run via `aug redis` etc.
-
-  * if you've installed as a gem, the examples will be located wherever your gems get installed
+`aug -h` will print usage details.
 
-  * one quick way to find them should be `cd $GEM_HOME/gems/auger-x.x.x/cfg/examples`
+Sample configs are included in `auger/cfg/examples` (if installed as a
+gem, look in `$GEM_HOME/gems/auger-x.x.x/cfg/examples`). Use them as a
+basis to write your own tests, which auger can find in one of three ways:
 
-* alternatively, you can place your configs anywhere you'd like and
-  set the env_var: `AUGER_CFG=/path/to/your/configs/prod:/path/to/your/configs/stage`
+* in the directory `auger/cfg`
+* from the config load path defined in environment variable `AUGER_CFG`.
+  e.g. `AUGER_CFG=~/aug_cfg/prod:~/aug_cfg/staging`
+* using a relative path
 
-  * now call your tests via `aug name_of_my_config`, e.g. `aug redis`
+Reference config files using `aug foo`, to find `foo.rb` in
+`auger/cfg` or `AUGER_CFG` path, or `aug path/to/foo.rb` to find it directly.
 
-  * configs should take the format `name.rb`
-
-* `aug -l` will print available tests
-* `aug -h` will print usage details
-
-## Writing tests
-
-Tests are written as ruby code describing a test configuration. Files 
-containing tests should be placed in the path described by the `AUGER_CFG`
-environment variable.
+`aug -l` will print available config files in `AUGER_CFG` path.
 
 ### Example 1 - testing a webserver response
 
@@ -194,7 +189,7 @@ a checkmark or an 'x'.
 require 'json'
 
 project "Elasticsearch" do
-  servers 'prod-es-[01-04]'
+  server 'prod-es-[01-04]'
 
   http 9200 do
     get "/_cluster/health" do
@@ -341,13 +336,15 @@ ZSH completion:
 
 ## Pull Requests
 
-* yes please
-* new plugins and genereal bug fixes, updates, etc are all welcome
-* generally, we'd prefer you do the following to submit a pull:
-  * fork
-  * create a local topic branch
-  * make your changes and push
-  * submit your pull request
+Yes please.
+
+New plugins and general bug fixes, updates, etc are all welcome.
+
+Generally, we'd prefer you do the following to submit a pull:
+* fork
+* create a local topic branch
+* make your changes and push
+* submit your pull request
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-1.3.8
+1.4.0

data/bin/aug

@@ -14,7 +14,7 @@ require 'auger'
 
 ## set opts
 options = {}
-optparse = OptionParser.new do |opts|
+OptionParser.new do |opts|
   opts.banner = "Usage: aug [-h|--help] [-l|--list] [-v|--version] cfg"
 
   if ARGV[0] == nil
@@ -22,50 +22,33 @@ optparse = OptionParser.new do |opts|
     exit
   end
 
-  opts.on('-l', '--list', 'List available configs and exit.') do
-    list = AUGER_CFG.map do |dir| 
-      Dir["#{dir}/*.rb"].map{ |file| File.basename(file).sub(/\.rb$/, '') } 
-    end
-    puts list.flatten.sort
-    exit
-  end
-
   opts.on('-h', '--help', 'Display help') do
     puts opts
     exit
   end
 
-  opts.on('-s', '--server REGEX', 'Limit to server names matching regex.') do |s|
-    options[:server] = s
-  end
-
-  opts.on('-t', '--time', 'Show request times.') do |t|
-    options[:time] = true
-  end
-
   opts.on('-v', '--version', 'Display version and exit.') do
-    puts Auger::VERSION.color(:green)
+    puts Auger::VERSION
     exit
   end
-end
-optparse.parse!
-
-## cfg file can be e.g. 'imagine' or relative path
-cfg = 
-  if File.exists?(ARGV[0])
-    ARGV[0]
-  elsif path = AUGER_CFG.find { |path| File.exists?("#{path}/#{ARGV[0]}.rb") }
-    [path, "#{ARGV[0]}.rb"].join(File::SEPARATOR)
-  else
-    raise ArgumentError, "config #{ARGV[0]} not found"
+
+  opts.on('-l', '--list', 'List available configs and exit.') do
+    puts(AUGER_CFG.map do |dir|
+           Dir["#{dir}/*.rb"].map{ |file| File.basename(file).sub(/\.rb$/, '') } 
+         end.flatten.sort)
+    exit
   end
+end.parse!
+
+## load plugins
+Dir["#{File.dirname(File.dirname(__FILE__))}/lib/plugins/*.rb"].each { |file| require file }
 
 ## pretty-print Result object
 module Auger
   class Result
 
     def format
-      output = 
+      output =
         case self.outcome
         when TrueClass  then "\u2713"
         when MatchData  then outcome.captures.empty? ? "\u2713" : outcome.captures.join(' ')
@@ -88,48 +71,61 @@ module Auger
           end
         else                           :green
         end
-    
+
       return output.color(color)
     end
   end
 end
 
+## find cfg in path, or just use local file
+cfg = AUGER_CFG.map do |path|
+  File.join(path, "#{ARGV[0]}.rb")
+end.find do |file|
+  File.exists?(file)
+end || ARGV[0]
+
+## load config file and loop projects
 Auger::Config.load(cfg).projects.each do |project|
 
-  threads = Hash.new { |h,k| h[k] = [] }
-
-  ## run tests
-  project.connections.each do |connection|
-    servers = project.servers(connection.roles)
-    servers.select! { |server| server.name.match(options[:server]) } if options[:server]
-    servers.map do |server|
-      threads[server.name] << Thread.new do
-        conn = connection.do_open(server)
-        connection.requests.map do |request|
-          response, time = request.do_run(conn)
+  servers = project.servers.map do |server|
+
+    pipes = project.connections(*server.roles).map do |connection|
+      read, write = IO.pipe
+
+      Process.fork do
+        read.close              # child does not need
+        conn = connection.try_open(server)
+
+        responses = connection.requests.map do |request|
+          response, time = request.try_run(conn)
           request.tests.map do |test|
-            result = test.run(response)
-            result.time = time
-            result
+            [ test.name, test.run(response).format ]
           end
         end
+
+        Marshal.dump(responses, write)
+        connection.try_close(conn)
       end
+
+      write.close               # parent does not need
+      read                      # return the pipe
     end
+
+    [ server, pipes ]           # return server and its read pipes
   end
 
+  Process.waitall
+
   ## width of test name column
-  max_test_length = 
-    project.connections.map{|c| c.requests.map{|r| r.tests.map{|t| t.name.length}}}.flatten.max
+  max_test_length = project.tests.map { |test| test.name.length }.max
 
   ## print results
-  threads.keys.each do |server|
-    puts "[#{server.color(:cyan)}]"
-    threads[server].each do |thread| 
-      results = thread.value    # this waits on thread
-      results.flatten.each do |result|
-        output = "  %+#{max_test_length}s  %-30s" % [result.test.name, result.format]
-        output << "[#{result.time}]".color(:blue) if options[:time]
-        puts output
+  servers.each do |server, pipes|
+    puts "[#{server.name.color(:cyan)}]"
+
+    pipes.each do |pipe|
+      Marshal.load(pipe).flatten(1).each do |test, result|
+        puts "  %+#{max_test_length}s  %-30s" % [ test, result ]
       end
     end
   end

data/bin/aug_simple

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+## this is the simplest auger client, written for educational purposes;
+## not intended for actual use
+
+AUGER_DIR = File.dirname(File.dirname(__FILE__))
+AUGER_LIB = File.join(AUGER_DIR, 'lib')
+
+## relative path to libs (in case not installed as a gem)
+$LOAD_PATH.unshift(AUGER_LIB) unless $LOAD_PATH.include?(AUGER_LIB)
+require "auger"
+
+## load plugins
+Dir["#{File.dirname(File.dirname(__FILE__))}/lib/plugins/*.rb"].each { |file| require file }
+
+## load config file and loop projects
+Auger::Config.load(ARGV[0]).projects.each do |project|
+
+  project.servers.each do |server|
+    puts "[#{server.name}]"
+
+    project.connections(*server.roles).each do |connection|
+      conn = connection.try_open(server)
+      
+      connection.requests.each do |request|
+        response, time = request.try_run(conn)
+
+        request.tests.each do |test|
+          result = test.run(response)
+          puts "  #{test.name}: #{result.outcome}"
+        end
+
+      end
+
+      connection.try_close(conn)
+
+    end
+    
+  end
+  
+end

data/lib/auger/connection.rb

@@ -30,7 +30,7 @@ module Auger
     end
 
     ## call plugin open() and return plugin-specific connection object, or exception
-    def do_open(server)
+    def try_open(server)
       options = @options.merge(server.options)
       begin
         self.open(server.name, options)
@@ -39,6 +39,15 @@ module Auger
       end
     end
     
+    ## safe way to call plugin close() (rescue if the connection did not exist)
+    def try_close(conn)
+      begin
+        self.close(conn)
+      rescue => e
+        e
+      end
+    end
+
   end
   
 end

data/lib/auger/project.rb

@@ -3,7 +3,7 @@ require 'host_range'
 module Auger
 
   class Project
-    attr_accessor :name, :fqdns, :hosts, :connections, :roles
+    attr_accessor :name, :connections, :servers
     
     def self.load(name, &block)
       project = new(name)
@@ -13,51 +13,44 @@ module Auger
 
     def initialize(name)
       @name = name
-      @hosts = []
-      @fqdns = []
+      @servers = []
       @connections = []
-      @roles = Hash.new { |h,k| h[k] = [] }
       self
     end
 
-    def role(name, *args)
-      options = args.last.is_a?(Hash) ? args.pop : {}
-      servers = args.map { |arg| HostRange.parse(arg) }.flatten
-      servers.each { |server| roles[name] << Auger::Server.new(server, options) }
-    end
-
+    ## set server, or list of server names, with optional roles and options
+    ## e.g. server server1, server2, :roleA, :roleB, options => values
     def server(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
-      roles = []
-      servers = []
-      args.each do |arg|
-        case arg
-        when Symbol then roles << arg
-        when String then servers << arg
-        else raise ArgumentError, "illegal argument to server: #{arg}"
-        end
+      roles = args.select { |arg| arg.class == Symbol }
+      servers = args.select { |arg| arg.class == String }.map { |arg| HostRange.parse(arg) }
+      @servers += servers.flatten.map do |name|
+        Auger::Server.new(name, *roles, options)
       end
-      roles = [nil] if roles.empty? # default role
-      roles.each { |name| role(name, *servers, options) }
     end
 
-    alias :hosts :server
-
-    ## return array of servers for given array of roles (default to all)
-    def servers(roles = [])
-      (roles.empty? ? @roles.values : @roles.values_at(*roles))
-        .flatten
+    ## get list of server objects (optionally matching list of roles)
+    def servers(*roles)
+      if roles.empty?
+        @servers
+      else
+        roles.map do |role|
+          @servers.select { |server| server.roles.include?(role) }
+        end.flatten.uniq
+      end
     end
 
-    alias :host :hosts
-
-    ## add fqdn or return list of fqdns
-    def fqdns(*ranges)
-      ranges.empty? ? @fqdns.flatten : @fqdns << [*ranges].map {|r| HostRange.parse(r)}
+    ## return all connections, or those matching list of roles;
+    ## connections with no roles match all, or find intersection with roles list
+    def connections(*roles)
+      if roles.empty?
+        @connections
+      else
+        @connections.select { |c| c.roles.empty? or !(c.roles & roles).empty? }
+      end
     end
 
-    alias :fqdn :fqdns
-
+    ## return list of all test objects for this project
     def tests
       @connections.map do |connection|
         connection.requests.map do |request|

data/lib/auger/request.rb

@@ -38,7 +38,7 @@ module Auger
     end
 
     ## call plugin run() and return plugin-specfic response object or exception
-    def do_run(conn)
+    def try_run(conn)
       return conn if conn.is_a? Exception
       begin
         arg = @arg

data/lib/auger/server.rb

@@ -1,11 +1,12 @@
 module Auger
 
   class Server
-    attr_accessor :name, :options
+    attr_accessor :name, :options, :roles
 
-    def initialize(name, options)
+    def initialize(name, *args)
       @name = name
-      @options = options || {}
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @roles = args
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auger
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-05 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -98,6 +98,7 @@ email:
 - heffergm@gmail.com
 executables:
 - aug
+- aug_simple
 extensions: []
 extra_rdoc_files: []
 files:
@@ -109,6 +110,7 @@ files:
 - VERSION
 - auger.gemspec
 - bin/aug
+- bin/aug_simple
 - cfg/examples/elasticsearch.rb
 - cfg/examples/redis.rb
 - cfg/examples/riak.rb
@@ -148,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: App && infrastructure testing DSL