parallel_report_portal 2.0.1 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e7791266b8182c87f0456af3f5a473d9757290a0d7c753753db088413aec9d5
-  data.tar.gz: c96a4e60af404fc80d9fa8427b2cc6dd1080871f1cdc9873c3834d0c7f3b59f2
+  metadata.gz: 10a0ede4e1da6f5fc4788775483996e7ecf4a21009b06bfbbec5b49593c623bc
+  data.tar.gz: 8a0f3966ac4134f96e4a18e42e4b779943425d5d7cf9947dfc6afa10ee376859
 SHA512:
-  metadata.gz: a2ce25379d17872648ce74db6b68f12d4e799d0c18b2eccf03d49a0ee8b14a9ecd7d30f02652667598687f26afa03d2c138ceb2988ac461ce223465019d2f91c
-  data.tar.gz: 91ad9f32747f427aefc47d29f751efd422fb300836fe054b6bb5e7965ffa430b272eb928d6661b490efecba2b3916262f57c81477a1fb9a5685936148c595af9
+  metadata.gz: 380772393a3450a86df43444caa69e09b93d5b9b88a66ea658adc0baac40b064fe74e299cdec0dbf99c299a295c2d550914040ae87a65d82458c801e9f94ca2d
+  data.tar.gz: 5950fe72eb47bf2c195621d94faac14cfbb7a17b73aeae16f02a952b01a475f86e6a0901a8113ad7f00dd9d5081f5b162fd51266424cf5b7d6070b65162d3a5c

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/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/cucumber/report.rb

@@ -175,7 +175,12 @@ module ParallelReportPortal
 
       def lookup_test_case(test_case)
         if using_cucumber_messages?
-          @ast_lookup.scenario_source(test_case).scenario
+          sc = @ast_lookup.scenario_source(test_case)
+          if sc.respond_to?(:scenario)
+            @ast_lookup.scenario_source(test_case).scenario
+          else
+            @ast_lookup.scenario_source(test_case).scenario_outline
+          end
         else
           test_case
         end

data/lib/parallel_report_portal/http.rb

@@ -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
@@ -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
@@ -162,7 +166,7 @@ module ParallelReportPortal
           name: "#{keyword}: #{test_case.name}",
           type: 'STEP',
           launch_id: launch_id,
-          description: test_case.location.to_s,
+          description: test_case.description,
           attributes: test_case.tags.map(&:name)
         }.to_json
       end

data/lib/parallel_report_portal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_report_portal
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -187,12 +187,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".drone.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - Appraisals
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - ParallelReportPortal.drawio
 - README.md
@@ -235,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.2.3
 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

data/Gemfile.lock

@@ -1,148 +0,0 @@
-PATH
-  remote: .
-  specs:
-    parallel_report_portal (2.0.1)
-      cucumber (>= 3.2)
-      faraday (~> 1.0)
-      net-http-persistent (~> 4.0)
-      parallel_tests (>= 2.29.1)
-      rubytree (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.1.3.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    appraisal (2.4.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    builder (3.2.4)
-    bump (0.10.0)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.8)
-    connection_pool (2.2.5)
-    crack (0.4.5)
-      rexml
-    cucumber (6.0.0)
-      builder (~> 3.2, >= 3.2.4)
-      cucumber-core (~> 9.0, >= 9.0.0)
-      cucumber-create-meta (~> 4.0, >= 4.0.0)
-      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
-      cucumber-gherkin (~> 18.1, >= 18.1.0)
-      cucumber-html-formatter (~> 13.0, >= 13.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-      cucumber-wire (~> 5.0, >= 5.0.0)
-      diff-lcs (~> 1.4, >= 1.4.4)
-      mime-types (~> 3.3, >= 3.3.1)
-      multi_test (~> 0.1, >= 0.1.2)
-      sys-uname (~> 1.2, >= 1.2.2)
-    cucumber-core (9.0.0)
-      cucumber-gherkin (~> 18.1, >= 18.1.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-      cucumber-tag-expressions (~> 3.0, >= 3.0.1)
-    cucumber-create-meta (4.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-      sys-uname (~> 1.2, >= 1.2.2)
-    cucumber-cucumber-expressions (12.1.1)
-    cucumber-gherkin (18.1.1)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    cucumber-html-formatter (13.0.0)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    cucumber-messages (15.0.0)
-      protobuf-cucumber (~> 3.10, >= 3.10.8)
-    cucumber-tag-expressions (3.0.1)
-    cucumber-wire (5.0.0)
-      cucumber-core (~> 9.0, >= 9.0.0)
-      cucumber-cucumber-expressions (~> 12.1, >= 12.1.1)
-      cucumber-messages (~> 15.0, >= 15.0.0)
-    diff-lcs (1.4.4)
-    faraday (1.4.1)
-      faraday-excon (~> 1.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-excon (1.1.0)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.1.0)
-    ffi (1.15.0)
-    hashdiff (1.0.1)
-    i18n (1.8.10)
-      concurrent-ruby (~> 1.0)
-    json (2.5.1)
-    method_source (1.0.0)
-    middleware (0.1.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    minitest (5.14.4)
-    multi_test (0.1.2)
-    multipart-post (2.1.1)
-    net-http-persistent (4.0.1)
-      connection_pool (~> 2.2)
-    parallel (1.20.1)
-    parallel_tests (3.7.0)
-      parallel
-    protobuf-cucumber (3.10.8)
-      activesupport (>= 3.2)
-      middleware
-      thor
-      thread_safe
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    public_suffix (4.0.6)
-    rake (10.5.0)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    ruby2_keywords (0.0.4)
-    rubytree (1.0.0)
-      json (~> 2.1)
-      structured_warnings (~> 0.3)
-    structured_warnings (0.4.0)
-    sys-uname (1.2.2)
-      ffi (~> 1.1)
-    thor (1.1.0)
-    thread_safe (0.3.6)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    webmock (3.12.2)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal (~> 2.4)
-  bump (~> 0.8)
-  bundler (~> 2.0)
-  parallel_report_portal!
-  pry (~> 0.12)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  webmock (~> 3.12)
-
-BUNDLED WITH
-   2.1.4