gridium 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2308c591e8510889e1757c6ba7a3d06cda13676
-  data.tar.gz: 1d2b86fcc8e680a7c8c34209a40188333d6096a0
+  metadata.gz: c0b267c861928652d286605296c289c05834430a
+  data.tar.gz: a778ba115b547531c36de17ef519468e94915dcf
 SHA512:
-  metadata.gz: d85b1f0c1e566f810afa8f95ab969174210fbf8e33b31507a73cdd72c316594d241821c139d25219242b4499433077248df8e794ed9a47b4262633a9b8f46351
-  data.tar.gz: b2072f20624c7ac16f0e8b0991068243f0d05db665015ba21dd20c9ecc9c3da5c00f185ec460952f4e9b9a40463eaf50676a4791be40a81a1c552b8f4113c64a
+  metadata.gz: 533b3a7724808ff449f8218f2764393e98e387df614ba91d135712947b81959a0c7f188ecd7da43935f09439820e0709fd160548adc932c7068238e632c1b6a9
+  data.tar.gz: 766c008f362c7c8d2df085f343b536538041538fc46a4911fd7523dea742cb14043e2522dda7e86741a20e143d6d0a46597b9a6ee580d4fdfa88320eaf8c6856

data/docker-compose.yml

@@ -21,5 +21,9 @@ services:
       - S3_SECRET_ACCESS_KEY=$S3_SECRET_ACCESS_KEY
       - S3_DEFAULT_REGION=$S3_DEFAULT_REGION
       - S3_ROOT_BUCKET=$S3_ROOT_BUCKET
+      - GRIDIUM_TR_PID=$GRIDIUM_TR_PID
+      - GRIDIUM_TR_PW=$GRIDIUM_TR_PW
+      - GRIDIUM_TR_URL=$GRIDIUM_TR_URL
+      - GRIDIUM_TR_USER=$GRIDIUM_TR_USER
       - BUILD_NUMBER=$BUILD_NUMBER
     command: "tail -f /dev/null"

data/lib/testrail.rb

@@ -4,120 +4,150 @@ require 'uri'
 require 'json'
 
 module Gridium
-	class TestRail
-		ENV_ERROR = "Environment Variable not set!"
+  class TestRail
+    ENV_ERROR = "Environment Variable not set!"
+    CONFIG = {:pass => 1, :blocked => 2, :untested => 3, :retest => 4, :fail => 5}.freeze
 
-    #TestRail Statuses
-    PASSED = 1
-    BLOCKED = 2
-    UNTESTED = 3
-    RETEST = 4
-    FAILED = 5
 
-		def initialize
+    def initialize
       if Gridium.config.testrail
         @url = ENV['GRIDIUM_TR_URL'].empty? || ENV['GRIDIUM_TR_URL'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_URL'] + '/index.php?/api/v2/'
         @user = ENV['GRIDIUM_TR_USER'].empty? || ENV['GRIDIUM_TR_USER'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_USER']
         @password = ENV['GRIDIUM_TR_PW'].empty? || ENV['GRIDIUM_TR_PW'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_PW']
         @pid = ENV['GRIDIUM_TR_PID'].empty? || ENV['GRIDIUM_TR_PID'].nil? ? ENV_ERROR : ENV['GRIDIUM_TR_PID']
-				@testcase_ids = Array.new
-				@testcase_infos = Array.new
+        @retry_attempts = 5
+        @time_between_retries = 3
+        @tc_results = Array.new
+        @tc_ids = Array.new
       end
-		end
+      @run_info = {:id => 0 ,:error => false, :include_all => false}
+    end
 
+    # Creates a new test Run in your TestRail instance.
+    #
+    # @param name [String] the name of the test run. Error text will be added if an error occurs
+    # @param desc [String] a description of the run being added. Error text will be added if an error occurs
+    # @return [int] The run ID of the created run or zero if no run created.
     def add_run(name, desc)
       if Gridium.config.testrail
         Log.debug("[GRIDIUM::TestRail] Creating Test Run: name: #{name} desc: #{desc}")
         if name.nil? || name.empty? then
-          raise(ArgumentError, "Empty Run Name - Run name is required")
+          @run_info[:error] = true
+        else
+          @run_info[:name] = name
+          @run_info[:desc] = desc
         end
-        r = _send_request('POST', "add_run/#{@pid}", {:name => name, :description => desc, :include_all => false})
-        Log.debug("Result: #{r}")
-        unless r["id"].nil?
-          @runid = r["id"]
+        r = _send_request('POST', "#{@url}add_run/#{@pid}", @run_info)
+        if r.key?('error') || r["id"].nil?
+          @run_info[:error] = true
+        else
+          @run_info[:id] = r["id"]
+          Log.debug("[GRIDIUM::TestRail] Run Added: #{r}")
         end
       end
+      return @run_info[:id]
     end
 
-		def add_case(rspec_test)
-			if Gridium.config.testrail
-				Log.debug("[GRIDIUM::TestRail] Adding to list of TestRail Cases...")
-				if rspec_test.nil? then
-					Log.error("[GRIDIUM::TestRail] No test added to results. Turn of Gridium.config.testrail\n")
-				end
-				if rspec_test.exception
-					status = FAILED
-					message = rspec_test.exception.message
-				else
-					status = PASSED
-					message = 'Test Passed.'
-				end
-				test_info = {:trid => rspec_test.metadata[:testrail_id], :status_id => status, :message => message}
-				@testcase_infos.push(test_info)
-				@testcase_ids.push(test_info[:trid])
-			end
-		end
+    # Adds determines what the result of the test is and adds information to various arrays for processing during closing.
+    #
+    # @param rspec_test [RSpec::Example] the example provided by RSpec
+    # @return [bool] determine if case was added or not
+    def add_case(rspec_test)
+      added = false
+      if Gridium.config.testrail
+        Log.debug("[GRIDIUM::TestRail] Adding to list of TestRail Cases...")
+        if rspec_test.nil? then
+          Log.error("[GRIDIUM::TestRail] No test added to results. Turn of Gridium.config.testrail\n")
+        end
+        if rspec_test.exception
+          status = CONFIG[:fail]
+          message = rspec_test.exception.message
+        else
+          status = CONFIG[:pass]
+          message = 'Test Passed.'
+        end
+        test_info = {:case_id => rspec_test.metadata[:testrail_id], :status_id => status, :comment => message}
+        @tc_results.push(test_info)
+        @tc_ids.push(test_info[:case_id])
+        added = true
+       end
+       return added
+     end
 
-		def close_run
-			if Gridium.config.testrail
-				Log.debug("[GRIDIUM::TestRail] Closing test runid: #{@runid}\n")
-				unless @runid.nil?
-					r = _send_request('POST', "update_run/#{@runid}", {:case_ids => @testcase_ids})
-					@testcase_infos.each do |tc|
-						r = _send_request(
-							'POST',
-							"add_result_for_case/#{@runid}/#{tc[:trid]}",
-							status_id: tc[:status_id],
-							comment: tc[:message]
-							)
-							sleep(0.25)
-					end
-					r = _send_request('POST', "close_run/#{@runid}", nil)
-				end
-			end
-		end
+    # Updates the existing test run with test cases and results.  Adds error text for missing test cases if needed. Closes the run as long as it exists.
+    #
+    # @return [bool] if the run was closed or not
+    def close_run
+      closed = false
+      if Gridium.config.testrail && !@run_info[:error]
+        Log.debug("[GRIDIUM::TestRail] Closing test runid: #{@run_info[:id]}\n")
+        r = _send_request('POST', "#{@url}update_run/#{@run_info[:id]}", {:case_ids => @tc_ids})
+        Log.debug("[GRIDIUM::TestRail] UPDATE RUN: #{r}")
+        sleep 0.25
+        r = _send_request('POST', "#{@url}add_results_for_cases/#{@run_info[:id]}", {results: @tc_results})
+        Log.debug("[GRIDIUM::TestRail] ADD RESULTS: #{r}")
+        sleep 0.25
+        Log.debug("#{r.class}")
+        if r.is_a?(Hash)
+          r = _send_request('POST', "#{@url}update_run/#{@run_info[:id]}", {:name => "ER:#{@run_info[:name]}", :description => "#{@run_info[:desc]}\nThe following was returned when adding cases: #{r}"})
+          Log.warn("[GRIDIUM::TestRail] ERROR: #{r}")
+          sleep 0.25
+        end
+        r = _send_request('POST', "#{@url}close_run/#{@run_info[:id]}", nil)
+        Log.debug("[GRIDIUM::TestRail] CLOSE RUN: #{r}")
+        closed = true
+      end
+      return closed
+    end
 
     private
-		def _send_request(method, uri, data)
-			url = URI.parse(@url + uri)
-			Log.debug("[GRIDIUM::TestRail] Method: #{method} URL:#{uri} Data:#{data}")
-			if method == 'POST'
-				request = Net::HTTP::Post.new(url.path + '?' + url.query)
-				request.body = JSON.dump(data)
-			else
-				request = Net::HTTP::Get.new(url.path + '?' + url.query)
-			end
-			request.basic_auth(@user, @password)
-			request.add_field('Content-Type', 'application/json')
-
-			conn = Net::HTTP.new(url.host, url.port)
-			if url.scheme == 'https'
-				conn.use_ssl = true
-				conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
-			end
-			response = conn.request(request)
-			if response.body && !response.body.empty?
-				result = JSON.parse(response.body)
-			else
-				result = {}
-			end
+    def _send_request(method, uri, data)
+      attempts = @retry_attempts
+      url = URI.parse(uri)
+      Log.debug("[GRIDIUM::TestRail] Method: #{method} URL:#{uri} Data:#{data}")
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
 
-			if response.code != '200'
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      begin
+        response = conn.request(request)
+        if response.body && !response.body.empty?
+          result = JSON.parse(response.body)
+        else
+          result = {}
+        end
 
-				if result && result.key?('error')
-					error = '"' + result['error'] + '"'
-				else
-					error = 'No additional error message received'
-				end
-				Log.debug("[GRIDIUM::TestRail] Error with request: #{error}")
-				raise APIError.new('TestRail API returned HTTP %s (%s)' %
-					[response.code, error])
-			end
+        if response.code != '200'
+          if result && result.key?('error')
+            error = '"' + result['error'] + '"'
+          else
+            error = 'No additional error message received'
+          end
+           Log.error("[GRIDIUM::TestRail] #{response.code} - Error with request: #{error}")
+        end
+      rescue SocketError => error
+        Log.warn("[GRIDIUM::TestRail] SocketError - Retrying....")
+        if attempts > 0
+          attempts -= 1
+          sleep @time_between_retries
+          retry
+        end
+        Log.error("[GRIDIUM::TestRail] Socket Error after numerous attempts. Error: #{error}")
+        result = {error: "SocketError after #{@retry_attempts} attempts.  See Error Log."}
+      end
 
-			result
-		end
-	end
+      result
+    end
+  end
 
-	class APIError < StandardError
-	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gridium
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.18
 platform: ruby
 authors:
 - Seth Urban
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler