rpruby 1.2 → 1.2.1

data/lib/rpruby/tasks.rb

@@ -0,0 +1,27 @@
+require 'rake'
+require 'pathname'
+require 'tempfile'
+require_relative '../rpruby'
+
+namespace :rpruby do
+  desc 'Start launch in Report Portal and print its id to $stdout (for use with attach_to_launch formatter mode)'
+  task :start_launch do
+    description = ENV['description'] || Rpruby::Settings.instance.description
+    file_to_write_launch_id = ENV['file_for_launch_id'] || Rpruby::Settings.instance.file_with_launch_id
+    file_to_write_launch_id ||= Pathname(Dir.tmpdir) + 'rp_launch_id.tmp'
+    launch_id = Rpruby.start_launch(description)
+    File.write(file_to_write_launch_id, launch_id)
+    puts launch_id
+  end
+
+  desc 'Finish launch in Report Portal (for use with attach_to_launch formatter mode)'
+  task :finish_launch do
+    launch_id = ENV['launch_id'] || Rpruby::Settings.instance.launch_id
+    file_with_launch_id = ENV['file_with_launch_id'] || Rpruby::Settings.instance.file_with_launch_id
+    puts "Launch id isn't provided. Provide it either via RP_LAUNCH_ID or RP_FILE_WITH_LAUNCH_ID environment variables" if !launch_id && !file_with_launch_id
+    puts 'Both RP_LAUNCH_ID and RP_FILE_WITH_LAUNCH_ID are provided via environment variables' if launch_id && file_with_launch_id
+    Rpruby.launch_id = launch_id || File.read(file_with_launch_id)
+    Rpruby.close_child_items(nil)
+    Rpruby.finish_launch
+  end
+end

data/lib/rpruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rpruby
+  VERSION = '1.2.1'.freeze
+end

data/lib/rpruby.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+require 'base64'
+require 'cgi'
+require 'http'
+require 'json'
+require 'mime/types'
+require 'pathname'
+require 'tempfile'
+require 'uri'
+
+require_relative 'rpruby/event_bus'
+require_relative 'rpruby/models/item_search_options'
+require_relative 'rpruby/models/test_item'
+require_relative 'rpruby/settings'
+require_relative 'rpruby/http_client'
+require_relative "rpruby/version"
+
+module Rpruby
+  class Error < StandardError; end
+  LOG_LEVELS = { error: 'ERROR', warn: 'WARN', info: 'INFO', debug: 'DEBUG', trace: 'TRACE', fatal: 'FATAL', unknown: 'UNKNOWN' }.freeze
+
+  class << self
+    attr_accessor :launch_id, :current_scenario
+
+    def now
+      (current_time.to_f * 1000).to_i
+    end
+
+    def status_to_level(status)
+      case status
+      when :passed
+        LOG_LEVELS[:info]
+      when :failed, :undefined, :pending, :error
+        LOG_LEVELS[:error]
+      when :skipped
+        LOG_LEVELS[:warn]
+      else
+        LOG_LEVELS.fetch(status, LOG_LEVELS[:info])
+      end
+    end
+
+    def start_launch(description, start_time = now)
+      required_data = { name: Settings.instance.launch, start_time: start_time, description:
+          description, mode: Settings.instance.launch_mode }
+      data = prepare_options(required_data, Settings.instance)
+      @launch_id = send_request(:post, 'launch', json: data)['id']
+    end
+
+    def finish_launch(end_time = now)
+      data = { end_time: end_time }
+      send_request(:put, "launch/#{@launch_id}/finish", json: data)
+    end
+
+    def start_item(item_node)
+      path = 'item'
+      path += "/#{item_node.parent.content.id}" unless item_node.parent&.is_root?
+      item = item_node.content
+      data = { start_time: item.start_time, name: item.name[0, 255], type: item.type.to_s, launch_id: @launch_id, description: item.description }
+      data[:tags] = item.tags unless item.tags.empty?
+      event_bus.broadcast(:prepare_start_item_request, request_data: data)
+      send_request(:post, path, json: data)['id']
+    end
+
+    def finish_item(item, status = nil, end_time = nil, force_issue = nil)
+      unless item.nil? || item.id.nil? || item.closed
+        data = { end_time: end_time.nil? ? now : end_time }
+        data[:status] = status unless status.nil?
+        if force_issue && status != :passed # TODO: check for :passed status is probably not needed
+          data[:issue] = { issue_type: 'AUTOMATION_BUG', comment: force_issue.to_s }
+        elsif status == :skipped
+          data[:issue] = { issue_type: 'NOT_ISSUE' }
+        end
+        send_request(:put, "item/#{item.id}", json: data)
+        item.closed = true
+      end
+    end
+
+    # TODO: implement force finish
+
+    def send_log(status, message, time)
+      unless @current_scenario.nil? || @current_scenario.closed # it can be nil if scenario outline in expand mode is executed
+        data = { item_id: @current_scenario.id, time: time, level: status_to_level(status), message: message.to_s }
+        send_request(:post, 'log', json: data)
+      end
+    end
+
+    def send_file(status, path_or_src, label = nil, time = now, mime_type = 'image/png')
+      str_without_nils = path_or_src.to_s.gsub("\0", '') # file? does not allow NULLs inside the string
+      if File.file?(str_without_nils)
+        send_file_from_path(status, path_or_src, label, time, mime_type)
+      else
+        if mime_type =~ /;base64$/
+          mime_type = mime_type[0..-8]
+          path_or_src = Base64.decode64(path_or_src)
+        end
+        extension = ".#{MIME::Types[mime_type].first.extensions.first}"
+        Tempfile.open(['report_portal', extension]) do |tempfile|
+          tempfile.binmode
+          tempfile.write(path_or_src)
+          tempfile.rewind
+          send_file_from_path(status, tempfile.path, label, time, mime_type)
+        end
+      end
+    end
+
+    # @option options [Hash] options, see ReportPortal::ItemSearchOptions
+    def get_items(filter_options = {})
+      page_size = 100
+      max_pages = 100
+      all_items = []
+      1.step.each do |page_number|
+        raise 'Too many pages with the results were returned' if page_number > max_pages
+
+        options = ItemSearchOptions.new({ page_size: page_size, page_number: page_number }.merge(filter_options))
+        page_items = send_request(:get, 'item', params: options.query_params)['content'].map do |item_params|
+          TestItem.new(item_params)
+        end
+        all_items += page_items
+        break if page_items.size < page_size
+      end
+      all_items
+    end
+
+    # @param item_ids [Array<String>] an array of items to remove (represented by ids)
+    def delete_items(item_ids)
+      send_request(:delete, 'item', params: { ids: item_ids })
+    end
+
+    # needed for parallel formatter
+    def item_id_of(name, parent_node)
+      path = if parent_node.is_root? # folder without parent folder
+               "item?filter.eq.launch=#{@launch_id}&filter.eq.name=#{CGI.escape(name)}&filter.size.path=0"
+             else
+               "item?filter.eq.parent=#{parent_node.content.id}&filter.eq.name=#{CGI.escape(name)}"
+             end
+      data = send_request(:get, path)
+      if data.key? 'content'
+        data['content'].empty? ? nil : data['content'][0]['id']
+      end
+    end
+
+    # needed for parallel formatter
+    def launch_id_to_number()
+      path = "launch/#{@launch_id}"
+      data = send_request(:get, path)
+      data['id']
+    end
+
+    # needed for parallel formatter
+    def close_child_items(parent_id)
+      path = if parent_id.nil?
+               "item?filter.eq.launchId=#{launch_id_to_number}"
+             else
+               "item?filter.eq.parent=#{parent_id}&page.page=1&page.size=100"
+             end
+      ids = []
+      loop do
+        data = send_request(:get, path)
+        if data.key?('links')
+          link = data['links'].find { |i| i['rel'] == 'next' }
+          url = link.nil? ? nil : link['href']
+        else
+          url = nil
+        end
+        data['content'].each do |i|
+          ids << i['id'] if i['has_childs'] && i['status'] == 'IN_PROGRESS'
+        end
+        break if url.nil?
+      end
+
+      ids.each do |id|
+        close_child_items(id)
+        finish_item(TestItem.new(id: id))
+      end
+    end
+
+    # Registers an event. The proc will be called back with the event object.
+    def on_event(name, &proc)
+      event_bus.on(name, &proc)
+    end
+
+    private
+
+    def send_file_from_path(status, path, label, time, mime_type)
+      File.open(File.realpath(path), 'rb') do |file|
+        filename = File.basename(file)
+        json = [{ level: status_to_level(status), message: label || filename, item_id: @current_scenario.id, time: time, file: { name: filename } }]
+        form = {
+          json_request_part: HTTP::FormData::Part.new(JSON.dump(json), content_type: 'application/json'),
+          binary_part: HTTP::FormData::File.new(file, filename: filename, content_type: MIME::Types[mime_type].first.to_s)
+        }
+        send_request(:post, 'log', form: form)
+      end
+    end
+
+    def send_request(verb, path, options = {})
+      http_client.send_request(verb, path, options)
+    end
+
+    def http_client
+      @http_client ||= HttpClient.new
+    end
+
+    def current_time
+      # `now_without_mock_time` is provided by Timecop and returns a real, not mocked time
+      return Time.now_without_mock_time if Time.respond_to?(:now_without_mock_time)
+
+      Time.now
+    end
+
+    def event_bus
+      @event_bus ||= EventBus.new
+    end
+
+    def prepare_options(data, config = {})
+      if config.attributes
+        data[:attributes] = config.attributes
+      elsif (data[:tags] = config.tags)
+      end
+      data
+    end
+  end
+end

data/rpruby.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+# lib = File.expand_path('lib', __dir__)
+# $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative "lib/rpruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rpruby"
+  spec.version       = Rpruby::VERSION
+  spec.authors       = ["Jayachandra Konduru(JC)"]
+  spec.email         = ["jayak8390@gmail.com"]
+
+  spec.summary       = 'ReportPortal Ruby Client'
+  spec.description   = 'Cucumber and RSpec clients for EPAM ReportPortal system'
+  spec.homepage      = 'https://github.com/jaya-konduru/rpruby'
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_dependency('http')
+  spec.add_dependency('mime-types')
+  spec.add_dependency('rubytree')
+  spec.add_development_dependency('rubocop')
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rpruby
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: 1.2.1
 platform: ruby
 authors:
 - Jayachandra Konduru(JC)
@@ -69,10 +69,45 @@ dependencies:
 description: Cucumber and RSpec clients for EPAM ReportPortal system
 email:
 - jayak8390@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".DS_Store"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/report_portal.yaml.example
+- lib/rpruby.rb
+- lib/rpruby/cucumber/formatter.rb
+- lib/rpruby/cucumber/messagereport.rb
+- lib/rpruby/cucumber/parallel_formatter.rb
+- lib/rpruby/cucumber/parallel_report.rb
+- lib/rpruby/cucumber/report.rb
+- lib/rpruby/event_bus.rb
+- lib/rpruby/events/prepare_start_item_request.rb
+- lib/rpruby/http_client.rb
+- lib/rpruby/logging/log4r_outputter.rb
+- lib/rpruby/logging/logger.rb
+- lib/rpruby/logging/logging_appender.rb
+- lib/rpruby/models/item_search_options.rb
+- lib/rpruby/models/test_item.rb
+- lib/rpruby/rspec/formatter.rb
+- lib/rpruby/settings.rb
+- lib/rpruby/tasks.rb
+- lib/rpruby/version.rb
+- rpruby.gemspec
 homepage: https://github.com/jaya-konduru/rpruby
 licenses:
 - MIT