res 1.1.0.pre2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c42e81948be748fac40ccc5af1b4ef6fbdc73981
-  data.tar.gz: 86443f1069f5e84aea04bad85061136f61863430
+  metadata.gz: 092fab54cb28019323fb52c264ab4a328eca7887
+  data.tar.gz: 9fb52f6992949fdbce49c7a531a06227f3c168fd
 SHA512:
-  metadata.gz: 00ebad5cf8582e2e16c1350f8428618d494e7b9a4a2a908e2d1d660564a285c15ad8184267de4c46568002b2423acdb572b65dc4ef6649e880bc8976f129a5ad
-  data.tar.gz: 365367e6f592b8e26fa838d5ebaaeb105e65ee73ef15e514e511c8dbb9ed7a9626e10c9e303c85b477139366882799100608de73dcfebdfe3c1e52a90854ade3
+  metadata.gz: b29793fefaeb91e1bc3163aa9b5f96e05843de719d66dbfdacb66d3c08b9e2afa02aa84b581f8efdfafce50679d2ac526a6d300963f269c13845ad6f39108c9f
+  data.tar.gz: 362b6502e7036285599612faaa35f0fc3742fc907a7a3c95fdc5a7ddf96da923f3cd2dc98f6393f7320b18b49901e651ab1e9a61c9622a0910554ad01b7b45a3

data/README.md

@@ -37,7 +37,11 @@ Note: This cucumber formatter works for cucumber version < 2.0
     
 ## Junit
 
-    ./bin/res.rb --junit '/path/to/xunit_result.xml'
+    res.rb --junit '/path/to/xunit_result.xml'
+Note: The Res output of the xunit parser is saved in the current directory
+
+## Casper
+    res.rb --junitcasper '/path/to/xunit_result.xml'
 Note: The Res output of the xunit parser is saved in the current directory
 
 ## Reporters
@@ -48,7 +52,7 @@ tool.
 
 If you have a Res IR file, you can submit using a reporter: 
 
-    ./bin/res.rb --res '/path/to/file.res' --submit REPORTER [... options]
+    res.rb --res '/path/to/file.res' --submit REPORTER [... options]
 
 ### Hive
 
@@ -63,7 +67,7 @@ Hive CI uses a Res reporter for result submission, the api arguments look like t
 
 ### TestRail
 
-    ./bin/res.rb --res '/path/to/file.res' --submit testrail --config-file '/path/to/.test_rail.yaml'
+    res.rb --res '/path/to/file.res' --submit testrail --config-file '/path/to/.test_rail.yaml'
 
 Our TestRail reporter currently be used to sync a suite with TestRail, and
 to submit test results against a test run. You will need to create a
@@ -79,6 +83,8 @@ Your config file should be called .test_rail.yaml, and should look like this:
     suite:     'MySuite'
     run_name:  'RunName' or run_id:    '1234'
 
+Note: Above parameters can also be set through environment as TESTRAIL_#{PARAMETER} instead of config file.
+
 ### Testmine 
 
 The Testmine reporter is very similar to the TestRail reporter, but doesn't 
@@ -93,6 +99,8 @@ should be called .testmine.yaml, and should look like this:
     component: 'Android acceptance'
     suite:     'MySuiteName'
 
+Note: Above parameters can also be set through environment as TESTMINE_#{PARAMETER} instead of config file.
+
 ## License
 
 *Res* is available to everyone under the terms of the MIT open source licence. Take a look at the LICENSE file in the code.

data/bin/res

@@ -0,0 +1,156 @@
+#! /usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+require 'res/ir'
+require 'res/reporters/testmine'
+require 'res/reporters/test_rail'
+require 'res/reporters/hive'
+require 'res/parsers/junit'
+require 'res/parsers/junitcasper'
+require 'openssl'
+
+class CLIParser
+
+  #
+  # Return a structure describing the options.
+  #
+  def self.parse(args)
+
+    # Default values
+    options = OpenStruct.new
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: res [options]"
+
+      opts.on("-r", "--res RES_FILE",
+              "res file to load") do |res|
+        options.res = res
+      end
+
+      opts.on("-s", "--submit REPORTER",
+              "Reporter to use to submit results") do |reporter|
+        options.reporter = reporter
+      end
+
+      opts.on("--junit junit_xml",
+              "Parse junit xml to res type") do |junit|
+        options.junit = junit
+      end
+
+      opts.on("--junitcasper junit_xml",
+              "Parse junit xml to res type") do |junitcasper|
+        options.junitcasper = junitcasper
+      end
+
+      opts.on("--cert CERT",
+              "Client certificate file") do |cert|
+        options.cert = cert
+      end
+
+      opts.on("--cacert CACERT",
+              "CA Certificate") do |cacert|
+        options.cacert = cacert
+      end
+
+      opts.on("--no-ssl-verification",
+              "Turn off ssl verification (don't do this)") do |no_ssl_verification|
+        options.ssl_verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      opts.on("--url URL",
+              "URL to submit results to") do |url|
+        options.url = url
+      end
+
+      opts.on("--job-id JOB_ID",
+              "JOB_ID to submit results against") do |job_id|
+        options.job_id = job_id
+      end
+
+      opts.on("--config-file CONFIG_FILE",
+              "Config file for the submitter") do |config_file|
+        options.config_file = config_file
+      end
+
+      opts.on("--version VERSION",
+              "VERSION of the world under test") do |version|
+        options.version = version
+      end
+
+      opts.on("--target TARGET",
+              "Target of execution (e.g. Chrome)") do |target|
+        options.target = target
+      end
+
+      opts.on_tail("-h", "--help", "Display help") do
+        puts opts
+        exit
+      end
+
+    end
+
+    opt_parser.parse!(args)
+    options
+  end
+end
+
+options = CLIParser.parse(ARGV)
+
+if options.res
+  ir = Res::IR.load(options.res)
+  puts 'IR File loaded'
+end
+
+if options.junit
+  junit_output = Res::Parsers::Junit.new(options.junit)
+  ir = Res::IR.load(junit_output.io)
+end
+
+if options.junitcasper
+  junit_output = Res::Parsers::Junitcasper.new(options.junitcasper)
+  ir = Res::IR.load(junit_output.io)
+end
+
+raise "No results loaded" if !ir
+
+if options.reporter
+  case options.reporter
+    when 'hive'
+
+      raise "Need to provide a hive job_id" if !options.job_id
+
+      reporter = Res::Reporters::Hive.new(
+          :url => options.url,
+          :cert => options.cert,
+          :cacert => options.cacert,
+          :ssl_verify_mode => options.ssl_verify_mode
+      )
+
+      reporter.submit_results( ir, :job_id => options.job_id )
+    when 'testmine'
+
+      reporter = Res::Reporters::Testmine.new(
+          :config_file => options.config_file,
+          :version     => options.version,
+          :target      => options.target,
+          :url         => options.url
+      )
+
+      id = reporter.submit_results(ir)
+      puts "Reported to testmine: #{id}"
+    when 'testrail'
+      reporter = Res::Reporters::TestRail.new(
+          :config_file => options.config_file,
+          :target      => options.target,
+          :url         => options.url,
+          :ir          => ir
+      )
+
+      output = reporter.submit_results(ir)
+      puts output
+    else
+
+      raise "#{options.reporter} not implemented"
+  end
+end

data/lib/res.rb

@@ -3,27 +3,29 @@ require 'res/ir'
 # Res API
 module Res
 
+  @data = []
+
   # Report Res IR to a test repository or similar
   def self.submit_results(args)
     reporter_class = Res.reporter_class(args[:reporter])
     reporter = reporter_class.new( args )
-    
+
     ir = Res::IR.load(args[:ir])
-    
+
     reporter.submit_results( ir, args )
   end
 
   def self.reporter_class(type)
     case type
-    when :test_rail
-      require 'res/reporters/test_rail'
-      Res::Reporters::TestRail
-    when :hive
-      require 'res/reporters/hive'
-      Res::Reporters::Hive
-    when :testmine
-      require 'res/reporters/testmine'
-      Res::Reporters::Testmine
+      when :test_rail
+        require 'res/reporters/test_rail'
+        Res::Reporters::TestRail
+      when :hive
+        require 'res/reporters/hive'
+        Res::Reporters::Hive
+      when :testmine
+        require 'res/reporters/testmine'
+        Res::Reporters::Testmine
     end
   end
 
@@ -34,12 +36,19 @@ module Res
 
   def self.parser_class(type)
     case type
-    when :junit
-      require 'res/parsers/junit'
-      Res::Parsers::Junit
-    else
-      raise "#{type} parser not Implemented"
+      when :junit
+        require 'res/parsers/junit'
+        Res::Parsers::Junit
+      when :junitcasper
+        require 'res/parsers/junitcasper'
+        Res::Parsers::Junitcasper
+      else
+        raise "#{type} parser not Implemented"
     end
   end
 
+  def self.perf_data
+    @data
+  end
+
 end

data/lib/res/formatters/rspec.rb

@@ -5,15 +5,16 @@ module Res
   module Formatters
     class Rspec
      
-      attr_accessor :output, :result
+      attr_accessor :output, :result, :start_time
       RSpec::Core::Formatters.register self, :start, 
                                              :example_group_started, :example_passed, :example_failed, :example_pending, 
                                              :stop, :start_dump
                                              
 
       def initialize output
-	@io = output
-	@result = Array.new
+      	@io = output
+        @result = Array.new
+        @start_time = Time.now
       end
 
       # Called when rspec starts execution 
@@ -120,7 +121,7 @@ module Res
       # Called At the end of the suite
       def stop(stop_notification)
         @ir = ::Res::IR.new( :type        => 'Rspec',
-                            :started     => '',
+                            :started     => @start_time,
                             :results     => result,
                             :finished    => Time.now(),
                             )

data/lib/res/formatters/ruby_cucumber.rb

@@ -1,19 +1,22 @@
 # Formatter for ruby cucumber
 
 require 'fileutils'
+require 'res'
 require 'res/ir'
 require 'cucumber/formatter/io'
-require 'cucumber/formatter/summary'
 
 module Res
   module Formatters
     class RubyCucumber
       include FileUtils
       include ::Cucumber::Formatter::Io
-     
+
       def initialize(runtime, path_or_io, options)
+        cucumber_version = %x(cucumber --version)
+        @cucumber_version = cucumber_version.gsub("\n","") 
+        
         @runtime = runtime
-        @io = ensure_io(path_or_io) 
+        @io = ensure_io(path_or_io, "reporter")
         @options = options
         @exceptions = []
         @indent = 0
@@ -42,7 +45,13 @@ module Res
         @_context = {}
         @_feature[:started] = Time.now()
         begin
-          hash = RubyCucumber.split_uri( feature.location.to_s )
+          if @cucumber_version.to_f < 1.3.to_f
+            uri = feature.file.to_s
+          else  
+           uri = feature.location.to_s
+          end
+          
+          hash = RubyCucumber.split_uri( uri )
           @_feature[:file] = hash[:file]
           @_feature[:line] = hash[:line]
           @_feature[:urn]  = hash[:urn]
@@ -90,7 +99,12 @@ module Res
         @_context = {}
         @_feature_element[:started] = Time.now
         begin
-          hash = RubyCucumber.split_uri( feature_element.location.to_s )
+          if @cucumber_version.to_f < 1.3.to_f
+            uri = feature_element.file_colon_line
+          else  
+            uri = feature_element.location.to_s
+          end
+          hash = RubyCucumber.split_uri( uri )
           @_feature_element[:file] = hash[:file]
           @_feature_element[:line] = hash[:line]
           @_feature_element[:urn] = hash[:urn]
@@ -109,29 +123,14 @@ module Res
       def after_feature_element(feature_element)
         @_context = {}
 
-        scenario_class = Cucumber::Formatter::LegacyApi::Ast::Scenario
-        example_table_class = Cucumber::Core::Ast::Location
-
-        fail =  @runtime.scenarios(:failed).select do |s|
-          [scenario_class, example_table_class].include?(s.class)
-        end.map do |s|
-          if s.location == feature_element.location
-            s
-          end          
-        end
-
-        if fail.compact.empty? and feature_element.respond_to? :status
-          @_feature_element[:status] = feature_element.status if feature_element.status.to_s != "skipped"
-        else
-          fail = fail.compact
-          @_feature_element[:status] = fail[0].status
+        if feature_element.respond_to? :status
+          @_feature_element[:status] = feature_element.status
         end
-
         @_feature_element[:finished] = Time.now
+        @_feature_element[:values] = Res.perf_data.pop if !Res.perf_data.empty?
       end
 
       def before_background(background)
-        #@_context[:background] = background
       end
 
       def after_background(background)
@@ -143,7 +142,6 @@ module Res
       def examples_name(keyword, name)
       end
 
-
       def scenario_name(keyword, name, file_colon_line, source_indent)
         @_context[:type] = "Cucumber::" + keyword.gsub(/\s+/, "")
         @_context[:name] = name || ''
@@ -163,6 +161,7 @@ module Res
         @_context = @_step
       end
 
+      # Argument list changed after cucumber 1.4, hence the *args
       def step_name(keyword, step_match, status, source_indent, background, *args)
 
         file_colon_line = args[0] if args[0]
@@ -171,11 +170,10 @@ module Res
         name = keyword + step_match.format_args(lambda{|param| %{#{param}}}) 
         @_step[:name] = name
         @_step[:status] = status
-        #@_step[:background] = background
         @_step[:type] = "Cucumber::Step"
 
       end
-        
+
       def exception(exception, status)
         @_context[:message] = exception.to_s
       end
@@ -210,17 +208,14 @@ module Res
       end
 
       def after_table_row(table_row)
-	if table_row.class == Cucumber::Formatter::LegacyApi::Ast::ExampleTableRow
-
+        if table_row.class == Cucumber::Ast::OutlineTable::ExampleRow
           @_current_table_row[:name] = table_row.name
           if table_row.exception
             @_current_table_row[:message] = table_row.exception.to_s
           end
-
-          if table_row.status and table_row.status != "skipped" and table_row.status != nil
+          if table_row.scenario_outline
             @_current_table_row[:status] = table_row.status
           end
-            
           @_current_table_row[:line] = table_row.line
           @_current_table_row[:urn] = @_feature_element[:file] + ":" + table_row.line.to_s
           @_table << @_current_table_row

data/lib/res/formatters/{ruby_cucumber_legacy.rb → ruby_cucumber_2.rb}

@@ -1,21 +1,20 @@
 # Formatter for ruby cucumber
 
 require 'fileutils'
+require 'res'
 require 'res/ir'
 require 'cucumber/formatter/io'
+require 'cucumber/formatter/summary'
 
 module Res
   module Formatters
-    class RubyCucumberLegacy
+    class RubyCucumber2
       include FileUtils
       include ::Cucumber::Formatter::Io
-
+     
       def initialize(runtime, path_or_io, options)
-        cucumber_version = %x(cucumber --version)
-        @cucumber_version = cucumber_version.gsub("\n","") 
-        
         @runtime = runtime
-        @io = ensure_io(path_or_io, "reporter")
+        @io = ensure_io(path_or_io) 
         @options = options
         @exceptions = []
         @indent = 0
@@ -44,13 +43,7 @@ module Res
         @_context = {}
         @_feature[:started] = Time.now()
         begin
-          if @cucumber_version.to_f < 1.3.to_f
-            uri = feature.file.to_s
-          else  
-           uri = feature.location.to_s
-          end
-          
-          hash = RubyCucumberLegacy.split_uri( uri )
+          hash = RubyCucumber2.split_uri( feature.location.to_s )
           @_feature[:file] = hash[:file]
           @_feature[:line] = hash[:line]
           @_feature[:urn]  = hash[:urn]
@@ -98,12 +91,7 @@ module Res
         @_context = {}
         @_feature_element[:started] = Time.now
         begin
-          if @cucumber_version.to_f < 1.3.to_f
-            uri = feature_element.file_colon_line
-          else  
-            uri = feature_element.location.to_s
-          end
-          hash = RubyCucumberLegacy.split_uri( uri )
+          hash = RubyCucumber2.split_uri( feature_element.location.to_s )
           @_feature_element[:file] = hash[:file]
           @_feature_element[:line] = hash[:line]
           @_feature_element[:urn] = hash[:urn]
@@ -122,13 +110,30 @@ module Res
       def after_feature_element(feature_element)
         @_context = {}
 
-        if feature_element.respond_to? :status
-          @_feature_element[:status] = feature_element.status
+        scenario_class = Cucumber::Formatter::LegacyApi::Ast::Scenario
+        example_table_class = Cucumber::Core::Ast::Location
+
+        fail =  @runtime.scenarios(:failed).select do |s|
+          [scenario_class, example_table_class].include?(s.class)
+        end.map do |s|
+          if s.location == feature_element.location
+            s
+          end          
+        end
+
+        if fail.compact.empty? and feature_element.respond_to? :status
+          @_feature_element[:status] = feature_element.status if feature_element.status.to_s != "skipped"
+        else
+          fail = fail.compact
+          @_feature_element[:status] = fail[0].status
         end
+
         @_feature_element[:finished] = Time.now
+        @_feature_element[:values] = Res.perf_data.pop if !Res.perf_data.empty?
       end
 
       def before_background(background)
+        #@_context[:background] = background
       end
 
       def after_background(background)
@@ -140,6 +145,7 @@ module Res
       def examples_name(keyword, name)
       end
 
+
       def scenario_name(keyword, name, file_colon_line, source_indent)
         @_context[:type] = "Cucumber::" + keyword.gsub(/\s+/, "")
         @_context[:name] = name || ''
@@ -159,7 +165,6 @@ module Res
         @_context = @_step
       end
 
-      # Argument list changed after cucumber 1.4, hence the *args
       def step_name(keyword, step_match, status, source_indent, background, *args)
 
         file_colon_line = args[0] if args[0]
@@ -168,10 +173,11 @@ module Res
         name = keyword + step_match.format_args(lambda{|param| %{#{param}}}) 
         @_step[:name] = name
         @_step[:status] = status
+        #@_step[:background] = background
         @_step[:type] = "Cucumber::Step"
 
       end
-
+        
       def exception(exception, status)
         @_context[:message] = exception.to_s
       end
@@ -206,14 +212,17 @@ module Res
       end
 
       def after_table_row(table_row)
-        if table_row.class == Cucumber::Ast::OutlineTable::ExampleRow
+	if table_row.class == Cucumber::Formatter::LegacyApi::Ast::ExampleTableRow
+
           @_current_table_row[:name] = table_row.name
           if table_row.exception
             @_current_table_row[:message] = table_row.exception.to_s
           end
-          if table_row.scenario_outline
+
+          if table_row.status and table_row.status != "skipped" and table_row.status != nil
             @_current_table_row[:status] = table_row.status
           end
+            
           @_current_table_row[:line] = table_row.line
           @_current_table_row[:urn] = @_feature_element[:file] + ":" + table_row.line.to_s
           @_table << @_current_table_row

data/lib/res/parsers/junitcasper.rb

@@ -0,0 +1,98 @@
+require 'ox'
+require 'json'
+require 'res/ir'
+
+module Res
+  module Parsers
+    class Junitcasper
+      attr_accessor :io
+
+      def initialize(junit_xml)
+        file = File.open(junit_xml, "rb")
+        begin
+          junit = Ox.parse(file.read)
+        rescue Ox::ParseError => e
+          raise "Invalid xunit XML format. Error: #{e}"
+        end
+        file.close
+        @test_suites = create_test_suites(packagenames(junit))
+        junit.nodes.collect do |test_suites|
+          create_multiple_test_suite(test_suites)
+        end
+        ir = ::Res::IR.new(:type => 'Casper',
+                           :started => "",
+                           :finished => Time.now(),
+                           :results => @test_suites
+        )
+
+        @io = File.open("./junitcasper.res", "w")
+        @io.puts ir.json
+        @io.close
+      end
+
+      def test_case(suite)
+        testcases = Hash.new
+        testcases = suite.nodes.collect do |node|
+          if node.value == "testcase"
+            testcase = Hash.new
+            testcase[:type] = "Casper::" + node.value
+            testcase[:name] = truncateName(node.attributes[:name])
+            testcase["duration"] = node.attributes[:time]
+            testcase["status"] = "passed"
+            if node.nodes[0] != nil
+              testcase["status"] = "failed" if node.nodes[0].value == "failure" or node.nodes[0].value == "error"
+              testcase["status"] = "notrun" if node.nodes[0].value == "skipped"
+            end
+            testcase
+          end
+        end
+        testcases.compact
+      end
+
+      def create_multiple_test_suite(suites)
+        i = 0
+        suites.nodes.each_with_index do |suite, index|
+          test_suite = Hash.new
+          test_suite[:type] = "Casper::testsuite"
+          test_suite[:name] = suite.attributes[:name]
+          test_suite[:children] = Array.new
+          test_suite[:children] = test_case(suite)
+          i = @test_suites.index { |test_suites|
+            test_suites[:name] == suite.attributes[:package]
+          }
+          @test_suites[i][:children].push(test_suite)
+        end
+      end
+
+      def create_test_suites (pkgnames)
+        test_suites= Array.new
+        pkgnames.each_with_index do |pkgname, index|
+          test_suites[index] = Hash.new
+          test_suites[index][:type]= "Casper::testsuites"
+          test_suites[index][:name]= pkgname
+          test_suites[index][:children] = Array.new
+        end
+        test_suites
+      end
+
+
+      def packagenames (junit)
+        packagename=junit.nodes[0].nodes.collect do |node|
+          node.attributes[:package]
+        end
+        packagename.uniq
+      end
+
+      def truncateName(inputText)
+        if inputText.to_s.empty? ==false
+          return inputText[0..253]#.gsub(/\s+$/, '')
+        else
+          return inputText
+        end
+      end
+
+
+    end # class JUnit
+  end # class Parsers
+end # class Res
+

data/lib/res/reporters/test_rail.rb

@@ -10,7 +10,7 @@ module Res
       attr_accessor :ir, :case_status, :config, :project, :suite
       def initialize(args)
         @url = args[:url]
-        @config = Res::Config.new([:user, :password, :namespace, :project, :suite], :optional => [:run_id, :run_name], :pre_env => 'test_rail')
+        @config = Res::Config.new([:user, :password, :namespace, :project, :suite], :optional => [:run_id, :run_name], :pre_env => 'testrail_')
         config.process(args)
 
         @case_status = {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: res
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre2
+  version: 1.2.0
 platform: ruby
 authors:
 - BBC
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -86,19 +86,22 @@ description: Formatters, parsers, and submitters for test results
 email:
 - david.buckhurst@bbc.co.uk
 - asim.khan.ext@bbc.co.uk
-executables: []
+executables:
+- res
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/res
 - lib/res.rb
 - lib/res/config.rb
 - lib/res/formatters/rspec.rb
 - lib/res/formatters/ruby_cucumber.rb
-- lib/res/formatters/ruby_cucumber_legacy.rb
+- lib/res/formatters/ruby_cucumber_2.rb
 - lib/res/ir.rb
 - lib/res/mappings.rb
 - lib/res/parsers/junit.rb
+- lib/res/parsers/junitcasper.rb
 - lib/res/reporters/hive.rb
 - lib/res/reporters/test_rail.rb
 - lib/res/reporters/testmine.rb
@@ -117,9 +120,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8
@@ -127,3 +130,4 @@ signing_key:
 specification_version: 4
 summary: Test Result report libraries
 test_files: []
+has_rdoc: