testrailtagging 0.3.8.3 → 0.3.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 255ff6aaa6d669963a11e5f9238368685285b6e7
-  data.tar.gz: e429dc94325ba160713b5a4804d5293100f2e109
+  metadata.gz: af7c34382755322b02544cb166a43b304a37e6b5
+  data.tar.gz: 3ff0363f332f5144430cd08cf9c9eba4be717c07
 SHA512:
-  metadata.gz: 058a42733aa3d316d73f4cc74668e3b300622f308c25cb8025b0fc00b95f01c867b0981e43ad0a40f1511f9788e23c24ed62130d4d3a151235a5ede7d90bb8be
-  data.tar.gz: ce4d61d0d2ee53baa3f992475ea0d7183f9d56bf76e1e93afb90175d1693812311335c9b7bbb0c32bbdf0f04787d9e3d1e7b8834440abd5f2ff32af334896b3b
+  metadata.gz: 64a8c220b778ab6e8f6c634a7bb893576d6fe4211c36207d5338a75f2b6094edb8885f937788a0bebae20bc32c61f828421458de60d6e3d6f95951538462d340
+  data.tar.gz: f124e7cb3756f6779f50d2845302675a71c836ff9e2d3e0ee178481355218cd0a860380d79b75824a7c459c3545e7fe252a2e62f4f8e072152f54cf759b1711d

data/README.md

@@ -46,6 +46,14 @@ Then you set an environment variable called TESTRAIL_RUN_ID, with that value. Fo
 
 `export TESTRAIL_RUN_ID=14153`
 
+You can also set an optional environment variable to report results in batches, rather than after each test 
+case.
+This helps reduce traffic to Testrail and also provides less flakiness in results not being posted when
+something slow down testrail. To do this, add the following variable and set it to whatever number of test
+case results you'd like to have posted at a time:
+
+`TESTRAIL_BATCH_SIZE=15`
+
 Next, in your RSpec configuration file (usually spec_helper.rb) you need to call a registration function: 
 
 

data/lib/files/testrail_rspec_integration.rb

@@ -22,6 +22,8 @@ module TestRailRSpecIntegration
   class TestRailPlanFormatter
     RSpec::Core::Formatters.register self, :example_passed, :example_pending, :example_failed, :start, :stop
     public
+    @@cases = []
+
     def initialize(out)
       @out = out
     end
@@ -30,6 +32,10 @@ module TestRailRSpecIntegration
       @@product = product
     end
 
+    def set_test_run_id(run_id)
+      @@run_id = run_id
+    end
+
     def test_id_key
       case @@product
         when :bridge
@@ -66,6 +72,14 @@ module TestRailRSpecIntegration
         end
       end
 
+      # Initialize the batch size for test rail batching based on environment variable.
+      # One test is the default, in case people don't want to batch or haven't provided the variable.
+      if !ENV["TESTRAIL_BATCH_SIZE"].nil?
+        @batch_size = ENV["TESTRAIL_BATCH_SIZE"]
+      else
+        @batch_size = 1
+      end
+
       # Pull down ALL the test cases from testrail. Granted this is more than what rspec will actually
       # execute. But there is no safe way to append a test case to a test run in a parallel environment.
       # The Testrail API is just too limited.
@@ -76,9 +90,14 @@ module TestRailRSpecIntegration
       puts "Count of tests to be run: #{TestRailRSpecIntegration.get_run_count}"
       puts "Count of tests that entered filter: #{TestRailRSpecIntegration.get_total_count}"
 
+      puts "Batching test results in groups of #{@batch_size}"
       @test_case_hash = TestRailOperations.get_test_run_cases(@testrail_run_id)
       # save the test case ID's that were actually executed
       @executed_test_ids = []
+
+      # Need a class variable for after suite hooks to post results,
+      # since the after suite hooks are defined outside the class
+      set_test_run_id(@testrail_run_id)
     end
 
     # This gets called after all tests are run
@@ -108,8 +127,8 @@ module TestRailRSpecIntegration
       return unless active
       example = notification.example
       result = example.execution_result
-
       testrail_ids = example.metadata[test_id_key]
+
       return unless testrail_ids.present?
       completion_message = ""
 
@@ -120,21 +139,28 @@ module TestRailRSpecIntegration
         completion_message.gsub!(/\[(\d)+m/, '')
       end
 
-      cases = [] # the test cases
       Array(testrail_ids).each do |id|
         tc = @test_case_hash[id.to_i]
         next unless tc # A test case ID exists in the rspec file, but not on testrail
         tc.set_status(result.status, completion_message)
-        cases << tc
+        @@cases << tc
         @executed_test_ids << id.to_i
       end
 
-      post_results cases
+      # Batches together test cases before posting. Relies on environment variable TESTRAIL_BATCH_SIZE to determine
+      # batch size.
+      # Relies on an 'after suite' hook to capture and post results for any number of remaining test cases less
+      # than the batch size
+      if @@cases.size >= @batch_size.to_i
+        TestRailPlanFormatter.post_results @@cases
+        @@cases.clear
+      end
     end
 
     # test_cases is an array of TestCase instances
-    def post_results(test_cases)
+    def self.post_results(test_cases)
       data = []
+
       test_cases.each do |tc|
 
         status_value = TestRailOperations.status_rspec_to_testrail(tc.status)
@@ -156,11 +182,11 @@ module TestRailRSpecIntegration
       end
 
       if data.size > 0
-        TestRailOperations.post_run_results(@testrail_run_id, data)
+        TestRailOperations.post_run_results(@@run_id, data)
         test_case_ids = test_cases.collect { |tc| tc.id }
-        @out.puts "Successfully posted results for testcases: #{test_case_ids} to test run: #{@testrail_run_id}"
+        puts "Successfully posted results for testcases: #{test_case_ids} to test run: #{@@run_id}"
       else
-        @out.puts "No results sent to test rail"
+        puts "No results sent to test rail"
       end
     end
 
@@ -169,6 +195,7 @@ module TestRailRSpecIntegration
     alias_method :example_failed, :example_finished
 
     private
+
     # For pushing results up to a test plan in TestRail.
     def is_for_test_rail_plan
       !ENV["TESTRAIL_RUN"].nil? && !ENV["TESTRAIL_PLAN_ID"].nil? && !ENV["TESTRAIL_ENTRY_ID"].nil? && !ENV["TESTRAIL_ENTRY_RUN_ID"].nil?
@@ -370,6 +397,15 @@ module TestRailRSpecIntegration
     if add_formatter
       TestRailRSpecIntegration.add_formatter_for(config)
     end
+
+    # Captures and posts results for any remaining test case results in @@cases that don't fill a full batch
+    config.after(:suite) do |suite|
+      total_cases = TestRailPlanFormatter.class_variable_get(:@@cases)
+
+      if total_cases.size > 0
+        TestRailRSpecIntegration::TestRailPlanFormatter.post_results total_cases
+      end
+    end
   end
 
   # Registers a callback custom formatter to an rspec. The new test run is created from

data/lib/files/version.rb

@@ -1,3 +1,3 @@
 module Testrailtagging
-  VERSION = "0.3.8.3"
+  VERSION = "0.3.8.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrailtagging
 version: !ruby/object:Gem::Version
-  version: 0.3.8.3
+  version: 0.3.8.4
 platform: ruby
 authors:
 - Chris Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Utilities for working with testrail.