cucumber-formatter 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6034bdd263ebe1f6316a9dd15d4db9d4365a40ae
-  data.tar.gz: 775c63f2ae7e5e76ffd77296792a556d643d5f39
+  metadata.gz: 51da32d4f5d9326a9f967539d43582d890e46d9e
+  data.tar.gz: 14dd80718d3103a9efd448eb7ad48555cecc19b9
 SHA512:
-  metadata.gz: 9513eb0b028a8c266c5bf340170775dfae6d3feb44c55e3421f0fd018f3c8675e04ce841f6b3d4a74519a6a6d3efbd35a5129aed93862b5a8285a22d732c6cca
-  data.tar.gz: 7b704830ad057a6c9df06bb1049bad66199d3682aa20c287b9cbae22cc6768ab13dee9ec33b202bd60f146b21682af2c7c87edf8be60c58b9dadc2bc22480aa8
+  metadata.gz: 0171ed75b8a7d99d24dd7728475cbe556b7b1acb48faca98ccef33363ac7713db304491b1fce3ec0415449ef32026504fbd16ab01ad7b84d9dcc7568a8a09587
+  data.tar.gz: 2c0c252a8f1adaccf9a0be0f35a900161504122cd2e5802a8782a38c244fb541053ffd71440377cd686aa94154e8a90d8f112ec82abfb430e919e725fce12831

data/lib/cucumber_formatter.rb

@@ -1,36 +1,36 @@
-=begin
-Copyright (c) 2015, Salesforce.com, Inc.
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification,
-are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation and/or
-  other materials provided with the distribution.
-
-* Neither the name of Salesforce.com nor the names of its contributors may be
-  used to endorse or promote products derived from this software without specific
-  prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
-INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
-BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
-OF THE POSSIBILITY OF SUCH DAMAGE.
-=end
+# Copyright (c) 2015, Salesforce.com, Inc.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+
+# * Neither the name of Salesforce.com nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
 
 require_relative 'database.rb'
+require_relative 'failure_rate_module.rb'
 
 class CucumberFormatter
+  include FailureRateModule
 
   def initialize(step_mother, io, options)
     puts "Initializing CucumberMetrics ...\n\n\n"
@@ -102,6 +102,11 @@ class CucumberFormatter
       @db_avail = false
     end
 
+    #update failure rate if configured
+    if OpenStruct.new(YAML.load_file(METRICS_CONFIG_FILE)).failure_rate
+      check_past_failures(@scenario.title)
+    end
+
     if scenario.failed?
       begin
         save_links(scenario) if @db_avail
@@ -129,7 +134,6 @@ class CucumberFormatter
   private
 
   def save_str_start_time
-    ###############
     @scenario_time_start = Time.now
 
     @start_time = Time.now

data/lib/database.rb

@@ -1,3 +1,31 @@
+# Copyright (c) 2015, Salesforce.com, Inc.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+
+# * Neither the name of Salesforce.com nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'mysql2'
 
 class Database

data/lib/failure_rate_module.rb

@@ -0,0 +1,141 @@
+# Copyright (c) 2015, Salesforce.com, Inc.
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+
+# * Redistributions of source code must retain the above copyright notice, this
+# list of conditions and the following disclaimer.
+
+# * Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation and/or
+# other materials provided with the distribution.
+
+# * Neither the name of Salesforce.com nor the names of its contributors may be
+# used to endorse or promote products derived from this software without specific
+# prior written permission.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+# OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module FailureRateModule
+
+  ### calculate and save the failure rate for scenarios
+  def check_past_failures(scenario)
+    # load the failure rate config settings
+    config = OpenStruct.new(YAML.load_file(METRICS_CONFIG_FILE)).failure_rate
+    machines = Array.new
+
+    # only useful if the regex is in the config file
+    unless config == nil || config['machines_regex'] == nil || !config['machines_regex'].is_a?(Array)
+      config['machines_regex'].each do |r|
+        machines << r.gsub('/', '')
+      end
+    end
+    machines.uniq!
+
+    scenario = scenario.strip[0..255].gsub('\'', '')
+    period = parse_time_period(config['time_period'])
+
+    sql = "SELECT s.id, COUNT(*) as count FROM scenarios s
+             LEFT JOIN scenario_test_runs str ON str.scenario_id = s.id
+           WHERE s.scenario_name like \'#{scenario}\'
+             AND test_run_at > DATE_SUB(NOW(), INTERVAL #{period.upcase})"
+
+    # find the machines used to calculate failure rate
+    # if not configured, will not add to query
+    machines.each_with_index do |reg, i|
+      if i == 0
+        sql += " AND (machine_name RLIKE '#{reg}' "
+      else
+        sql += "OR machine_name RLIKE '#{reg}' "
+      end
+      sql += ") " if i == machines.size - 1
+    end
+
+    scenario_id = 0
+    all_tests = 0
+    failed_tests = 0
+
+    Database.query(sql).each do |r|
+      all_tests = r["count"]
+      scenario_id = r["id"]
+    end
+
+    # this is required if the query above returns a count of 0; we still want
+    # to update the failure rate, but we need the scenario ID to do so
+    if scenario_id == 0 || scenario_id == nil
+      scenario_sql = "SELECT id FROM scenarios WHERE scenario_name like '#{scenario}'"
+      Database.query(scenario_sql).each do |r|
+        scenario_id = r["id"]
+      end
+    end
+
+    sql = sql + " AND (passed is NULL OR passed = 0)"
+
+    Database.query(sql).each do |r|
+      failed_tests = r["count"]
+    end
+
+    # prevents divide by zero errors when no test runs in db
+    ratio = all_tests > 0 ? failed_tests.fdiv(all_tests) : 0
+    # get threshold from config settings and make sure it's less than 1
+    threshold = config['threshold']
+    if threshold == nil || !threshold.is_a?(Float) || threshold >= 1
+      threshold = 0.05
+    end
+
+    readable_period = period.split(' ')
+    if readable_period[0].to_i != 1
+      readable_period[1] += "s"
+    end
+
+    body_text = "\n#{(ratio * 100).round}% of the test runs for \"#{scenario}\"
+    have failed in the past #{readable_period.join(' ').downcase}. You'd better get some eyes on it.\n\n"
+
+    if ratio > threshold
+      puts body_text
+    end
+
+    # update the scenarios table with the failure rate
+    insert_sql = "UPDATE scenarios SET failure_rate = #{ratio * 100} WHERE id = #{scenario_id}"
+    Database.query(insert_sql)
+  end
+
+  # basically, we need a format MySQL will recognize. That means an integer
+  # followed by a specific interval type. It is currently restricted to days,
+  # weeks, months, quarters, and years. See the MySQL developers site:
+  # https://dev.mysql.com/doc/refman/5.5/en/date-and-time-functions.html#function_date-add
+  # Override valid_times and default_time_period to change the defaults
+  def parse_time_period(period)
+    if period == nil || !period.is_a?(String)
+      default_time_period
+    else
+      period = period.gsub('.', '').split(' ')
+      if period.size != 2 || period[0] == nil || period[1] == nil
+        default_time_period
+      elsif valid_times.include?(period[1].upcase) && period[0].strip =~ /\d+/
+        period.join(' ')
+      else
+        default_time_period
+      end
+    end
+  end
+
+  def valid_times
+    %w(DAY WEEK MONTH QUARTER YEAR)
+  end
+
+  def default_time_period
+    "1 WEEK"
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cucumber-formatter
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Hartill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -32,6 +32,7 @@ extra_rdoc_files: []
 files:
 - lib/cucumber_formatter.rb
 - lib/database.rb
+- lib/failure_rate_module.rb
 homepage: https://github.com/SalesforceEng/cucumber-metrics
 licenses:
 - BSD 3-clause