parallel_report_portal 2.1.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a0ede4e1da6f5fc4788775483996e7ecf4a21009b06bfbbec5b49593c623bc
-  data.tar.gz: 8a0f3966ac4134f96e4a18e42e4b779943425d5d7cf9947dfc6afa10ee376859
+  metadata.gz: 6eac77f10cdc4ca803b014029883de0cc28439fe645547190ff1022878f430c5
+  data.tar.gz: 1e50abb80970dfcab716abe749b554b6622209ac55a51c207b4bbc7e3201d078
 SHA512:
-  metadata.gz: 380772393a3450a86df43444caa69e09b93d5b9b88a66ea658adc0baac40b064fe74e299cdec0dbf99c299a295c2d550914040ae87a65d82458c801e9f94ca2d
-  data.tar.gz: 5950fe72eb47bf2c195621d94faac14cfbb7a17b73aeae16f02a952b01a475f86e6a0901a8113ad7f00dd9d5081f5b162fd51266424cf5b7d6070b65162d3a5c
+  metadata.gz: 9e3b3b267691986d4e98051be3fc2027cfff873a3cb69de2ce1d5e18df435b769bf8bc94ace5f03b436d285f28b121b0986056cfc3f909aaa94c7931b96f6210
+  data.tar.gz: '068c14c09b3b8c47da4b6bf2a5513316f66ecc8893bca4ff112787bc6f2db1582198d042f6cbc35357adcc23136bd4215ecddc84c50988bf22efbac94471c469'

data/.rspec

@@ -1 +1,2 @@
 --require spec_helper
+--format documentation

data/lib/parallel_report_portal/after_launch.rb

@@ -0,0 +1,13 @@
+module ParallelReportPortal
+  # Handle post launch hooks
+  module AfterLaunch
+
+    attr_accessor :launch_finished_block
+    attr_accessor :report_url
+
+    def after_launch(&block)
+      @launch_finished_block = block
+    end
+
+  end
+end

data/lib/parallel_report_portal/configuration.rb

@@ -1,23 +1,23 @@
 module ParallelReportPortal
   # The Configuration class holds the connection properties to communicate with
   # Report Portal and to identify the user and project for reporting.
-  # 
+  #
   # It attempts to load a configuration file called +report_portal.yml+ first in a
   # local directory called +config+ and if that's not found in the current directory.
   # (Report Portal actually tells you to create a files called +REPORT_PORTAL.YML+ in
-  # uppercase -- for this reason the initializer is case insensitive with regards to 
+  # uppercase -- for this reason the initializer is case insensitive with regards to
   # the file name)
-  # 
+  #
   # It will then try an apply the following environment variables, if present (these
   # can be specified in either lowercase for backwards compatibility with the official
   # gem or in uppercase for reasons of sanity)
-  # 
+  #
   # == Environment variables
-  # 
+  #
   # RP_UUID:: The UUID of the user associated with this launch
   # RP_ENDPOINT:: the URL of the Report Portal API endpoint
   # RP_PROJECT:: the Report Portal project name -- this must already exist within Report Port and this user must be a member of the project
-  # RP_LAUNCH:: The name of this launch 
+  # RP_LAUNCH:: The name of this launch
   # RP_DESCRIPTION:: A textual string describing this launch
   # RP_TAGS:: A set of tags to pass to Report Portal for this launch. If these are set via an environment variable, provide a comma-separated string of tags
   # RP_ATTRIBUTES:: A set of attribute tags to pass to Report Portal for this launch. If these are set via an environment variable, provide a comma-separated string of attributes
@@ -52,7 +52,6 @@ module ParallelReportPortal
     # @return [Integer] the number of seconds for the read connection to timeout
     attr_accessor :read_timeout
 
-
     # Create an instance of Configuration.
     #
     # The initializer will first attempt to load a configuration files called
@@ -101,6 +100,7 @@ module ParallelReportPortal
                end
     end
 
+
     # Simple method to obtain an attribute from this class or set default value
     # param [symbol] a symbol version of the attribute
     def fetch(key, default_value)

data/lib/parallel_report_portal/cucumber/report.rb

@@ -4,39 +4,39 @@ require 'tree'
 module ParallelReportPortal
   module Cucumber
     # Report object. This handles the management of the state hierarchy and
-    # the issuing of the requests to the HTTP module. 
+    # the issuing of the requests to the HTTP module.
     class Report
-      
+
       attr_reader :launch_id
-      
+
       Feature = Struct.new(:feature, :id)
-      
-      LOG_LEVELS = { 
-        error: 'ERROR', 
-        warn: 'WARN', 
-        info: 'INFO', 
-        debug: 'DEBUG', 
-        trace: 'TRACE', 
-        fatal: 'FATAL', 
-        unknown: 'UNKNOWN' 
+
+      LOG_LEVELS = {
+        error: 'ERROR',
+        warn: 'WARN',
+        info: 'INFO',
+        debug: 'DEBUG',
+        trace: 'TRACE',
+        fatal: 'FATAL',
+        unknown: 'UNKNOWN'
       }
 
-      
+
       # Create a new instance of the report
       def initialize(ast_lookup = nil)
         @feature = nil
-        @tree = Tree::TreeNode.new( 'root' ) 
+        @tree = Tree::TreeNode.new( 'root' )
         @ast_lookup = ast_lookup
       end
-      
+
       # Issued to start a launch. It is possilbe that this method could be called
       # from multiple processes for the same launch if this is being run with
       # parallel tests enabled. A temporary launch file will be created (using
       # exclusive locking). The first time this method is called it will write the
       # launch id to the launch file, subsequent calls by other processes will read
       # this launch id and use that.
-      # 
-      # @param start_time [Integer] the millis from the epoch 
+      #
+      # @param start_time [Integer] the millis from the epoch
       # @return [String] the UUID of this launch
       def launch_started(start_time)
         ParallelReportPortal.file_open_exlock_and_block(ParallelReportPortal.launch_id_file, 'a+' ) do |file|
@@ -50,39 +50,42 @@ module ParallelReportPortal
           @launch_id
         end
       end
-      
+
       # Called to finish a launch. Any open children items will be closed in the process.
-      # 
+      #
       # @param clock [Integer] the millis from the epoch
       def launch_finished(clock)
         @tree.postordered_each do |node|
-          ParallelReportPortal.req_feature_finished(node.content, clock) unless node.is_root?
+          response = ParallelReportPortal.req_feature_finished(node.content, clock) unless node.is_root?
+          parse_report_link_from_response(response)
         end
-        ParallelReportPortal.req_launch_finished(launch_id, clock)
+        response = ParallelReportPortal.req_launch_finished(launch_id, clock)
+        parse_report_link_from_response(response)
+        ParallelReportPortal.launch_finished_block.call if ParallelReportPortal.launch_finished_block
       end
-      
+
       # Called to indicate that a feature has started.
-      # 
-      # @param 
+      #
+      # @param
       def feature_started(feature, clock)
         parent_id = hierarchy(feature, clock)
         feature = feature.feature if using_cucumber_messages?
         ParallelReportPortal.req_feature_started(launch_id, parent_id, feature, clock)
       end
-      
+
       def feature_finished(clock)
         if @feature
           resp = ParallelReportPortal.req_feature_finished(@feature.id, clock)
         end
       end
-            
+
       def test_case_started(event, clock)
         test_case = lookup_test_case(event.test_case)
         feature = lookup_feature(event.test_case)
         feature = current_feature(feature, clock)
         @test_case_id = ParallelReportPortal.req_test_case_started(launch_id, feature.id, test_case, clock)
       end
-      
+
       def test_case_finished(event, clock)
         result = event.result
         status = result.to_sym
@@ -93,7 +96,7 @@ module ParallelReportPortal
         end
         resp = ParallelReportPortal.req_test_case_finished(@test_case_id, status, clock)
       end
-      
+
       def test_step_started(event, clock)
         test_step = event.test_step
         if !hook?(test_step)
@@ -104,11 +107,11 @@ module ParallelReportPortal
           elsif (using_cucumber_messages? ? test_step : step_source).multiline_arg.data_table?
             detail << (using_cucumber_messages? ? test_step : step_source).multiline_arg.raw.reduce("\n") {|acc, row| acc << "| #{row.join(' | ')} |\n"}
           end
-          
+
           ParallelReportPortal.req_log(@test_case_id, detail, status_to_level(:trace), clock)
         end
       end
-      
+
       def test_step_finished(event, clock)
         test_step = event.test_step
         result = event.result
@@ -129,13 +132,13 @@ module ParallelReportPortal
         ParallelReportPortal.req_log(@test_case_id, detail, status_to_level(status), clock) if detail
 
       end
-    
+
       private
 
       def using_cucumber_messages?
         @ast_lookup != nil
       end
-      
+
       def hierarchy(feature, clock)
         node = nil
         path_components = if using_cucumber_messages?
@@ -144,7 +147,7 @@ module ParallelReportPortal
                             feature.location.file.split(File::SEPARATOR)
                           end
         ParallelReportPortal.file_open_exlock_and_block(ParallelReportPortal.hierarchy_file, 'a+b' ) do |file|
-          @tree = Marshal.load(File.read(file)) if file.size > 0 
+          @tree = Marshal.load(File.read(file)) if file.size > 0
           node = @tree.root
           path_components[0..-2].each do |component|
             next_node = node[component]
@@ -161,7 +164,7 @@ module ParallelReportPortal
           file.write(Marshal.dump(@tree))
           file.flush
         end
-        
+
         node.content
       end
 
@@ -193,7 +196,7 @@ module ParallelReportPortal
           step.source.last
         end
       end
-      
+
       def current_feature(feature, clock)
         if @feature&.feature == feature
           @feature
@@ -202,7 +205,7 @@ module ParallelReportPortal
           @feature = Feature.new(feature, feature_started(feature, clock))
         end
       end
-      
+
       def hook?(test_step)
         if using_cucumber_messages?
           test_step.hook?
@@ -210,7 +213,7 @@ module ParallelReportPortal
           ! test_step.source.last.respond_to?(:keyword)
         end
       end
-      
+
       def status_to_level(status)
         case status
         when :passed
@@ -223,8 +226,13 @@ module ParallelReportPortal
           LOG_LEVELS.fetch(status, LOG_LEVELS[:info])
         end
       end
-      
-    
+
+      def parse_report_link_from_response(response)
+        if response
+          json = JSON.parse(response.body)
+          ParallelReportPortal.report_url = json['link'] if json['link']
+        end
+      end
     end
   end
 end

data/lib/parallel_report_portal/http.rb

@@ -2,7 +2,7 @@ require 'logger'
 require 'tempfile'
 
 module ParallelReportPortal
-  # A collection of methods for communicating with the ReportPortal 
+  # A collection of methods for communicating with the ReportPortal
   # REST interface.
   module HTTP
 
@@ -10,16 +10,16 @@ module ParallelReportPortal
     @@logger = Logger.new(STDOUT)
     @@logger.level = Logger::ERROR
 
-    # Construct the Report Portal project URL (as a string) based 
+    # Construct the Report Portal project URL (as a string) based
     # on the config settings.
-    # 
+    #
     # @return [String] URL the report portal base URL
     def url
       "#{ParallelReportPortal.configuration.endpoint}/#{ParallelReportPortal.configuration.project}"
     end
 
     # Helper method for constructing the +Bearer+ header
-    # 
+    #
     # @return [String] header the bearer header value
     def authorization_header
       "Bearer #{ParallelReportPortal.configuration.uuid}"
@@ -28,7 +28,7 @@ module ParallelReportPortal
     # Get a preconstructed Faraday HTTP connection
     # which has the endpont and headers ready populated.
     # This object is memoized.
-    # 
+    #
     # @return [Faraday::Connection] connection the HTTP connection object
     def http_connection
       @http_connection ||= Faraday.new(
@@ -49,7 +49,7 @@ module ParallelReportPortal
     # Get a preconstructed Faraday HTTP multipart connection
     # which has the endpont and headers ready populated.
     # This object is memoized.
-    # 
+    #
     # @return [Faraday::Connection] connection the HTTP connection object
     def http_multipart_connection
       @http_multipart_connection ||= Faraday.new(
@@ -74,10 +74,10 @@ module ParallelReportPortal
     def req_launch_started(time)
       resp = http_connection.post('launch') do |req|
               req.body = {
-                name: ParallelReportPortal.configuration.launch, 
-                start_time: time, 
-                tags: ParallelReportPortal.configuration.tags, 
-                description: ParallelReportPortal.configuration.description, 
+                name: ParallelReportPortal.configuration.launch,
+                start_time: time,
+                tags: ParallelReportPortal.configuration.tags,
+                description: ParallelReportPortal.configuration.description,
                 mode: (ParallelReportPortal.configuration.debug ? 'DEBUG' : 'DEFAULT' ),
                 attributes: ParallelReportPortal.configuration.attributes
               }.to_json
@@ -88,7 +88,7 @@ module ParallelReportPortal
         @@logger.error("Launch failed with response code #{resp.status} -- message #{resp.body}")
       end
     end
-    
+
     # Send a request to Report Portal to finish a launch.
     # It will bubble up any Faraday connection exceptions.
     def req_launch_finished(launch_id, time)
@@ -96,10 +96,10 @@ module ParallelReportPortal
         req.body = { end_time: time }.to_json
       end
     end
-    
+
     # Send a request to ReportPortal to start a feature.
     # It will bubble up any Faraday connection exceptions.
-    # 
+    #
     # @return [String] id the UUID of the feature
     def req_feature_started(launch_id, parent_id, feature, time)
         description = if feature.description
@@ -116,9 +116,9 @@ module ParallelReportPortal
                       description,
                       time )
     end
-    
+
     # Sends a request to Report Portal to add an item into its hierarchy.
-    # 
+    #
     # @return [String] uuid the UUID of the newly created child
     def req_hierarchy(launch_id, name, parent, type, tags, description, time )
       resource = 'item'
@@ -134,23 +134,23 @@ module ParallelReportPortal
           attributes: tags
         }.to_json
       end
-      
+
       if resp.success?
         JSON.parse(resp.body)['id']
       else
         @@logger.warn("Starting a heirarchy failed with response code #{resp.status} -- message #{resp.body}")
       end
     end
-  
+
     # Send a request to Report Portal that a feature has completed.
     def req_feature_finished(feature_id, time)
       ParallelReportPortal.http_connection.put("item/#{feature_id}") do |req|
         req.body = { end_time: time }.to_json
       end
     end
-  
+
     # Send a request to ReportPortal to start a test case.
-    # 
+    #
     # @return [String] uuid the UUID of the test case
     def req_test_case_started(launch_id, feature_id, test_case, time)
       resp = ParallelReportPortal.http_connection.post("item/#{feature_id}") do |req|
@@ -176,7 +176,7 @@ module ParallelReportPortal
         @@logger.warn("Starting a test case failed with response code #{resp.status} -- message #{resp.body}")
       end
     end
-    
+
     # Request that the test case be finished
     def req_test_case_finished(test_case_id, status, time)
       resp = ParallelReportPortal.http_connection.put("item/#{test_case_id}") do |req|
@@ -186,8 +186,8 @@ module ParallelReportPortal
         }.to_json
       end
     end
-    
-    
+
+
     # Request that Report Portal records a log record
     def req_log(test_case_id, detail, level, time)
       resp = ParallelReportPortal.http_connection.post('log') do |req|
@@ -202,19 +202,26 @@ module ParallelReportPortal
 
 
     # Request that Report Portal attach a file to the test case.
-    # 
+    #
     # @param status [String] the status level of the log, e.g. info, warn
     # @param path [String] the fully qualified path of the file to attach
     # @param label [String] a label to add to the attachment, defaults to the filename
     # @param time [Integer] the time in milliseconds for the attachment
     # @param mime_type [String] the mimetype of the attachment
-    def send_file(status, path, label = nil, time = ParallelReportPortal.clock, mime_type = 'image/png')
+    def send_file(
+      status,
+      path,
+      label = nil,
+      time = ParallelReportPortal.clock,
+      mime_type = 'image/png',
+      scenario_id = nil
+    )
       File.open(File.realpath(path), 'rb') do |file|
         label ||= File.basename(file)
 
-        # where did @test_case_id come from? ok, I know where it came from but this 
+        # where did @test_case_id come from? ok, I know where it came from but this
         # really should be factored out of here and state handled better
-        json = { level: status, message: label, item_id: @test_case_id, time: time, file: { name: File.basename(file) } }
+        json = { level: status, message: label, item_id: scenario_id || @test_case_id, time: time, file: { name: File.basename(file) } }
 
         json_file = Tempfile.new
         json_file << [json].to_json

data/lib/parallel_report_portal/version.rb

@@ -1,3 +1,3 @@
 module ParallelReportPortal
-  VERSION = "2.1.1"
+  VERSION = "2.4.0"
 end

data/lib/parallel_report_portal.rb

@@ -1,3 +1,4 @@
+require 'parallel_report_portal/after_launch'
 require "parallel_report_portal/clock"
 require "parallel_report_portal/configuration"
 require "parallel_report_portal/file_utils"
@@ -8,19 +9,20 @@ require 'parallel_tests'
 module ParallelReportPortal
   class Error < StandardError; end
 
+  extend ParallelReportPortal::AfterLaunch
   extend ParallelReportPortal::HTTP
   extend ParallelReportPortal::FileUtils
   extend ParallelReportPortal::Clock
 
   # Returns the configuration object, initializing it if necessary.
-  # 
+  #
   # @return [Configuration] the configuration object
   def self.configuration
     @configuration ||= Configuration.new
   end
 
   # Configures the Report Portal environment.
-  # 
+  #
   # @yieldparam [Configuration] config the configuration object yielded to the block
   def self.configure(&block)
     yield configuration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_report_portal
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2023-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -205,6 +205,7 @@ files:
 - gemfiles/cucumber_6.0.gemfile
 - lib/parallel_report_portal.rb
 - lib/parallel_report_portal/.DS_Store
+- lib/parallel_report_portal/after_launch.rb
 - lib/parallel_report_portal/clock.rb
 - lib/parallel_report_portal/configuration.rb
 - lib/parallel_report_portal/cucumber/formatter.rb
@@ -234,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Run Cucumber Tests in parallel and with Cucumber 3 and 4+