test-unit-runner-html 0.0.2

data/History.txt

@@ -0,0 +1,11 @@
+=== 0.0.1 / 2012-01-12
+
+* Fixes & Improvements
+* New config parameters:
+  - report_dir - Where place reports
+  - same-report - Overwrites the same report file if set in true (default),
+    generate new file in each run ({timestamp}_{output_file option}) otherwise.
+
+=== 0.0.1 / 2011-11-29
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/test/unit/runner/html.rb
+lib/test/unit/ui/html/testrunner.rb

data/README.txt

@@ -0,0 +1,25 @@
+= Test::Unit::Runner::HTML
+
+* http://rubyforge.org/projects/test-unit/
+
+== DESCRIPTION:
+
+Test::Unit::Runner::HTML - Generates reports in HTML format.
+
+== FEATURES/PROBLEMS:
+
+* This provides "--runner=html" option to use HTML UI.
+
+== INSTALL:
+
+* sudo gem install test-unit-runner-html
+
+== USAGE:
+
+  require 'test/unit/runner/html'
+
+== LICENSE:
+
+(The Ruby License)
+
+This software is distributed under the same terms as ruby.

data/Rakefile

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'rubygems'
+gem 'test-unit'
+require 'hoe'
+require './lib/test/unit/runner/html'
+
+Test::Unit.run = true
+
+version = Test::Unit::Runner::HTML::VERSION
+ENV["VERSION"] = version
+Hoe.new('test-unit-runner-html', version) do |p|
+  p.developer('Ilya Cherepanov', 'ilya.cherepanov@nevosoft.ru')
+
+  p.rubyforge_name = "test-unit"
+end
+
+task :tag do
+  message = "Released Test::Unit::Runner::HTML #{version}!"
+  base = "svn+ssh://#{ENV['USER']}@rubyforge.org/var/svn/test-unit/extensions/test-unit-runner-html/"
+  sh 'svn', 'copy', '-m', message, "#{base}trunk", "#{base}tags/#{version}"
+end
+
+# vim: syntax=Ruby

data/lib/test/unit/runner/html.rb

@@ -0,0 +1,46 @@
+module Test
+  module Unit
+    AutoRunner.register_runner(:html) do |auto_runner|
+      require 'test/unit/ui/html/testrunner'
+      Test::Unit::UI::HTML::TestRunner
+    end
+
+    AutoRunner.setup_option do |auto_runner, opts|
+      opts.on("--html-report=FILE", String,
+              "Outputs to file FILE") do |file|
+        auto_runner.runner_options[:output_file] = file
+      end
+      report_options = [
+              ["-", false],
+              ["no", false],
+              ["false", false],
+              ["+", true],
+              ["yes", true],
+              ["true", true],
+      ]
+      opts.on("--same-report=FILE", report_options,
+              "Write report in the same file if set, in filename_timestamp.html otherwise.",
+              "(default is false)") do |val|
+        val = false if val.nil?
+        auto_runner.runner_options[:same_report] = val
+      end
+      opts.on("--report-dir=DIR", report_options,
+              "Reports directory") do |val|
+        Dir.mkdir_p val unless Dir.exist? val
+        unless val =~ /[\\\/]$/
+          val =+ File.PATH_SEPARATOR
+        end
+        auto_runner.runner_options[:report_dir] = val
+      end
+    end
+  end
+end
+module Test
+  module Unit
+    module Assertions
+      def assert_fail msg
+         assert false, build_message(msg)
+      end
+    end
+  end
+end

data/lib/test/unit/ui/html/testrunner.rb

@@ -0,0 +1,343 @@
+#--
+#
+# Author:: Ilya Cherepanov
+# Copyright::
+#   * Copyright (c) 2011 Ilya Cherepanov <ilya.cherepanov@nevosoft.ru>
+#   * Copyright (c) 2011 Kouhei Sutou <kou@clear-code.com>
+# License:: Ruby license.
+
+# encode: utf-8
+
+require 'erb'
+require 'time'
+require 'test/unit/ui/testrunner'
+require 'test/unit/ui/testrunnermediator'
+
+module Test
+  module Unit
+    module UI
+      module HTML
+
+        # Runs a Test::Unit::TestSuite and outputs HTML.
+        class TestRunner < UI::TestRunner
+          include ERB::Util
+          # Creates a new TestRunner for running the passed
+          # suite. :output option specifies where runner
+          # output should go to; defaults to STDOUT.
+          def initialize(suite, options={})
+            super
+            Dir.mkdir @options[:report_dir] unless Dir.exist? @options[:report_dir]
+            unless @options[:report_dir] =~ /[\\\/]$/
+              @options[:report_dir] = @options[:report_dir]  + '/'
+            end
+            dir = @options[:report_dir] || ''
+            of =  "#{Time.now.to_i.to_s}_#{@options[:output_file]}" if (@options[:output_file] && !@options[:same_report])
+            of ||= @options[:output_file]
+            @output = File.new(dir+of, "w") if of
+            @output ||= STDOUT
+            @already_outputted = false
+            @indent = 0
+            @top_level = true
+            @current_test = nil
+            @current_test_suite = nil
+            @already_outputted = false
+            @summary = []
+            @cur_suite = nil
+            @cur_suite_cases = []
+            @cur_case = nil
+            @cur_case_tests = []
+            @cur_test = nil
+          end
+
+          private
+          def attach_to_mediator
+            @mediator.add_listener(TestResult::PASS_ASSERTION,
+                                   &method(:result_pass_assertion))
+            @mediator.add_listener(TestResult::FAULT,
+                                   &method(:result_fault))
+            @mediator.add_listener(TestRunnerMediator::STARTED,
+                                   &method(:started))
+            @mediator.add_listener(TestRunnerMediator::FINISHED,
+                                   &method(:finished))
+            @mediator.add_listener(TestCase::STARTED_OBJECT,
+                                   &method(:test_started))
+            @mediator.add_listener(TestCase::FINISHED_OBJECT,
+                                   &method(:test_finished))
+            @mediator.add_listener(TestSuite::STARTED_OBJECT,
+                                   &method(:test_suite_started))
+            @mediator.add_listener(TestSuite::FINISHED_OBJECT,
+                                   &method(:test_suite_finished))
+          end
+
+          def store_test test
+            unless @already_outputted
+              @cur_test.started = test.start_time
+              @cur_test.elapsed = test.elapsed_time
+              @cur_test.passed = test.passed?
+              @cur_test.interrupted = test.interrupted?
+              @cur_test.status = @result.status
+
+              @cur_case_tests << @cur_test
+              @cur_test = []
+              @already_outputted = true
+            end
+          end
+
+          def store_case ca
+            @cur_case_tests.each do |t|
+              @cur_case << t
+            end
+            @cur_case.started = ca.start_time
+            @cur_case.elapsed = ca.elapsed_time
+            @cur_case.passed = ca.passed?
+            @cur_case.status = @result.status
+            @cur_suite_cases << @cur_case
+            @cur_case = []
+            @cur_case_tests = []
+          end
+
+          def store_suite suite
+            @cur_suite_cases.each do |c|
+              @cur_suite << c
+            end
+            @cur_suite.started = suite.start_time
+            @cur_suite.elapsed = suite.elapsed_time
+            @cur_suite.passed = suite.passed?
+            @cur_suite.status = @result.status
+            @cur_suite.result = @result
+            @summary << @cur_suite
+            @cur_suite_cases = []
+            @cur_suite = []
+          end
+
+          def started(result)
+            @result = result
+          end
+
+          def test_suite_started(suite)
+            @current_test_suite = suite
+
+            if suite.test_case.nil?
+              @cur_suite = ResultSuite.new suite.name
+            else
+              @cur_case = ResultCase.new suite.name
+            end
+          end
+
+          def test_started(test)
+            @already_outputted = false
+            @current_test = test
+            @cur_test = ResultTest.new test.name
+          end
+
+          def result_pass_assertion(result)
+            @cur_test.assertion
+          end
+
+          def result_fault(fault)
+            @cur_test << fault
+            store_test @current_test
+          end
+
+          def test_finished(test)
+            store_test test
+            @current_test = nil
+          end
+
+          def test_suite_finished(suite)
+            if suite.test_case.nil?
+              store_suite suite
+            else
+              store_case suite
+            end
+            @current_test_suite = nil
+          end
+
+          def finished(elapsed_time)
+            if $DEBUG
+              o = File.new 'debug.log', 'w'
+              o.puts YAML.dump @summary
+            end
+            head
+            @summary.each do |suite|
+              output_suite suite
+            end
+            footer
+          end
+
+          def output_suite suite
+            open_tag 'article', 'box suite rounded '+suite.status do
+              content '', 'div', 'light rounded'
+              content suite.name, 'div', 'name'
+              open_tag 'div', 'stats' do
+                content 'Started: '+suite.started.ctime.to_s, 'div', 'time'
+                content 'Elapsed: '+suite.elapsed.to_s, 'div', 'time'
+                content "#{suite.n_test} tests in #{suite.n_case} cases", 'div', 'num-info'
+              end
+              button suite.passed
+              open_tag 'section', 'more' do
+                suite.cases.each do |ca|
+                  output_case ca
+                end
+              end
+            end
+          end
+
+          def output_case ca
+            open_tag 'article', 'box rounded case '+ca.status do
+              content '', 'div', 'light rounded'
+              content ca.name, 'div', 'name'
+              open_tag 'div', 'stats' do
+                content 'Started: '+ca.started.ctime.to_s, 'div', 'time'
+                content 'Elapsed: '+ca.elapsed.to_s, 'div', 'time'
+                content "#{ca.n_test} tests", 'div', 'num-info'
+              end
+              button ca.passed
+              open_tag 'section', 'more' do
+                ca.tests.each do |t|
+                  output_test t
+                end
+              end
+            end
+          end
+
+          def output_test test
+            open_tag 'article', 'box rounded test '+test.status do
+              content '', 'div', 'light rounded'
+              content test.name, 'div', 'name'
+              open_tag 'div', 'stats' do
+                content 'Started: '+test.started.ctime.to_s, 'div', 'time'
+                content 'Elapsed: '+test.elapsed.to_s, 'div', 'time'
+              end
+              if !test.passed && !test.faults.nil? && !test.faults.empty?
+                button test.passed
+                open_tag 'section', 'more_test' do
+                  test.faults.each do |f|
+                    open_tag 'div', 'box error' do
+                      file, line = f.location[0].scan(  /(.*):(?!\/)(\d+)/)[0]
+                      content f.message, 'div', 'message'
+                      content 'in '+(File.basename file), 'div', 'file'
+                      content 'on line # '+line.to_s, 'div', 'line'
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          def head
+            @output.puts "<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>Test report created at #{Time.now.ctime}</title>
+  <link rel='stylesheet' type='text/css' href='css/main.css' />
+    <script type='text/javascript' src='https://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.js'></script>
+    <script type='text/javascript' src='js/main.js'></script>
+</head>
+<body>
+  <section class='container'>"
+          end
+
+          def footer
+            @output.puts "  </section>
+  <footer>
+      <a href='#'>Link</a>
+  </footer>
+</body>\n</html>"
+          end
+
+          def button passed
+            content passed ? '+' : '-', 'div', 'expand button'
+          end
+          def indent
+            " " * @indent
+          end
+
+          def open_tag(tag, classname=nil)
+            @output.puts "#{indent}<#{tag}#{classname.nil? ? '' : ' class="'+classname+'"'}>"
+            @indent += 2
+            if block_given?
+              yield
+              close_tag(tag)
+            end
+          end
+
+          def content(cont, tag=nil, classname=nil)
+            return if cont.nil?
+            case cont
+            when Time
+              cont = cont.ctime
+            end
+            if tag.nil?
+              @output.puts "#{indent}#{h(cont)}"
+            elsif
+              @output.puts "#{indent}<#{tag}#{classname.nil? ? '' : ' class="'+classname+'"'}>#{h(cont)}</#{tag}>"
+            end
+          end
+
+          def close_tag(tag)
+            @indent -= 2
+            @output.puts("#{indent}</#{tag}>")
+          end
+
+        end
+      end
+    end
+  end
+end
+
+class Result
+  attr_accessor :name, :status, :result
+  attr_accessor :started, :elapsed, :passed
+  def initialize n
+    @name = n if n =~ /^test/
+    @name ||= File.basename n, '.rb'
+    @status = ''
+    @result = ''
+  end
+  def name= n
+    @name = nil
+    @name = n if n =~ /^test/
+    @name ||= File.basename n, '.rb'
+  end
+end
+
+class ResultSuite < Result
+  attr_accessor :cases, :n_case, :n_test
+
+  def << (suite_case)
+    @cases ||= []
+    @cases.push suite_case
+    @n_case ||= 0
+    @n_case += 1
+    @n_test ||= 0
+    @n_test += suite_case.n_test
+  end
+end
+
+class ResultCase < Result
+  attr_accessor :tests, :n_test
+
+  def << (test)
+    @tests ||= []
+    @tests.push test
+    @n_test ||= 0
+    @n_test += 1
+  end
+end
+
+class ResultTest < Result
+  attr_accessor :assertions, :faults, :interrupted
+
+  def << (fault)
+    @faults ||= []
+    @faults.push fault
+  end
+
+  def assertion
+    @assertions ||= 0
+    @assertions += 1
+  end
+end
+

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: test-unit-runner-html
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Cherepanov Ilya
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: &19148484 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *19148484
+description: A Ruby library to generate Test::Unit reports in HTML format
+email: ilya.cherepanov@nevosoft.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- History.txt
+- README.txt
+- Rakefile
+- Manifest.txt
+- lib/test/unit/runner/html.rb
+- lib/test/unit/ui/html/testrunner.rb
+homepage: http://nevosoft.ru
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: test-unit-runner-html
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Generates Test::Unit reports in HTML format
+test_files: []