testrail_rspec 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caf3e56aa6b5f3282ca4782031502ac33f1a9a24
-  data.tar.gz: 30c176d341f33987bcf8dd745dee4541e62cf02c
+  metadata.gz: a309a3c8560f79c8d8d14007533e8b2390f7e223
+  data.tar.gz: 43e3a1f3ce7d8239ba75ebe9ee029432b16fbbc4
 SHA512:
-  metadata.gz: 561a7ece1fe03c9f4d91125d6f071347cd27e81a2f20b773b5b76ae0561be5aae48aa35fd408526bea4cddfcb15bf8f8bdf90f07eb643bf127851a9b410cc5e1
-  data.tar.gz: ca1fe5af70bcbbf0df9cf204dfca1e625323533c3ad1498279751dfb6014979f8dc04f9ac92832d3cbedb20f3391606d1a418ae974c66283e116875548a44818
+  metadata.gz: c004fc325ba968da4ae437d0a079179b40e7d0a745271bef13478d97bb22880a5608df38b23069841b77686e8cade25e115772c03bb6da27162f1cdf7757e5ea
+  data.tar.gz: 2ee15a1484369276635bb168bae6fa341e91edc47dfeb82f0c6871f93c62815874fba0cf46b9b47714636eec339d4960310d55736ff3d6516f8f7981d14e3c3d

data/README.md

@@ -28,11 +28,22 @@ via RSpec.configure in spec_helper.rb - describe it in more details when decided
 add to .rspec file this way:
 
     $ --format TestrailExport
+the same for [Parallel Tests][3]
 
 or use it from commandline this way:
 
     $ rspec spec --format TestrailExport
 
+### Customize it
+##### Test Run name
+Test run names consists of two parts by default:
+
+- **TEST_RUN_NAME** envirnment variable value or execution time/date (i.e. **"15 Oct 2014 15:41 CEST"**)
+- suite name (if only it is different then _Master_ which is reserved for single suite projects)
+
+example test run name: **15 Oct 2014 15:41 CEST - Test Suite 1**
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/testrail-rspec/fork )
@@ -42,4 +53,5 @@ or use it from commandline this way:
 5. Create a new Pull Request
 
 [1]: http://www.gurock.com/testrail/            "TestRail"
-[2]: http://docs.gurock.com/testrail-api2/start "TestRail API"
+[2]: http://docs.gurock.com/testrail-api2/start "TestRail API"
+[3]: https://github.com/grosser/parallel_tests  "Parallel Tests"

data/lib/testrail_export.rb

@@ -20,7 +20,7 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
 
   def initialize(output)
     @options = {}
-    @project_id = nil
+    @project = nil
     super(output)
   end
 
@@ -28,8 +28,8 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
   def start(notification)
     @options = RSpec.configuration.testrail_formatter_options
     @client = Testrail::Client.new(@options)
-    @client.get_projects.each { |project| @project_id = project['id'] if project['name'] == @options[:project] }
-    @start_time_str = start_timestamp
+    @client.get_projects.each { |project| @project = project if project['name'] == @options[:project] }
+    @run_name = ENV['TEST_RUN_NAME'] || start_timestamp
 
     puts "TestRail Exporter [INFO] Executing #{notification.count} tests. Loaded in #{notification.load_time}"
 
@@ -101,14 +101,15 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
   end
 
   def dump_summary(notification)
+    @client.get_projects.each { |project| @project = project if project['name'] == @options[:project] } unless @project
     # Create project if it is not present / could do it setting controlled
-    if @project_id.nil?
+    if @project.nil?
       puts "TestRail Exporter [INFO] Creating project: #{@options[:project]}"
-      @project_id = @client.add_project(@options[:project])['id']
+      @project = @client.add_project(@options[:project])
     end
 
     suites = Hash.new do |h,k|
-      h[k] = Tree::TreeNode.new(k, @client.find_or_create_suite(k, @project_id) )
+      h[k] = Tree::TreeNode.new(k, @client.find_or_create_suite(k, @project['id']) )
     end
 
 
@@ -116,7 +117,7 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
       build_hierarchy_tree!(suites, example)
     end
 
-    suites.each { |_, suite| update_test_run(suite) }
+    suites.each { |_, suite| update_test_run(suite, @run_name) }
 
     super
   end
@@ -139,7 +140,7 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
 
   def build_hierarchy_tree!(suites, example)
     path = get_path_for(example)
-
+    path.unshift('Master') if @project['suite_mode'] == 1
     parent_node = suite_node = suites[path.shift]
     path.unshift('Direct cases') unless path.size > 1
 
@@ -162,16 +163,26 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
 
   end
 
-  def update_test_run(suite)
-    run_id = @client.create_run(suite.content, @start_time_str)['id']
+  def update_test_run(suite, run_name)
+    run_id = @client.create_run(suite.content, run_name)['id']
     results = suite.each_leaf.map do |test|
       test_result = test.content[:result].execution_result
       run_time_seconds = test_result.run_time.round(0)
+      infos = { elapsed: (run_time_seconds == 0) ? nil : "#{run_time_seconds}s",
+                version: nil
+      }
+      infos[:comment] = case test_result.status
+                          when :failed
+                            [test_result.exception.message, test_result.exception.backtrace].join("\n")
+                          when :pending
+                            test_result.pending_message
+                          else
+                            nil
+                        end
       {
           case_id:    test.content[:case]['id'],
-          status_id:  Testrail::STATUS[test_result.status],
-          elapsed:    (run_time_seconds == 0) ? nil : "#{run_time_seconds}s"
-      }
+          status_id:  Testrail::STATUS[test_result.status]
+      }.merge(infos.delete_if { |_,v| v.nil? })
     end
     @client.add_results_for_cases(run_id, results)
   end
@@ -180,4 +191,4 @@ class TestrailExport < RSpec::Core::Formatters::BaseTextFormatter
     # make it a bit freezed
     Time.at((Time.now.to_i.to_s[0..7] + "00").to_i).strftime('%d %b %Y %R %Z')
   end
-end
+end

data/lib/testrail_export/client.rb

@@ -48,11 +48,12 @@ module Testrail
       @projects ||= @client.send_get('get_projects')
     end
 
-    def add_project(project_name)
+    def add_project(project_name, suite_mode=1)
       @projects = nil # invalidate cached stuff
-      @client.send_post('add_project', {name: project_name,
-                                        announcement: AUTOMATED_DESCRIPTION,
-                                        show_anouncement: true})
+      @client.send_post('add_project', { name: project_name,
+                                         announcement: AUTOMATED_DESCRIPTION,
+                                         show_anouncement: true,
+                                         suite_mode: suite_mode })
     end
 
     def get_project(project_id)
@@ -136,7 +137,11 @@ module Testrail
     # ----------------------------------------------------> runs <------------------------------------------------------
 
     def create_run(suite, prefix=nil)
-      @client.send_post("add_run/#{suite['project_id']}", { suite_id: suite['id'], name: "#{prefix || nice_time_now} - #{suite['name']}", description: 'describe it somehow'})
+      trailer = suite['name'] == 'Master' ? nil : suite['name']
+      run_name = [prefix || nice_time_now, trailer].compact.join(' - ')
+      @client.send_post("add_run/#{suite['project_id']}", { suite_id: suite['id'],
+                                                            name: run_name,
+                                                            description: 'Automated tests execution'})
     end
 
     def add_results_for_cases(run_id, results)

data/testrail_rspec.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.name          = "testrail_rspec"
 
-  spec.version       = '0.0.6'
+  spec.version       = '0.0.7'
 
   spec.authors       = ["Michal Kubik"]
   spec.email         = ["michal.kubik@boost.no"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrail_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Michal Kubik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2014-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: RSpec exporter formatter - pushes test run results to TestRail instance.