parallel_report_portal 2.0.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0add9e8d3a73f7dc7886490f11a20c8d1b50ac9dda6a9421a8d8d0bb747ab039
-  data.tar.gz: 25a678c5e5e6924427b1c63903ced4289de914888d095dd13d710b718209cc08
+  metadata.gz: 35cc50dee2f24a1533a8ef831c0cd1977fc36c6fd9c6cdb5ccdd4a73c8022cc2
+  data.tar.gz: fa3c3fbe565ac7e1aa5b728a6fe73f401d84c4b327eebe83a4f1af6697d6fda0
 SHA512:
-  metadata.gz: 5ba5a9a4da4503db9c6c341f50dd452ea27dff36b231fb2106ba6c7519284519f6408a5a0178ae105dea62178d56873a10d5dade750b3f40f89f0042c0442250
-  data.tar.gz: abf1e05a8b9a223032e5dac8cc5083a22c9d94e55c5d732a141f493b02678d4c56e0321cb14457cacd71c586ad7d7b9b989fe7b3cdeb9a7cd91e26c9f5b9bda0
+  metadata.gz: 8b26b53f1e989cf4e2179e6361be41b783ca692d739aa7bdabaab50b9599c4e5378fa05b1fb9920bde748bdff56ef99a0afb4f4431b23329ac69b83db81ea057
+  data.tar.gz: c0cc62184f810e2bd53119e7115e29be3c014d707f8bce610c825a466d356337a0c694d4dae6e14b87f137f136136ae1056aceec0f6a7e590b35a59dedc79961

data/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [push]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.rspec

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

data/README.md

@@ -2,7 +2,7 @@
 
 This gem is a Ruby-Cucumber formatter which sends the test output to [Report Portal](https://reportportal.io).
 
-This formatter supports plain 'ol Cucumber tests and those wrapped with [parallel_tests](https://rubygems.org/gems/parallel_tests). 
+This formatter supports plain 'ol Cucumber tests and those wrapped with [parallel_tests](https://rubygems.org/gems/parallel_tests).
 
 It also supports Cucumber 3.x and 4+ (Cucumber implementations using cucumber-messages).
 
@@ -30,20 +30,30 @@ The formatter supports configuration via a config file or via environment variab
 
 #### Configuration file
 
-It will search for a file called `report_portal.yml` or `REPORT_PORTAL.YML` in `./config` and `./`. It expects this file to contain the standard Report Portal configuration options -- see the Report Portal documentation.
+It will search for a file called `report_portal.yml` or `REPORT_PORTAL.YML` in `./config` and `./`. It expects this file to contain the standard Report Portal configuration options -- see the Report Portal documentation. Optionally, the config file keys may match those accepted through environment variables -- they may contain 'rp*' and 'RP*'.
+
+#### Configurable Timeouts
+
+When running in parallel you might encounter some connection timeouts and these have been made configurable. You can configure the Report Portal yaml file with these attributes and set your own custom timeout values.
+
+```yaml
+idle_timeout: 100
+open_timeout: 60
+read_timeout: 60
+```
 
 #### Environment variables
 
 It will search for the following environment variables which may be in upper or lowercase (the official client defers to lower case, this is available here for compatibility).
 
-* `RP_UUID` - the user's UUID for this Report Portal instance which must be created in advance
-* `RP_ENDPOINT` - the endpoint for this Report Portal instance 
-* `RP_PROJECT` - the Report Portal project name which must be created in advance and this user added as a member 
-* `RP_LAUNCH` - the name of this 'launch'  
-* `RP_DEBUG` - *optional* if set to the string value `true` it will instruct Report Portal to add the output of these tests to the debug tab 
-* `RP_DESCRIPTION` - *optional* a textual description of the launch 
-* `RP_TAGS` - *optional* a string of comma separated tags 
-* `RP_ATTRIBUTES` - *optional* a string of comma separated attributes 
+- `RP_UUID` - the user's UUID for this Report Portal instance which must be created in advance
+- `RP_ENDPOINT` - the endpoint for this Report Portal instance
+- `RP_PROJECT` - the Report Portal project name which must be created in advance and this user added as a member
+- `RP_LAUNCH` - the name of this 'launch'
+- `RP_DEBUG` - _optional_ if set to the string value `true` it will instruct Report Portal to add the output of these tests to the debug tab
+- `RP_DESCRIPTION` - _optional_ a textual description of the launch
+- `RP_TAGS` - _optional_ a string of comma separated tags
+- `RP_ATTRIBUTES` - _optional_ a string of comma separated attributes
 
 ### With cucumber
 
@@ -61,9 +71,7 @@ cucumber -f ParallelReportPortal::Cucumber::Formatter --out /dev/null -f progres
 
 ```
 parallel_cucumber -- -f ParallelReportPortal::Cucumber::Formatter -- features/
- ```
-
-
+```
 
 ## Development
 

data/lib/parallel_report_portal/configuration.rb

@@ -22,7 +22,7 @@ module ParallelReportPortal
   # 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
   class Configuration
-    ATTRIBUTES = [:uuid, :endpoint, :project, :launch, :debug, :description, :tags, :attributes]
+    ATTRIBUTES = [:uuid, :endpoint, :project, :launch, :debug, :description, :tags, :attributes, :open_timeout, :idle_timeout, :read_timeout]
 
     # @return [String] the Report Portal user UUID
     attr_accessor :uuid
@@ -45,10 +45,16 @@ module ParallelReportPortal
     # @return [Array<String>] an array of attributes to attach to this launch
     #   (Report Portal 5)
     attr_reader :attributes
-  
+    # @return [Integer] the number of seconds for the open connection to timeout
+    attr_accessor :open_timeout
+    # @return [Integer] the number of seconds for the open and idle connection to timeout
+    attr_accessor :idle_timeout
+    # @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
     # +report_portal.yml+ (case insensitive) in the both the +config+ and current
     # working directory (the former takes precidence). It will then apply
@@ -64,18 +70,18 @@ module ParallelReportPortal
     # Sets the tags for the launch. If an array is provided, the array is used,
     # if a string is provided, the string is broken into components by splitting
     # on a comma.
-    # 
+    #
     # e.g.
     #   configuration.tags="one,two, three"
     #   #=> ["one", "two", "three"]
-    # 
+    #
     # param [String | Array<String>] taglist a list of tags to set
     def tags=(taglist)
       if taglist.is_a?(String)
         @tags = taglist.split(',').map(&:strip)
       elsif taglist.is_a?(Array)
         @tags = taglist
-      else 
+      else
         @tags = []
       end
       tags
@@ -84,7 +90,7 @@ module ParallelReportPortal
 
     # Enables the debug flag which is sent to Report Portal. If this flag is set
     # Report Portal will include this launch in its 'debug' tab.
-    # 
+    #
     # param [Boolean | String] value if the value is a Boolean, it will take that value
     #   if it is a String, it will set values of 'true' to +true+, else all values will be false.
     def debug=(value)
@@ -95,21 +101,27 @@ 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)
+      self.send(key).nil? ? default_value : self.send(key)
+    end
+
     # Sets the attributes for the launch. If an array is provided, the array is used,
     # if a string is provided, the string is broken into components by splitting
     # on a comma.
-    # 
+    #
     # e.g.
     #   configuration.tags="one,two, three"
     #   #=> ["one", "two", "three"]
-    # 
+    #
     # param [String | Array<String>] taglist a list of tags to set
     def attributes=(attrlist)
       if attrlist.is_a?(String)
         @attributes = attrlist.split(',').map(&:strip)
       elsif attrlist.is_a?(Array)
         @attributes = attrlist
-      else 
+      else
         @attributes = []
       end
       attributes
@@ -129,10 +141,18 @@ module ParallelReportPortal
         .then { |fn| fn ? File.read(fn) : '' }
         .then { |ys| YAML.safe_load(ys, symbolize_names: true) }
         .then do |yaml|
+        if yaml
+          yaml.transform_keys! { |key| key.downcase }
           ATTRIBUTES.each do |attr|
-            send(:"#{attr}=", yaml[attr]) if yaml&.fetch(attr, nil)
+            yaml_key = if yaml.has_key?("rp_#{attr}".to_sym)
+                         "rp_#{attr}".to_sym
+                       else
+                         attr
+                       end
+            send(:"#{attr}=", yaml[yaml_key]) if yaml.fetch(yaml_key, nil)
           end
         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(
@@ -39,7 +39,9 @@ module ParallelReportPortal
         }
       ) do |f|
         f.adapter :net_http_persistent, pool_size: 5 do |http|
-          http.idle_timeout = 100
+          http.idle_timeout = ParallelReportPortal.configuration.fetch(:idle_timeout, 100)
+          http.open_timeout = ParallelReportPortal.configuration.fetch(:open_timeout, 60)
+          http.read_timeout = ParallelReportPortal.configuration.fetch(:read_timeout, 60)
         end
       end
     end
@@ -47,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(
@@ -60,7 +62,9 @@ module ParallelReportPortal
         conn.request :url_encoded
         conn.adapter :net_http_persistent, pool_size: 5 do |http|
           # yields Net::HTTP::Persistent
-          http.idle_timeout = 100
+          http.idle_timeout = ParallelReportPortal.configuration.fetch(:idle_timeout, 100)
+          http.open_timeout = ParallelReportPortal.configuration.fetch(:open_timeout, 60)
+          http.read_timeout = ParallelReportPortal.configuration.fetch(:read_timeout, 60)
         end
       end
     end
@@ -70,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
@@ -84,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)
@@ -92,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
@@ -112,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'
@@ -130,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|
@@ -172,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|
@@ -182,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|
@@ -198,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.0.2"
+  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.0.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2022-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -187,7 +187,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".drone.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - Appraisals
@@ -234,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Run Cucumber Tests in parallel and with Cucumber 3 and 4+

data/.drone.yml

@@ -1,21 +0,0 @@
-kind: pipeline
-name: default
-
-platform:
-  os: linux
-  arch: amd64
-
-steps:
-  - name: Build & Publish
-    pull: if-not-exists
-    image: 714782054810.dkr.ecr.eu-west-2.amazonaws.com/base-images/qe-ruby:2.7.0
-    commands:
-      - apk add --update git --update alpine-sdk  --no-cache
-      - gem install bundler
-      - bundle
-      - gem install nexus
-      - gem build parallel_report_portal.gemspec
-      - gem nexus --url https://nexus.tooling.dvla.gov.uk/repository/gem-private/ parallel_report_portal*gem
-    when:
-      branch:
-        - master