testrail_rspec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 892fde2a276a04d5eb848babfe6f5d55f890bc46
-  data.tar.gz: 1367fdb75da3e603bf8ca11ba3bdecf825917d63
+  metadata.gz: 17b37cac0d137dcd55f241b808e8ba02fa234a07
+  data.tar.gz: 5891b2058f8bf42d9d925a51262de4a18e9c89ae
 SHA512:
-  metadata.gz: f13bbde2db33c79f2f593f971c81190403e5b5d513a5b4d93fc4c143389dadcdd1b775a60a9b7052a4a34c5cf401a5a258e87dba570a27970d021c762ba3f19a
-  data.tar.gz: 8a780a95af0e588b3ad66ca7e932a384954d298b72c6be55a005e2e8ed6ccea14f831ebd6d24cad33fae59c2f6a504dcbe21787c6c944a932de1ff3bd206d975
+  metadata.gz: d4c0abc08cc139acc854f1d176f8fde321eb793dd2c882fec3523a52b71d13ac38022f2f1d910f7d5168969b4dbcf4727b6dc976f44eacc1e4b3266284e10faa
+  data.tar.gz: 21bea9900fd213c483d0634ace6a3d393aa1868437f6fc33617a32ab0dd59dd3a9d816723ccf0fb46e3a900a18f155671d2afe8a33dd82cc4a0c11a7a071730f

data/README.md

@@ -1,4 +1,4 @@
-# Testrail::Rspec
+# TestrailRspec
 
 This gem provides custom RSpec formatter allowing to export test results directly to [TestRail][1] instance via their [API][2].
 

data/lib/testrail_rspec.rb

@@ -6,177 +6,175 @@ require 'rubytree'
 require "testrail_rspec/version"
 require "testrail_rspec/client"
 
-module TestrailRspec
+class TestrailRspec < RSpec::Core::Formatters::BaseTextFormatter
 
   RSpec.configuration.add_setting :testrail_formatter_options, :default => {}
 
-  class Exporter < RSpec::Core::Formatters::BaseTextFormatter
-    RSpec::Core::Formatters.register self, :start, :close, :dump_summary
-    #                                  # :example_started, :example_passed,
-    #                                  # :example_pending,  :example_failed,
-    #                                  :dump_failures, :dump_pending
-    #                                  # :start_dump
+  RSpec::Core::Formatters.register self, :start, :close, :dump_summary
+  #                                  # :example_started, :example_passed,
+  #                                  # :example_pending,  :example_failed,
+  #                                  :dump_failures, :dump_pending
+  #                                  # :start_dump
 
 
-    # TODO: after exporter is done and working remove unnecessary overriden methods
+  # TODO: after exporter is done and working remove unnecessary overriden methods
 
-    def initialize(output)
-      @options = {}
-      @project_id = nil
-      super(output)
-    end
+  def initialize(output)
+    @options = {}
+    @project_id = nil
+    super(output)
+  end
 
-    # To start
-    def start(notification)
-      @options = RSpec.configuration.testrail_formatter_options
-      @client = TestrailRspec::Client.new(@options)
-      @client.get_projects.each { |project| @project_id = project['id'] if project['name'] == @options[:project] }
+  # To start
+  def start(notification)
+    @options = RSpec.configuration.testrail_formatter_options
+    @client = TestrailRspec::Client.new(@options)
+    @client.get_projects.each { |project| @project_id = project['id'] if project['name'] == @options[:project] }
 
-      puts "TestRail Exporter [INFO] Executing #{notification.count} tests. Loaded in #{notification.load_time}"
+    puts "TestRail Exporter [INFO] Executing #{notification.count} tests. Loaded in #{notification.load_time}"
 
-      super
-    end
+    super
+  end
+
+  # Once per example group <-----------------------------------------------------------------------------
+  # def example_group_started(notification)
+  #   groups = []
+  #   current_group = notification.group
+  #   until current_group.top_level?
+  #     groups << current_group
+  #     current_group = current_group.parent if current_group.parent_groups.size > 1
+  #   end
+  #
+  #   groups << current_group
+  #
+  #   unless groups[0].examples.empty?
+  #     groups.reverse.each_with_index do |group, idx|
+  #       puts (idx == 0 ? "Spec: " : "") + (' ' *2 * idx) + "#{group.description}"
+  #     end
+  #     puts (' ' *2 * groups.size) + groups[0].examples.map(&:description).join("\n" + (' ' *2 * groups.size))
+  #   end
+  #
+  #   super
+  # end
+
+  # Once per example <-----------------------------------------------------------------------------------
+  # def example_started(notification)
+  #   puts " - case: #{notification.example.description}"
+  # end
+
+  # One of these per example <---------------------------------------------------------------------------
+  # def example_passed(passed)
+  #   puts "\tpass: #{passed.example.description}"
+  # end
+
+  # def example_failed(failure)
+  #   puts "\tfail: #{failure.example.description}"
+  # end
+  #
+  # def example_pending(pending)
+  #   puts "\tpend: #{pending.example.description}"
+  # end
+
+  # Optionally at any time <------------------------------------------------------------------------------
+  # def message(notification)
+  #   puts "msg notification: #{notification.inspect}"
+  #   super
+  # end
+
+  # At the end of the suite <-----------------------------------------------------------------------------
+  # def stop(notification)
+  #   puts "stop notification: #{notification.inspect}"
+  # end
+
+  # def start_dump(null_notification)
+  #   puts "start_dump notification: #{null_notification.inspect}"
+  # end
+  #
+  def dump_pending(notification)
+    # puts "dump pend notification: #{notification.inspect}"
+    # super
+  end
 
-    # Once per example group <-----------------------------------------------------------------------------
-    # def example_group_started(notification)
-    #   groups = []
-    #   current_group = notification.group
-    #   until current_group.top_level?
-    #     groups << current_group
-    #     current_group = current_group.parent if current_group.parent_groups.size > 1
-    #   end
-    #
-    #   groups << current_group
-    #
-    #   unless groups[0].examples.empty?
-    #     groups.reverse.each_with_index do |group, idx|
-    #       puts (idx == 0 ? "Spec: " : "") + (' ' *2 * idx) + "#{group.description}"
-    #     end
-    #     puts (' ' *2 * groups.size) + groups[0].examples.map(&:description).join("\n" + (' ' *2 * groups.size))
-    #   end
-    #
-    #   super
-    # end
-
-    # Once per example <-----------------------------------------------------------------------------------
-    # def example_started(notification)
-    #   puts " - case: #{notification.example.description}"
-    # end
-
-    # One of these per example <---------------------------------------------------------------------------
-    # def example_passed(passed)
-    #   puts "\tpass: #{passed.example.description}"
-    # end
-
-    # def example_failed(failure)
-    #   puts "\tfail: #{failure.example.description}"
-    # end
-    #
-    # def example_pending(pending)
-    #   puts "\tpend: #{pending.example.description}"
-    # end
-
-    # Optionally at any time <------------------------------------------------------------------------------
-    # def message(notification)
-    #   puts "msg notification: #{notification.inspect}"
-    #   super
-    # end
-
-    # At the end of the suite <-----------------------------------------------------------------------------
-    # def stop(notification)
-    #   puts "stop notification: #{notification.inspect}"
-    # end
-
-    # def start_dump(null_notification)
-    #   puts "start_dump notification: #{null_notification.inspect}"
-    # end
-    #
-    def dump_pending(notification)
-      # puts "dump pend notification: #{notification.inspect}"
-      # super
+  def dump_failures(notification)
+    # puts "dump fail notification: #{notification.inspect}"
+    # super
+  end
+
+  def dump_summary(notification)
+    # Create project if it is not present / could do it setting controlled
+    if @project_id.nil?
+      puts "TestRail Exporter [INFO] Creating project: #{@options[:project]}"
+      @project_id = @client.add_project(@options[:project])['id']
     end
 
-    def dump_failures(notification)
-      # puts "dump fail notification: #{notification.inspect}"
-      # super
+    suites = Hash.new do |h,k|
+      h[k] = Tree::TreeNode.new(k, @client.find_or_create_suite(k, @project_id) )
     end
 
-    def dump_summary(notification)
-      # Create project if it is not present / could do it setting controlled
-      if @project_id.nil?
-        puts "TestRail Exporter [INFO] Creating project: #{@options[:project]}"
-        @project_id = @client.add_project(@options[:project])['id']
-      end
 
-      suites = Hash.new do |h,k|
-        h[k] = Tree::TreeNode.new(k, @client.find_or_create_suite(k, @project_id) )
-      end
+    notification.examples.each do |example|
+      build_hierarchy_tree!(suites, example)
+    end
 
+    suites.each { |_, suite| update_test_run(suite) }
 
-      notification.examples.each do |example|
-        build_hierarchy_tree!(suites, example)
-      end
+    super
+  end
 
-      suites.each { |_, suite| update_test_run(suite) }
+  def close(null_notification)
+    # TODO: could close any open connection
+    puts "TestRail Exporter [INFO] Closing..."
+    super
+  end
 
-      super
-    end
+  private
 
-    def close(null_notification)
-      # TODO: could close any open connection
-      puts "TestRail Exporter [INFO] Closing..."
-      super
-    end
+  def get_path_for(node)
+    asc_arr = node.is_a?(RSpec::Core::Example) ? [node.description] : []
+    parent = (node.respond_to? :parent) ? node.parent : node.example_group
+    asc_arr << parent.description
+    asc_arr.push(*get_path_for(parent)) unless parent.top_level?
+    node.is_a?(RSpec::Core::Example) ? asc_arr.reverse : asc_arr
+  end
 
-    private
+  def build_hierarchy_tree!(suites, example)
+    path = get_path_for(example)
 
-    def get_path_for(node)
-      asc_arr = node.is_a?(RSpec::Core::Example) ? [node.description] : []
-      parent = (node.respond_to? :parent) ? node.parent : node.example_group
-      asc_arr << parent.description
-      asc_arr.push(*get_path_for(parent)) unless parent.top_level?
-      node.is_a?(RSpec::Core::Example) ? asc_arr.reverse : asc_arr
-    end
+    parent_node = suite_node = suites[path.shift]
+    path.unshift('Direct cases') unless path.size > 1
 
-    def build_hierarchy_tree!(suites, example)
-      path = get_path_for(example)
-
-      parent_node = suite_node = suites[path.shift]
-      path.unshift('Direct cases') unless path.size > 1
-
-      path.each_with_index do |item, idx|
-        child_node = (parent_node.children.map(&:name).include? item) ? parent_node[item] : nil
-        if child_node and (idx + 1 == path.size)
-          puts "TestRail Exporter [INFO] Second case with same path and name detected:\n\t#{suite_node.content['name']} -> #{path.join(' -> ')}"
-        end
-
-        unless child_node
-          child_node = if idx + 1 == path.size
-                         Tree::TreeNode.new(item, { case: @client.find_or_create_case(item, parent_node.content, idx), result: example })
-                       else
-                         Tree::TreeNode.new(item, @client.find_or_create_section(item, suite_node.content, parent_node.content, idx))
-                       end
-          parent_node << child_node
-        end
-        parent_node = child_node
+    path.each_with_index do |item, idx|
+      child_node = (parent_node.children.map(&:name).include? item) ? parent_node[item] : nil
+      if child_node and (idx + 1 == path.size)
+        puts "TestRail Exporter [INFO] Second case with same path and name detected:\n\t#{suite_node.content['name']} -> #{path.join(' -> ')}"
       end
 
-    end
-
-    def update_test_run(suite)
-      run_id = @client.create_run(suite.content)['id']
-      results = suite.each_leaf.map do |test|
-        test_result = test.content[:result].execution_result
-        run_time_seconds = test_result.run_time.round(0)
-        {
-            case_id:    test.content[:case]['id'],
-            status_id:  TestrailRspec::STATUS[test_result.status],
-            elapsed:    (run_time_seconds == 0) ? nil : "#{run_time_seconds}s"
-        }
+      unless child_node
+        child_node = if idx + 1 == path.size
+                       Tree::TreeNode.new(item, { case: @client.find_or_create_case(item, parent_node.content, idx), result: example })
+                     else
+                       Tree::TreeNode.new(item, @client.find_or_create_section(item, suite_node.content, parent_node.content, idx))
+                     end
+        parent_node << child_node
       end
-      @client.add_results_for_cases(run_id, results)
+      parent_node = child_node
     end
 
+  end
 
+  def update_test_run(suite)
+    run_id = @client.create_run(suite.content)['id']
+    results = suite.each_leaf.map do |test|
+      test_result = test.content[:result].execution_result
+      run_time_seconds = test_result.run_time.round(0)
+      {
+          case_id:    test.content[:case]['id'],
+          status_id:  TestrailRspec::STATUS[test_result.status],
+          elapsed:    (run_time_seconds == 0) ? nil : "#{run_time_seconds}s"
+      }
+    end
+    @client.add_results_for_cases(run_id, results)
   end
+
+
 end

data/lib/testrail_rspec/version.rb

@@ -1,3 +1,3 @@
 module TestrailRspec
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testrail_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michal Kubik