rscout 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f99db4dc314b86a999f18358e0b0b00443d72fed
-  data.tar.gz: a48d9e65ffa1138de4233062f246c560691d5e74
+  metadata.gz: 2b4e0f84ccdddbea2fb2e27d4017f6ae4d3d95f2
+  data.tar.gz: ae5c5d7608094e91b5753f1156aab2cd46571916
 SHA512:
-  metadata.gz: 5f865c5c520d4981b433226734e80fad990525a521f013cfd6bfc65b1a91dfbdd6f96deceb90b916a230da576b4a25d931a7155a57c7aa1e785e2f2fd54f065a
-  data.tar.gz: 7065eb96ad0b9403c6b9158b8c79e3b4e6ae4691bf94f7e891ea058540134bf1960b9b526e2db3d2cb9e8c6e1f7a6b9a631baea5f3979c0d4dba4a5fa32399da
+  metadata.gz: 0baee0226aceb46c71edb2697ba40f8679b5a8ce547e3e3328a06c720124f7816636597d977abd44b4459482e81dc748bdd27df29c6d6e0bb13ecbfbbc59e871
+  data.tar.gz: 6a6ec2e4968aae8cf02797014c4c7d089b01966f8ef7f80ba9de7153d5fca7b93ac2b31f59990cef858bee179fb094c9dc41fb24ce05df522c124706cd5cce08

data/README.md

@@ -69,9 +69,21 @@ Note: For PagerDuty configurations, you should use their REST API to determine t
 The `rscout` command should be run from the directory where you keep your RScout test Gemfile. See Configuration section above.
 
     $ cd myproject
-    $ SMTP_ADDRESS=localhost SMTP_PORT=1025 bundle exec rscout test --env production`
+    $ RSCOUT_LOG=/path/to/rscout.log RSCOUT_EMAIL=rscout_from@example.com SMTP_ADDRESS=localhost SMTP_PORT=1025 bundle exec rscout test --env production`
 
-Supply the rscout command with the necessary SMTP ENV keys if applicable.
+Supply the rscout command with the necessary ENV keys if applicable.
+
+For documentation, run `rscout --help`, which outputs:
+
+```
+Usage:
+  rscout test e, --env=ENV
+
+Options:
+  e, --env=ENV                              # The environment to run the test suite on.
+  s, [--send-success], [--no-send-success]  # Send notifications even without any test failures.
+  v, [--verbose], [--no-verbose]            # Show verbose messaging.
+```
 
 ## TODO
 

data/bin/rscout

@@ -12,6 +12,7 @@ Dotenv.load
 class RscoutCommand < Thor
   desc 'test', 'Run tests'
   method_option :env, required: :true, type: :string, aliases: [:e], desc: 'The environment to run the test suite on.'
+  method_option :send_success, type: :boolean, aliases: [:s], default: false, lazy_default: true, desc: 'Send notifications even without any test failures.'
   method_option :verbose, type: :boolean, aliases: [:v], default: false, lazy_default: true, desc: 'Show verbose messaging.'
   def test
     Mail.defaults do
@@ -32,6 +33,7 @@ class RscoutCommand < Thor
     RScout.options[:env] = options.env
     RScout.options[:verbose] = options.verbose
     RScout.options[:from_email] = ENV['RSCOUT_EMAIL'] if ENV['RSCOUT_EMAIL']
+    RScout.options[:send_success] = options.send_success
 
     RScout.run_suite Dir.pwd
   end

data/lib/rscout.rb

@@ -18,7 +18,8 @@ module RScout
     logger: DEFAULT_LOGGER,
     verbose: false,
     env: 'development',
-    from_email: 'rscout@localhost'
+    from_email: 'rscout@localhost',
+    send_success: false
   }
 
   class << self
@@ -93,9 +94,9 @@ module RScout
             output.json.close unless output.json.closed?
           end
 
-          if failed
-            logger.info "Tests failed."
-            send_failure_notifications config, env, output
+          if failed || options[:send_success]
+            logger.info (failed ? "Tests failed." : "Tests passed.")
+            send_notifications config, env, output, failed
           end
 
           failed
@@ -103,24 +104,31 @@ module RScout
       end
     end
 
-    def send_failure_notifications(config, env, output)
-      email_body = [output.txt.string, output.error.backtrace.join("\n")].join("\n")
+    def send_notifications(config, env, output, failed=false)
+      email_body_parts = []
+      email_body_parts << output.txt.string if output.txt && output.txt.respond_to?(:string)
+      email_body_parts << output.error.backtrace.join("\n") if output.error.backtrace
+      email_body = email_body_parts.join("\n\n")
+
       if config.email_enabled && config.email
-        logger.info "Sending emails alert to #{config.email}"
+        logger.info "Sending email alert to #{config.email}"
+
+        status_text = failed ? "RSout Alert: Tests failing" : "RScout: All tests passing"
+
         begin
           mail = Mail.new do
             from     RScout.options[:from_email]
             to       config.email
-            subject  "RScout Alert: Tests failing on #{config.name.to_s.humanize.titleize} (#{env})"
+            subject  "#{status_text} on #{config.name.to_s.humanize.titleize} (#{env})"
             add_file filename: 'results.html', content: output.html.string
 
-            header["X-Priority"] = "1 (Highest)"
-            header["X-MSMail-Priority"] = "High"
-            header["Importance"] = "High"
-
-            text_part do
-              body email_body
+            if failed
+              header["X-Priority"] = "1 (Highest)"
+              header["X-MSMail-Priority"] = "High"
+              header["Importance"] = "High"
             end
+
+            body email_body
           end
 
           mail.deliver!
@@ -130,7 +138,7 @@ module RScout
         end
       end
 
-      if config.pagerduty_enabled && config.pagerduty_service_key
+      if failed && config.pagerduty_enabled && config.pagerduty_service_key
         logger.info "Triggering PagerDuty incident to #{config.pagerduty_service_key}"
         begin
           if config.pagerduty_service_key.match(/@(.*)pagerduty.com$/)

data/lib/rscout/version.rb

@@ -1,3 +1,3 @@
 module Rscout
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/rscout.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["andrew@tremorlab.com"]
   spec.description   = %q{Integration tests with Rspec}
   spec.summary       = %q{Integration tests with Rspec}
-  spec.homepage      = "https://github.com/andrhamm"
+  spec.homepage      = "https://github.com/andrhamm/rscout"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rscout
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Andrew Hammond (@andrhamm)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-28 00:00:00.000000000 Z
+date: 2014-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -215,7 +215,7 @@ files:
 - lib/rscout.rb
 - lib/rscout/version.rb
 - rscout.gemspec
-homepage: https://github.com/andrhamm
+homepage: https://github.com/andrhamm/rscout
 licenses:
 - MIT
 metadata: {}