onlyoffice_tcm_helper 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5314bcff82aacd110912a3f45496c8e0a5f0933e01f2b7355e3ba19cceecf5f9
+  data.tar.gz: af52601a9fb478d7c666b77dbf7b09dfcdb3ccbf56ea4f4bd8dfd5c83c053372
+SHA512:
+  metadata.gz: eb18c3a30ad1f24711c834a8cd8134db353f1aa7e8635323ca3c476500559b27a9e2e26d5165c20bbed8113a2b9ec92f777f04cb29e42f82fc3b41dda81fdb5d
+  data.tar.gz: 75ec1b4918b802443c454f1802593ef86c21fe66d076b03b1e731598c8b11727ad42aeb9c67fdc9560d34059bb79e4d23b382e72be9c016d798ee86ba11191b8

data/lib/onlyoffice_tcm_helper.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_tcm_helper/helpers/rspec_helper'
+require 'onlyoffice_tcm_helper/helpers/time_helper'
+require 'onlyoffice_tcm_helper/version'
+require 'rspec'
+require 'socket'
+require 'json'
+
+# namespace for gem
+module OnlyofficeTcmHelper
+  # Class for generate data for result by RSpec::Core::Example
+  class TcmHelper
+    include TimeHelper
+    include RspecHelper
+    # @return [Symbol] one of status: passed, passed_2, failed, aborted, pending, service_unavailable, lpv
+    attr_accessor :status
+    # @return [String] name of case(or name of result_set)
+    attr_reader :case_name
+    # @return [RSpec::Core::Example] example - is a returned object in "after" block
+    attr_reader :example
+    # @return [String] is a comment for result, like a error, link to bug, etc
+    attr_reader :comment
+    # @return [String] is a name of product
+    attr_reader :product_name
+    # @return [String] is a name of plan
+    attr_reader :plan_name
+    # @return [String] is a name of suite(ore run)
+    attr_reader :suite_name
+    # @return [String] is a name last case, who result has generated
+    attr_reader :last_case
+    # @return [Hash] is a result message.
+    attr_accessor :result_message
+
+    def initialize(params = {})
+      @product_name = params[:product_name]
+      @plan_name = params[:plan_name]
+      @suite_name = params[:suite_name]
+    end
+
+    # @param [RSpec::Core::Example] example - is a returned object in "after" block
+    # @return [TcmHelper] is object
+    def parse(example)
+      @case_name = example.metadata[:description]
+      get_status_and_comment(example)
+      @result_message = get_message_and_custom_fields(example)
+      self
+    end
+
+    # Get message and custom fields from example
+    # @param [Object] example to get
+    # @return [String] json data
+    def get_message_and_custom_fields(example)
+      custom_fields = {}
+      custom_fields[:subdescriber] = [
+        { title: 'elapsed', value: example_time_in_seconds(example) },
+        { title: 'custom_host', value: Socket.gethostname }
+      ]
+      custom_fields[:describer] = [{ title: 'comment', value: @comment }]
+      custom_fields.to_json
+    end
+
+    # @param [RSpec::Core::Example] example - is a returned object in "after" block
+    # @return [Symbol] is a symbolic name of test status
+    def get_status_and_comment(example)
+      @status = if result_is_failed?(example)
+                  comment = "\n#{example.exception.to_s
+                                        .gsub('got:', "got:\n")
+                                        .gsub('expected:', "expected:\n")
+                                        .gsub('to return ', "to return:\n")}\n"\
+                            "In line:\n#{RspecHelper.find_failed_line(example)}"
+                  @comment = comment
+                  :failed
+                elsif example.pending?
+                  @comment = example.execution_result.pending_message
+                  :pending
+                elsif result_is_passed?(example)
+                  @comment = "\nOk"
+                  :passed
+                elsif result_is_passed2?(example)
+                  @comment = "\nPassed 2"
+                  :passed_2
+                elsif result_is_service_unavailable?(example)
+                  @comment = "\n#{example.exception}"
+                  :service_unavailable
+                elsif result_is_lpv?(example)
+                  @comment = "\n#{example.exception}"
+                  :lpv
+                else
+                  @comment = "\n#{example.exception}"
+                  :aborted
+                end
+      @last_case = @case_name
+    end
+
+    def result_is_passed?(example)
+      example.exception.nil? && @last_case != example.description
+    end
+
+    def result_is_passed2?(example)
+      example.exception.nil? && @last_case == example.description
+    end
+
+    def result_is_failed?(example)
+      # return true if example.metadata[:execution_result].pending_fixed
+      ['got:', 'expected:', 'to return'].map do |current_error|
+        return true if example.exception.to_s.include?(current_error)
+      end
+      false
+    end
+
+    def result_is_service_unavailable?(example)
+      example.exception.to_s.include?('Service Unavailable')
+    end
+
+    def result_is_lpv?(example)
+      example.exception.to_s.include?('Limited program version')
+    end
+  end
+end

data/lib/onlyoffice_tcm_helper/helpers/rspec_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'onlyoffice_file_helper'
+# namespace
+module OnlyofficeTcmHelper
+  # module with methods for parsing test results
+  module RspecHelper
+    # This method is based on
+    # https://github.com/rspec/rspec-core/blob/v3.3.0/lib/rspec/core/formatters/exception_presenter.rb#L130
+    # It extracted exact line of code from failed exception
+    # @param [RSpec::Core::Example] example
+    # @return [String] line value
+    def self.find_failed_line(example)
+      example_path = example.metadata[:absolute_file_path].downcase
+      dirty_line = example.exception.backtrace.find do |line|
+        next unless (line_path = line[/(.+?):(\d+)(|:\d+)/, 1])
+
+        File.expand_path(line_path).casecmp(example_path).zero?
+      end
+      line_number = dirty_line[/:\d*:/].delete(':').to_i
+      OnlyofficeFileHelper::FileHelper.read_array_from_file(example.metadata[:absolute_file_path])[line_number - 1]
+    rescue StandardError => e
+      "Cannot find failed line because of exception: #{e}"
+    end
+  end
+end

data/lib/onlyoffice_tcm_helper/helpers/time_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# namespace
+module OnlyofficeTcmHelper
+  # it is helper for work with time class
+  module TimeHelper
+    # Example time in seconds
+    # @param [Object] example with data
+    # @return [String] time in seconds
+    def example_time_in_seconds(example)
+      execution_time = (Time.now - example.metadata[:execution_result].started_at).to_i
+      execution_time = 1 if execution_time.zero? # Testrail cannot receive 0 as elapsed time
+      "#{execution_time}s"
+    end
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'sub_elements/executing_result'
+# class is describe object like RSpec::Core::Example
+class PseudoExample
+  attr_reader :description, :execution_result
+
+  def initialize(description = 'Check something', started_at = Time.now)
+    @description = description
+    @execution_result = ExecutingResult.new(started_at)
+  end
+
+  # @return [Hash] metadata of class
+  def metadata
+    {
+      description: @description,
+      execution_result: @execution_result,
+      absolute_file_path: __FILE__
+    }
+  end
+
+  # @return [nil] non-existing exception
+  def exception; end
+
+  # @return [false] is example pending
+  def pending?
+    false
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_aborted.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# class is describe object like RSpec::Core::Example with error in no expected code
+class PseudoExampleAborted < PseudoExample
+  # @return [String] exception string
+  def exception
+    "undefined local variable or method `tasdasdrue' "\
+    'for #<RSpec::ExampleGroups::OnlyofficeTcmHelper::'\
+    'StatusChecks:0x000000020b8400>'
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_failed.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'pseudo_example_failed/mock_failed_exception'
+
+# class is describe object like RSpec::Core::Example with error in expected code
+class PseudoExampleFailed < PseudoExample
+  def initialize(description = 'Check something',
+                 exception_with_failed_lines: false)
+    @exception_with_failed_lines = exception_with_failed_lines
+    super(description)
+  end
+
+  # @return [Hash] metadata of class
+  def metadata
+    {
+      description: 'Test for create failed status result',
+      execution_result: ExecutingResult.new,
+      absolute_file_path: "#{Dir.pwd}/spec/onlyoffice_tcm_helper_spec.rb"
+    }
+  end
+
+  # @return [Object] exception data
+  def exception
+    return MockFailedException.new if @exception_with_failed_lines
+
+    'expected: falsey value
+     got: true'
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_failed/mock_failed_exception.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Mock class to check exception
+class MockFailedException
+  # @return [String] string representation
+  def to_s
+    'expected: falsey value
+     got: true'
+  end
+
+  # @return [Array<String>] list of backtrace
+  def backtrace
+    ['trace_without_line',
+     "#{Dir.pwd}/spec/onlyoffice_tcm_helper_spec.rb:3:in `get_status_and_comment",
+     "#{Dir.pwd}/spec/onlyoffice_tcm_helper_spec.rb:4:in `parse"]
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_lpv.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# class is describe object like RSpec::Core::Example with special tag
+class PseudoExampleLPV < PseudoExample
+  # @return [String] exception string
+  def exception
+    'Limited program version'
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_passed.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# class is describe object like RSpec::Core::Example with no error
+class PseudoExamplePassed < PseudoExample; end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_pending.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'sub_elements/executing_result_pending'
+
+# class is describe object like RSpec::Core::Example with pending result
+class PseudoExamplePending < PseudoExample
+  def initialize(description)
+    super(description)
+    @execution_result = ExecutingResultPending.new
+  end
+
+  def pending?
+    true
+  end
+end

data/lib/onlyoffice_tcm_helper/models/pseudo_example_service_unavailable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# class is describe object like RSpec::Core::Example with special tag
+class PseudoExampleServiceUnavailable < PseudoExample
+  # @return [String] exception string
+  def exception
+    'Service Unavailable: 503'
+  end
+end

data/lib/onlyoffice_tcm_helper/models/sub_elements/executing_result.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# class is describe same RSpec::Core::Example::ExecutingResult with no errors
+class ExecutingResult
+  attr_reader :started_at
+
+  def initialize(started_at = Time.now)
+    @started_at = started_at
+  end
+end

data/lib/onlyoffice_tcm_helper/models/sub_elements/executing_result_pending.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# class is describe same RSpec::Core::Example::ExecutingResult with pending status
+class ExecutingResultPending
+  attr_reader :started_at, :pending_message
+
+  def initialize
+    @started_at = Time.now
+    @pending_message = 'Pending exception'
+  end
+end

data/lib/onlyoffice_tcm_helper/name.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OnlyofficeTcmHelper
+  # @return [String] gem name
+  NAME = 'onlyoffice_tcm_helper'
+end

data/lib/onlyoffice_tcm_helper/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module OnlyofficeTcmHelper
+  # @return [String] version of gem
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: onlyoffice_tcm_helper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- ONLYOFFICE
+- Dmitry Rotaty
+- Pavel Lobashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onlyoffice_file_helper
+  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: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+description: It is helper for work with tcm systems, used in QA
+email:
+- shockwavenn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/onlyoffice_tcm_helper.rb
+- lib/onlyoffice_tcm_helper/helpers/rspec_helper.rb
+- lib/onlyoffice_tcm_helper/helpers/time_helper.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_aborted.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_failed.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_failed/mock_failed_exception.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_lpv.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_passed.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_pending.rb
+- lib/onlyoffice_tcm_helper/models/pseudo_example_service_unavailable.rb
+- lib/onlyoffice_tcm_helper/models/sub_elements/executing_result.rb
+- lib/onlyoffice_tcm_helper/models/sub_elements/executing_result_pending.rb
+- lib/onlyoffice_tcm_helper/name.rb
+- lib/onlyoffice_tcm_helper/version.rb
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_tcm_helper
+licenses:
+- AGPL-3.0
+metadata:
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_tcm_helper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_tcm_helper/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/onlyoffice_tcm_helper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_tcm_helper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_tcm_helper
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+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: It is helper for work with tcm systems
+test_files: []