qat-reporter-xray-sa 1.0.0

data/lib/qat/reporter/xray/tasks/tests/report.rb

@@ -0,0 +1,47 @@
+require_relative 'helpers'
+
+module QAT
+  module Reporter
+    class Xray
+      # namespace for test ids utility methods and objects
+      module Tests
+        # the test id report wrapper
+        class Report
+          include Helpers
+
+          attr_reader :path, :content
+
+          def initialize(path)
+            @path    = path
+            @content = JSON.parse(File.read(path))
+          end
+
+          # Returns the report max test id
+          def max_id
+            @max_id ||= @content['max']
+          end
+
+          # Returns the report untagged tests information
+          def untagged
+            @untagged ||= @content['untagged']
+          end
+
+          # Returns the report test id mapping to scenarios information
+          def mapping
+            @mapping ||= @content['mapping']
+          end
+
+          # Returns the report duplicate test id information
+          def duplicate
+            @duplicate ||= @content['duplicate']
+          end
+
+          # Tags all untagged scenario with a test id
+          def tag_untagged!
+            tag_untagged(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/qat/reporter/xray/tasks/tests.rb

@@ -0,0 +1,139 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+require 'rake/testtask'
+require 'json'
+require 'fileutils'
+require 'awesome_print'
+require 'fileutils'
+require 'active_support/core_ext/string/inflections'
+require_relative 'tests/report'
+require_relative 'tests/helpers'
+
+namespace :qat do
+  namespace :reporter do
+    namespace :xray do
+      namespace :tests do
+        # Run a rake task by name
+        def run_task!(task_name)
+          begin
+            Rake::Task["qat:reporter:xray:tests:#{task_name}"].invoke
+          rescue SystemExit => exception
+            exitstatus = exception.status
+            @kernel.exit(exitstatus) unless exitstatus == 0
+          end
+        end
+
+        desc 'Generates the test id report in JSON'
+        task :report_test_ids do
+          FileUtils.mkdir('public') unless File.exists?(File.join(Dir.pwd, 'public'))
+          ENV['CUCUMBER_OPTS'] = nil
+          Cucumber::Rake::Task.new('test_ids', 'Generates test ids as tags for tests without test id') do |task|
+            task.bundler       = false
+            task.fork          = false
+            task.cucumber_opts = ['--no-profile',
+                                  '--dry-run',
+                                  '--out', 'public/xray_test_ids.json']
+          end.runner.run
+        end
+
+        desc 'Validates the existing test ids and checks for duplicates'
+        task :validate_test_ids do
+          run_task!('report_test_ids')
+          #read json file
+          file_path = File.realpath(File.join(Dir.pwd, 'public', 'xray_test_ids.json'))
+          report    = QAT::Reporter::Xray::Tests::Report.new(file_path)
+
+          exit(1) if report.duplicate.any?
+        end
+
+        desc 'Generates test ids as tags for tests without test id'
+        task :generate_test_ids do
+          run_task!('report_test_ids')
+          #read json file
+          file_path = File.realpath(File.join(Dir.pwd, 'public', 'xray_test_ids.json'))
+          report    = QAT::Reporter::Xray::Tests::Report.new(file_path)
+
+          report.tag_untagged!
+        end
+
+
+        desc 'Generate features zip file to import in Xray'
+        task :zip_features do
+          require 'zip'
+
+          file_mask     = File.join('features', '**', '*.feature')
+          feature_files = Dir.glob(file_mask)
+          puts feature_files
+
+          zipfile_name = 'features.zip'
+
+          FileUtils.rm_f(zipfile_name) if File.exists?(zipfile_name)
+
+          Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
+            feature_files.each do |file|
+              zipfile.add(file, file)
+            end
+          end
+        end
+
+        # Validates the import task arguments
+        def validate_import_args(args)
+          [:xray_username, :jira_url, :jira_type, :project_key].each do |key|
+            raise ArgumentError.new "No #{key.to_s.humanize} was provided" unless args[key]
+          end
+        end
+
+        desc 'Import Cucumber tests to Xray'
+        task :import_features, [:xray_username, :jira_url, :jira_type, :project_key, :file_path] do |_, args|
+          run_task!('generate_test_ids')
+          run_task!('zip_features')
+
+          require 'qat/reporter/xray'
+
+          file_path = args.delete(:file_path) || 'features.zip'
+
+          validate_import_args(args)
+          project_key = args[:project_key] or raise ArgumentError.new 'No project key was provided'
+          login_credentials = [args[:xray_username], ENV['JIRA_PASSWORD']] or raise ArgumentError.new 'No login credentials were provided'
+          jira_type = args[:jira_type] or raise ArgumentError.new 'No jira type key was provided'
+          jira_url = args[:jira_url] or raise ArgumentError.new 'No jira url key was provided'
+
+          QAT::Reporter::Xray.configure do |c|
+            c.project_key                = project_key
+            c.login_credentials          = login_credentials
+            c.cloud_xray_api_credentials = login_credentials if jira_type.eql? 'cloud'
+            c.jira_type                  = jira_type
+            c.jira_url                   = jira_url
+          end
+
+          QAT::Reporter::Xray::Config.publisher.import_cucumber_tests(project_key, file_path)
+        end
+
+        desc 'Export Xray test scenarios '
+        task :export_xray_test_scenarios, [:xray_username, :jira_url, :jira_type, :project_key, :keys, :filter] do |_, args|
+
+          require 'qat/reporter/xray'
+
+          project_key = args[:project_key] or raise ArgumentError.new 'No project key was provided'
+          login_credentials = [args[:xray_username], ENV['JIRA_PASSWORD']] or raise ArgumentError.new 'No login credentials were provided'
+          jira_type = args[:jira_type] or raise ArgumentError.new 'No jira type was provided'
+          jira_url = args[:jira_url] or raise ArgumentError.new 'No jira url was provided'
+          xray_export_test_filter = args[:filter] or raise ArgumentError.new 'No filter key was provided'
+          xray_export_test_keys = args[:keys] or raise ArgumentError.new 'No test issue key was provided'
+
+          QAT::Reporter::Xray.configure do |c|
+            c.project_key                = project_key
+            c.login_credentials          = login_credentials
+            c.cloud_xray_api_credentials = login_credentials if jira_type.eql? 'cloud'
+            c.jira_type                  = jira_type
+            c.jira_url                   = jira_url
+            c.xray_export_test_filter    = xray_export_test_filter
+            c.xray_export_test_keys      = xray_export_test_keys
+          end
+
+          QAT::Reporter::Xray::Config.publisher.export_test_scenarios(xray_export_test_keys, xray_export_test_filter)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+#encoding: utf-8
+#@version 1.0
+require_relative 'tasks/tests'

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

@@ -0,0 +1,44 @@
+require 'rest-client'
+require_relative 'issue'
+
+module QAT
+  module Reporter
+    class Xray
+      # QAT::Reporter::Xray::TestExecution represents a Xray Test Execution object
+      class Test < Issue
+
+        # Creates a Test issue in Jira
+        def create(options = {})
+          data     = defaults.merge(options)
+          response = super(data)
+          test_key = JSON.parse(response)['key']
+          puts "Created test with key: '#{test_key}'."
+        end
+
+        private
+        def defaults
+          {
+            fields: {
+              project:
+                                 {
+                                   key: QAT::Reporter::Xray::Config.project_key
+                                 },
+              summary:           "Execution of automated tests #{Time.now.strftime('%F %T')}",
+              description:       'Creation of automated Test',
+              issuetype:         {
+                name: 'Test'
+              },
+              customfield_10200: {
+                value: 'Cucumber'
+              },
+              customfield_10201: {
+                value: 'Scenario'
+              },
+              customfield_10202: 'customfield_10202'
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+require 'rest-client'
+require_relative 'issue'
+
+module QAT
+  module Reporter
+    class Xray
+      # QAT::Reporter::Xray::TestExecution represents a Xray Test Execution object
+      class TestExecution < Issue
+
+        # Creates a Test Execution issue in Jira
+        def create(options = {})
+          data               = test_execution_defaults.merge(options)
+          response           = super(data)
+          test_execution_key = JSON.parse(response)['key']
+          puts "Created test execution with key: '#{test_execution_key}', saving in 'XRAY_TEST_EXECUTION' env variable."
+          ENV['XRAY_TEST_EXECUTION'] = test_execution_key
+        end
+
+        # Posts the execution json results in Xray
+        def import_execution_results(execution_results, info = {})
+          puts execution_results
+          if jira_id
+            issue_info                    = info.merge(default_update_headers(execution_results))
+            issue_info[:testExecutionKey] = jira_id
+          else
+            issue_info = info.merge(default_create_headers(execution_results))
+          end
+          #If no test execution found, Xray will create one automatically
+          QAT::Reporter::Xray::Config.publisher.send_execution_results(issue_info)
+        end
+
+        private
+
+        def default_create_headers(execution_results)
+          {
+            info: {
+                    summary:     "Execution of automated tests #{Time.now.strftime('%F %T')}",
+                    description: 'This execution is automatically created when importing execution results from an external source',
+                  }.merge(test_execution_info(execution_results))
+          }.merge(execution_results)
+        end
+
+        def default_update_headers(execution_results)
+          {
+            info: test_execution_info(execution_results)
+          }.merge(execution_results)
+        end
+
+        def test_execution_info(execution_results)
+          {
+            startDate:        execution_results[:tests].first[:start],
+            finishDate:       execution_results[:tests].last[:finish],
+            version:          QAT::Reporter::Xray::Config.xray_test_version.to_s,
+            revision:         QAT::Reporter::Xray::Config.xray_test_revision.to_s,
+            testEnvironments: [QAT::Reporter::Xray::Config.xray_test_environment]
+          }
+        end
+
+        def test_execution_defaults
+          {
+            fields: {
+              project:
+                           {
+                             key: QAT::Reporter::Xray::Config.project_key
+                           },
+              summary:     "Execution of automated tests #{Time.now.strftime('%F %T')}",
+              description: 'Creation of automated Test Execution',
+              issuetype:   {
+                name: 'Test Execution'
+              }
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# QAT namespace
+module QAT
+  # Namespace for QAT Reporter
+  module Reporter
+    # Namespace for QAT Reporter's Xray integrations
+    class Xray
+      # Represents QAT Reporter's Xray integrations' version
+      VERSION = '1.0.0'
+    end
+  end
+end

data/lib/qat/reporter/xray.rb

@@ -0,0 +1,2 @@
+require_relative 'xray/version'
+require_relative 'xray/config'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: qat-reporter-xray-sa
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- QAT
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.9
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    QAT Report Xray Standalone belongs to QAT Report collection but stand alone version, so no dependencies from other
+    QAT gems are required.
+email: qatoolkit@readinessit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/qat/reporter/xray.rb
+- lib/qat/reporter/xray/config.rb
+- lib/qat/reporter/xray/issue.rb
+- lib/qat/reporter/xray/publisher.rb
+- lib/qat/reporter/xray/publisher/base.rb
+- lib/qat/reporter/xray/publisher/cloud.rb
+- lib/qat/reporter/xray/publisher/hosted.rb
+- lib/qat/reporter/xray/tasks.rb
+- lib/qat/reporter/xray/tasks/tests.rb
+- lib/qat/reporter/xray/tasks/tests/helpers.rb
+- lib/qat/reporter/xray/tasks/tests/report.rb
+- lib/qat/reporter/xray/test.rb
+- lib/qat/reporter/xray/test_execution.rb
+- lib/qat/reporter/xray/version.rb
+homepage: https://www.ritain.io
+licenses:
+- GPL-3.0
+metadata:
+  source_code_uri: https://github.com/Ritain-io/qat-reporter-xray-standalone
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Utility for Test Reports in Jira Xray.
+test_files: []