parallel_report_portal 2.3.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35cc50dee2f24a1533a8ef831c0cd1977fc36c6fd9c6cdb5ccdd4a73c8022cc2
-  data.tar.gz: fa3c3fbe565ac7e1aa5b728a6fe73f401d84c4b327eebe83a4f1af6697d6fda0
+  metadata.gz: dca25702756ef6361e293e078cbca0e4a7b3e58e01a172729f49a319fa43fd15
+  data.tar.gz: 81397b39a9131c2ef601e782da487c7ec5be55cb6a90e8ba98d00de5c95248b5
 SHA512:
-  metadata.gz: 8b26b53f1e989cf4e2179e6361be41b783ca692d739aa7bdabaab50b9599c4e5378fa05b1fb9920bde748bdff56ef99a0afb4f4431b23329ac69b83db81ea057
-  data.tar.gz: c0cc62184f810e2bd53119e7115e29be3c014d707f8bce610c825a466d356337a0c694d4dae6e14b87f137f136136ae1056aceec0f6a7e590b35a59dedc79961
+  metadata.gz: 8b1fd11d745dbba815364eadb751c9d8c15ff23fa36fd3c40490d1e2d718c125cc7d83cd7d4f8ca1540114ee86898b2fafc1405809506a92857840adc260d801
+  data.tar.gz: ef8ba69e9d7cf3f61f78e56b3df1e8e256541192f22c1656267268c5c97a0878bb76ddc5f0411184f12a14d89bdc4396a99aaca2b267e92620204393fb38668d

data/.gitignore

@@ -7,6 +7,8 @@
 /pkg/
 /spec/reports/
 /tmp/
+/out/
+/vendor/
 
 # Appraisal lock files
 /gemfiles/*.lock
@@ -15,5 +17,6 @@ Gemfile.lock
 # rspec failure tracking
 .rspec_status
 .DS_Store
+.ruby-version
 
 *.gem

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

@@ -1,42 +1,51 @@
 require 'faraday'
+require 'faraday/net_http_persistent'
+require 'faraday/multipart'
 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
+        check_faraday_compatibility
+      end
+
+      def check_faraday_compatibility
+        if Gem::Version.create(Faraday::VERSION) < Gem::Version.create('2.0')
+          Kernel.warn("Minimum of Faraday v2 is expected for compatibility with parallel_report_portal", category: :deprecated)
+        end
       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 +59,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 +105,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 +116,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 +141,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 +156,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 +173,7 @@ module ParallelReportPortal
           file.write(Marshal.dump(@tree))
           file.flush
         end
-        
+
         node.content
       end
 
@@ -193,7 +205,7 @@ module ParallelReportPortal
           step.source.last
         end
       end
-      
+
       def current_feature(feature, clock)
         if @feature&.feature == feature
           @feature
@@ -202,7 +214,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 +222,7 @@ module ParallelReportPortal
           ! test_step.source.last.respond_to?(:keyword)
         end
       end
-      
+
       def status_to_level(status)
         case status
         when :passed
@@ -223,8 +235,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/version.rb

@@ -1,3 +1,3 @@
 module ParallelReportPortal
-  VERSION = "2.3.0"
+  VERSION = "2.5.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

data/parallel_report_portal.gemspec

@@ -38,7 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 3.12"
   
   spec.add_runtime_dependency 'cucumber', '>= 3.2'
-  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'faraday-net_http_persistent', '~> 2.1'
+  spec.add_runtime_dependency 'faraday-multipart', '~> 1.0', '>= 1.0.4'
   spec.add_runtime_dependency 'parallel_tests', '>= 2.29.1'
   spec.add_runtime_dependency 'rubytree', '~> 1.0'
   spec.add_runtime_dependency 'net-http-persistent', '~> 4.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_report_portal
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -124,12 +124,29 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -137,6 +154,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 - !ruby/object:Gem::Dependency
   name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
@@ -205,6 +225,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 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Run Cucumber Tests in parallel and with Cucumber 3 and 4+