reportportal 0.7

data/LICENSE.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,81 @@
+# Ruby Cucumber and RSpec formatters for ReportPortal
+
+## Installation
+
+Use Ruby 2.2+
+
+Add `gem 'reportportal', git: 'https://github.com/reportportal/agent-ruby.git'` to your `Gemfile`. Run `bundle install`.
+
+## Usage (examples)
+
+* With Cucumber:
+
+```cucumber <other options> -f ReportPortal::Cucumber::Formatter```
+
+* With Cucumber and parallel_tests gem:
+
+```parallel_cucumber <some options> -o '<some other options> -f ReportPortal::Cucumber::ParallelFormatter'```
+
+* With RSpec:
+
+```rspec <other options> -f ReportPortal::RSpec::Formatter```
+
+## Configuration
+Create report_portal.yml configuration file in one of the following folders of your project: '.', './.config', './config' (see report_portal.yaml.example).
+Alternatively specify path to configuration file via rp_config environment variable.
+
+Supported settings:
+
+ - uuid - uuid of the ReportPortal user
+ - endpoint - URI of ReportPortal web service where requests should be sent
+ - launch - launch name
+ - description - custom launch description
+ - project - project name
+ - tags - array of tags for the launch
+ - formatter_modes - array of modes that modify formatter behavior, see [formatter modes](#formatter_modes)
+ - launch_id - id of previously created launch (to be used if formatter_modes contains attach_to_launch)
+ - file_with_launch_id - path to file with id of launch (to be used if formatter_modes contains attach_to_launch)
+ - disable_ssl_verification - set to true to disable SSL verification on connect to ReportPortal (potential security hole!). Set `disable_ssl_verification` to `true` if you see the following error:
+```
+Request to https://rp.epam.com/reportportal-ws/api/v1/pass-team/launch//finish produced an exception: RestClient::SSLCertificateNotVerified: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed
+```
+ - is_debug - set to true to mark the launch as 'DEBUG' (it will appear in Debug tab in Report Portal)
+ - use_standard_logger - set to true to enable logging via standard Ruby Logger class to ReportPortal. Note that log messages are transformed to strings before sending.
+
+Each of these settings can be overridden by an environment variable with the same name and 'rp_' prefix (e.g. 'rp_uuid' for 'uuid'). Environment variables take precedence over YAML configuration.
+Environment variable values are parsed as YAML entities.
+
+## WebMock configuration
+If you use WebMock for stubbing and setting expectations on HTTP requests in Ruby,
+add this to your configuration file (for RSpec it would be `rails_helper.rb` or `spec_helper.rb`)
+
+```ruby
+WebMock.disable_net_connect!(:net_http_connect_on_start => true, :allow_localhost => true, :allow => [/rp\.epam\.com/]) # Don't break Net::HTTP
+```
+
+<a name="formatter_modes"></a>
+## Formatter modes
+
+The following modes are supported:
+
+* attach_to_launch (do not create a new launch but add executing features/scenarios to an existing launch. Use launch_id or file_with_launch_id settings to configure that. If they are not present client will check rp_launch_id.tmp in `Dir.tmpdir`)
+* group_by_folder (represent folders with features as nested suites in Report Portal) # TODO: not supported by new Cucumber formatter currently
+
+## Logging
+Experimental support for three common logging frameworks was added:
+
+- Logger (part of standard Ruby library)
+- [Logging](http://rubygems.org/gems/logging)
+- [Log4r](https://rubygems.org/gems/log4r)
+
+To use Logger, set use_standard_logger parameter to true (see Configuration chapter). For the other two corresponding appenders/outputters are available under reportportal/logging.
+
+## Parallel formatter
+
+ReportPortal::Cucumber::ParallelFormatter can be used for tests started via parallel_tests gem.
+
+Note: Launch id is shared between independent processes (as is the case with parallel_tests gem) via a file in `Dir.tmpdir`.
+
+## Links
+
+ - [ReportPortal](https://github.com/reportportal/)

data/lib/report_portal/cucumber/formatter.rb

@@ -0,0 +1,67 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'thread'
+
+require_relative 'report'
+
+module ReportPortal
+  module Cucumber
+    class Formatter
+      # @api private
+      def initialize(config)
+        ENV['REPORT_PORTAL_USED'] = 'true'
+
+        @queue = Queue.new
+        @thread = Thread.new do
+          @report = ReportPortal::Cucumber::Report.new
+          loop do
+            method_arr = @queue.pop
+            @report.public_send(*method_arr)
+          end
+        end
+        @thread.abort_on_exception = true
+
+        @io = config.out_stream
+
+        [:test_case_started, :test_case_finished, :test_step_started, :test_step_finished].each do |event_name|
+          config.on_event event_name do |event|
+            @queue.push([event_name, event, ReportPortal.now])
+          end
+        end
+        config.on_event :test_run_finished, &method(:on_test_run_finished)
+      end
+
+      def puts(message)
+        @queue.push([:puts, message, ReportPortal.now])
+        @io.puts(message)
+        @io.flush
+      end
+
+      def embed(*args)
+        @queue.push([:embed, *args, ReportPortal.now])
+      end
+
+      def on_test_run_finished(_event)
+        @queue.push([:done, ReportPortal.now])
+        sleep 0.03 while !@queue.empty? || @queue.num_waiting == 0 # TODO: how to interrupt launch if the user aborted execution
+        @thread.kill
+      end
+    end
+  end
+end

data/lib/report_portal/cucumber/json_slurper.rb

@@ -0,0 +1,177 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'base64'
+require 'securerandom'
+require 'mime/types'
+
+require_relative '../../reportportal'
+require_relative '../settings'
+
+module ReportPortal
+  module Cucumber
+    # Helper class to parse and post test launch data generated by Cucumber's JSON formatter
+    # Supports ONLY reports generated with -x switch (i.e. expanded outlines)
+    class JSONSlurper
+      def initialize(filename)
+        @json = JSON.parse(File.read(filename))
+        fail "Cannot process #{filename} because it was generated without -x/--expand Cucumber option!" unless expanded?
+        calculate_start_time
+      end
+
+      def run
+        ReportPortal.start_launch('', get_time)
+
+        @json.each do |feature|
+          current_feature = ReportPortal::TestItem.new("Feature: #{feature['name']}",
+                                                       :TEST,
+                                                       nil,
+                                                       get_time,
+                                                       feature['uri'],
+                                                       nil,
+                                                       tags(feature))
+          current_feature_node = Tree::TreeNode.new(SecureRandom.hex, current_feature)
+          current_feature.id = ReportPortal.start_item(current_feature_node)
+          current_element_name = nil
+          current_outline_row = 0
+
+          feature['elements'].each do |element|
+            type = element['type'] == 'background' ? :BEFORE_CLASS : :STEP
+
+            element_name = "#{element['keyword']}: #{element['name']}"
+            if element['keyword'] == 'Scenario Outline'
+              if element['name'] == current_element_name
+                current_outline_row += 1
+              else
+                current_element_name = element['name']
+                current_outline_row = 1
+              end
+              element_name << " [#{current_outline_row}]"
+            end
+
+            ReportPortal.current_scenario = ReportPortal::TestItem.new(element_name,
+                                                                       type,
+                                                                       nil,
+                                                                       get_time,
+                                                                       "#{feature['uri']}:#{element['line']}",
+                                                                       nil,
+                                                                       tags(element))
+            current_scenario_node = Tree::TreeNode.new(SecureRandom.hex, ReportPortal.current_scenario)
+            ReportPortal.current_scenario.id = ReportPortal.start_item(current_scenario_node)
+
+            statuses = report_hooks(element, 'before')
+            forced_issue = nil
+            element['steps'].each do |step|
+              name = decorate("#{step['keyword']}#{step['name']}")
+              if step['rows']
+                name << step['rows'].reduce("\n") { |acc, row| acc << decorate("| #{row['cells'].join(' | ')} |") << "\n" }
+              end
+              if step['doc_string']
+                name << %(\n"""\n#{step['doc_string']['value']}\n""")
+              end
+
+              ReportPortal.send_log(:passed, name, get_time)
+              step['output'].each { |o| ReportPortal.send_log(:passed, o, get_time) } unless step['output'].nil?
+              error = step['result']['error_message']
+              ReportPortal.send_log(:failed, error, get_time) if error
+              (step['embeddings'] || []).each do |embedding|
+                ReportPortal.send_file(:failed, embedding['data'], 'Embedding', get_time, embedding['mime_type'])
+              end
+              statuses << step['result']['status']
+              forced_issue ||= case step['result']['status']
+                               when 'pending'
+                                 error
+                               when 'undefined'
+                                 "Undefined step #{step['name']} at #{step['match']['location']}"
+                               else
+                                 nil
+                               end
+
+              ReportPortal.send_log(step['result']['status'].to_sym,
+                                    "STEP #{step['result']['status'].upcase}",
+                                    get_time(step['result']['duration'].to_i / 1_000_000))
+            end
+            statuses += report_hooks(element, 'after')
+
+            status = if statuses.any? { |s| %w(failed undefined pending).include? s }
+                       :failed
+                     elsif statuses.all? { |s| s == 'passed' }
+                       :passed
+                     else
+                       :skipped
+                     end
+
+            ReportPortal.finish_item(ReportPortal.current_scenario, status, get_time, forced_issue)
+            ReportPortal.current_scenario = nil
+          end
+
+          ReportPortal.finish_item(current_feature, nil, get_time)
+        end
+        ReportPortal.finish_item(root, nil, get_time)
+        ReportPortal.finish_launch(get_time)
+      end
+
+      private
+
+      def tags(item)
+        item['tags'].nil? ? [] : item['tags'].map { |h| h['name'] }
+      end
+
+      def decorate(str)
+        sep = '-' * 25
+        "#{sep}#{str}#{sep}"
+      end
+
+      def expanded?
+        bad_item = @json.find do |f|
+          so = f['elements'].find { |e| e['keyword'] == 'Scenario Outline' }
+          so ? so.key?('examples') : false
+        end
+        bad_item.nil?
+      end
+
+      def calculate_start_time
+        duration_nanos = 0
+        @json.each do |f|
+          f['elements'].each do |e|
+            items = e['steps'] + (e['before'] || []) + (e['after'] || [])
+            items.each do |s|
+              duration_nanos += s['result']['duration'].to_i
+            end
+          end
+        end
+        @now = (Time.now.to_f * 1000).to_i - (duration_nanos / 1_000_000)
+      end
+
+      # update current time and return
+      def get_time(offset = 0)
+        @now += offset + 1
+      end
+
+      # report before/after hooks and return array of their statuses
+      def report_hooks(element, tag)
+        (element[tag] || []).map do |hook|
+          ReportPortal.send_log(hook['result']['status'].to_sym,
+                                "HOOK #{hook['match']['location']} #{hook['result']['status'].upcase}",
+                                get_time(hook['result']['duration'].to_i / 1_000_000))
+          hook['result']['status']
+        end
+      end
+    end
+  end
+end