parallel_report_portal 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10a0ede4e1da6f5fc4788775483996e7ecf4a21009b06bfbbec5b49593c623bc
-  data.tar.gz: 8a0f3966ac4134f96e4a18e42e4b779943425d5d7cf9947dfc6afa10ee376859
+  metadata.gz: 35cc50dee2f24a1533a8ef831c0cd1977fc36c6fd9c6cdb5ccdd4a73c8022cc2
+  data.tar.gz: fa3c3fbe565ac7e1aa5b728a6fe73f401d84c4b327eebe83a4f1af6697d6fda0
 SHA512:
-  metadata.gz: 380772393a3450a86df43444caa69e09b93d5b9b88a66ea658adc0baac40b064fe74e299cdec0dbf99c299a295c2d550914040ae87a65d82458c801e9f94ca2d
-  data.tar.gz: 5950fe72eb47bf2c195621d94faac14cfbb7a17b73aeae16f02a952b01a475f86e6a0901a8113ad7f00dd9d5081f5b162fd51266424cf5b7d6070b65162d3a5c
+  metadata.gz: 8b26b53f1e989cf4e2179e6361be41b783ca692d739aa7bdabaab50b9599c4e5378fa05b1fb9920bde748bdff56ef99a0afb4f4431b23329ac69b83db81ea057
+  data.tar.gz: c0cc62184f810e2bd53119e7115e29be3c014d707f8bce610c825a466d356337a0c694d4dae6e14b87f137f136136ae1056aceec0f6a7e590b35a59dedc79961

data/.rspec

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

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.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_report_portal
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.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: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -234,7 +234,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+