reportportal 0.7

data/lib/report_portal/patches/rest_client.rb

@@ -0,0 +1,63 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+# monkey-patch to temporarily solve the issue in https://github.com/rest-client/rest-client/pull/222
+module RestClient
+  module Payload
+    extend self
+    class Multipart < Base
+      def build_stream(params)
+        content_type = params.delete(:content_type)
+        b = '--' + boundary
+
+        @stream = Tempfile.new("RESTClient.Stream.#{rand(1000)}")
+        @stream.binmode
+        @stream.write(b + EOL)
+
+        case params
+        when Hash, ParamsArray
+          x = Utils.flatten_params(params)
+        else
+          x = params
+        end
+
+        last_index = x.length - 1
+        x.each_with_index do |a, index|
+          k, v = * a
+          if v.respond_to?(:read) && v.respond_to?(:path)
+            create_file_field(@stream, k, v)
+          else
+            create_regular_field(@stream, k, v, content_type)
+          end
+          @stream.write(EOL + b)
+          @stream.write(EOL) unless last_index == index
+        end
+        @stream.write('--')
+        @stream.write(EOL)
+        @stream.seek(0)
+      end
+
+      def create_regular_field(s, k, v, type = nil)
+        s.write("Content-Disposition: form-data; name=\"#{k}\"")
+        s.write("#{EOL}Content-Type: #{type}#{EOL}") if type
+        s.write(EOL)
+        s.write(v)
+      end
+    end
+  end
+end

data/lib/report_portal/rspec/formatter.rb

@@ -0,0 +1,130 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'securerandom'
+require 'tree'
+require 'rspec/core'
+
+require_relative '../../reportportal'
+
+# TODO: Screenshots
+# TODO: Logs
+module ReportPortal
+  module RSpec
+    class Formatter
+      MAX_DESCRIPTION_LENGTH = 255
+      MIN_DESCRIPTION_LENGTH = 3
+
+      ::RSpec::Core::Formatters.register self, :start, :example_group_started, :example_group_finished,
+                                               :example_started, :example_passed, :example_failed,
+                                               :example_pending, :message, :stop
+
+      def initialize(_output)
+        ENV['REPORT_PORTAL_USED'] = 'true'
+      end
+
+      def start(_start_notification)
+        cmd_args = ARGV.map { |arg| (arg.include? 'rp_uuid=')? 'rp_uuid=[FILTERED]' : arg }.join(' ')
+        ReportPortal.start_launch(cmd_args)
+        @root_node = Tree::TreeNode.new(SecureRandom.hex)
+        @current_group_node = @root_node
+      end
+
+      def example_group_started(group_notification)
+        description = group_notification.group.description
+        if description.size < MIN_DESCRIPTION_LENGTH
+          p "Group description should be at least #{MIN_DESCRIPTION_LENGTH} characters ('group_notification': #{group_notification.inspect})"
+          return
+        end
+        item = ReportPortal::TestItem.new(description[0..MAX_DESCRIPTION_LENGTH-1],
+                                          :TEST,
+                                          nil,
+                                          ReportPortal.now,
+                                          '',
+                                          false,
+                                          [])
+        group_node = Tree::TreeNode.new(SecureRandom.hex, item)
+        if group_node.nil?
+          p "Group node is nil for item #{item.inspect}"
+        else
+          @current_group_node << group_node unless @current_group_node.nil? # make @current_group_node parent of group_node
+          @current_group_node = group_node
+          group_node.content.id = ReportPortal.start_item(group_node)
+        end
+      end
+
+      def example_group_finished(_group_notification)
+        unless @current_group_node.nil?
+          ReportPortal.finish_item(@current_group_node.content)
+          @current_group_node = @current_group_node.parent
+        end
+      end
+
+      def example_started(notification)
+        description = notification.example.description
+        if description.size < MIN_DESCRIPTION_LENGTH
+          p "Example description should be at least #{MIN_DESCRIPTION_LENGTH} characters ('notification': #{notification.inspect})"
+          return
+        end
+        ReportPortal.current_scenario = ReportPortal::TestItem.new(description[0..MAX_DESCRIPTION_LENGTH-1],
+                                                                   :STEP,
+                                                                   nil,
+                                                                   ReportPortal.now,
+                                                                   '',
+                                                                   false,
+                                                                   [])
+        example_node = Tree::TreeNode.new(SecureRandom.hex, ReportPortal.current_scenario)
+        if example_node.nil?
+          p "Example node is nil for scenario #{ReportPortal.current_scenario.inspect}"
+        else
+          @current_group_node << example_node
+          example_node.content.id = ReportPortal.start_item(example_node)
+        end
+      end
+
+      def example_passed(_notification)
+        ReportPortal.finish_item(ReportPortal.current_scenario, :passed) unless ReportPortal.current_scenario.nil?
+        ReportPortal.current_scenario = nil
+      end
+
+      def example_failed(notification)
+        exception = notification.exception
+        ReportPortal.send_log(:failed, %(#{exception.class}: #{exception.message}\n\nStacktrace: #{notification.formatted_backtrace.join("\n")}), ReportPortal.now)
+        ReportPortal.finish_item(ReportPortal.current_scenario, :failed) unless ReportPortal.current_scenario.nil?
+        ReportPortal.current_scenario = nil
+      end
+
+      def example_pending(_notification)
+        ReportPortal.finish_item(ReportPortal.current_scenario, :skipped) unless ReportPortal.current_scenario.nil?
+        ReportPortal.current_scenario = nil
+      end
+
+      def message(notification)
+        if notification.message.respond_to?(:read)
+          ReportPortal.send_file(:passed, notification.message)
+        else
+          ReportPortal.send_log(:passed, notification.message, ReportPortal.now)
+        end
+      end
+
+      def stop(_notification)
+        ReportPortal.finish_launch
+      end
+    end
+  end
+end

data/lib/report_portal/settings.rb

@@ -0,0 +1,76 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+require 'singleton'
+
+module ReportPortal
+  class Settings
+    include Singleton
+
+    PREFIX = 'rp_'
+
+    def initialize
+      filename = ENV.fetch("#{PREFIX}config") do
+        glob = Dir.glob('{,.config/,config/}report{,-,_}portal{.yml,.yaml}')
+        p "Multiple configuration files found for ReportPortal. Using the first one: #{glob.first}" if glob.size > 1
+        glob.first
+      end
+
+      @properties = filename.nil? ? {} : YAML.load_file(filename)
+      keys = {
+        'uuid' => true,
+        'endpoint' => true,
+        'project' => true,
+        'launch' => true,
+        'description' => false,
+        'tags' => false,
+        'is_debug' => false,
+        'disable_ssl_verification' => false,
+        # for parallel execution only
+        'use_standard_logger' => false,
+        'launch_id' => false,
+        'file_with_launch_id' => false,
+      }
+
+      keys.each do |key, is_required|
+        define_singleton_method(key.to_sym) { setting(key) }
+        fail "ReportPortal: Define environment variable '#{PREFIX}#{key}' or key #{key} in the configuration YAML file" if is_required && public_send(key).nil?
+      end
+    end
+
+    def launch_mode
+      is_debug ? 'DEBUG' : 'DEFAULT'
+    end
+
+    def formatter_modes
+      setting('formatter_modes') || []
+    end
+
+    def project_url
+      "#{endpoint}/#{project}"
+    end
+
+    private
+
+    def setting(key)
+      pkey = PREFIX + key
+      ENV.key?(pkey) ? YAML.load(ENV[pkey]) : @properties[key]
+    end
+  end
+end

data/lib/report_portal/tasks.rb

@@ -0,0 +1,44 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rake'
+require 'pathname'
+require 'tempfile'
+require_relative '../reportportal'
+
+namespace :reportportal do
+  desc 'Start launch in Report Portal and print its id to $stdout (needed for use with ReportPortal::Cucumber::AttachToLaunchFormatter)'
+  task :start_launch do
+    description = ENV['description']
+    file_to_write_launch_id = ENV.fetch('file_for_launch_id') { Pathname(Dir.tmpdir) + 'rp_launch_id.tmp' }
+    launch_id = ReportPortal.start_launch(description)
+    File.write(file_to_write_launch_id, launch_id)
+    puts launch_id
+  end
+
+  desc 'Finish launch in Report Portal (needed for use with ReportPortal::Cucumber::AttachToLaunchFormatter)'
+  task :finish_launch do
+    launch_id = ENV['launch_id']
+    file_with_launch_id = ENV['file_with_launch_id']
+    puts "Launch id isn't provided. Provide it either via launch_id or file_with_launch_id environment variables" if !launch_id && !file_with_launch_id
+    puts "Both launch_id and file_with_launch_id are present in environment variables" if launch_id && file_with_launch_id
+    ReportPortal.launch_id = launch_id || File.read(file_with_launch_id)
+    ReportPortal.close_child_items(nil)
+    ReportPortal.finish_launch
+  end
+end

data/lib/report_portal/version.rb

@@ -0,0 +1,21 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+module ReportPortal
+  VERSION = '0.7'
+end

data/lib/reportportal.rb

@@ -0,0 +1,208 @@
+# Copyright 2015 EPAM Systems
+# 
+# 
+# This file is part of Report Portal.
+# 
+# Report Portal is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ReportPortal is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Report Portal.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'json'
+require 'rest_client'
+require 'uri'
+require 'pathname'
+require 'tempfile'
+
+require_relative 'report_portal/settings'
+require_relative 'report_portal/patches/rest_client'
+
+module ReportPortal
+  TestItem = Struct.new(:name, :type, :id, :start_time, :description, :closed, :tags)
+  LOG_LEVELS = { error: 'ERROR', warn: 'WARN', info: 'INFO', debug: 'DEBUG', trace: 'TRACE', fatal: 'FATAL', unknown: 'UNKNOWN' }
+
+  @response_handler = proc do |response, request, result, &block|
+    if (200..207).include? response.code
+      response
+    else
+      p "ReportPortal API returned #{response}"
+      p "Offending request method/URL: #{request.args[:method].upcase} #{request.args[:url]}"
+      p "Offending request payload: #{request.args[:payload]}}"
+      response.return!(request, result, &block)
+    end
+  end
+
+  class << self
+    attr_accessor :launch_id, :current_scenario
+
+    def now
+      (Time.now.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)
+      url = "#{Settings.instance.project_url}/launch"
+      data = { name: Settings.instance.launch, start_time: start_time, tags: Settings.instance.tags, description: description, mode: Settings.instance.launch_mode }
+      @launch_id = do_request(url) do |resource|
+        JSON.parse(resource.post(data.to_json, content_type: :json, &@response_handler))['id']
+      end
+    end
+
+    def finish_launch(end_time = now)
+      url = "#{Settings.instance.project_url}/launch/#{@launch_id}/finish"
+      data = { end_time: end_time }
+      do_request(url) do |resource|
+        resource.put data.to_json, content_type: :json, &@response_handler
+      end
+    end
+
+    def start_item(item_node)
+      url = "#{Settings.instance.project_url}/item"
+      url += "/#{item_node.parent.content.id}" unless item_node.parent && 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?
+      do_request(url) do |resource|
+        JSON.parse(resource.post(data.to_json, content_type: :json, &@response_handler))['id']
+      end
+    end
+
+    def finish_item(item, status = nil, end_time = nil, force_issue = nil)
+      unless item.nil? || item.id.nil? || item.closed
+        url = "#{Settings.instance.project_url}/item/#{item.id}"
+        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
+        do_request(url) do |resource|
+          resource.put data.to_json, content_type: :json, &@response_handler
+        end
+        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
+        url = "#{Settings.instance.project_url}/log"
+        data = { item_id: @current_scenario.id, time: time, level: status_to_level(status), message: message.to_s }
+        do_request(url) do |resource|
+          resource.post(data.to_json, content_type: :json, &@response_handler)
+        end
+      end
+    end
+
+    def send_file(status, path, label = nil, time = now, mime_type='image/png')
+      url = "#{Settings.instance.project_url}/log"
+      unless File.file?(path)
+        extension = ".#{MIME::Types[mime_type].first.extensions.first}"
+        temp = Tempfile.open(['file',extension])
+        temp.binmode
+        temp.write(Base64.decode64(path))
+        temp.rewind
+        path = temp
+      end
+      File.open(File.realpath(path), 'rb') do |file|
+        label ||= File.basename(file)
+        json = { level: status_to_level(status), message: label, item_id: @current_scenario.id, time: time, file: { name: File.basename(file) } }
+        data = { :json_request_part => [json].to_json, label => file, :multipart => true, :content_type => 'application/json' }
+        do_request(url) do |resource|
+          resource.post(data, { content_type: 'multipart/form-data' }, &@response_handler)
+        end
+      end
+    end
+
+    # needed for parallel formatter
+    def item_id_of(name, parent_node)
+      if parent_node.is_root? # folder without parent folder
+        url = "#{Settings.instance.project_url}/item?filter.eq.launch=#{@launch_id}&filter.eq.name=#{URI.escape(name)}&filter.size.path=0"
+      else
+        url = "#{Settings.instance.project_url}/item?filter.eq.parent=#{parent_node.content.id}&filter.eq.name=#{URI.escape(name)}"
+      end
+      do_request(url) do |resource|
+        data = JSON.parse(resource.get)
+        if data.key? 'content'
+          data['content'].empty? ? nil : data['content'][0]['id']
+        else
+          nil # item isn't started yet
+        end
+      end
+    end
+
+    # needed for parallel formatter
+    def close_child_items(parent_id)
+      if parent_id.nil?
+        url = "#{Settings.instance.project_url}/item?filter.eq.launch=#{@launch_id}&filter.size.path=0&page.page=1&page.size=100"
+      else
+        url = "#{Settings.instance.project_url}/item?filter.eq.parent=#{parent_id}&page.page=1&page.size=100"
+      end
+      ids = []
+      loop do
+        response = do_request(url) { |r| JSON.parse(r.get) }
+        if response.key?('links')
+          link = response['links'].find { |i| i['rel'] == 'next' }
+          url = link.nil? ? nil : link['href']
+        else
+          url = nil
+        end
+        response['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)
+        # temporary, we actually only need the id
+        finish_item(TestItem.new(nil, nil, id, nil, nil, nil, nil))
+      end
+    end
+
+    private
+
+    def create_resource(url)
+      props = { :headers => {:Authorization => "Bearer #{Settings.instance.uuid}"}}
+      verify_ssl = Settings.instance.disable_ssl_verification
+      props[:verify_ssl] = !verify_ssl unless verify_ssl.nil?
+      RestClient::Resource.new url, props
+    end
+
+    def do_request(url)
+      resource = create_resource(url)
+      tries = 3
+      begin
+        yield resource
+      rescue
+        p "Request to #{url} produced an exception: #{$!.class}: #{$!}"
+        $!.backtrace.each { |l| p l }
+        retry unless (tries -= 1).zero?
+        p "Failed to execute request to #{url} after 3 attempts."
+        nil
+      end
+    end
+  end
+end