testrailtagging 0.3.6.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9f009ba3976701fa82d946346d030b94031d6f2
+  data.tar.gz: 5ad488c40e11de6091230a008d046219c954b1fa
+SHA512:
+  metadata.gz: 67c05020b50585a06696d8a4f5afa0fb93c24be4d7efa9d8858241439b5186ae24c31358b075fdb31f392e689f051d6b2dd08750943400eebe577b48c69912d6
+  data.tar.gz: e3630127311e5850c6b33b14f5ff831054f1c9d36f0a921730782aa2573cc35b153b40dd0ba8c5a0c8d9927470e1e8c0c5f5bf969bd63a9ad3cc59f4435551b1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at cjohnson@instructure.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testrailtagging.gemspec
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Johnson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Testrailtagging
+
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrailtagging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrailtagging
+
+## Usage
+
+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`
+
+which this gem will look for and use.
+ 
+### 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:
+
+`https://blablabla.testrail.com/index.php?/runs/view/14153`
+
+Here the test run is 14153.
+
+Then you set an environment variable called TESTRAIL_RUN_ID, with that value. For example:
+
+`export TESTRAIL_RUN_ID=14153`
+
+Next, in your RSpec configuration file (usually spec_helper.rb) you need to call a registration function: 
+
+
+```ruby
+RSpec.configure do |config|
+  TestRailRSpecIntegration.register_rspec_integration(config,:bridge)
+end
+```
+
+Here you pass in the rspec config, and an identifier for your product. Either :bridge or :canvas.
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/testrailtagging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/testrailtagging"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/files/RSpecParser.rb

@@ -0,0 +1,177 @@
+require "parser/current"
+require_relative "TestCase"
+
+def colorize(text, color_code)
+  "\e[1;#{color_code}m#{text}\e[0m"
+end
+
+def red(text)
+  colorize(text, 31)
+end
+
+def green(text)
+  colorize(text, 32)
+end
+
+class RSpecParser
+  public
+  attr_reader :file, :test_cases
+  attr_accessor :verbose
+  def initialize(file_name)
+    file = file_name
+    @top_node = Parser::CurrentRuby.parse_file(file)
+    @ids = []
+    @metadata = {}
+    @skips = []
+    test_cases = []
+    @skips_in_before = []
+    @condition_set = false
+    @indent_amount = "     "
+    @in_testrail_id = false
+  end
+
+  # Performs the parsing of the rspec file and generates an array of TestCase instances
+  def parse(verbosity:false)
+    verbose = verbosity
+    traverse(@top_node, "")
+    # get the last one added to the array
+    test_cases << @current_test_case.clone
+    test_cases.each do |tc|
+      tc.skip += @skips_in_before
+    end
+    puts "" if verbose
+  end
+
+  # Prints to standard out the test cases that were generated by parsing the file
+  def inspect
+    test_cases.each do |tc|
+      puts tc.print
+    end
+  end
+
+  # Prints to standard out the full, unvarnished abstract syntax tree in all it's ugliness.
+  def dump_ast
+    print_ast(@top_node, "")
+    puts ""
+  end
+
+  private
+  def check_node(node)
+    case node
+      when :before
+        @state = :example_body
+        @in_before = true
+      when :example
+        @in_before = false
+        if @state != :example
+          test_cases << @current_test_case.clone if @current_test_case
+          @ids.clear
+          @metadata.clear
+          @skips.clear
+          @condition_set = false
+          @title = nil
+        end
+        @current_test_case = TestRailOperations::TestCase.new(nil,   # test ID, don't know it yet
+                                                              nil,   # title, don't know it yet
+                                                              nil,   # priority, don't know it yet
+                                                              true,  # automated, of course this is automated
+                                                              nil,   # screen size, don't know it yet
+                                                              true,  # is automatable if it is automated
+                                                              nil,   # no Jira references
+                                                              nil)   # no runonce references
+        # get the title
+        @state = :example_title
+      when :skip
+        if @condition_set
+          # do nothing, the browsers have already been set.
+        else
+          @skips << "allbrowsers" # a skip call with no conditions. Skips on all browsers
+        end
+
+        if @in_before
+          @skips_in_before += @skips.clone
+        else
+          @current_test_case.skip = @skips.clone
+        end
+        @state = :example_body
+      when :testrail_id
+        @state = :testrail_id
+      when :priority
+        @state = :priority
+      when :ENV
+        @state = :example_body
+    end
+  end
+
+  def check_node_string(node)
+    if @state == :example_title
+      @title = node.children[0]
+      @current_test_case.title = @title.clone
+      @state = :example_args
+    elsif @state == :example_body
+      if (node.children[0] == "SELENIUM_BROWSER")
+        @state = :selenium_browser
+      end
+    elsif @state == :selenium_browser
+      browser_skip = node.children[0]
+      @skips << browser_skip
+      @state == :example_body
+    elsif @state == :skip
+      @state = :example_body
+    elsif @state == :testrail_id
+      id = node.children[0]
+      @ids << id
+    end
+  end
+
+  def check_node_type(node)
+    case node.type
+      when :if
+        @condition_set = true
+      when :str
+        check_node_string(node)
+      when :args
+        @state == :example_body
+      when :begin
+        @state = :example_body
+        if @ids.count > 0
+          @metadata[:testrail_id] = @ids.clone
+          @current_test_case.metadata = @metadata.clone
+          @current_test_case.id = @ids.clone
+        end
+      when :int
+        if @state == :priority
+          @metadata[:priority] = node.children[0].to_i
+          @current_test_case.priority = node.children[0].to_i
+          @state = :example_args
+        end
+    end
+  end
+
+  # Recursive function to iterate through the direct acyclic graph of the abstract syntax tree (AST).
+  def traverse(node, indent)
+    check_node(node)
+    check_node_type(node) if node.respond_to?(:type)
+    return unless node.respond_to?(:children)
+    node.children.each do |child|
+      traverse(child, indent + @indent_amount)
+    end
+  end
+
+  # recursive function to dump the entire abstract syntax tree, and NOT the pretty print version
+  # which hides child elements
+  def print_ast(node, indent)
+    if node.to_s.match("example")
+      puts green("#{indent}#{node} <#{node.class}>")
+    elsif node.to_s.match("skip") && node.class == Symbol
+      puts red("#{indent}#{node} <#{node.class}>")
+    else
+      puts "#{indent}#{node} <#{node.class}>"
+    end
+
+    return unless node.respond_to?(:children)
+    node.children.each do |child|
+      print_ast(child, indent + @indent_amount)
+    end
+  end
+end

data/lib/files/TestCase.rb

@@ -0,0 +1,38 @@
+
+module TestRailOperations
+  # Represents a test case in test rail.
+  class TestCase
+    attr_accessor :id, :title, :priority, :automated, :screen_size, :result_message, :status
+    attr_accessor :automatable, :references, :run_once
+    attr_accessor :file # Which rspec file the test case is found in
+    attr_accessor :metadata, :skip
+    attr_accessor :temp_id
+    attr_accessor :assigned_to
+
+    def initialize(id, title, priority, automated, screen_size, automatable, references, run_once)
+      @id          = id
+      @title       = title
+      @priority    = priority
+      @automated   = automated
+      @screen_size = screen_size
+      @automatable = automatable
+      @references  = references
+      @run_once  = run_once
+      @skip = []
+    end
+
+    def set_status(status, message)
+      @status = status
+      @result_message = message # a string
+    end
+
+    def print
+      puts ""
+      puts "Test Case: #{@id}, #{@title}"
+      puts "\tPriority:    #{@priority}"
+      puts "\tScreen Size: #{@screen_size}"
+      puts "\tAutomated:   #{@automated}"
+      puts "\tSkips:       #{skip}"
+    end
+  end
+end