qat-reporter-xray 6.0.0

data/lib/qat/cucumber/core_ext/result.rb

@@ -0,0 +1,16 @@
+require 'cucumber/core/test/result'
+
+#Patch for Cucumber::Core::Test::Result::Unknown to implement methods used by the formatters
+#@since 1.1.0
+class Cucumber::Core::Test::Result::Unknown
+
+  #Dummy function
+  def with_appended_backtrace(_)
+    ''
+  end
+
+  #Dummy function
+  def with_filtered_backtrace(_)
+    ''
+  end
+end

data/lib/qat/cucumber/core_ext.rb

@@ -0,0 +1,3 @@
+require_relative 'core_ext/result'
+require_relative 'core_ext/formatter/html'
+require_relative 'core_ext/formatter/junit'

data/lib/qat/formatter/xray/test_ids.rb

@@ -0,0 +1,96 @@
+require 'cucumber/formatter/io'
+require 'json'
+
+module QAT
+  module Formatter
+    class Xray
+      class TestIds
+        include Cucumber::Formatter::Io
+
+        def initialize(runtime, path_or_io, options)
+          @io                 = ensure_io(path_or_io)
+          @tags               = []
+          @scenario_tags      = []
+          @no_test_id         = {}
+          @max_test_id        = 0
+          @duplicate_test_ids = {}
+          @test_id_mapping    = {}
+          @options            = options
+        end
+
+        def before_feature(feature)
+          @in_scenarios = false
+        end
+
+        def tag_name(tag_name)
+          @scenario_tags << tag_name if @in_scenarios
+        end
+
+        def after_tags(tags)
+          @in_scenarios = true unless @in_scenarios
+        end
+
+        def scenario_name(keyword, name, file_colon_line, source_indent)
+          if @scenario_tags.any? { |tag| tag.match(/@id:(\d+)/) }
+            id           = @scenario_tags.map { |tag| tag.match(/@id:(\d+)/) }.compact.first.captures.first.to_i
+            @max_test_id = id if id > @max_test_id
+
+            test_id_info = { name: name,
+                             path: file_colon_line }
+
+            if @test_id_mapping[id]
+              if @duplicate_test_ids[id]
+                @duplicate_test_ids[id] << test_id_info
+              else
+                @duplicate_test_ids[id] = [@test_id_mapping[id], test_id_info]
+              end
+            else
+              @test_id_mapping[id] = test_id_info
+            end
+
+          else
+            @no_test_id[name] = file_colon_line unless @scenario_tags.include?('@dummy_test')
+          end
+          @scenario_tags = []
+        end
+
+        def after_features(features)
+          publish_result
+          @io.flush
+        end
+
+        private
+
+        def publish_result
+          content = {
+            max:       @max_test_id,
+            untagged:  @no_test_id,
+            mapping:   Hash[@test_id_mapping.sort],
+            duplicate: Hash[@duplicate_test_ids.sort]
+          }
+
+          if @duplicate_test_ids.any?
+            dups_info = @duplicate_test_ids.map do |id, dups|
+              text = dups.map { |dup| "Scenario: #{dup[:name]} - #{dup[:path]}" }.join("\n")
+              "TEST ID #{id}:\n#{text}\n"
+            end
+
+            duplicates_info = <<-TXT.gsub(/^\s*/, '')
+          ------------------------------------
+          Duplicate test ids found!
+          ------------------------------------
+          #{dups_info.join("\n")}
+            TXT
+            puts duplicates_info
+          end
+
+          @io.puts(content.to_json({
+                                     indent:    ' ',
+                                     space:     ' ',
+                                     object_nl: "\n"
+                                   }))
+        end
+      end
+    end
+  end
+end

data/lib/qat/formatter/xray.rb

@@ -0,0 +1,186 @@
+require 'cucumber/formatter/io'
+require 'json'
+require 'fileutils'
+require 'qat/logger'
+require 'time'
+require 'base64'
+require_relative '../reporter/xray/config'
+require_relative '../reporter/xray/test_execution'
+
+module QAT
+  # Namespace for custom Cucumber formatters and helpers.
+  #@since 0.1.0
+  module Formatter
+    # Namespace for Xray formatter
+    #@since 1.0.0
+    class Xray
+      include ::Cucumber::Formatter::Io
+      include QAT::Logger
+
+      #@api private
+      def initialize(runtime, path_or_io, options)
+        @io      = ensure_io(path_or_io)
+        @options = options
+        @tests   = []
+      end
+
+      #@api private
+      def tag_name(tag_name)
+        @test_jira_id = tag_name.to_s.split('_')[1] if tag_name.match(test_tag_regex)
+      end
+
+      #@api private
+      def before_test_case(test_case)
+        @current_scenario = test_case.source[1]
+
+        @exception = nil
+
+        @start_time   = Time.now
+        @evidences    = []
+        @file_counter = 0
+      end
+
+      #@api private
+      def after_test_case(_, status)
+        # When jira type is cloud the test result string must be different (accordingly with xray api)
+        test_status = if status.is_a? ::Cucumber::Core::Test::Result::Passed
+                        jira_type == 'cloud' ? 'PASSED' : 'PASS'
+                      elsif status.is_a? ::Cucumber::Core::Test::Result::Failed
+                        jira_type == 'cloud' ? 'FAILED' : 'FAIL'
+                      else
+                        'NO RUN'
+                      end
+
+        @end_time = Time.now
+
+        comment = status.respond_to?(:exception) ? build_exception(status.exception) : ''
+
+        log.warn 'Jira ID is not defined!' unless @test_jira_id
+        if @current_scenario.is_a? ::Cucumber::Core::Ast::ScenarioOutline
+          save_current_scenario_outline(test_status, comment)
+        else
+          save_current_scenario(test_status, comment)
+        end
+
+      end
+
+      #@api private
+      def after_features(*_)
+        publish_result
+      end
+
+      def embed(src, mime_type, label)
+
+
+        data = if File.file?(src)
+                 File.open(src) do |file|
+                   Base64.strict_encode64(file.read)
+                 end
+               elsif src =~ /^data:image\/(png|gif|jpg|jpeg);base64,/
+                 src
+               else
+                 Base64.strict_encode64(src)
+               end
+
+        ext = mime_type.split('/').last
+
+        file_name = if File.file?(src)
+                      File.basename(src)
+                    elsif label.to_s.empty?
+                      "file_#{@file_counter += 1}.#{ext}"
+                    else
+                      "#{label}.#{ext}"
+                    end
+
+        @evidences << { data: data, filename: file_name, contentType: mime_type }
+      end
+
+      private
+
+      def jira_type
+        QAT::Reporter::Xray::Config.jira_type
+      end
+
+      def test_prefix
+        QAT::Reporter::Xray::Config.test_prefix
+      end
+
+      def project_key
+        QAT::Reporter::Xray::Config.project_key
+      end
+
+      def test_tag_regex
+        /@#{test_prefix}(#{project_key}-\d+)/
+      end
+
+      def build_exception(exception)
+        "#{exception.message} (#{exception.class})\n#{exception.backtrace.join("\n")}"
+      end
+
+      def save_current_scenario(status, comment = '')
+        test_info             = {
+          testKey: @test_jira_id,
+          start:   @start_time.iso8601,
+          finish:  @end_time.iso8601,
+          comment: comment,
+          status:  status
+        }
+        test_info[:evidences] = @evidences unless @evidences.empty?
+        @tests << test_info
+      end
+
+      def save_current_scenario_outline(status, comment = '')
+        if @tests.any? { |test| test[:testKey] == @test_jira_id }
+          outline = @tests.select { |test| test[:testKey] == @test_jira_id }.first
+
+          outline[:finish] = @end_time.iso8601
+          unless outline[:status] == 'FAIL' || outline[:status] == 'FAILED'
+            outline[:status]  = status
+            outline[:comment] = comment
+          end
+          outline[:examples] << status
+
+          @tests.delete_if { |test| test[:testKey] == @test_jira_id }
+          @tests << outline
+        else
+          @tests << {
+            testKey:  @test_jira_id,
+            start:    @start_time.iso8601,
+            finish:   @end_time.iso8601,
+            comment:  comment,
+            status:   status,
+            examples: [
+                        status
+                      ]
+          }
+          if @tests.is_a? Array
+            @tests.first[:evidences] = @evidences unless @evidences.empty?
+          else
+            @tests[:evidences] = @evidences unless @evidences.empty?
+          end
+
+        end
+      end
+
+      # Writes results to a JSON file
+      def publish_result
+        content = {
+          tests: @tests
+        }
+        @io.puts(JSON.pretty_generate(content))
+
+        jira_id = ENV['XRAY_TEST_EXECUTION'].to_s
+
+        if jira_id.empty?
+          log.warn 'Importing Test results to a new Test Execution.'
+          jira_id = nil
+        else
+          log.info "Importing Test results to Test Execution '#{jira_id}'."
+        end
+
+        QAT::Reporter::Xray::TestExecution.new(jira_id).import_execution_results(content)
+
+      end
+    end
+  end
+end

data/lib/qat/reporter/xray/config.rb

@@ -0,0 +1,153 @@
+require_relative 'publisher'
+
+module QAT
+  module Reporter
+    class Xray
+      # QAT::Reporter::Xray configuration module
+      module Config
+        class << self
+
+          attr_accessor :project_key, :test_prefix, :story_prefix, :jira_url, :xray_default_api_url, :login_credentials, :publisher, :jira_type,
+                        :cloud_xray_api_credentials, :xray_test_environment, :xray_test_version, :xray_test_revision, :xray_export_test_keys, :xray_export_test_filter
+
+          # Default xray API url (Jira Cloud)
+          DEFAULT_XRAY_URL = 'https://xray.cloud.xpand-it.com'
+
+          # Default test tag prefix
+          DEFAULT_TEST_PREFIX = 'TEST_'
+          # Default story tag prefix
+          DEFAULT_STORY_PREFIX = 'STORY_'
+
+          # Returns the xray instanced type (hosted or cloud)
+          def jira_type
+            @jira_type
+          end
+
+          # Returns the jira url
+          def jira_url
+            @jira_url
+          end
+
+          # Returns the default xray jira url for cloud api
+          def xray_default_api_url
+            DEFAULT_XRAY_URL
+          end
+
+          # Returns the login credentials array could -> [username, password, apiToken]
+          def login_credentials
+            @login_credentials
+          end
+
+          # Returns the login credentials array for cloud api [client_id, client_secret]
+          def cloud_xray_api_credentials
+            @cloud_xray_api_credentials || nil
+          end
+
+          # Returns the test keys to export
+          def xray_export_test_keys
+            @keys || nil
+          end
+
+          # Returns the test filter to export
+          def xray_export_test_filter
+            @filter || nil
+          end
+
+          # Returns the project key value
+          def project_key
+            @project_key
+          end
+
+          # Returns the test tag prefix value
+          def test_prefix
+            @test_prefix || DEFAULT_TEST_PREFIX
+          end
+
+          # Returns the story tag prefix value
+          def story_prefix
+            @story_prefix || DEFAULT_STORY_PREFIX
+          end
+
+          # Returns the xray test environment value
+          def xray_test_environment
+            @xray_test_environment || get_env_from_qat_config
+          end
+
+          # Returns the xray test version value
+          def xray_test_version
+            @xray_test_version || get_version_from_qat_config
+          end
+
+          # Returns the xray test revision value
+          def xray_test_revision
+            @xray_test_revision || get_revision_from_qat_config
+          end
+
+          def publisher=(publisher)
+            @publisher = publisher
+          end
+
+          def publisher
+            @publisher
+          end
+
+
+          private
+
+          def get_env_from_qat_config
+            begin
+              QAT.configuration.dig(:xray, :environment_name)
+            rescue ArgumentError
+              raise(NoEnvironmentDefined, 'JIRA\'s environment must be defined!')
+            end
+          end
+
+          def get_version_from_qat_config
+            begin
+              QAT.configuration.dig(:xray, :version)
+            rescue ArgumentError
+              raise(NoVersionDefined, 'JIRA\'s version must be defined!')
+            end
+          end
+
+          def get_revision_from_qat_config
+            begin
+              QAT.configuration.dig(:xray, :revision)
+            rescue ArgumentError
+              raise(NoRevisionDefined, 'JIRA\'s revision must be defined!')
+            end
+          end
+
+          # Error returned when the QAT project has not defined the Jira Environment
+          class NoEnvironmentDefined < StandardError
+          end
+          # Error returned when the QAT project has not defined the Jira Version
+          class NoVersionDefined < StandardError
+          end
+          # Error returned when the QAT project has not defined the Jira Revision
+          class NoRevisionDefined < StandardError
+          end
+        end
+      end
+
+      class << self
+        # Configures the QAT::Formatter::Xray
+        def configure(&block)
+          yield Config
+
+          QAT::Reporter::Xray::Config.publisher = QAT::Reporter::Xray::Publisher.const_get(QAT::Reporter::Xray::Config.jira_type.capitalize).new
+
+          raise(ProjectKeyUndefinedError, 'JIRA\'s project key must be defined!') unless QAT::Reporter::Xray::Config.project_key
+          raise(LoginCredentialsUndefinedError, 'JIRA\'s login credentials must be defined!') unless QAT::Reporter::Xray::Config.login_credentials
+        end
+
+        # Error returned when the the JIRA project key is not defined
+        class ProjectKeyUndefinedError < StandardError
+        end
+        # Error returned when the the JIRA login credentials is not defined
+        class LoginCredentialsUndefinedError < StandardError
+        end
+      end
+    end
+  end
+end

data/lib/qat/reporter/xray/issue.rb

@@ -0,0 +1,46 @@
+require 'rest-client'
+require 'json'
+
+module QAT
+  module Reporter
+    class Xray
+      # QAT::Reporter::Xray::Issue represents an abstract Xray issue
+      class Issue
+
+        attr_reader :jira_id
+
+        # Initializes Xray Publisher url and login information
+        def initialize(jira_id = nil)
+          @jira_id = jira_id
+          if jira_id
+            raise(InvalidIssueType, "The given issue '#{jira_id}' type does not correspond!") unless valid_test_execution?
+          end
+        end
+
+        # Creates a issue
+        def create(data)
+          QAT::Reporter::Xray::Config.publisher.create_issue(data)
+        end
+
+        # Error returned when the the JIRA Issue does not correspond
+        class InvalidIssueType < StandardError
+        end
+        # Error returned when publisher string is not known
+        class PublisherNotKnownError < StandardError
+        end
+
+        private
+
+        def valid_test_execution?
+          base     = Publisher::Base.new
+          response = JSON.parse(Publisher::Base::Client.new(base.base_url).get("/rest/api/2/issue/#{jira_id}", base.default_headers))
+          if response.dig('fields', 'issuetype', 'name').eql? 'Test Execution'
+            true
+          else
+            false
+          end
+        end
+      end
+    end
+  end
+end