test_rail_integration 0.0.8.1 → 0.0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34e5aab95105471b707cb4eb7118f50387709f8c
-  data.tar.gz: c3178b167f25a87c33a28576c9cb40f1a47cbc36
+  metadata.gz: bc5cbef07f354e0d32aa921ae232a51994faf657
+  data.tar.gz: b30b50310e51039182a2419f486a77dbbe421a2a
 SHA512:
-  metadata.gz: eac5d9cb35222047cf84f31371ea2feade18ad9a8e0144f55af865418acc188e27a22ab3b75e1f384042c871d729a55f5c0bfd1020f1889bd4c84faf3ad4247a
-  data.tar.gz: 84458e08a4e1dfe8cc7284e737ee67c37143eeb6f3d6fde9bd6e89653da5c7f821b42e96aac3520562cb0d702314e2fafa0912cefa519d14196ed1488f0b4b3b
+  metadata.gz: 888b1a1edff070819afd93b279c8506a8656ab3baf99958c17945bc9498371cfeac1dda88ea46abcea3a7e2befc2ed0d7431cbfe9175cf6c48ed7fde8b26bced
+  data.tar.gz: 84c180ac6ee8100369b6c70c759029eecd434764a77890f47b43fceccf3d191ed0205e30c415f108a1759975c33828744822f632f7dcf03f9818aa9adfab0b58

data/lib/test_rail_integration/generator/connection.rb

@@ -38,7 +38,7 @@ module TestRail
     #
     # client.send_get("get_results_for_case/12/3534")
     #
-    def self.get_test_result(case_id)
+    def self.get_test_results(case_id)
       client.send_get("get_results_for_case/#{test_run_id}/#{case_id}")
     end
 
@@ -49,44 +49,6 @@ module TestRail
       client.send_post("add_run/#{project_id}", {suite_id: test_suite_id, name: name, include_all: false, case_ids: cases_with_types})
     end
 
-    #
-    # Parse results and returns Failed if this test was marked as failed.
-    #
-    def self.get_previous_test_result(case_id)
-      test_results = get_test_result(case_id).map { |status_hash| status_hash["status_id"] }
-      status = TestCaseResult::FAILED if test_results.include?(TestCaseResult::FAILED)
-      status ||= TestCaseResult::PASS if test_results.first == TestCaseResult::PASS
-      status ||= TestCaseResult::NEW
-      status
-    end
-
-    #
-    # Parse results and returns previous comment.
-    #
-    def self.get_previous_comments(case_id)
-      test_comment = get_test_result(case_id).map { |hash| hash["comment"] }
-      comment = test_comment
-      comment ||= []
-      comment
-    end
-
-    #
-    # Get indexes of failed results
-    #
-    def self.get_indexes_of_fails(test_case_id)
-      indexes = get_test_result(test_case_id).map.with_index { |result, index| result["status_id"] == TestCaseResult::COMMENT[:fail][:status] ? index : nil }
-      indexes.compact
-    end
-
-    #
-    # Get last failed comment for test case
-    #
-    def self.get_last_failed_comment(test_case_id)
-      comments = get_previous_comments(test_case_id)
-      index = Connection.get_indexes_of_fails(test_case_id).first
-      comments[index]
-    end
-
     #
     # Get ID of all test cases from current test run
     #

data/lib/test_rail_integration/generator/project/check.rb

@@ -7,29 +7,30 @@ module TestRail
 
   class Check
 
-
     def self.check_test_run_statuses
       start_time = Time.new
       results = []
 
-      test_cases_id = Connection.cases_with_types
-      test_cases_id.each do |test_case|
+      test_cases_ids = Connection.cases_with_types
+      test_cases_ids.each do |test_case_id|
+
+        case_info = Connection.get_case_info(test_case_id)
+        scenario = Scenario.new(case_info['title'], ["@C#{test_case_id}"])
+        test_case_result = TestRail::TestCaseResult.new(scenario)
+        test_results = test_case_result.test_results.map { |status_hash| status_hash["status_id"] }
 
-        test_results = Connection.get_test_result(test_case).map { |status_hash| status_hash["status_id"] }
-        if test_results.include?(TestCaseResult::COMMENT[:fail][:status]) && test_results.include?(TestCaseResult::COMMENT[:pass][:status])
-          fail_indexes = test_results.map.with_index{ |element, index| element == TestCaseResult::COMMENT[:fail][:status] ? index : nil }.compact
-          pass_indexes = test_results.map.with_index{ |element, index| element == TestCaseResult::COMMENT[:pass][:status] ? index : nil }.compact
+        if test_results.include?(TestCaseResult::COMMENT[:fail][:status]) &&
+            test_results.include?(TestCaseResult::COMMENT[:pass][:status])
 
-          if pass_indexes.first < fail_indexes.first
-            scenario = Connection.get_case_info(test_case)
-            test_case_result = TestRail::TestCaseResult.new(test_case, scenario['title'])
+          if test_case_result.get_indexes_of_passes.first < test_case_result.get_indexes_of_fails.first
             test_case_result.comment ||= TestRail::TestCaseResult::COMMENT[:fail]
             TestRail::Connection.commit_test_result(test_case_result)
 
             p test_case_result.test_case_id
-            p test_case_result.title
+            p test_case_result.scenario.title
             results.push(test_case_result)
           end
+
         end
       end
       end_time = Time.now - start_time
@@ -38,4 +39,16 @@ module TestRail
     end
 
   end
+
+  class Scenario
+
+    attr_accessor :title, :source_tag_names
+
+    def initialize(title, source_tag_names)
+      self.title = title
+      self.source_tag_names = source_tag_names
+    end
+
+  end
+
 end

data/lib/test_rail_integration/generator/test_case_result.rb

@@ -3,7 +3,13 @@ require_relative 'test_rail_data_load'
 module TestRail
   class TestCaseResult
 
-    attr_accessor :test_case_id, :title, :comment, :exception_message, :assign_to, :previous_comment
+    attr_accessor :test_case_id,
+                  :comment,
+                  :exception_message,
+                  :assign_to,
+                  :previous_comment,
+                  :scenario,
+                  :test_results
 
     COMMENT_STATUS ||= TestRail::TestRailDataLoad.test_rail_data[:status_comment]
     PASS ||= TestRail::TestRailDataLoad.test_rail_data[:test_pass]
@@ -13,16 +19,90 @@ module TestRail
     FAILED_COMMENT ||= TestRail::TestRailDataLoad.test_rail_data[:test_failed_comment]
     ASSIGN_TO ||= TestRail::TestRailDataLoad.test_rail_data[:assign_to]
 
-
     COMMENT ||= {:pass => {status: PASS, comment: PASS_COMMENT},
                  :fail => {status: FAILED, comment: FAILED_COMMENT},
                  :unchanged_pass => {status: COMMENT_STATUS, comment: PASS_COMMENT}
     }
 
-    def initialize(test_case_id, title)
-      self.test_case_id = test_case_id
-      self.title = title
-      self.previous_comment = TestRail::Connection.get_last_failed_comment(test_case_id) unless Connection.get_indexes_of_fails(test_case_id).empty?
+    TEST_RAIL_ID_REGEX ||= /^@C\d+/
+
+    def initialize(scenario)
+      self.test_case_id = scenario.source_tag_names.find { |e| e.match(TEST_RAIL_ID_REGEX) }[2..-1]
+      self.scenario = scenario
+      self.test_results = TestRail::Connection.get_test_results(self.test_case_id)
+      self.previous_comment = get_last_failed_comment unless get_indexes_of_fails.empty?
+    end
+
+    def failed?
+      !scenario.passed?
+    end
+
+    def passed?
+      scenario.passed? && get_previous_test_result != FAILED
+    end
+
+    def unchanged_pass?
+      scenario.passed? && get_previous_test_result == FAILED
+    end
+
+    #
+    # Get indexes of failed results
+    #
+    def get_indexes_of_fails
+      indexes = self.test_results.map.with_index { |result, index| result["status_id"] == TestCaseResult::COMMENT[:fail][:status] ? index : nil }
+      indexes.compact
+    end
+
+    def get_indexes_of_passes
+      indexes = self.test_results.map.with_index { |result, index| result["status_id"] == TestCaseResult::COMMENT[:pass][:status] ? index : nil }
+      indexes.compact
+    end
+
+    #
+    # Parse results and returns previous comment.
+    #
+    def get_previous_comments
+      test_comment = self.test_results.map { |hash| hash["comment"] }
+      comment = test_comment
+      comment ||= []
+      comment
+    end
+
+    #
+    # Get last failed comment for test case
+    #
+    def get_last_failed_comment
+      comments = get_previous_comments
+      index = get_indexes_of_fails.first
+      comments[index]
+    end
+
+    #
+    # Parse results and returns Failed if this test was marked as failed.
+    #
+    def get_previous_test_result
+      test_results = self.test_results.map { |status_hash| status_hash["status_id"] }
+      status = FAILED if test_results.include?(FAILED)
+      status ||= PASS if test_results.first == PASS
+      status ||= NEW
+      status
+    end
+
+    def update
+      self.comment = COMMENT[:pass] if passed?
+      self.comment ||= COMMENT[:unchanged_pass] if unchanged_pass?
+
+      if failed?
+        self.comment ||= COMMENT[:fail]
+        self.exception_message = scenario.steps.exception rescue nil
+        self.assign_to = ASSIGN_TO
+      end
+
+      raise("Invalid test case result : scenario.passed? #{self.scenario.passed?}, prev_result? #{get_previous_test_result}, run_result? #{self.scenario.passed?}") if self.comment.nil?
+
+      TestRail::Connection.commit_test_result(self)
+
+      self
     end
 
     #
@@ -31,7 +111,7 @@ module TestRail
     # {status_id: 1, comment: "Test passed"}
     #
     def to_test_rail_api
-      comment_message = "#{self.comment[:comment]} \"#{self.title}\""
+      comment_message = "#{self.comment[:comment]} \"#{self.scenario.title}\""
       comment_message = "**[#{Fixtures.instance['venture']}]** #{self.comment[:comment]} for \"#{self.title}\"" unless defined?(Fixtures.instance['venture']).nil?
       comment_message += "\n Exception : #{self.exception_message}" unless self.exception_message.nil?
       comment_message += "\n #{self.previous_comment}" if self.comment[:status] == COMMENT[:fail][:status] || self.comment[:status] == COMMENT[:unchanged_pass][:status]

data/lib/test_rail_integration/generator/test_rail_hooks.rb

@@ -3,47 +3,15 @@ require 'test_rail_integration/generator/connection'
 module TestRail
   class Hook
 
-    TEST_RAIL_ID_REGEX ||= /^@C\d+/
-
     #
     # Updating Test Rail according to logic
     #
     def self.update_test_rail(scenario)
-      test_case_id = scenario.source_tag_names.find { |e| e.match(TEST_RAIL_ID_REGEX) }[2..-1]
-
-      prev_result = TestRail::Connection.get_previous_test_result(test_case_id)
-      run_result = scenario.passed?
-      test_case_result = TestRail::TestCaseResult.new(test_case_id, scenario.title)
-
-      test_case_result.comment = TestRail::TestCaseResult::COMMENT[:pass] if passed_result?(run_result, prev_result)
-      test_case_result.comment ||= TestRail::TestCaseResult::COMMENT[:unchanged_pass] if unchanged_pass_result?(run_result, prev_result)
-
-      if failed_result?(run_result)
-        test_case_result.comment ||= TestRail::TestCaseResult::COMMENT[:fail]
-        test_case_result.exception_message = scenario.steps.exception rescue nil
-        test_case_result.assign_to = TestRail::TestCaseResult::ASSIGN_TO
-      end
-
-      raise("Invalid test case result : scenario.passed? #{scenario.passed?}, prev_result? #{prev_result}, run_result? #{run_result}") if test_case_result.comment.nil?
-
-      TestRail::Connection.commit_test_result(test_case_result)
-
-    end
-
-    def self.failed_result?(result)
-      !result
-    end
-
-    def self.passed_result?(result, prev_result)
-      result && prev_result != TestRail::TestCaseResult::FAILED
-    end
-
-    def self.unchanged_pass_result?(result, prev_result)
-      result && prev_result == TestRail::TestCaseResult::FAILED
+      TestRail::TestCaseResult.new(scenario).update
     end
 
     at_exit do
-      TestRail::Connection.change_test_run_name
+      TestRail::Connection.change_test_run_name until ENV['rspec-tests-running']
     end
   end
 end

data/lib/test_rail_integration/version.rb

@@ -1,3 +1,3 @@
 module TestRailIntegration
-  VERSION = "0.0.8.1"
+  VERSION = "0.0.8.2"
 end

data/spec/api_calls_spec.rb

@@ -0,0 +1,31 @@
+require 'rspec'
+require_relative '../lib/test_rail_integration/generator/connection'
+
+describe 'Api calls' do
+
+  context 'When i am creating test case result' do
+
+    before(:each) do
+      allow(TestRail::Connection).to receive(:commit_test_result).and_return('good!')
+      @scenario = double('scenario')
+      allow(@scenario).to receive(:source_tag_names).and_return(['@C4556'])
+      allow(@scenario).to receive(:title).and_return('title')
+      allow(@scenario).to receive(:passed?).and_return(true)
+      allow(TestRail::Connection).to receive(:get_test_results).and_return([])
+    end
+
+    it 'i am calling get_test_results api method once' do
+      expect(TestRail::Connection).to receive(:get_test_results).once
+      test_case_result = TestRail::TestCaseResult.new(@scenario)
+      test_case_result.update
+    end
+
+    it 'i am calling commit_test_result api method once' do
+      expect(TestRail::Connection).to receive(:commit_test_result).once
+      test_case_result = TestRail::TestCaseResult.new(@scenario)
+      test_case_result.update
+    end
+
+  end
+
+end

data/spec/check_test_run_spec.rb

@@ -4,29 +4,55 @@ require_relative '../lib/test_rail_integration/generator/project/check'
 
 describe 'Checking test run' do
 
-  context 'when last result is pass but we already have fail results' do
+  context 'when last result is pass' do
+
+    context 'but we already have one result' do
+
+      before(:each) do
+        allow(TestRail::Connection).to receive(:cases_with_types).and_return([1011])
+        allow(TestRail::Connection).to receive(:get_test_results).and_return([{"status_id" => 1, :comment => "FTW"}, {"status_id" => 5, :comment => "Burn heretics"}])
+        allow(TestRail::Connection).to receive(:get_case_info).and_return({id: 1011, "title" => 'MLP'})
+        allow(TestRail::Connection).to receive(:commit_test_result).and_return([])
+      end
+
+      it 'should change status to fail' do
+        test_case_results = TestRail::Check.check_test_run_statuses
+        expect(test_case_results[0].comment).to eq({:status => 5, :comment => "test **failed:**"})
+      end
+
+      it 'should call api once' do
+        expect(TestRail::Connection).to receive(:cases_with_types).once
+        expect(TestRail::Connection).to receive(:get_case_info).once
+        expect(TestRail::Connection).to receive(:get_test_results).once
+        expect(TestRail::Connection).to receive(:commit_test_result).once
+        TestRail::Check.check_test_run_statuses
+      end
 
-    it 'should change status to fail' do
+    end
 
-      allow(TestRail::Connection).to receive(:cases_with_types).and_return([1011])
-      allow(TestRail::Connection).to receive(:get_test_result).and_return([{"status_id" => 1, :comment => "FTW"}, {"status_id" => 5, :comment => "Burn heretics"}])
-      allow(TestRail::Connection).to receive(:get_case_info).and_return({id: 1011, "title" => 'MLP'})
-      allow(TestRail::Connection).to receive(:commit_test_result).and_return([])
+    context 'but we already have several results' do
 
-      test_case_results = TestRail::Check.check_test_run_statuses
-      expect(test_case_results[0].title).to eq('MLP')
-      expect(test_case_results[0].comment).to eq({:status => 5, :comment => "test **failed:**"})
-    end
+      before(:each) do
+        allow(TestRail::Connection).to receive(:cases_with_types).and_return([1011, 1213])
+        allow(TestRail::Connection).to receive(:get_test_results).and_return([{"status_id" => 1, :comment => "FTW"}, {"status_id" => 5, :comment => "Burn heretics"}] )
+        allow(TestRail::Connection).to receive(:get_case_info).and_return({id: 1011, "title" => 'MLP'})
+        allow(TestRail::Connection).to receive(:commit_test_result).and_return([])
+      end
 
-    it "should call api twice" do
+      it 'should have two results' do
+        test_case_results = TestRail::Check.check_test_run_statuses
+        expect(test_case_results.length).to eq 2
+      end
 
-      allow(TestRail::Connection).to receive(:cases_with_types).and_return([1011, 1213])
-      allow(TestRail::Connection).to receive(:get_test_result).and_return([{"status_id" => 1, :comment => "FTW"}, {"status_id" => 5, :comment => "Burn heretics"}] )
-      allow(TestRail::Connection).to receive(:get_case_info).and_return({id: 1011, "title" => 'MLP'})
-      allow(TestRail::Connection).to receive(:commit_test_result).and_return([])
+      it 'should call api twice' do
+        expect(TestRail::Connection).to receive(:cases_with_types).once
+        expect(TestRail::Connection).to receive(:get_case_info).twice
+        expect(TestRail::Connection).to receive(:get_test_results).twice
+        expect(TestRail::Connection).to receive(:commit_test_result).twice
+        TestRail::Check.check_test_run_statuses
+      end
 
-      test_case_results = TestRail::Check.check_test_run_statuses
-      expect(test_case_results.length).to eq 2
     end
+
   end
 end

data/spec/hooks_spec.rb

@@ -0,0 +1,125 @@
+require 'rspec'
+require_relative '../lib/test_rail_integration/generator/connection'
+require_relative '../lib/test_rail_integration/generator/test_rail_hooks'
+
+describe 'Update test results' do
+
+  before(:all) do
+    ENV['rspec-tests-running'] = '1'
+  end
+
+  before(:each) do
+    allow(TestRail::Connection).to receive(:commit_test_result).and_return('good!')
+    @scenario = double('scenario')
+    allow(@scenario).to receive(:source_tag_names).and_return(['@C4556'])
+    allow(@scenario).to receive(:title).and_return('title')
+  end
+
+  context 'when there is no previous result' do
+
+    before(:each) do
+      allow(TestRail::Connection).to receive(:get_test_results).and_return([])
+    end
+
+    it 'current result should be passed' do
+      test_result = TestRail::Hook.update_test_rail(passed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>1, :comment => 'test **passed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 1, :comment => "test **passed:** \"title\""})
+    end
+
+    it 'current result should be failed' do
+      test_result = TestRail::Hook.update_test_rail(failed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>5, :comment => 'test **failed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 5, :comment => "test **failed:** \"title\"\n Exception : exception\n "})
+    end
+
+  end
+
+  context 'when previous result is passed' do
+
+    before(:each) do
+      allow(TestRail::Connection).to receive(:get_test_results).and_return(
+                                         [{"status_id" => 1, "comment" =>"test **passed:**"}])
+    end
+
+    it 'current result should be passed' do
+      test_result = TestRail::Hook.update_test_rail(passed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>1, :comment => 'test **passed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 1, :comment => "test **passed:** \"title\""})
+    end
+
+    it 'current result should be failed' do
+      test_result = TestRail::Hook.update_test_rail(failed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>5, :comment => 'test **failed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 5, :comment => "test **failed:** \"title\"\n Exception : exception\n "})
+    end
+
+  end
+
+  context 'when previous result is failed' do
+
+    before(:each) do
+      allow(TestRail::Connection).to receive(:get_test_results).and_return(
+                                         [{"status_id" => 5, "comment" =>"test **failed:**"}])
+    end
+
+    it 'current result should be failed' do
+      test_result = TestRail::Hook.update_test_rail(failed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>5, :comment => 'test **failed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 5, :comment => "test **failed:** \"title\"\n Exception : exception\n test **failed:**"})
+    end
+
+    it 'current result should be comment' do
+      test_result = TestRail::Hook.update_test_rail(passed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>0, :comment => 'test **passed:**'})
+      expect(test_result.to_test_rail_api).to eq({:comment => "test **passed:** \"title\"\n test **failed:**"})
+    end
+
+  end
+
+  context 'when previous result is comment' do
+
+    before(:each) do
+      allow(TestRail::Connection).to receive(:get_test_results).and_return(
+                                         [{"status_id" => 5, "comment" =>"test **failed:**"}])
+    end
+
+    it 'current result should be comment' do
+      allow(@scenario).to receive(:passed?).and_return(true)
+      test_result = TestRail::Hook.update_test_rail(passed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>0, :comment => 'test **passed:**'})
+      expect(test_result.to_test_rail_api).to eq({:comment => "test **passed:** \"title\"\n test **failed:**"})
+    end
+
+    it 'current result should be failed' do
+      test_result = TestRail::Hook.update_test_rail(failed_scenario)
+      expect(test_result.test_case_id).to eq('4556')
+      expect(test_result.comment).to eq({:status=>5, :comment => 'test **failed:**'})
+      expect(test_result.to_test_rail_api).to eq({:status_id => 5, :comment => "test **failed:** \"title\"\n Exception : exception\n test **failed:**"})
+    end
+
+  end
+
+  private
+  def passed_scenario
+    allow(@scenario).to receive(:passed?).and_return(true)
+    @scenario
+  end
+
+  private
+  def failed_scenario
+    allow(@scenario).to receive(:passed?).and_return(false)
+    steps = double('steps')
+    allow(steps).to receive(:exception).and_return('exception')
+    allow(@scenario).to receive(:steps).and_return(steps)
+    @scenario
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_rail_integration
 version: !ruby/object:Gem::Version
-  version: 0.0.8.1
+  version: 0.0.8.2
 platform: ruby
 authors:
 - Kirikami
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,7 +179,9 @@ files:
 - lib/test_rail_integration/generator/test_run_creation.rb
 - lib/test_rail_integration/generator/test_run_parameters.rb
 - lib/test_rail_integration/version.rb
+- spec/api_calls_spec.rb
 - spec/check_test_run_spec.rb
+- spec/hooks_spec.rb
 - spec/spec_helper.rb
 - test_rail_integration.gemspec
 homepage: https://github.com/Kirikami/test_rail_integration
@@ -207,5 +209,7 @@ signing_key:
 specification_version: 4
 summary: Gem for integration between framework and TestRail API
 test_files:
+- spec/api_calls_spec.rb
 - spec/check_test_run_spec.rb
+- spec/hooks_spec.rb
 - spec/spec_helper.rb