testrail_rspec_formatter 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c6ed2420e271a13f68503bc3c95a17ad71a3afb
-  data.tar.gz: 6dcfcf9dc87468142dc91209546097e5ea2e536c
+  metadata.gz: 7b4673b0d7956f86f4ab15a919497f4b363b8d3b
+  data.tar.gz: cf3cf82f5ca169f1cf1c6035849fadfe31b5b3ad
 SHA512:
-  metadata.gz: 5868d6f21d1b2a1ba92b225fb1defa46b3b94c5ed967ef12178ee81e5f95b420d32daae01f82cfb69f012961fd70e8182adc255f1ccaae0ba1d9e01640d48548
-  data.tar.gz: e9a5a560aa363d75f0fe48a0dae8176735158c73084bb5517f781367595312d5361f15a480f3c59850cb1096e7ac4b5cff86a0ddbed747c90a2f45181777962b
+  metadata.gz: 2448d88a23d8279dcdfbf4560472a5266164e657f225acb31378b140cdfba35fefbf120f26f6960491851215cc747f334dc97a9dd957a5ab04d25c10c5260d60
+  data.tar.gz: 83d567833ad7c1f6ccf5675e681db0884538c2b89c3fe5955d4401669f8ef36d0eabda9163e9babac995a927b2c4bf50d7aa0df31865cd3c9086e33c253cfad6

data/README.md

@@ -1,8 +1,6 @@
 # TestrailRspecFormatter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/testrail_rspec_formatter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An RSpec formatter that sends results to [TestRail](http://www.gurock.com/testrail/)
 
 ## Installation
 
@@ -22,7 +20,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After specs run the formatter will mark test cases of a test run as either passed, failed or retest,
+depending on whether a spec passed, failed or is pending. Specs are associated with TestRail test cases
+by adding a tag with the name `testrail` to them:
+
+```ruby
+describe "som test" do
+  id "some spec", testrail: 1234 do # 1234 is the id of a test case
+    # ...
+  end
+end
+```
+
+The formatter must be configured with a run name inside a project id. If a run with that name doesn't exist
+it is created.
+
+The recommended way to use this formatter is to set the run name to a project's version or tag, and only
+run it on release or deploy versions (using the disabeld configuration option).
+
+### Configuration
+
+In addition to the configuration specified below, the formatter is only ran when passed to rspec
+via a `--formatter` argument (which can be in the `.rspec` file):
+
+```
+rspec spec --format TestrailRspecFormatter::Formatter
+```
+
+To have it ran in addition to the default progress (dots) formatter, execute:
+
+```
+rspec spec --format progress --format TestrailRspecFormatter::Formatter
+```
+
+Configure it via `ENV` variables or `RSpec.configure` (or with a mix of them).
+
+### Via ENV
+
+* TESTRAIL_FORMATTER_PROJECT_ID: (required) the id of the TestRail project
+* TESTRAIL_FORMATTER_RUN_NAME: (required) the name of the run to target
+* TESTRAIL_FORMATTER_URL: (required) the URL to target (`"https://your-user.testrail.com"``)
+* TESTRAIL_FORMATTER_USER: (required) your TestRail user
+* TESTRAIL_FORMATTER_PASSWORD: (required) your TestRail password (not recommended) or API key (recommended)
+* TESTRAIL_FORMATTER_DISABLED: (optional) set to 1 to disable the formatter
+
+### Via `RSpec.configure`
+
+```ruby
+RSpec.configure do |config|
+  config.testrail_formatter_options[:project_id] = ... # (required) the id of the TestRail project
+  config.testrail_formatter_options[:run_name]   = ... # (required) the name of the run to target
+  config.testrail_formatter_options[:url]        = ... # (required) the URL to target (`"https://your-user.testrail.com"``)
+  config.testrail_formatter_options[:user]       = ... # (required) your TestRail user
+  config.testrail_formatter_options[:password]   = ... # (required) your TestRail password (not recommended) or API key (recommended)
+  config.testrail_formatter_options[:disabled]   = ... # (optional) set to true to disable the formatter
+end
+```
 
 ## Development
 
@@ -32,10 +85,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/testrail_rspec_formatter.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/manastech/testrail_rspec_formatter.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/testrail_rspec_formatter/client.rb

@@ -14,6 +14,7 @@ require 'json'
 
 module TestrailRspecFormatter
   class APIClient
+    attr_accessor :base_url
     attr_accessor :user
     attr_accessor :password
 
@@ -21,6 +22,7 @@ module TestrailRspecFormatter
       if !base_url.match(/\/$/)
         base_url += '/'
       end
+      @base_url = base_url
       @url = base_url + 'index.php?/api/v2/'
     end
 
@@ -35,7 +37,7 @@ module TestrailRspecFormatter
     # uri                 The API method to call including parameters
     #                     (e.g. get_case/1)
     #
-    def send_get(uri)
+    def get(uri)
       _send_request('GET', uri, nil)
     end
 
@@ -52,7 +54,7 @@ module TestrailRspecFormatter
     # data                The data to submit as part of the request (as
     #                     Ruby hash, strings must be UTF-8 encoded)
     #
-    def send_post(uri, data)
+    def post(uri, data)
       _send_request('POST', uri, data)
     end
 
@@ -87,8 +89,9 @@ module TestrailRspecFormatter
         else
           error = 'No additional error message received'
         end
-        raise APIError.new('TestRail API returned HTTP %s (%s)' %
-          [response.code, error])
+        ex = APIError.new('TestRail API returned HTTP %s (%s)' % [response.code, error])
+        ex.code = response.code.to_i
+        raise
       end
 
       result
@@ -96,5 +99,6 @@ module TestrailRspecFormatter
   end
 
   class APIError < StandardError
+    attr_accessor :code
   end
 end

data/lib/testrail_rspec_formatter/formatter.rb

@@ -17,11 +17,17 @@ module TestrailRspecFormatter
     RSpec::Core::Formatters.register self, :start, :close, :dump_summary, :dump_failures, :dump_pending
 
     def dump_summary(notification)
+      disabled = testrail_config_value(:disabled, "TESTRAIL_FORMATTER_DISABLED", false)
+      if disabled == "1" || disabled == true
+        testrail_log "skipped because it was disabled"
+        return
+      end
+
+      testrail_log "starting..."
+
       examples = notification.examples
       results = []
       examples.each do |example|
-        next if example.pending?
-
         testrail_metadata = example.metadata[:testrail]
         next unless testrail_metadata
 
@@ -32,9 +38,13 @@ module TestrailRspecFormatter
         results << result
       end
 
-      unless results.empty?
+      if results.empty?
+        testrail_log "no test cases found (no spec had a testrail tag)"
+      else
         post_testrail_results(results)
       end
+    ensure
+      testrail_log "finished"
     end
 
     def dump_failures(*)
@@ -49,10 +59,32 @@ module TestrailRspecFormatter
 
     def post_testrail_results(results)
       client = new_testrail_client
-      run_id = testrail_config_value(:run_id, "TESTRAIL_FORMATTER_RUN_ID")
 
-      json = {results: results}
-      client.send_post("add_results_for_cases/#{run_id}", json)
+      project_id = testrail_config_value(:project_id, "TESTRAIL_FORMATTER_PROJECT_ID")
+      run_name = testrail_config_value(:run_name, "TESTRAIL_FORMATTER_RUN_NAME")
+
+      testrail_log "target url is: #{client.base_url}"
+
+      runs = client.get("get_runs/#{project_id}")
+      run = runs.find { |run| run["name"] == run_name }
+      if run
+        run_id = run["id"]
+        testrail_log "found run with name #{run_name.inspect}, id is #{run["id"]}"
+      else
+        testrail_log "no run found with name #{run_name.inspect}, creating one..."
+        case_ids = results.map { |result| result[:case_id] }
+        run = client.post("add_run/#{project_id}", {
+          name: run_name,
+          include_all: false,
+          case_ids: case_ids,
+        })
+        run_id = run["id"]
+        testrail_log "created run with id #{run["id"]}"
+      end
+
+      testrail_log "sending results for #{results.size} test case#{results.size == 1 ? "" : "s"}..."
+
+      client.post("add_results_for_cases/#{run_id}", {results: results})
     end
 
     def new_testrail_client
@@ -62,17 +94,27 @@ module TestrailRspecFormatter
       client
     end
 
-    def testrail_config_value(hash_key, env_key)
-      RSpec.configuration.testrail_formatter_options[hash_key] || ENV[env_key] || raise("Missing RSpec.configuration.testrail_formatter_options[#{hash_key.inspect}] or ENV[#{env_key.inspect}]")
+    def testrail_config_value(hash_key, env_key, default = nil)
+      value = RSpec.configuration.testrail_formatter_options[hash_key] || ENV[env_key]
+      if !value && default == nil
+        raise("Missing RSpec.configuration.testrail_formatter_options[#{hash_key.inspect}] or ENV[#{env_key.inspect}]")
+      end
+      value || default
     end
 
     def testrail_status(example)
-      case example.execution_result.status
-      when :passed
+      case
+      when example.pending?
+        RETEST
+      when example.execution_result.status == :passed
         PASSED
       else
         FAILED
       end
     end
+
+    def testrail_log(message)
+      output.puts "TestRail: #{message}"
+    end
   end
 end

data/lib/testrail_rspec_formatter/version.rb

@@ -1,3 +1,3 @@
 module TestrailRspecFormatter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrail_rspec_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ary Borenszweig
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec