cucumber-formatter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e476c346672c51f036ddf89abf4632d9d27579a
+  data.tar.gz: 58184c841540ac038ea79602b0a84e0aa27e97c4
+SHA512:
+  metadata.gz: 7af94bb19f29b63edc9cc7ea3a9dd17f217530d26e8bb6ce9518de3f2da52f896a85898db22eb344f30211fc759c4112d15c60632756ee69af72eea12e107bcf
+  data.tar.gz: 5ea75aab1eb0be1d22cadd4f6a66b1ce4170a4cbe6b170ae367666e7ae46263f37a4fe6c1bc70e01a51b24c16e6b79f343c7087d3819a20e12e5f0eee316d04d

data/lib/cucumber_formatter.rb

@@ -0,0 +1,192 @@
+=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
+
+class CucumberFormatter
+
+  def initialize(step_mother, io, options)
+    puts "Initializing CucumberMetrics ...\n\n\n"
+  end
+
+  def before_feature_element(scenario)
+    @scenario = scenario
+    @scenario_time_start = Time.now
+
+    @start_time = Time.now
+    @end_time = Time.now
+    machine_name = Socket.gethostname
+
+    @dbm ||= dbm
+
+    if scenario == nil
+      fail "The scenario did not run"
+    end
+
+    get_scenario_id(scenario)
+    get_environment_id
+    get_browser_id
+
+    # save the test run
+    sql = "INSERT INTO scenario_test_runs (scenario_id, test_run_at, test_environment_id,
+            browser_id, machine_name, created_at, updated_at)
+           VALUES (#{@scenario_id}, now(), #{@env_id}, #{@browser_id}, \'#{machine_name}\', now(), now())"
+    @dbm.query(sql)
+    @str_id = @dbm.last_id
+
+    # extract and save the tags
+    tags = extract_tags(scenario)
+    tags.each do |t|
+      sql = "INSERT INTO scenario_tags (scenario_test_run_id, tag_name, created_at, updated_at)
+             VALUES (#{@str_id}, \'#{t}\', now(), now())"
+      @dbm.query(sql)
+    end
+  end
+
+  #save the step
+  def after_step(step)
+    step_name = get_step_name(@scenario).strip[0..255].gsub('\'', '')
+    @start_time = @end_time
+    @end_time = Time.now
+
+    sql = "INSERT INTO scenario_steps (scenario_test_run_id, name, elapsed_time, created_at, updated_at)
+           VALUES (#{@str_id}, \'#{step_name}\', #{(@end_time - @start_time).round}, now(), now())"
+    @dbm.query sql
+  end
+
+  #finish saving the test run
+  def after_feature_element(scenario)
+    scenario.failed? ? passed = 0 : passed = 1
+
+    sql = "UPDATE scenario_test_runs SET elapsed_time = #{Time.now - @scenario_time_start}, passed = #{passed},
+           updated_at = now() WHERE id = #{@str_id}"
+    @dbm.query sql
+
+    if scenario.failed?
+      save_links(scenario)
+    end
+    #reset step counter when scenario is finished
+    @step_counter = 0
+  end
+
+  private
+
+  # get the step name; keep track of the counter through the scenario
+  def get_step_name(scenario)
+    @step_counter ||= 0
+    steps = scenario.instance_eval {@steps}
+    step_name = (steps.instance_eval {@steps})[@step_counter]
+    @step_counter += 1
+    return step_name.name
+  end
+
+  def get_scenario_id(scenario)
+    # make sure the scenario title will fit in the database
+    trimmed_scenario_title = scenario.title.strip[0...255]
+    trimmed_scenario_title = trimmed_scenario_title.gsub('\'', '')
+
+    @scenario_id = 0
+    sql = "SELECT id FROM scenarios WHERE scenario_name LIKE \'#{trimmed_scenario_title}\'"
+    results = @dbm.query(sql)
+    results.each do |r|
+      @scenario_id = r["id"]
+    end
+
+    # if the scenario isn't in the database, then we need to save it and get its ID
+    if @scenario_id == 0
+      sql = "INSERT INTO scenarios (scenario_name, created_at, updated_at)
+             VALUES (\'#{trimmed_scenario_title}\', now(), now())"
+      @dbm.query sql
+
+      @scenario_id = @dbm.last_id
+    end
+  end
+
+  def get_environment_id
+    @env_id = 0
+    sql = "SELECT id FROM test_environments WHERE env_name like \'#{TESTENV}\'"
+    results = @dbm.query(sql)
+    results.each do |r|
+      @env_id = r["id"]
+    end
+
+    if @env_id == 0
+      sql = "INSERT INTO test_environments (env_name, created_at, updated_at) VALUES(\'#{TESTENV}\', now(), now())"
+      @dbm.query sql
+
+      @env_id = @dbm.last_id
+    end
+  end
+
+  def get_browser_id
+    @browser_id = 0
+    sql = "SELECT id FROM browsers WHERE browser_name like \'#{BROWSER}\'"
+    results = @dbm.query(sql)
+    results.each do |r|
+      @browser_id = r["id"]
+    end
+
+    if @browser_id == 0
+      sql = "INSERT INTO browsers (browser_name, created_at, updated_at) VALUES(\'#{BROWSER}\', now(), now())"
+      @dbm.query sql
+
+      @browser_id = @dbm.last_id
+    end
+  end
+
+  # save the links for failed scenarios; feature file, scenario, and failed step
+  def save_links(scenario)
+    failed_step = ""
+    ((scenario.instance_eval {@steps}).instance_eval {@steps}).each do |step|
+      if step.status == :failed
+        failed_step = step.name
+      end
+    end
+
+    sql = "INSERT INTO scenario_failed_links (scenario_test_run_id, failed_step,
+              feature, scenario, scenario_file, created_at, updated_at)
+           VALUES(#{@str_id}, \'#{failed_step.gsub('\'', '')}\', \'#{scenario.feature.title.gsub('\'', '')}\',
+            \'#{scenario.title.gsub('\'', '')}\', \'#{scenario.feature.file.gsub('\'', '')}\', now(), now())"
+
+    @dbm.query(sql)
+  end
+
+  # connect to database with credentials in metrics yml file
+  def dbm
+    database = OpenStruct.new(YAML.load_file(METRICS_CONFIG_FILE))
+    Mysql2::Client.new(:host => database.metrics_db['host'],
+                       :username => database.metrics_db['username'],
+                       :password => database.metrics_db['password'],
+                       :database => database.metrics_db['database'])
+  end
+
+  def extract_tags(scenario)
+    scenario.source_tag_names
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-formatter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eric Hartill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: Save data collected from Cucumber test to the database
+email: ehartill@salesforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cucumber_formatter.rb
+homepage: https://github.com/SalesforceEng/cucumber-metrics
+licenses:
+- BSD 3-clause
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Collect metrics from Cucumber tests
+test_files: []
+has_rdoc: