rscout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a199aefeb4ee4e5c194b886370a2559f00b748f
+  data.tar.gz: 501ec0f44aca8336752435ce11cadb26b5c651f0
+SHA512:
+  metadata.gz: 7608d23bf7aabcd9020e6368783429950bed01a6ffe0c5c6f45d3e4d306667bf9370c39d7bc8dc68044ea0dc0a21d341ba5cea8dc418dae04f131ae0226dcefe
+  data.tar.gz: c3182dbb2052068285f4e000702e39aaad7545528cc88e77759e608a842d6a269bace44e470cc3037230072e017acb356d9c883be1946a848eb85c6d67a752d0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.env
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Hammond
+
+MIT License
+
+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,88 @@
+Run integration tests on your live APIs. Write tests in RSpec and get email and/or PagerDuty notifications when tests are failing.
+
+At EverTrue, we run a dedicated server we call Scout, which has many projects' RScout tests deployed to it. Our Scout server is a Sinatra web app which has a REST API which leverages RScout to run the many test suites for our various REST APIs.
+
+## Features
+
+* Sends email notifications with details of failing tests
+* Sends PagerDuty notifications
+* YAML configuration supports multiple environments
+* Simple command-line interface
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rscout'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rscout
+
+## Configuration
+
+Recommended directory structure:
+
+```
+myproject
+| rscout_tests
+| | config
+| | | rscout.yml
+| | spec
+| | | myfirsttest_spec.rb
+| | | spec_helper.rb
+| | Gemfile
+```
+
+We keep our RScout tests separate from our main tests, for consistency accross all our projects. You'll be running the `rscout` command from the `rscout_tests` directory (name not important) and the relation of the `Gemfile`, `config/rscout.yml` and `spec/` are important.
+
+Example `rscout.yml` file:
+
+```
+default: &default
+  name: myproject
+  pagerduty_id: PM3WJQN
+  pagerduty_service_key: my-api@myteam.pagerduty.com
+  pagerduty_enabled: false
+  email: andrew@example.com
+  email_enabled: true
+
+development:
+  <<: *default
+
+staging:
+  <<: *default
+
+production:
+  <<: *default
+  pagerduty_enabled: true
+```
+
+Note: For PagerDuty configurations, you should use their REST API to determine the values for `pagerduty_id` and `pagerduty_service_key`. Only one is necessary. If your PagerDuty service is setup with a "service_key" then RScout will send the notification to that email address since their REST API does not support REST notifications for these service configurations. For us, this was based on if the given service was integrated with Pingdom.
+
+## Usage
+
+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`
+
+Supply the rscout command with the necessary SMTP ENV keys if applicable.
+
+## TODO
+
+* Abstract notification modules, support other services
+* Pingdom integration
+* Slack/HipChat integration
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/bin/rscout

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require 'dotenv'
+require 'rscout'
+require 'mail'
+
+Dotenv.load
+
+class RscoutCommand < Thor
+  desc 'test', 'Run tests'
+  # method_option :suite, required: :true, type: :string, aliases: [:s], desc: 'The name of the test suite to run.'
+  method_option :env, required: :true, type: :string, aliases: [:e], desc: 'The environment to run the test suite on.'
+  method_option :verbose, type: :boolean, aliases: [:v], default: false, lazy_default: true, desc: 'Show verbose messaging.'
+  def test
+    Mail.defaults do
+      smtp = {}
+
+      smtp[:user_name] = ENV['SMTP_USERNAME'] if ENV['SMTP_USERNAME']
+      smtp[:password] = ENV['SMTP_PASSWORD'] if ENV['SMTP_PASSWORD']
+      smtp[:domain] = ENV['SMTP_DOMAIN'] if ENV['SMTP_DOMAIN']
+      smtp[:address] = ENV['SMTP_ADDRESS'] if ENV['SMTP_ADDRESS']
+      smtp[:port] = ENV['SMTP_PORT'] if ENV['SMTP_PORT']
+      smtp[:authentication] = ENV['SMTP_AUTHENTICATION'] if ENV['SMTP_AUTHENTICATION']
+      smtp[:enable_starttls_auto] = ENV['SMTP_ENABLESTARTTLS_AUTO'] if ENV['SMTP_ENABLESTARTTLS_AUTO']
+
+      delivery_method :smtp, smtp
+    end
+
+    RScout.run_suite Dir.pwd, options.env
+  end
+end
+
+RscoutCommand.start

data/lib/rscout.rb

@@ -0,0 +1,148 @@
+require 'rscout/version'
+require 'yaml'
+require 'hashie'
+require 'pagerduty'
+require 'mail'
+require 'logger'
+require 'active_support/core_ext/string'
+
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/formatters/json_formatter'
+require 'rspec/core/formatters/documentation_formatter'
+require 'rspec/core/formatters/html_formatter'
+
+module RScout
+  def self.logger
+    @@LOGGER ||= begin
+      logger = Logger.new STDOUT
+      logger.level = Logger::ERROR
+      logger
+    end
+  end
+
+  def self.run_suite(dir, env)
+    verbose = false
+    gemfile = File.join(dir, 'Gemfile')
+    configfile = File.join(dir, 'config', 'rscout.yml')
+
+    Bundler.with_clean_env do
+      Dir.chdir(dir) do
+        yaml = Hashie::Mash.new(YAML.load_file configfile)
+        config = yaml[env]
+
+        output = Hashie::Mash.new({
+          txt: StringIO.new,
+          html: StringIO.new,
+          json: StringIO.new,
+          stdout: nil,
+          results: nil,
+          error: Hashie::Mash.new({backtrace:[], message:nil})
+        })
+
+        failed = false
+        begin
+          html_formatter = RSpec::Core::Formatters::HtmlFormatter.new output.html
+          txt_formatter = RSpec::Core::Formatters::DocumentationFormatter.new output.txt
+          json_formatter = RSpec::Core::Formatters::JsonFormatter.new output.json
+
+          reporter = RSpec::Core::Reporter.new(json_formatter, txt_formatter, html_formatter)
+
+          rspec = RSpec.configuration
+          rspec.instance_variable_set(:@reporter, reporter)
+
+          tests = Dir.glob File.join(dir, 'spec/**/*_spec.rb')
+
+          rspec_task = lambda { RSpec::Core::Runner.run tests }
+
+          if verbose
+            rspec_task.call
+          else
+            output.stdout = RScout.capture_stdout &rspec_task
+          end
+
+          output.results = json_formatter.output_hash
+
+          failed = output.results[:summary][:failure_count] > 0
+          failure_count = output.results[:summary][:failure_count].to_s
+        rescue => e
+          failed = true
+          RScout.logger.error "Exception encountered while running RSpec: #{e.message}"
+          RScout.logger.error e.backtrace
+          output.error = e
+        ensure
+          output.txt.close unless output.txt.closed?
+          output.html.close unless output.html.closed?
+          output.json.close unless output.json.closed?
+        end
+
+        if failed
+          RScout.logger.info "Tests failed."
+          RScout.send_failure_notifications config, env, output
+        end
+
+        failed
+      end
+    end
+  end
+
+  def self.send_failure_notifications(config, env, output)
+    email_body = [output.txt.string, output.error.backtrace.join("\n")].join("\n")
+    if config.email_enabled && config.email
+      RScout.logger.info "Sending emails alert to #{config.email}"
+      begin
+        mail = Mail.new do
+          from     'Scout <platform+scout@evertrue.com>'
+          to       config.email
+          subject  "Scout Alert: Tests failing 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
+          end
+        end
+
+        mail.deliver!
+      rescue => e
+        RScout.logger.error "Failed to send email alert!"
+        RScout.logger.error e.message + "\n " + e.backtrace.join("\n ")
+      end
+    end
+
+    if config.pagerduty_enabled && config.pagerduty_service_key
+      RScout.logger.info "Triggering PagerDuty incident to #{config.pagerduty_service_key}"
+      begin
+        if config.pagerduty_service_key.match(/@(.*)pagerduty.com$/)
+          mail = Mail.new do
+             from    'RScout <platform+rscout@evertrue.com>'
+             to      config.pagerduty_service_key
+             subject "DOWN alert: RScout tests failing on #{config.name.to_s.humanize.titleize} (#{env})"
+             body    email_body
+          end
+
+          mail.deliver!
+        else
+          p = Pagerduty.new config.pagerduty_service_key, ['scout', env].join('_')
+          incident = p.trigger 'RScout tests failing!', output.results
+        end
+      rescue => e
+        RScout.logger.error "Failed to send PagerDuty alert!"
+        RScout.logger.error e.message + "\n " + e.backtrace.join("\n ")
+      end
+    end
+  end
+
+  def self.capture_stdout(&block)
+    RScout.logger.debug "Starting stdout capture…"
+    previous_stdout, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = previous_stdout
+    RScout.logger.debug "Ended stdout capture."
+  end
+end

data/lib/rscout/version.rb

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

data/rscout.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rscout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rscout"
+  spec.version       = Rscout::VERSION
+  spec.authors       = ["Andrew Hammond (@andrhamm)"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'json'
+  spec.add_dependency 'dotenv-rails'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'rspec', '~> 2.14.1'
+  spec.add_dependency 'dotenv'
+  spec.add_dependency 'hashie'
+  spec.add_dependency 'pagerduty'
+  spec.add_dependency 'syntax'
+  spec.add_dependency 'mail'
+  spec.add_dependency 'activesupport', '~> 4.0', '>= 4.0.2'
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: rscout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Hammond (@andrhamm)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pagerduty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: syntax
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration tests with Rspec
+email:
+- andrew@tremorlab.com
+executables:
+- rscout
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rscout
+- lib/rscout.rb
+- lib/rscout/version.rb
+- rscout.gemspec
+homepage: https://github.com/andrhamm
+licenses:
+- MIT
+metadata: {}
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Integration tests with Rspec
+test_files: []
+has_rdoc: