elastic_results 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99161c14e7dbbdf95b0b78a312fb3c2c4e1cc7de
+  data.tar.gz: 3db34b799da012ecc7912dbc3bdff3f4675d94a2
+SHA512:
+  metadata.gz: b505765a9fd4d5600e2eb33b2808cc252d6b0badce330a6fe08178ff551446a7381ffa1435e5f3bf316b2b5679bb0b49818a72c00ec4905f93a7d29682c80899
+  data.tar.gz: 352701d01b84d4a9c6db7d79aba5f220f796f7bc2be5872f2934fb92ec59ef250f4c2cdd71507008f670d889ee4efa0484bba4930959a6a7de49fe7a7e625fb0

data/.gitignore

@@ -0,0 +1,86 @@
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+### Ruby template
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+ru# Created by .ignore support plugin (hsz.mobi)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    elastic_results (0.1.0)
+      elasticsearch
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    elasticsearch (1.0.15)
+      elasticsearch-api (= 1.0.15)
+      elasticsearch-transport (= 1.0.15)
+    elasticsearch-api (1.0.15)
+      multi_json
+    elasticsearch-transport (1.0.15)
+      faraday
+      multi_json
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    multi_json (1.11.2)
+    multipart-post (2.0.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  elastic_results!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 CoverMyMeds
+
+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,124 @@
+# ElasticResults
+
+Store the results of your test runs in Elasticsearch via custom formatters.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elastic_results'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elastic_results
+
+## Cucumber Usage
+Add this line to your features/support/env.rb file:
+```ruby
+require 'elastic_results/cucumber'
+```
+
+Tell cucumber to use elastic_results:
+```
+bundle exec cucumber  --format ElasticResults::Cucumber::Formatter
+```
+
+Tell cucumber to use elastic_results but still give normal output:
+```
+bundle exec cucumber --format pretty --format ElasticResults::Cucumber::Formatter -o /dev/null
+```
+
+Make this the default by adding the following to config/cucumber.yml
+```
+default: --format pretty --format ElasticResults::Cucumber::Formatter -o /dev/null
+```
+
+## RSpec Usage
+Add this line to your spec_helper.rb file:
+```ruby
+require 'elastic_results/rspec'
+```
+
+Tell rspec to use elastic_results:
+```
+bundle exec rspec -r 'elastic_results/rspec'  --format ElasticResults::RSpec::Formatter
+```
+
+Tell rspec to use elastic_results but still give normal output:
+```
+bundle exec rspec -r 'elastic_results/rspec'  --format ElasticResults::RSpec::Formatter --format progress
+```
+
+Make this the default by adding the following to spec_helper.rb
+```ruby
+RSpec.configure do |config|
+  config.add_formatter 'ElasticResults::RSpec::Formatter'
+  config.add_formatter 'progress'
+  # the rest of your rspec configuration
+end
+```
+Then run rspec as normal.
+
+
+## SimpleCov Usage
+Add this lines to your spec_helper.rb file:
+```ruby
+require 'elastic_results/simplecov'
+SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, ElasticResults::SimpleCov::Formatter]
+```
+Then run simplecov as normal.
+
+
+
+## Configuration
+elastic_results exposes several configuration points that can be set via environment variables or by accssing them on the ElasticResults module:
+
+| ENV                | ElasticResults    | Default                                       | Notes                                                                                                                             |
+|--------------------|-------------------|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
+| ES_URL             | es_url            | http://localhost                              | The URL where elasticsearch can be reached                                                                                        |
+| ES_INDEX_RESULT    | es_index_result   | test_results-YYYY-MM-DD                       | The index to post test results to.  The default uses a prefix of test_results and a suffix of today's date                        |
+| ES_TYPE_RESULT     | es_type_result    | test_result                                   | The data type to use for test results.                                                                                            |
+| ES_INDEX_COVERAGE  | es_index_coverage | coverage-YYYY-MM-DD                           | The index to post coverage data to. The default uses a prefix of coverage and a suffix of today's date                            |
+| ES_TYPE_COVERAGE   | es_type_coverage  | simplecov                                     | The data type to use for coverage data.                                                                                           |
+| ES_LOG             | es_log            | ENV['DEBUG']                                  | Log calls to elasticsearch to STDOUT? (useful for debugging elastic_results)                                                      |
+| SUITE_NAME         | suite_name        | Dir.pwd                                       | The name of your suite.  If not given, it will be guessed using the name of the current folder when you launch your tests.        |
+| SUITE_TYPE         | suite_type        | integration                                   | The type of suite you're running. i.e. unit, integration, regression, etc                                                         |
+| GIT_COMMIT         |                   | Output of: git rev-parse HEAD                 | The git revision being tested.  Jenkins will set this in CI, otherwise it's pulled from git.                                      |
+| GIT_URL            |                   | Output of: git config --get remote.origin.url | The url to the git repo being used.  Jenkins will set this in CI, otherwise it's pulled from git.                                 |
+| GIT_BRANCH         |                   | Output of: git rev-parse --abbrev-ref HEAD    | The git branch being used.  Jenkins will set this in CI, otherwise it's pulled from git.                                          |
+| TEAM_NAME          | team_name         | ???                                           | The name of your team.  This makes it possible to slice your results easier.                                                      |
+| BUILD_URL          |                   |                                               | The url to your Jenkins build if any.  Set by Jenkins.                                                                            |
+| NODE_NAME          |                   | Socket.gethostname                            | The node that ran the test.  Set by Jenkins, or pulled from the machine.                                                          |
+| BUILD_NUMBER       |                   | MMDDYYHHMMSSUU                                | The jenkins build number.  If not present, a fake build number will be built using the current date/time down to the millisecond. |
+| JOB_NAME           |                   |                                               | The jenkins job name.                                                                                                             |
+| BUILD_TAG          |                   |                                               | The jenkins build tag.                                                                                                            |
+| TEST_ENV/RAILS_ENV |                   |                                               | The enivironment the tests were run against.  Will use TEST_ENV if present, otherwise will use RAILS_ENV                          |
+|                    | use_unsafe_index  | true if WebMock is defined, otherwise false   | If true, validation of the SSL cert for the elasticsearch host will be skipped.  Useful when your testing tools break things.     |
+
+
+## Example config block:
+```ruby
+ElasticResults.team_name = 'MyTeam - MySubTeam'
+ElasticResults.suite_type = 'unit'
+ElasticResults.kibana_url = 'https://kibana.mycompany.com'
+ElasticResults.es_url =  %w(https://es1.mycompany.net:9200 https://es1.mycompany.net:9200).sample
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/covermymeds/elastic_results
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'elastic_results'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/elastic_results.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'elastic_results/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'elastic_results'
+  spec.version       = ElasticResults::VERSION
+  spec.authors       = ['Donavan Stanley']
+  spec.email         = ['dstanley@covermymeds.com']
+
+  spec.summary       = 'Formatters to shove test results into elastic search'
+  spec.homepage      = 'https://github.com/covermymeds/elastic_results'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_dependency 'elasticsearch'
+  spec.add_dependency 'googl'
+end

data/lib/elastic_results/cucumber.rb

@@ -0,0 +1,70 @@
+require 'cucumber/formatter/gherkin_formatter_adapter'
+require 'gherkin/formatter/argument'
+require 'gherkin/formatter/json_formatter'
+require 'elastic_results'
+require 'elasticsearch'
+require 'time'
+require 'socket'
+
+module ElasticResults
+  # Namespace for cucumber related stuff
+  module Cucumber
+    # Replacement for the stock Json formatter that outputs to elasticsearch
+    class JSONFormatter < ::Gherkin::Formatter::JSONFormatter
+      def initialize
+        @feature_hashes = []
+        @current_step_or_hook = nil
+      end
+
+      def eof
+        feature_hash = @feature_hashes.last
+        feature_hash['elements'].each do |scenario_hash|
+          record_scenario feature_hash, scenario_hash
+        end
+      end
+
+      def done
+        ElasticResults.write_urls
+      end
+
+      private
+
+      def record_scenario(feature_hash, scenario_hash)
+        ElasticResults.index_result result_for(feature_hash, scenario_hash)
+      end
+
+      def result_for(feature_hash, scenario_hash)
+        Result.new.tap do |res|
+          res.id = scenario_hash['id']
+          res.feature_name = feature_hash['name']
+          res.scenario_name = scenario_hash['name']
+          res.uri = feature_hash['uri']
+
+
+          res.tags.append(feature_hash['tags'].map { |t| t['name'] }) unless feature_hash['tags'].nil?
+
+
+          res.tags.append(scenario_hash['tags'].map { |t| t['name'] }) unless scenario_hash['tags'].nil?
+
+          # Cucumber stores times in nanoseconds for each step, because that's SUPER useful!
+          res.runtime = scenario_hash['steps'].map { |s| s['result']['duration'] }.reduce { |a, e| a + e } / 1_000_000_000.0
+
+          failing_step = scenario_hash['steps'].find { |step| !step['result'].nil? && step['result']['status'] == :failed }
+          unless failing_step.nil?
+            res.exception_msg = failing_step['result']['error_message']
+            res.exception_class = res.exception_msg =~ /ExpectationNotMetError/ ? 'ExpectationNotMetError' : 'RuntimeError'
+            res.exception_stacktrace = "#{failing_step['name']}\n#{failing_step['match']['location']}"
+          end
+        end
+      end
+    end
+
+    # A format adapter that uses our special JSON formatter
+    class Formatter < ::Cucumber::Formatter::GherkinFormatterAdapter
+      def initialize(_runtime, _io, options)
+        options[:expand] = true
+        super(ElasticResults::Cucumber::JSONFormatter.new, false, options)
+      end
+    end
+  end
+end

data/lib/elastic_results/result.rb

@@ -0,0 +1,50 @@
+require 'time'
+require 'socket'
+
+module ElasticResults
+  # A common data format for test results.  The Cucumber and Rspec formatters populate this class.
+  class Result
+    attr_accessor :outcome, :exception_class, :exception_msg, :exception_stacktrace, :runtime
+    attr_accessor :id, :uri, :feature_name, :scenario_name, :build_number
+
+    def to_hash
+      result_hash = base_info
+
+      [:outcome, :exception_class, :exception_msg, :exception_stacktrace, :runtime,
+       :id, :uri, :feature_name, :scenario_name, :tags].each do |field|
+        result_hash[field] = send field
+      end
+      result_hash
+    end
+
+    def tags
+      @tags ||= []
+    end
+
+    def outcome
+      @outcome ||= exception_class.nil? ? 'pass' : fail_type
+    end
+
+    def fail_type
+      exception_class =~ /ExpectationNotMet/ ? :fail : :broke
+    end
+
+    def base_info
+      {
+        '@timestamp' => Time.now.iso8601(3),
+        build_number: ENV['BUILD_NUMBER'] ? ENV['BUILD_NUMBER'] : ElasticResults.build_id,
+        build_url: ENV['BUILD_URL'],
+        node_name: ENV['NODE_NAME'] ? ENV['NODE_NAME'] : Socket.gethostname,
+        job_name: ENV['JOB_NAME'],
+        build_tag: ENV['BUILD_TAG'],
+        environment: ENV['TEST_ENV'] || ENV['RAILS_ENV'],
+        git_commit: ElasticResults.git_commit,
+        git_url: ElasticResults.git_url,
+        git_branch: ElasticResults.git_branch,
+        suite_name: ElasticResults.suite_name,
+        suite_type: ElasticResults.suite_type,
+        team: ElasticResults.team_name
+      }
+    end
+  end
+end

data/lib/elastic_results/rspec.rb

@@ -0,0 +1,52 @@
+RSpec::Support.require_rspec_core 'formatters/base_formatter'
+require 'elastic_results'
+require 'json'
+require 'elasticsearch'
+require 'time'
+require 'socket'
+
+module ElasticResults
+  module RSpec
+    # @private
+    class Formatter < ::RSpec::Core::Formatters::BaseFormatter
+      ::RSpec::Core::Formatters.register self, :example_passed, :example_failed, :close
+
+      def initialize(output)
+        super
+      end
+
+      def example_passed(notification)
+        record_example notification.example
+      end
+
+      def example_failed(notification)
+        record_example notification.example
+      end
+
+      def record_example(example)
+        ElasticResults.index_result result_for(example)
+      end
+
+      def close(_notification)
+        ElasticResults.write_urls
+      end
+
+      private
+
+      def result_for(example)
+        Result.new.tap do |res|
+          res.id = example.id
+          res.feature_name = example.description
+          res.scenario_name = example.full_description
+          res.uri = example.location
+          res.runtime = example.metadata[:execution_result].run_time
+          unless example.exception.nil?
+            res.exception_class = example.exception.class.name
+            res.exception_msg = example.exception.message
+            res.exception_stacktrace = example.exception.backtrace
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elastic_results/setup/coverage.json

@@ -0,0 +1,86 @@
+{
+  "mappings": {
+    "simplecov": {
+      "_timestamp": {
+        "enabled": true
+      },
+      "properties": {
+        "@timestamp": {
+          "type": "date",
+          "format": "dateOptionalTime"
+        },
+        "environment":{
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "suite_name":{
+          "type": "string",
+          "null_value" : "na"
+        },
+        "suite_type":{
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "team":{
+          "type": "string",
+          "null_value" : "na"
+        },
+        "build_number": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "build_url": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "node_name": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "job_name": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "build_tag": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_commit": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_url": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_branch": {
+          "type": "string",
+          "null_value" : "na"
+        },
+        "metrics": {
+          "properties": {
+            "covered_strength": {
+              "type": "float"
+            },
+            "covered_lines": {
+              "type": "integer"
+            },
+            "total_lines": {
+              "type": "integer"
+            }
+          }
+        }
+
+      }
+    }
+  }
+}

data/lib/elastic_results/setup/test_results.json

@@ -0,0 +1,95 @@
+{
+  "mappings": {
+    "test_result": {
+      "_timestamp": {
+        "enabled": true
+      },
+      "properties": {
+        "@timestamp": {
+          "type": "date",
+          "format": "dateOptionalTime"
+        },
+        "environment":{
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "suite_name":{
+          "type": "string",
+          "null_value" : "na"
+        },
+        "suite_type": {
+          "type": "string",
+          "index": "not_analyzed",
+          "null_value" : "na"
+        },
+        "team":{
+          "type": "string",
+          "null_value" : "na"
+        },
+        "outcome": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "exception_msg": {
+          "type": "string"
+        },
+        "exception_class": {
+          "type": "string",
+          "null_value" : "na"
+        },
+        "exception_stacktrace": {
+          "type": "string",
+          "null_value" : "na"
+        },
+        "runtime" : {
+          "type": "float"
+        },
+        "build_number": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "build_url": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "node_name": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "job_name": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "build_tag": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_commit": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_url": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "git_branch": {
+          "type": "string",
+          "index" : "not_analyzed",
+          "null_value" : "na"
+        },
+        "tags": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}

data/lib/elastic_results/simplecov.rb

@@ -0,0 +1,49 @@
+require 'simplecov'
+require 'elastic_results'
+
+module ElasticResults
+  module SimpleCov
+    # A simple formatter that converts a SimpleCov Result to a hash to be stored in elastic search
+    class Formatter
+      def format(result)
+        data = base_info
+
+        data[:command_name] = result.command_name
+        data[:metrics] = {
+          covered_percent: result.covered_percent,
+          covered_strength: result.covered_strength.nan? ? 0.0 : result.covered_strength,
+          covered_lines: result.covered_lines,
+          total_lines: result.total_lines
+        }
+
+        ElasticResults.with_disabled_mocks {
+          if ElasticResults.use_unsafe_index
+            ElasticResults.unsafe_index ElasticResults.es_index_coverage, ElasticResults.es_type_coverage, data
+          else
+            ElasticResults.client.index index: ElasticResults.es_index_coverage, type: ElasticResults.es_type_coverage, body: data
+          end
+        }
+      end
+
+      private
+
+      def base_info
+        {
+          '@timestamp' => Time.now.iso8601(3),
+          build_number: ENV['BUILD_NUMBER'] ? ENV['BUILD_NUMBER'] : ElasticResults.build_id,
+          build_url: ENV['BUILD_URL'],
+          node_name: ENV['NODE_NAME'] ? ENV['NODE_NAME'] : Socket.gethostname,
+          job_name: ENV['JOB_NAME'],
+          build_tag: ENV['BUILD_TAG'],
+          environment: ENV['TEST_ENV'] || ENV['RAILS_ENV'],
+          git_commit: ElasticResults.git_commit,
+          git_url: ElasticResults.git_url,
+          git_branch: ElasticResults.git_branch,
+          suite_name: ElasticResults.suite_name,
+          suite_type: ElasticResults.suite_type,
+          team: ElasticResults.team_name
+        }
+      end
+    end
+  end
+end

data/lib/elastic_results/version.rb

@@ -0,0 +1,4 @@
+# Our root namespace for all objects
+module ElasticResults
+  VERSION = '1.0.2'
+end

data/lib/elastic_results.rb

@@ -0,0 +1,176 @@
+require 'elastic_results/version'
+require 'elastic_results/result'
+require 'elasticsearch'
+require 'json'
+
+require "net/https"
+require "uri"
+
+
+
+# Our root namespace for all objects
+module ElasticResults
+  class << self
+    attr_accessor :suite_name
+    attr_accessor :suite_type
+    attr_accessor :es_url
+    attr_accessor :es_index_result
+    attr_accessor :es_index_coverage
+    attr_accessor :es_type_result
+    attr_accessor :es_type_coverage
+    attr_accessor :es_log
+    attr_accessor :team_name
+    attr_accessor :build_id
+    attr_accessor :google_api_key
+    attr_accessor :kibana_url
+    attr_accessor :use_unsafe_index
+  end
+
+  # Return the mapping JSON for used in creating indicies
+  # the which paramter should map to to a filename in the setup folder
+  def self.mapping_for(which)
+    setup_folder = File.expand_path('./elastic_results/setup', File.dirname(__FILE__))
+    File.read("#{setup_folder}/#{which.to_s}.json")
+  end
+
+  # Memoized instance of the elasticsearch client
+  def self.client
+    @@client ||= Elasticsearch::Client.new url: ElasticResults.es_url, log: ElasticResults.es_log
+  end
+
+  # Given a payload store it as a test result
+  def self.index_result(payload)
+    index ElasticResults.es_index_result, ElasticResults.es_type_result, payload
+  end
+
+  # Given a payload store it as coverage data
+  def self.index_coverage(payload)
+    index ElasticResults.es_index_coverage,  ElasticResults.es_type_coverage, payload
+  end
+
+  # Generic index function that knows when to use the elasticsearch API.
+  def self.index(index, type, payload)
+    begin
+      with_disabled_mocks {
+        if ElasticResults.use_unsafe_index
+          unsafe_index index, type, payload.to_hash
+        else
+          client.index index: index, type: type, body: payload.to_hash
+        end
+      }
+    rescue Exception => ex
+      puts "#{ex.message} while storing results in Elasticsearch"
+    end
+
+
+  end
+
+  # An "unsafe" index routine which uses Net:HTTP with SSL validation turned off.  Needed for when WebMock is in use
+  # as it breaks SSL cert validations.
+  def self.unsafe_index(index, type, payload)
+    uri = URI.parse(ElasticResults.es_url)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    if ElasticResults.es_url =~ /https/
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+
+    request = Net::HTTP::Post.new("/#{index}/#{type}")
+    request.body = payload.to_json
+    response = http.request(request)
+  end
+
+  # Write out a tab deliminated file containing links to the build information
+  def self.write_urls(filename = 'build_links.txt')
+    File.open(filename, 'w') { |file| file.write("View failures in Kibana\t#{ElasticResults.fails_url}\t\nView all results in Kibana\t#{ElasticResults.results_url}\t") }
+  end
+
+  # Returns a link to the results. shortened URL if possible otherwise the full URL from long_results_url.
+  def self.results_url
+    if ElasticResults.google_api_key.nil?
+      long_results_url
+    else
+      require 'googl'
+      Googl.shorten(long_results_url, '127.0.0.1', ElasticResults.google_api_key).short_url
+    end
+  end
+
+  # Returns a link to the failures. shortened URL if possible otherwise the full URL from long_fails_url.
+  def self.fails_url
+    if ElasticResults.google_api_key.nil?
+      long_fails_url
+    else
+      require 'googl'
+      Googl.shorten(long_fails_url, '127.0.0.1', ElasticResults.google_api_key).short_url
+    end
+  end
+
+
+  # Set up defaults for the meta data
+  ElasticResults.team_name ||= ENV['TEAM_NAME'].nil? ? '???' : ENV['TEAM_NAME']
+  ElasticResults.suite_name ||= ENV['SUITE_NAME'].nil? ? File.basename(Dir.pwd) : ENV['SUITE_NAME']
+  ElasticResults.suite_type ||= ENV['SUITE_TYPE'].nil? ? 'integration' : ENV['SUITE_TYPE']
+  ElasticResults.es_url ||= ENV['ES_HOST'].nil? ? 'http://localhost' : ENV['ES_HOST']
+  ElasticResults.es_index_result ||= ENV['ES_INDEX_RESULT'].nil? ? "test_results-#{DateTime.now.strftime('%F')}" : ENV['ES_INDEX_RESULT']
+  ElasticResults.es_type_result ||= ENV['ES_TYPE_RESULT'].nil? ? 'test_result' : ENV['ES_TYPE_RESULT']
+  ElasticResults.es_log ||= ENV['DEBUG'].nil? ? false : true
+  ElasticResults.build_id ||= DateTime.now.strftime('%Y%m%d%H%M%S%L')
+  ElasticResults.es_index_coverage ||= ENV['ES_INDEX_COVERAGE'].nil? ? "coverage-#{DateTime.now.strftime('%F')}" : ENV['ES_INDEX_COVERAGE']
+  ElasticResults.es_type_coverage ||= ENV['ES_TYPE_COVERAGE'].nil? ? 'simplecov' : ENV['ES_TYPE_COVERAGE']
+  ElasticResults.google_api_key ||= ENV['GOOGLE_API_KEY']
+  ElasticResults.kibana_url ||= ENV['KIBANA_URL'].nil? ? 'http://localhost:5601' : ENV['KIBANA_URL']
+  ElasticResults.use_unsafe_index ||= defined?(WebMock) ? true : false
+
+
+  private
+  # Returns a full link to the discover page showing the test results for the current build
+  def self.long_results_url
+    build_id =  ENV['BUILD_NUMBER'] ? ENV['BUILD_NUMBER'] : ElasticResults.build_id
+    "#{ElasticResults.kibana_url}/#/discover/?_g=(refreshInterval:(display:Off,pause:!f,section:0,value:0),time:(from:now%2Fd,mode:quick,to:now%2Fd))&_a=(columns:!(team,suite_name,build_number,environment,runtime,outcome,feature_name,scenario_name,exception_class,exception_msg,exception_stacktrace),filters:!(),index:'test_results-*',interval:auto,query:(query_string:(analyze_wildcard:!t,query:'build_number:#{build_id}')),sort:!('@timestamp',desc))"
+  end
+
+  # Returns a full link to the discover page showing the test failures for the current build
+  def self.long_fails_url
+    build_id =  ENV['BUILD_NUMBER'] ? ENV['BUILD_NUMBER'] : ElasticResults.build_id
+    "#{ElasticResults.kibana_url}/#/discover/?_g=(refreshInterval:(display:Off,pause:!f,section:0,value:0),time:(from:now%2Fd,mode:quick,to:now%2Fd))&_a=(columns:!(team,suite_name,build_number,environment,runtime,outcome,feature_name,scenario_name,exception_class,exception_msg,exception_stacktrace),filters:!(),index:'test_results-*',interval:auto,query:(query_string:(analyze_wildcard:!t,query:'build_number:#{build_id}%20AND%20(outcome:broke%20OR%20outcome:fail)')),sort:!('@timestamp',desc))"
+  end
+
+  # Memoize the git_commit to avoid hitting git for each result
+  def self.git_commit
+    @@git_commit ||= ENV['GIT_COMMIT'] ? ENV['GIT_COMMIT'] : `git rev-parse HEAD`.chomp
+  end
+
+  # Memoize the git_url to avoid hitting git for each result
+  def self.git_url
+    @@git_url ||= ENV['GIT_URL'] ? ENV['GIT_URL'] : `git config --get remote.origin.url`.chomp
+  end
+
+  # Memoize the git_branch to avoid hitting git for each result
+  def self.git_branch
+    @@git_branch ||= ENV['GIT_BRANCH'] ? ENV['GIT_BRANCH'] : `git rev-parse --abbrev-ref HEAD`.chomp
+  end
+
+  # Helper function to disable mocks before calling out to the web (and getting blocked)
+  def self.with_disabled_mocks
+    should_reenable_webmock = false
+    if defined? WebMock
+      if !WebMock.net_connect_allowed?
+        should_reenable_webmock = true
+        WebMock.disable!
+      end
+    end
+
+    if defined? VCR
+      VCR.turned_off {
+        yield
+      }
+    else
+      yield
+    end
+
+    if should_reenable_webmock
+      WebMock.enable!
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: elastic_results
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Donavan Stanley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: elasticsearch
+  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: googl
+  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'
+description: 
+email:
+- dstanley@covermymeds.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- elastic_results.gemspec
+- lib/elastic_results.rb
+- lib/elastic_results/cucumber.rb
+- lib/elastic_results/result.rb
+- lib/elastic_results/rspec.rb
+- lib/elastic_results/setup/coverage.json
+- lib/elastic_results/setup/test_results.json
+- lib/elastic_results/simplecov.rb
+- lib/elastic_results/version.rb
+homepage: https://github.com/covermymeds/elastic_results
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Formatters to shove test results into elastic search
+test_files: []