opticon 0.0.1 → 0.0.2

data/CHANGELOG.txt

@@ -0,0 +1,13 @@
+=== 0.0.2 :: 2007-11-15
+
+* A series of tests on a service can now be specified as a block to the 
+  Service#test method.
+* All failures generated inside a test block are all batched together
+  into one notification.  
+* Opticon test scripts can now be run with the "-v" switch to verbosely
+  display what the script is doing.  
+* Failure messages are now a bit more readable for non-techies.
+
+=== 0.0.1 :: 2007-02-21
+
+* First public release.

data/Manifest.txt

@@ -1,7 +1,6 @@
 Rakefile
 README.txt
 CHANGELOG.txt
-History.txt
 Manifest.txt
 README.txt
 Rakefile
@@ -17,8 +16,10 @@ lib/opticon/service.rb
 lib/opticon/tester.rb
 lib/opticon/version.rb
 setup.rb
+test/opticon/email_notifier_test.rb
 test/opticon/http_test.rb
 test/opticon/mailer_test.rb
+test/opticon/service_test.rb
 test/opticon/tester_test.rb
 test/opticon_test.rb
-test/test_helper.rb
+test/test_helper.rb

data/README.txt

@@ -1,4 +1,4 @@
-Opticon is a no-nonsense utility for monitoring HTTP-based services (websites).
+Opticon is a no-nonsense utility for monitoring HTTP-based services (i.e. websites).
 
 When triggered, opticon connects to a list of URIs and checks to make sure that
 they pass some arbitrary test, such as responding with a non-error HTTP response 

data/examples/sample.rb

@@ -1,24 +1,38 @@
 #!/usr/bin/env ruby
-require 'rubygems'; gem 'opticon'; require 'opticon'
+require 'rubygems'
 
-# Where notifications will be emailed
-SEND_TO = "sample@nowhere.foo"
+begin
+  gem 'opticon'
+rescue Gem::LoadError
+  # try to load local copy if gem is not available 
+  $: << 'lib'
+end
+
+require 'opticon'
 
+# SEND_TO determines where notifications will be emailed.
+#
 # If you want to send to multiple mailboxes, you can specify an array of
 # addresses like so:
 # 
 #   SEND_TO = ['robert@nowhere.foo', 'sally@nowhere.foo']
 
-# Email notifications will show up as coming from this address.
-FROM = "opticon@nowhere.foo"
+SEND_TO = "sample@nowhere.foo"
 
+
+# Email notifications will show up as coming from the FROM address.
+#
 # You may have to set the FROM value to be a real email address (e.g. your 
 # email address). Otherwise your mail server may decide to drop Opticon's
 # notification messages.
 
+FROM = "opticon@nowhere.foo"
+
+
 # You don't have to change anything on this next line. This configures the 
 # default notification behaviour for Opticon, which is to email failures to the
 # addresses you configured above.
+
 Opticon.default_notifiers = Opticon::Notifier::Email.new(SEND_TO, :from => FROM)
 
 # You may need to configure the Mailer with your mail server info. Here's how to
@@ -34,6 +48,7 @@ Opticon.default_notifiers = Opticon::Notifier::Email.new(SEND_TO, :from => FROM)
 # See http://api.rubyonrails.com/classes/ActionMailer/Base.html for more details
 # on setting up the mailer.
 
+
 # Now you can set up some tests. Note that this is just plain Ruby code, formatted
 # a bit strangely (note the dot at the end of each line -- we are calling the test()
 # method on the URI string, and then on the result of each successive test).
@@ -47,11 +62,22 @@ Opticon.default_notifiers = Opticon::Notifier::Email.new(SEND_TO, :from => FROM)
 
 "http://google.com".
   # Google will try to redirect to http://www.google.com/
-  test(:responds_with_code, 302) 
+  test(:responds_with_code, 301) 
   # Note that currently there is no test for checking where you are being
   # redirected to. This functionality will be added in the future.
 
 
+# Alternatively, you can pack your tests into a a block (this is now the
+# preferred method):
+
+"http://www.yahoo.com/".test do
+  # check that the HTTP response code is in the 200 range
+  test(:responds_with_code, :success)
+  # check that the page includes the string "Privacy Policy"
+  test(:response_body_contains, "Privacy Policy") 
+end
+
+
 # For a comprehensive guide on configuring and using Opticon, please see:
 #
 #   http://code.google.com/p/opticon/wiki/ConfiguringOpticon

data/lib/opticon/failure.rb

@@ -23,7 +23,7 @@ module Opticon
     
     class ResponseCodeTestFailure < Base
       def failure_message
-        "Expected response code #{condition.inspect} but got '#{response.message}' (#{response.code})"
+        "The service did not respond as expected; expected response code was #{condition.inspect} but got #{response.code.inspect} (#{response.message.inspect})"
       end
     end
     
@@ -32,7 +32,7 @@ module Opticon
         if exception 
           return exception.message
         else
-          "Content did not include the expected #{condition.class} #{condition.inspect}"
+          "Page content did not include the expected #{condition.class} #{condition.inspect}"
         end
       end
     end

data/lib/opticon/mailer.rb

@@ -6,15 +6,26 @@ require 'action_mailer'
 module Opticon
   class Mailer < ::ActionMailer::Base
     # we use sendmail by default since it might just work out of the box
-    # (:smtp, which is the normal default, definetly won't work without manual configuration)
+    # (:smtp which is the normal default definitely won't work without manual configuration)
     self.delivery_method = :sendmail 
     self.template_root = File.dirname(File.expand_path(__FILE__))+'/..'
   
-    def failure_notification(failure, recipients, from)
+    def failure_notification(service, message, recipients, from)
+      subject = "HTTP Service Failure: #{service}"
+      
+      if ARGV.include?("-v")
+        puts "Mailing notification:"
+        puts "  TO:      #{recipients.inspect}"
+        puts "  SUBJECT: #{subject}"
+        puts "  FROM:    #{from}"
+        puts "  SERVICE: #{service}"
+        puts "  MESSAGE: #{message}"
+      end
+      
       self.recipients recipients
       self.from       from
-      subject    "HTTP Service Failure: #{failure.uri}"
-      body       :failure => failure
+      self.subject    subject
+      self.body       :service => service, :message => message
     end
   end
 end

data/lib/opticon/mailer/failure_notification.rhtml

@@ -1,5 +1,5 @@
-Service at '<%= @failure.uri %>' failed: 
+Service at '<%= @service %>' failed one or more Opticon tests: 
 
-<%= @failure.failure_message %>
+<%= @message %>
 
 (Generated by Opticon on host '<%= ENV['HOSTNAME'] %>' at <%= Time.now %>)

data/lib/opticon/notifier.rb

@@ -1,17 +1,70 @@
 require 'opticon/mailer'
+require 'pstore'
 
 module Opticon
-  module Notifier  
+  module Notifier
+    # Send failure notifications via email to the given list of recipients.
+    # 
+    # To set options, configure Opticon::Mailer the same way you
+    # would any other ActionMailer. For example, to send via SMTP:
+    # 
+    #   Opticon::Mailer.delivery_method = :smtp
+    #   
+    #   Opticon::Mailer.server_settings = {
+    #     :address => "mail.nowhere.foo",
+    #     :domain => "nowhere.foo",
+    #     :authentication => :login,
+    #     :user_name => "mail_user",
+    #     :password => "topsecret"
+    #   }
+    # 
     class Email
       attr_accessor :recipients, :from
       
+      # The same notification will not be resent over and over again unless
+      # this is set to true.
+      @@resend = false
+      
       def initialize(recipients, options = {:from => "opticon@#{ENV['HOSTNAME']}"})
         @recipients = recipients
         @from = options[:from]
       end
       
-      def notify(failure)
-        Opticon::Mailer.deliver_failure_notification(failure, recipients, from)
+      def notify(failures)
+        failures = [failures] unless failures.kind_of? Array
+        
+        failures_by_uri = {}
+        failures.each do |f|
+          failures_by_uri[f.uri] ||= []
+          failures_by_uri[f.uri] << f
+        end
+        
+        if ARGV.include?("-v")
+          puts "Notifying #{recipients.inspect} about #{failures.size} failures:"
+          failures.each{|f| puts "  #{f.failure_message}"}
+        end
+        
+        failures_by_uri.each do |uri, failures|
+          Opticon::Mailer.deliver_failure_notification(
+            uri,
+            failures.collect{|f| f.failure_message}.join("\n"),
+            recipients, from
+          )
+        end
+      end
+    end
+    
+    # Dummy notifier used in testing. It doesn't do anything other than store
+    # the error_messages given to notify in the object's notifications attribute.
+    class Dummy
+      attr_accessor :notifications
+    
+      def initialize()
+        @notifications = []
+      end
+    
+      def notify(failures)
+        @notifications << failures
       end
     end
   end

data/lib/opticon/service.rb

@@ -21,47 +21,82 @@ module Opticon
       @uri.to_s
     end
     
-    def test(tester, *args)
-      case tester
-      when :responds_with_code, 'responds_with_code'
-        tester = Opticon::Tester::ResponseCodeTester.new
-      when :response_body_contains, 'response_body_contains'
-        tester = Opticon::Tester::ContentTester.new
-      when Class
-        tester = tester.new
-      when Tester::Base
-        tester = tester
+    def test(*args, &block)
+      if block
+        @prev_batch_notify = @batch_notify
+        @batch_notify = true
+        instance_eval(&block)
+        send_batch_notification
+        @batch_notify = @prev_batch_notify
       else
-        begin
-          tester_class = "Opitcon::Tester::#{tester.to_s}".constantize
-          tester = tester_class.new
-        rescue NameError
-          bad_tester = true
+        tester_type = args[0]
+        condition = args[1]
+        options = args[2]
+      
+        case tester_type
+        when :responds_with_code, 'responds_with_code'
+          tester = Opticon::Tester::ResponseCodeTester.new
+        when :response_body_contains, 'response_body_contains'
+          tester = Opticon::Tester::ContentTester.new
+        when Class
+          tester = tester.new
+        when Tester::Base
+          tester = tester
+        else
+          begin
+            tester_class = "Opitcon::Tester::#{tester.to_s}".constantize
+            tester = tester_class.new
+          rescue NameError
+            bad_tester = true
+          end
+          
+          if bad_tester or !tester.respond_to? :test
+            raise ArgumentError, "'#{tester}' is not a valid tester. The parameter must be: 'responds_with_code', 'response_body_contains', or"+
+              " an Object or Class that responds to a 'test' method."
+          end
         end
         
-        if bad_tester or !tester.respond_to? :test
-          raise ArgumentError, "'#{tester}' is not a valid tester. The parameter must be: 'responds_with_code', 'response_body_contains', or"+
-            " an Object or Class that responds to a 'test' method."
+        tester.uri = @uri
+        
+        @failures ||= []
+        
+        debug = "#{@uri} #{tester_type} #{condition.inspect}?"
+        
+        if tester.test(condition)
+          puts "#{debug} ==> PASSED!" if ARGV.include?("-v")
+        else
+          puts "#{debug} ==> FAILED!" if ARGV.include?("-v")
+          notifiers.each {|n| n.notify(tester.failure)} unless @batch_notify
+          @failures << tester.failure
         end
+        
+        # return self to allow for chaining test calls
+        return self
       end
-      
-      tester.uri = @uri
-      
-      @failures = []
-      unless tester.test(*args)
-        notifiers.each {|n| n.notify(tester.failure)}
-        @failures << tester.failure
+    end
+    
+    def send_batch_notification
+      notifiers.each {|n| n.notify(@failures)} unless @failures.empty?
+    end
+  
+    def failures?
+      if @failures.nil?
+        raise "Test has not yet been run."
+      else
+        not @failures.empty?
       end
-      
-      # return self to allow for test chaining
-      return self
     end
   end
 end
 
-# this makes it possible to treat strings as Service objects
+# this makes it possible to use Strings like Service objects
 class String
-  def test(tester, *args)
-    Opticon::Service.new(to_s).test(tester, *args)
+  def method_missing(method, *args, &block)
+    service.send(method, *args, &block)
+  end
+  
+  private
+  def service
+    @service ||= Opticon::Service.new(to_s)
   end
 end

data/lib/opticon/tester.rb

@@ -9,19 +9,22 @@ module Opticon
       
       include Opticon::HTTP
       
-      def test(*args)
+      # Wrapper for calling the test method. 
+      # Generally you'll want to invoke this instead of invoking test directly.
+      def run(condition)
         begin
-          test_without_exception_handling(*args)
+          test(condition)
         rescue SocketError, TimeoutError, Net::HTTPError, Errno::ECONNREFUSED
-          @failure = Opticon::Failure::ConnectionFailure.new(uri, args, nil)
+          @failure = Opticon::Failure::ConnectionFailure.new(uri, condition, nil)
           @failure.exception = $!
           false
         end
       end
     end
-     
+    
+    # Tests that the service responds with some given HTTP status code.
     class ResponseCodeTester < Base
-      def test_without_exception_handling(condition)
+      def test(condition)
         case condition
         when :ok
           responds_with_code(200)
@@ -79,8 +82,10 @@ module Opticon
       end
     end
     
+    # Tests that the service responds with content that matches some given 
+    # string or regular expression.
     class ContentTester < Base
-      def test_without_exception_handling(condition)
+      def test(condition)
         unless (200..206).include?(response.code.to_i)
           @failure = Opticon::Failure::ContentTestFailure.new(uri, condition, response)
           if (300..307).include?(response.code.to_i)

data/lib/opticon/version.rb

@@ -2,7 +2,7 @@ module Opticon #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/opticon/email_notifier_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Opticon::ServiceTest < Test::Unit::TestCase
+
+  def test
+  end
+  
+end

data/test/opticon/mailer_test.rb

@@ -17,7 +17,7 @@ class Opticon::HTTPTest < Test::Unit::TestCase
   end
   
   def test_failure_notification
-    email = Opticon::Mailer.create_failure_notification(@failure, "test@test.ruby", "opticon@test.ruby")
+    email = Opticon::Mailer.create_failure_notification(@failure.uri, @failure.failure_message, "test@test.ruby", "opticon@test.ruby")
     assert_match(@failure.uri, email.subject)
     assert_equal("test@test.ruby", email.to.first)
     assert_match(@failure.uri, email.body)

data/test/opticon/service_test.rb

@@ -0,0 +1,62 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Opticon::ServiceTest < Test::Unit::TestCase
+
+  def setup
+    Opticon.default_notifiers = Opticon::Notifier::Dummy.new
+  end
+  
+  def test_initialize
+    uri = "http://www.yahoo.com/"
+    s = Opticon::Service.new(uri)
+    
+    assert_equal Opticon.default_notifiers, s.notifiers
+    assert_equal uri, s.to_s
+  end
+  
+  def test_test
+    uri = "http://www.yahoo.com/"
+    s = Opticon::Service.new(uri)
+    
+    assert !s.test(:responds_with_code, 200).failures?
+    assert s.test(:responds_with_code, 400).failures?
+    assert_equal 1, s.notifiers.first.notifications.size
+    assert_kind_of Opticon::Failure::ResponseCodeTestFailure, s.notifiers.first.notifications.first
+  end
+  
+  def test_string_convenience
+    uri = "http://www.yahoo.com/"
+    
+    assert !uri.test(:responds_with_code, 200).failures?
+    assert uri.test(:responds_with_code, 400).failures?
+  end
+  
+  def test_test_block
+    uri = "http://www.yahoo.com/"
+    s = Opticon::Service.new(uri)
+    
+    s.test do
+      test(:responds_with_code, 200)
+      test(:responds_with_code, 400)
+    end
+    
+    assert s.failures?
+    assert_equal 1, s.notifiers.first.notifications.size
+    assert_kind_of Opticon::Failure::ResponseCodeTestFailure, s.notifiers.first.notifications.first.first
+  end
+  
+  def test_test_block_on_string
+    uri = "http://www.yahoo.com/"
+    
+    uri.test do
+      test(:responds_with_code, 200)
+      test(:responds_with_code, 400)
+    end
+    
+    assert uri.failures?
+    assert_equal 1, uri.notifiers.first.notifications.size
+    
+    assert_kind_of Opticon::Failure::ResponseCodeTestFailure, uri.notifiers.first.notifications.first.first
+  end
+  
+end

data/test/opticon/tester_test.rb

@@ -9,18 +9,18 @@ class Opticon::HTTPTest < Test::Unit::TestCase
     tester = Opticon::Tester::ResponseCodeTester.new
     tester.uri = "http://www.yahoo.com"
     
-    assert tester.test(:success)
-    assert tester.test(200)
-    assert tester.test([200, 302])
-    assert !tester.test(:server_error)
+    assert tester.run(:success)
+    assert tester.run(200)
+    assert tester.run([200, 302])
+    assert !tester.run(:server_error)
   end
   
   def test_response_code_tester_failure
     tester = Opticon::Tester::ResponseCodeTester.new
     tester.uri = "http://www.yahoo.com/alskjdflaksjflkasjfklsTHIS_PAGE_DOESNT_EXIST"
     
-    assert tester.test(404)
-    assert !tester.test(:success)
+    assert tester.run(404)
+    assert !tester.run(:success)
     assert_kind_of Opticon::Failure::ResponseCodeTestFailure, tester.failure
     assert_equal 404.to_s, tester.failure.response.code.to_s
   end
@@ -29,13 +29,13 @@ class Opticon::HTTPTest < Test::Unit::TestCase
     tester = Opticon::Tester::ResponseCodeTester.new
     tester.uri = "http://there.is.no.such.server.foobarblah/test"
     
-    assert !tester.test(:success)
+    assert !tester.run(:success)
     assert_kind_of Opticon::Failure::ConnectionFailure, tester.failure
     
     tester = Opticon::Tester::ResponseCodeTester.new
     tester.uri = "http://localhost:65489789"
     
-    assert !tester.test(:success)
+    assert !tester.run(:success)
     assert_kind_of Opticon::Failure::ConnectionFailure, tester.failure
   end
   
@@ -43,11 +43,11 @@ class Opticon::HTTPTest < Test::Unit::TestCase
     tester = Opticon::Tester::ContentTester.new
     
     tester.uri = "http://code.google.com/p/opticon/"
-    assert tester.test("matt.zukowski"), tester.failure
+    assert tester.run("matt.zukowski"), tester.failure
     assert_nil tester.failure
     
     bad_string = "THIS STRING DOESNT EXIST IN OPTICON's GOOGLE CODE PAGE!!!"
-    assert !tester.test(bad_string), tester.failure
+    assert !tester.run(bad_string), tester.failure
     assert_equal bad_string, tester.failure.condition
   end
   
@@ -55,11 +55,11 @@ class Opticon::HTTPTest < Test::Unit::TestCase
     tester = Opticon::Tester::ContentTester.new
     
     tester.uri = "http://code.google.com/p/opticon/"
-    assert tester.test(/gnu general public license [23]\.[0-9]/i), tester.failure
+    assert tester.run(/gnu general public license v[0-9]/i), tester.failure
     assert_nil tester.failure
     
     bad_regexp = /klasjfkljasdlkfjasklfjslkdfj/
-    assert !tester.test(bad_regexp), tester.failure
+    assert !tester.run(bad_regexp), tester.failure
     assert_equal bad_regexp, tester.failure.condition
   end
   
@@ -68,10 +68,9 @@ class Opticon::HTTPTest < Test::Unit::TestCase
   
     tester.uri = "http://google.com/"    
     # google will try to redirect to http://www.google.com/
-    assert_equal 302, tester.response.code.to_i
-    assert !tester.test("Google Search"), tester.failure
+    assert_equal 301, tester.response.code.to_i
+    assert !tester.run("Google Search"), tester.failure
     assert_equal "http://www.google.com/", tester.failure.response['location']
   end
   
-  
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: opticon
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-02-20 00:00:00 -05:00
+  version: 0.0.2
+date: 2007-11-15 00:00:00 -05:00
 summary: Peace of mind through automated monitoring of your HTTP services.
 require_paths: 
 - lib
@@ -32,7 +32,6 @@ files:
 - Rakefile
 - README.txt
 - CHANGELOG.txt
-- History.txt
 - Manifest.txt
 - examples/sample.rb
 - lib/opticon.rb
@@ -46,15 +45,19 @@ files:
 - lib/opticon/tester.rb
 - lib/opticon/version.rb
 - setup.rb
+- test/opticon/email_notifier_test.rb
 - test/opticon/http_test.rb
 - test/opticon/mailer_test.rb
+- test/opticon/service_test.rb
 - test/opticon/tester_test.rb
 - test/opticon_test.rb
 - test/test_helper.rb
 test_files: 
 - test/opticon_test.rb
+- test/opticon/service_test.rb
 - test/opticon/tester_test.rb
 - test/opticon/mailer_test.rb
+- test/opticon/email_notifier_test.rb
 - test/opticon/http_test.rb
 rdoc_options: []