parallel_report_portal 3.0.0 → 3.0.2.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdb8752fe04d7457a3333f818ee74af105d17f1cb32ae0c6ecd8daa897d11f7f
-  data.tar.gz: ef6b77445231d20740f515f046c35fd39266361fd6637b524958907c974b8014
+  metadata.gz: e1d5cb1312e5c4b45d5581eea41e02df63266535ee5e3b58412f5d9fde5fd0dd
+  data.tar.gz: a10beda80c2270a68c06ff13a18701cf1cd0734eae91bd0c81c37cf0ecfd0623
 SHA512:
-  metadata.gz: 19864c308420494e6dd7c0cd6321fc53aaafba70b1fe6d0ea0caf9957c69b308aaf9034e1c48551d4a06ae2580c827975489dcf6d22f5523d13c251bb966dce6
-  data.tar.gz: c70a9b840d9d9cb2e2b1ecb071d6b2ff65e5479faacdea9bcf2307cc4edde7d8f768e4cbde5d18fadd7e4d637ed2a50fe6ba0483031cb68bb869a4d34b521532
+  metadata.gz: aa2e9ce388cd7de1df78bbcd958c44f6bd329e8ebc7c40c0f550b5e79febd82b2a5913e141fc74f3e80206968f801c9e885539b7df2a4f5c06ae4508b9df11a6
+  data.tar.gz: 02b361da3143afa20ecd5d2111cd74fef9655b848a56174b2624d60193b2f2ee40b996ccd0dbf29abefa165e271836cac7a8c08bcab63a71d08a7c80306be85d

data/.github/workflows/deploy.yml

@@ -0,0 +1,44 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ 3.1, 3.2, 3.3 ]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake
+
+  deploy:
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        run: |
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.PARALLEL_RP_RUBYGEMS_AUTH_TOKEN }}

data/.github/workflows/tests.yml

@@ -7,7 +7,9 @@
 
 name: Ruby
 
-on: [push]
+on:
+  push:
+    branches-ignore: [ master ]
 
 jobs:
   test:
@@ -15,14 +17,16 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: [ 3.1, 3.2, 3.3 ]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
       - 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
+          bundler-cache: true
+
       - name: Run tests
         run: bundle exec rake

data/README.md

@@ -46,7 +46,7 @@ read_timeout: 60
 
 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).
 
-- `REPORT_PORTAL_API_KEY` - the API Key for this Report Portal instance which must be created in advance
+- `RP_API_KEY` - the API Key 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'

data/lib/parallel_report_portal/configuration.rb

@@ -14,7 +14,7 @@ module ParallelReportPortal
   #
   # == Environment variables
   #
-  # REPORT_PORTAL_API_KEY:: The API key required for authentication
+  # RP_API_KEY:: The API key required for authentication
   # 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
@@ -61,7 +61,7 @@ module ParallelReportPortal
     def initialize
       load_configuration_file
       ATTRIBUTES.each do |attr|
-        env_value = get_env("rp_#{attr.to_s}") || get_env("report_portal_#{attr.to_s}")
+        env_value = get_env("rp_#{attr.to_s}")
         send(:"#{attr}=", env_value) if env_value
       end
 
@@ -153,8 +153,6 @@ module ParallelReportPortal
           ATTRIBUTES.each do |attr|
             yaml_key = if yaml.has_key?("rp_#{attr}".to_sym)
                          "rp_#{attr}".to_sym
-                       elsif yaml.has_key?("report_portal_#{attr}".to_sym)
-                         "report_portal_#{attr}".to_sym
                        else
                          attr
                        end

data/lib/parallel_report_portal/cucumber/report.rb

@@ -23,11 +23,10 @@ module ParallelReportPortal
         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
@@ -38,7 +37,7 @@ module ParallelReportPortal
         end
       end
 
-      # Issued to start a launch. It is possilbe that this method could be called
+      # Issued to start a launch. It is possible 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
@@ -48,13 +47,13 @@ module ParallelReportPortal
       # @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|
+        ParallelReportPortal.file_open_exlock_and_block(ParallelReportPortal.launch_id_file, 'a+') do |file|
           if file.size == 0
             @launch_id = ParallelReportPortal.req_launch_started(start_time)
             file.write(@launch_id)
             file.flush
           else
-             @launch_id = file.readline
+            @launch_id = file.readline
           end
           @launch_id
         end
@@ -65,12 +64,8 @@ module ParallelReportPortal
       # @param clock [Integer] the millis from the epoch
       def launch_finished(clock)
         @tree.postordered_each do |node|
-          response = ParallelReportPortal.req_feature_finished(node.content, clock) unless node.is_root?
-          parse_report_link_from_response(response)
+          ParallelReportPortal.http_repeater { ParallelReportPortal.req_feature_finished(node.content, clock) } unless node.is_root?
         end
-        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.
@@ -114,7 +109,7 @@ module ParallelReportPortal
           if (using_cucumber_messages? ? test_step : step_source).multiline_arg.doc_string?
             detail << %(\n"""\n#{(using_cucumber_messages? ? test_step : step_source).multiline_arg.content}\n""")
           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"}
+            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)
@@ -155,13 +150,14 @@ module ParallelReportPortal
                           else
                             feature.location.file.split(File::SEPARATOR)
                           end
-        ParallelReportPortal.file_open_exlock_and_block(ParallelReportPortal.hierarchy_file, 'a+b' ) do |file|
+
+        ParallelReportPortal.file_open_exlock_and_block(ParallelReportPortal.hierarchy_file, 'a+b') do |file|
           @tree = Marshal.load(File.read(file)) if file.size > 0
           node = @tree.root
           path_components[0..-2].each do |component|
             next_node = node[component]
             unless next_node
-              id = ParallelReportPortal.req_hierarchy(launch_id, "Folder: #{component}", node.content, 'SUITE', [], nil, clock )
+              id = ParallelReportPortal.req_hierarchy(launch_id, "Folder: #{component}", node.content, 'SUITE', [], nil, clock)
               next_node = Tree::TreeNode.new(component, id)
               node << next_node
               node = next_node
@@ -219,7 +215,7 @@ module ParallelReportPortal
         if using_cucumber_messages?
           test_step.hook?
         else
-          ! test_step.source.last.respond_to?(:keyword)
+          !test_step.source.last.respond_to?(:keyword)
         end
       end
 
@@ -235,13 +231,6 @@ 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

@@ -1,12 +1,13 @@
 require 'logger'
 require 'tempfile'
-require 'pry'
 
 module ParallelReportPortal
   # A collection of methods for communicating with the ReportPortal
   # REST interface.
   module HTTP
 
+    class HTTPBadGatewayError < StandardError; end
+
     # Creating class level logger and setting log level
     @@logger = Logger.new(STDOUT)
     @@logger.level = Logger::ERROR
@@ -84,9 +85,6 @@ module ParallelReportPortal
               }.to_json
       end
 
-      pp "#########################"
-      pp resp
-
       if resp.success?
         JSON.parse(resp.body)['id']
       else
@@ -97,9 +95,30 @@ module ParallelReportPortal
     # 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)
-      ParallelReportPortal.http_connection.put("launch/#{launch_id}/finish") do |req|
+      @@logger.debug { "Launch finish with ID: '#{launch_id}'" }
+
+      response = ParallelReportPortal.http_connection.put("launch/#{launch_id}/finish") do |req|
         req.body = { end_time: time }.to_json
       end
+
+      @@logger.error { "Launch finish failed with response code #{response.status} -- message #{response.body}" } unless response.success?
+      response
+    end
+
+    def force_stop(launch_id, time)
+      resp = ParallelReportPortal.http_connection.put("launch/#{launch_id}/stop") do |req|
+        req.body = { end_time: time, status: :stopped }.to_json
+      end
+      @@logger.warn { "Failed to force stop: response code #{resp.status} -- message #{resp.body}" } unless resp.success?
+
+      resp
+    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
 
     # Send a request to ReportPortal to start a feature.
@@ -149,9 +168,14 @@ module ParallelReportPortal
 
     # 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|
+      response = ParallelReportPortal.http_connection.put("item/#{feature_id}") do |req|
         req.body = { end_time: time }.to_json
       end
+      @@logger.debug { "Feature finish with ID: '#{feature_id}'" }
+
+
+      @@logger.error { "Feature finish failed with response code #{response.status} -- message #{response.body}" } unless response.success?
+      response
     end
 
     # Send a request to ReportPortal to start a test case.
@@ -240,5 +264,23 @@ module ParallelReportPortal
         end
       end
     end
+
+
+
+    def http_repeater(&block)
+      tries = 0
+      begin
+        tries += 1
+        response = block.call
+        raise HTTPBadGatewayError if response && !response.success? && response.status == 502
+      rescue HTTPBadGatewayError => _e
+        if tries <= 3
+          sleep(1)
+          @@logger.warn { 'HTTP call failed, retrying...' }
+          retry
+        end
+      end
+      response
+    end
   end
 end

data/lib/parallel_report_portal/version.rb

@@ -1,3 +1,3 @@
 module ParallelReportPortal
-  VERSION = "3.0.0"
+  VERSION = "3.0.2.beta.1"
 end

data/lib/parallel_report_portal.rb

@@ -33,6 +33,11 @@ module ParallelReportPortal
     if ParallelReportPortal.parallel?
       if ParallelTests.first_process?
         ParallelTests.wait_for_other_processes_to_finish
+
+        launch_id = File.read(launch_id_file)
+        response = http_repeater { req_launch_finished(launch_id, clock) }
+        response.success? ? parse_report_link_from_response(response) : force_stop(launch_id, clock)
+
         delete_file(launch_id_file)
         delete_file(hierarchy_file)
       end

data/parallel_report_portal.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "appraisal", '~> 2.4'
   spec.add_development_dependency "bump", "~> 0.8"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "webmock", "~> 3.12"
@@ -41,6 +41,6 @@ Gem::Specification.new do |spec|
   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 'rubytree', '~> 2.0'
   spec.add_runtime_dependency 'net-http-persistent', '~> 4.0'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: parallel_report_portal
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2.beta.1
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Thomas Feathers
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -177,14 +177,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/deploy.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
@@ -240,7 +241,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/dvla/dvla-reportportal-ruby
   source_code_uri: https://github.com/dvla/dvla-reportportal-ruby
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -255,8 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
 summary: Run Cucumber Tests in parallel and with Cucumber 3 and 4+
 test_files: []