probedock-cucumber 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2286ed5e21fbf47725e16a0c43c6e9f977f6b8f6
-  data.tar.gz: 6a32e6aa3309aef8cda90a6b35c7131424827ce1
+  metadata.gz: 51a99b927ad1d4edd9c1c4a90c407b8a4743d262
+  data.tar.gz: 3e264ed7f2ec4beb507fe2b472c0fafa06d4bf0e
 SHA512:
-  metadata.gz: 58cac119d835d2c90c3c12c71405662be7bfee895c01a0d24bb3589406872ce812b3c123c4d6b09ff933e3a345a93313052155c4dbe9103f8f77ad8229c6c7cb
-  data.tar.gz: c4b678b65c203690cd0cded6c85b507813225e83ab72887a556b6a85b0a4af9874076552ff623f08b1ef904bc7eb04ce26f0e5f217eb692fc8fea7fcf1de66fb
+  metadata.gz: cdc350bb64b6b7a8630d76c36bd8df034d5c41512ae51480fb8ee3abf7905bd7279a6b0db44fc35aa2f7eebfa72dc3c1ace97b4d8e77da81d5bb5a044c78608d
+  data.tar.gz: 21b1f8676d432f3276a92c26fafb7dbb363cfc1a612cb2e50337625d55a29ef3913c16e88c5e2ad641fb47f31e0d515a8c3914f8dccbc045f89da5b28ae0a1eb

data/README.md

@@ -1,6 +1,6 @@
 # Probe Dock Cucumber
 
-**Cucumber (Ruby) probe for [Probe Dock](https://github.com/probedock/probedock).**
+**[Cucumber](https://cucumber.io) (Ruby) probe for [Probe Dock](https://github.com/probedock/probedock).**
 
 [![Gem Version](https://badge.fury.io/rb/probedock-cucumber.svg)](http://badge.fury.io/rb/probedock-cucumber)
 [![Dependency Status](https://gemnasium.com/probedock/probedock-cucumber-ruby.svg)](https://gemnasium.com/probedock/probedock-cucumber-ruby)
@@ -13,7 +13,7 @@
 In your Gemfile:
 
 ```rb
-gem 'probedock-cucumber', '~> 0.1.0'
+gem 'probedock-cucumber', '~> 0.1.1'
 ```
 
 Then run `bundle install`.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/probe_dock_cucumber.rb

@@ -2,7 +2,7 @@
 require 'probedock-ruby'
 
 module ProbeDockCucumber
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   class Error < StandardError; end
 end

data/lib/probe_dock_cucumber/formatter.rb

@@ -1,75 +1,151 @@
 require 'paint'
 require 'digest/sha1'
 
+# Cucumber formatter to send test results to Probe Dock.
+#
+# The following events can be received by a formatter:
+#
+# before_features
+#   before_feature
+#     before_comment
+#       comment_line
+#     after_comment
+#     before_tags
+#       tag_name
+#     after_tags
+#     feature_name
+#     before_feature_element
+#       before_tags
+#         tag_name
+#       after_tags
+#       scenario_name
+#       before_steps
+#         before_step
+#           before_step_result
+#             step_name
+#           after_step_result
+#         after_step
+#       after_steps
+#     after_feature_element
+#   after_feature
+# after_features
 module ProbeDockCucumber
   class Formatter
 
     def initialize step_mother, io, options
 
+      # Initialize the Probe Dock client and an empty test run.
       config = ProbeDockProbe.config
       @client = ProbeDockProbe::Client.new config.server, config.client_options
       @test_run = ProbeDockProbe::TestRun.new config.project
 
+      # Current feature data.
       @current_feature = nil
       @current_feature_tags = []
 
+      # Current scenario data.
       @current_scenario = nil
       @current_scenario_tags = []
       @current_scenario_error = nil
     end
 
+    # Called when the test suite starts.
     def before_features *args
-      @start_time = Time.now
+      @suite_start_time = Time.now
     end
 
+    # Called before each feature is tested.
     def before_feature feature, *args
+
+      # Store the first line of the feature's description.
+      # It will be used in #add_result to build the complete name of the test.
       @current_feature = feature.name.sub(/\n.*$/m, '').strip
+
+      # Reset feature and scenario data.
       @current_feature_tags = []
       @current_scenario = nil
+      @current_scenario_tags = []
+      @current_scenario_error = nil
     end
 
-    def after_tags tags, *args
+    # Called every time a tag is encountered, either at the feature or the scenario level.
+    def tag_name name, *args
       if @current_scenario
-        @current_scenario_tags = tags.tags.collect{ |tag| tag.name.sub(/^@/, '').strip }.uniq
+        @current_scenario_tags << name.sub(/^@/, '').strip
       else
-        @current_feature_tags = tags.tags.collect{ |tag| tag.name.sub(/^@/, '').strip }.uniq
+        @current_feature_tags << name.sub(/^@/, '').strip
       end
     end
 
+    # Called before each scenario is tested.
     def before_feature_element feature_element, *args
+
+      # Store the first line of the scenario's description.
+      # It will be used in #add_result to build the complete name of the test.
       @current_scenario = feature_element.name.sub(/\n.*$/m, '').strip
+
+      # Reset scenario data.
       @current_scenario_tags = []
       @current_scenario_error = nil
       @current_scenario_start_time = Time.now
     end
 
+    # Called after each scenario step (Given, When, Then) is executed.
     def after_step_result keyword, step_match, multiline_arg, status, exception, *args
-      if exception
-        @current_scenario_error = exception
-      end
+      # If a step fails, the exception is provided here.
+      # It will be used in #add_result to build the error message of the test.
+      @current_scenario_error = exception if exception
     end
 
+    # Called after each completed scenario.
     def after_feature_element *args
-      add_result !@current_scenario_error, @current_scenario_error
+      add_result
     end
 
+    # Called when the test suite ends.
     def after_features *args
-      #puts "after_features: #{args.inspect}"
       end_time = Time.now
-      @test_run.duration = ((end_time - @start_time) * 1000).round
-      puts @test_run.inspect
-      #@client.process @test_run
+      @test_run.duration = ((end_time - @suite_start_time) * 1000).round
+      @client.process @test_run
     end
 
     private
 
-    def add_result successful, error = nil
+    # Adds a result to the test run.
+    # The test and result data was stored while the features and scenarios
+    # were being executed (see #before_feature, #tag_name, etc).
+    def add_result
 
-      options = {
-        tags: (@current_feature_tags + @current_scenario_tags).uniq,
+      result_options = {
+        name: complete_name,
+        passed: !@current_scenario_error,
         data: {}
       }
 
+      result_options[:duration] = ((Time.now - @current_scenario_start_time) * 1000).round
+
+      # Combine the tags of the feature and of the scenario.
+      result_options[:tags] = (@current_feature_tags + @current_scenario_tags).uniq.sort
+
+      # The fingerprint identifying the test contains the first line of the
+      # feature's and the scenario's descriptions joined with a separator.
+      fingerprint_data = [ @current_feature, @current_scenario ]
+      result_options[:fingerprint] = Digest::SHA1.hexdigest fingerprint_data.join('|||')
+      result_options[:data][:fingerprint] = result_options[:fingerprint]
+
+      # Build the message from the error's message and backtrace if an error occurred.
+      result_options[:message] = failure_message @current_scenario_error if @current_scenario_error
+
+      @test_run.add_result result_options
+    end
+
+    # Builds the complete test name.
+    # The name is obtained by joining the first line of the feature's
+    # and the scenario's descriptions. Additionally, if the feature's
+    # description doesn't end with a dot, a semicolon is added
+    # (e.g. "Feature: Scenario").
+    def complete_name
+
       name = @current_feature.dup
       if name.match /\.$/
         name << ' '
@@ -78,17 +154,6 @@ module ProbeDockCucumber
       end
 
       name << @current_scenario
-
-      options[:name] = name
-
-      fingerprint_data = [ @current_feature, @current_scenario ]
-      options[:fingerprint] = Digest::SHA1.hexdigest fingerprint_data.join('|||')
-      options[:data][:fingerprint] = options[:fingerprint]
-
-      options.merge! passed: successful, duration: ((Time.now - @current_scenario_start_time) * 1000).round
-      options[:message] = failure_message error if error
-
-      @test_run.add_result options
     end
 
     def failure_message error

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: probedock-cucumber
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Simon Oulevay (Alpha Hydrae)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: probedock-ruby