parallel_report_portal 2.0.0

data/lib/parallel_report_portal/file_utils.rb

@@ -0,0 +1,62 @@
+module ParallelReportPortal
+  # Common file handling methods
+  module FileUtils
+  
+    # Open a file with an exclusive lock and yield the open
+    # file to the block. If the system is unable to access the 
+    # file it will block until the lock is removed. This method
+    # guarantees that the lock will be removed.
+    # 
+    # @param [String] filename the name of the file to open
+    # @param [String] mode the mode to open the file with (e.g. +r+, +w++)
+    # @yieldparam [File] file the opened file
+    def file_open_exlock_and_block(filename, mode, &block)
+      file = File.new(filename, mode)
+      begin
+        file.flock(File::LOCK_EX)
+        yield(file) if block_given?
+      ensure
+        file.flock(File::LOCK_UN)
+        file.close
+      end
+    end
+    
+    # Attempts to determin if the current environment is running under a
+    # parallel testing environment
+    # 
+    # @return [Boolean] true if parallel
+    def parallel?
+      !ENV['PARALLEL_PID_FILE'].nil?
+    end
+  
+    # Returns a pathname for the pid for this launch, initialising if necesssary.
+    # 
+    # @return [Pathname] the pid pathname
+    def launch_id_file
+      @lock_file ||= Pathname(Dir.tmpdir) + ("report_portal_tracking_file_#{pid}.lck")
+    end
+    
+    # Returns a pathname for the hierarchy of this launch, initialising if necesssary.
+    # 
+    # @return [Pathname] the hierarchy pathname
+    def hierarchy_file
+      @hierarchy_file ||= Pathname(Dir.tmpdir) + ("report_portal_hierarchy_file_#{pid}.lck")
+    end
+    
+    # Gets the pid of this process or the parent pid if running in parallel mode.
+    # 
+    # @return [Integer] the pid
+    def pid
+      pid = parallel? ? Process.ppid : Process.pid
+    end
+    
+    # Helper for deleting a file. It will not throw an exception
+    # if the file does not exist.
+    # 
+    # @param [String] the filename to delete
+    def delete_file(filename)
+      File.delete(filename) if File.exist?(filename)
+    end
+  
+  end
+end

data/lib/parallel_report_portal/http.rb

@@ -0,0 +1,228 @@
+require 'logger'
+require 'tempfile'
+
+module ParallelReportPortal
+  # A collection of methods for communicating with the ReportPortal 
+  # REST interface.
+  module HTTP
+
+    # Creating class level logger and setting log level
+    @@logger = Logger.new(STDOUT)
+    @@logger.level = Logger::ERROR
+
+    # 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}"
+    end
+
+    # 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(
+        url: url,
+        headers: {
+          'Content-Type' => 'application/json',
+          'Authorization' => authorization_header
+        }
+      ) do |f|
+        f.adapter :net_http_persistent, pool_size: 5 do |http|
+          http.idle_timeout = 100
+        end
+      end
+    end
+
+    # 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(
+        url: url,
+        headers: {
+          'Authorization' => authorization_header
+        }
+      ) do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter :net_http_persistent, pool_size: 5 do |http|
+          # yields Net::HTTP::Persistent
+          http.idle_timeout = 100
+        end
+      end
+    end
+
+    # Send a request to ReportPortal to start a launch.
+    # It will bubble up any Faraday connection exceptions.
+    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, 
+                mode: (ParallelReportPortal.configuration.debug ? 'DEBUG' : 'DEFAULT' ),
+                attributes: ParallelReportPortal.configuration.attributes
+              }.to_json
+            end
+      if resp.success?
+        JSON.parse(resp.body)['id']
+      else
+        @@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)
+      ParallelReportPortal.http_connection.put("launch/#{launch_id}/finish") do |req|
+        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
+                        feature.description.split("\n").map(&:strip).join(' ')
+                      else
+                        feature.file
+                      end
+
+        req_hierarchy(launch_id,
+                      "#{feature.keyword}: #{feature.name}",
+                      parent_id,
+                      'TEST',
+                      feature.tags.map(&:name),
+                      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'
+      resource += "/#{parent}" if parent
+      resp = ParallelReportPortal.http_connection.post(resource) do |req|
+        req.body = {
+          start_time: time,
+          name: name,
+          type: type,
+          launch_id: launch_id,
+          tags: tags,
+          description: description,
+          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|
+
+        keyword = if test_case.respond_to?(:feature)
+                    test_case.feature.keyword
+                  else
+                    test_case.keyword
+                  end
+        req.body = {
+          start_time: time,
+          tags: test_case.tags.map(&:name),
+          name: "#{keyword}: #{test_case.name}",
+          type: 'STEP',
+          launch_id: launch_id,
+          description: test_case.location.to_s,
+          attributes: test_case.tags
+        }.to_json
+      end
+      if resp.success?
+        @test_case_id = JSON.parse(resp.body)['id'] if resp.success?
+      else
+        @@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|
+        req.body = {
+          end_time: time,
+          status: status
+        }.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|
+        req.body = {
+          item_id: test_case_id,
+          message: detail,
+          level: level,
+          time: time,
+        }.to_json
+      end
+    end
+
+
+    # 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')
+      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 
+        # 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_file = Tempfile.new
+        json_file << [json].to_json
+        json_file.rewind
+
+        resp = http_multipart_connection.post("log") do |req|
+          req.body = {
+            json_request_part: Faraday::UploadIO.new(json_file, 'application/json'),
+            file: Faraday::UploadIO.new(file, mime_type)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/parallel_report_portal/version.rb

@@ -0,0 +1,3 @@
+module ParallelReportPortal
+  VERSION = "2.0.0"
+end

data/parallel_report_portal.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "parallel_report_portal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "parallel_report_portal"
+  spec.version       = ParallelReportPortal::VERSION
+  spec.authors       = ["Nigel Brookes-Thomas"]
+  spec.email         = ["nigel.brookes-thomas@dvla.gov.uk"]
+
+  spec.summary       = %q{Run Cucumber Tests in parallel and with Cucumber 3 and 4+}
+  spec.description   = %q{A Cucumber formatter which integrates with Report Portal and supports both the parallel_tests gem and cucumber-messages}
+  spec.homepage      = "https://github.com/dvla/dvla-reportportal-ruby"
+
+  spec.license     = 'MIT'
+
+  # spec.metadata["allowed_push_host"] = ""
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/dvla/dvla-reportportal-ruby"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+  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 'parallel_tests', '>= 2.29.1'
+  spec.add_runtime_dependency 'rubytree', '~> 1.0'
+  spec.add_runtime_dependency 'net-http-persistent', '~> 4.0'
+end

metadata

@@ -0,0 +1,241 @@
+--- !ruby/object:Gem::Specification
+name: parallel_report_portal
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Nigel Brookes-Thomas
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.29.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.29.1
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: A Cucumber formatter which integrates with Report Portal and supports
+  both the parallel_tests gem and cucumber-messages
+email:
+- nigel.brookes-thomas@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".drone.yml"
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- ParallelReportPortal.drawio
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/.bundle/config
+- gemfiles/cucumber_3.2.gemfile
+- gemfiles/cucumber_4.1.gemfile
+- gemfiles/cucumber_5.2.gemfile
+- gemfiles/cucumber_6.0.gemfile
+- lib/parallel_report_portal.rb
+- lib/parallel_report_portal/.DS_Store
+- lib/parallel_report_portal/clock.rb
+- lib/parallel_report_portal/configuration.rb
+- lib/parallel_report_portal/cucumber/formatter.rb
+- lib/parallel_report_portal/cucumber/report.rb
+- lib/parallel_report_portal/file_utils.rb
+- lib/parallel_report_portal/http.rb
+- lib/parallel_report_portal/version.rb
+- parallel_report_portal.gemspec
+homepage: https://github.com/dvla/dvla-reportportal-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dvla/dvla-reportportal-ruby
+  source_code_uri: https://github.com/dvla/dvla-reportportal-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Run Cucumber Tests in parallel and with Cucumber 3 and 4+
+test_files: []