testrailtagging 0.3.8.5 → 0.3.8.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f37a99cc06d1145c1895ae5f04757f10183a048e64e59dabdc1c8403d0f7212a
-  data.tar.gz: 721856049f244b684633b303985678ab1698740778a79a7e254d7cb1497742bb
+SHA1:
+  metadata.gz: 1704bff5ff0563958d35e1fadf2a6fbc6da34865
+  data.tar.gz: 8d72ac9b1bda1be79d704d9827f574b065979062
 SHA512:
-  metadata.gz: 4abc90728c7a8c8f346e97a7a95d3bdfa3c205d5f943239e90845a51a00a9d0032dcef51886c1b386b7a46727b0f61de45de52d1b3baf3b2c14c159dd36a3555
-  data.tar.gz: f023c5d34851814a633419b8a8a66d3847cf85fa22006d595180ec486939d27f4f8f3e67ae24b5c3933d32d2415911c9a88f0b3b5028d46fee32d53a51318375
+  metadata.gz: fb26a2d4685020a0407b335624e33df77418afa801d26f928de90198d02f54bdc2a99f063b4128b55a41d89be0bd25a3d874e8c67309f062cdc8749565b98e89
+  data.tar.gz: 38d54e8f36886e5d89ab126a289795244706211d1d4966085009f02f8bb9fd5c155bf92a20e3447989b09247b8d03c958065a0ca6c8e6cb3494567c6661e2111

data/README.md

@@ -3,7 +3,7 @@
 Testrailtagging is some ruby modules and classes that integrate rspec together with GuRock's Testrail web-application.
 The main feature of this gem is to allow realtime reporting of rspec results to testrail.
 
-There is also functionality to push and pull data to testrail. 
+There is also functionality to push and pull data to testrail.
 
 ## Installation
 
@@ -21,15 +21,16 @@ Or install it yourself as:
 
     $ gem install testrailtagging
 
-## Usage
+## Configuration
 
 First, you must have a valid and active testrail account you want to post results to.
 Second to use the API's you will need a username and a password for testrail.
 
 Hence to do anything with this gem you will need to set the following environment variables:
- 
+
 `TESTRAIL_USER`
 `TESTRAIL_PASSWORD`
+`TESTRAIL_URL` (example:"https://canvas.testrail.com")
 
 which this gem will look for and use.
 
@@ -37,11 +38,12 @@ which this gem will look for and use.
 `TESTRAIL_RUN_DELETE_FORCE`
 With RUN_DELETE_DAYS defined the gem will delete all test runs in the provided plan_id that are older than
 the days specified.  There is a limit of 7 days which can be overridden with RUN_DELETE_FORCE set to true.
- 
+
 ### For Reporting results to testrail
 
 This is for reporting rspec results to a pre-existing test run at testrail.com.
-First, in testrail find the ID of the test run you want to push results to. You can find it in URL like this:
+#### Testrail Id
+In testrail find the ID of the test run you want to push results to. You can find it in URL like this:
 
 `https://blablabla.testrail.com/index.php?/runs/view/14153`
 
@@ -51,7 +53,8 @@ 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 
+#### Batching Results (optional)
+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
@@ -59,8 +62,8 @@ 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: 
-
+#### Setup
+In your RSpec configuration file (usually spec_helper.rb) you need to call a registration function:
 
 ```ruby
 RSpec.configure do |config|
@@ -68,9 +71,20 @@ RSpec.configure do |config|
 end
 ```
 
-Here you pass in the rspec config, and an identifier for your product. Either :bridge or :canvas.
+Here you pass in the rspec config and an identifier you how you want to label your test id.
+
+:bridge:
+`:testrail_id`
+:canvas
+`:test_id`
 
 
+#### How to Use
+For each spec that you want to report on, you will need to tag it with the testcase id from tetrail. If this is done, the rspec results will automatically be reported for that testcase to the sepcified run.
+
+example:
+`it 'can do something nifty', :testrail_id => [1234] do`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -91,4 +105,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/files/testrail_operations.rb

@@ -33,7 +33,7 @@ module TestRailOperations
   # Gets the Test Rail client
   # http://docs.gurock.com/testrail-api2/bindings-ruby
   def self.get_test_rail_client
-    url = "https://canvas.testrail.com"
+    url = ENV["TESTRAIL_URL"] || "https://canvas.testrail.com"
     trclient = TestRail::APIClient.new(url)
     trclient.user = ENV["TESTRAIL_USER"]
     trclient.password = ENV["TESTRAIL_PASSWORD"]

data/lib/files/testrail_rspec_integration.rb

@@ -14,7 +14,7 @@ module TestRailRSpecIntegration
   # # This is different from simply creating a stand-alone test run from the results of the test.
   # The tricky part about this is Jenkins run rspecs on multiple processes with different batches of
   # rspec tests.
-  
+
   @@total_count = 0
   @@run_count = 0
   @@skip_count = 0
@@ -45,6 +45,10 @@ module TestRailRSpecIntegration
       end
     end
 
+    def output
+      :testrailtagging
+    end
+
     # Gets whether the formatter is active or not.
     # We don't want to push results up to test rail for instance if --dry-run is specified on the command line.
     def active

data/lib/files/version.rb

@@ -1,3 +1,3 @@
 module Testrailtagging
-  VERSION = "0.3.8.5"
+  VERSION = "0.3.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testrailtagging
 version: !ruby/object:Gem::Version
-  version: 0.3.8.5
+  version: 0.3.8.6
 platform: ruby
 authors:
 - Chris Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2019-02-25 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.7.4
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Utilities for working with testrail.