rutemaweb 0.9.3 → 0.9.4

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.9.4 / 2008-11-28
+* Configuration file column added to run overview
+* More code to check for old OpenStruct instances of context
+* statistics graphs
+* rutemaweb now depends on gruff (and consequently on RMagick/ImageMagick) for the generation of graphs - It will work without but if you want the pretty colors you need gruff.
 === 0.9.3 / 2008-11-07
 * Fixed bug in display of run list (context incorrectly used)
 === 0.9.2 / 2008-11-05

data/README.txt

@@ -3,7 +3,9 @@ rutemaweb http://patir.rubyforge.org/rutema
 == DESCRIPTION:
 rutemaweb is the web frontend for rutema. 
 
-It can be used as a viewer for database files created with the ActiveRecord reporter.
+It can be used as a viewer for database files created with the rutema ActiveRecord reporter.
+It also provides you with some basic statistics about the tests in your database in the form of 
+diagrams of debatable aesthetics but undoubtable value!
 
 == FEATURES/PROBLEMS:
 
@@ -18,6 +20,7 @@ rutemaweb [results.db] and browse to http://localhost:7000 for the glorious view
 * ruport (http://rubyreports.org/)
 * acts_as_reportable
 * erubis
+* gruff/RMagick (optional, but needed if you want to see the statistics graphs)
 
 == INSTALL:
 * sudo gem install rutemaweb

data/Rakefile

@@ -20,6 +20,7 @@ Hoe.new('rutemaweb', "#{RutemaWeb::Version::STRING}") do |p|
   p.extra_deps<<['ramaze','=2008.06']
   p.extra_deps<<['erubis']
   p.extra_deps<<['acts_as_reportable']
+  p.extra_deps<<['gruff','0.3.4']
   p.spec_extras={:executables=>["rutemaweb"],
     :default_executable=>"rutemaweb"}
 end

data/lib/rutemaweb/gems.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 gem 'ramaze','=2008.06'
 require 'ramaze'
 #this fixes a clash with activesupport 2.1.1 (because it checks start_with? but not end_with?)
-#end Ramaze on 1.8.6 only creates a start_with? method
+#and Ramaze on 1.8.6 only creates a start_with? method
 class String; undef_method :start_with? end
 gem 'activerecord','=2.1.1'
 require 'active_record'
@@ -10,4 +10,4 @@ gem 'rutema',">=1.0.0"
 require 'patir/configuration'
 require 'patir/command'
 require 'patir/base'
-require 'ruport/acts_as_reportable'
+require 'ruport/acts_as_reportable'

data/lib/rutemaweb/main.rb

@@ -9,7 +9,7 @@ module RutemaWeb
   module Version
     MAJOR=0
     MINOR=9
-    TINY=3
+    TINY=4
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
   #Starts Ramaze

data/lib/rutemaweb/model.rb

@@ -35,8 +35,17 @@ module Rutema
         end
         return st
       end
+      #number of unsuccessful scenarios (does not count setup or teardown scripts)
       def number_of_failed
-        self.scenarios.select{|sc| !sc.success?}.size
+        self.scenarios.select{|sc| !sc.success? && sc.is_test? }.size
+      end
+      #returns the number of actual tests (so, don't take into account setup or teardown tests)
+      def number_of_tests
+         self.scenarios.select{|sc| sc.is_test? }.size
+      end
+      def config_file
+        return nil if self.context.is_a?(OpenStruct)
+        return context[:config_file]
       end
     end
     
@@ -53,7 +62,10 @@ module Rutema
         :conditions=>conditions,
         :offset => page_num*page_size) 
       end
-      
+      #returns true if the scenario does not belong to a setup or teardown script
+      def is_test?
+        return !(self.name=~/_setup$/ || self.name=~/_teardown$/)
+      end
       def success?
         return self.status=="success"
       end

data/lib/rutemaweb/ramaze_controller.rb

@@ -51,12 +51,19 @@ module Rutema
 
       def run_summary r
         Ramaze::Log.debug("Summary snippet for #{r}") if @logger
-        "#{run_link(r)} started at #{time_formatted(r.context[:start_time])}"
+        msg="#{run_link(r)}"
+        if r.context.is_a?(Hash)
+          msg<<" started at #{time_formatted(r.context[:start_time])}"
+        end
+        return msg
       end
 
       def run_link r
         "<a class=\"smallgreytext\" href=\"#{run_url(r)}\">Run #{r.id}</a>"
       end
+      def cfg_link cfg
+        "<a class=\"smallgreytext\" href=\"/statistics/config_report/#{cfg}\">#{cfg}</a>"
+      end
       #will render a hash in a table of key||value rows 
       def context_table context
         ret=""
@@ -101,6 +108,18 @@ module Rutema
 
     end
 
+    #Contains all the settings that control the display of information for RutemaWeb's controllers 
+    module Settings
+      @@rutemaweb_settings||=Hash.new
+      #Set to true to show all setup and teardown scenarios
+      def show_setup_teardown= v
+        @@rutemaweb_settings[:show_setup_teardown]= v
+      end 
+      
+      def show_setup_teardown?
+        return @@rutemaweb_settings[:show_setup_teardown]
+      end
+    end
     #Sets the values we need for public and view directories
     def self.ramaze_settings
       Ramaze::Global.public_root = File.expand_path(File.join(File.dirname(__FILE__),"public"))
@@ -109,6 +128,7 @@ module Rutema
 
     class MainController < Ramaze::Controller
       include ViewUtilities
+      include Settings
       map '/'
       engine :Erubis
       layout :layout
@@ -132,9 +152,9 @@ module Rutema
 
         runs=Rutema::Model::Run.find_on_page(page_number,PAGE_SIZE)
         runs.each do |r| 
-          dt<<[status_icon(r.status),run_summary(r)]
+          dt<<[status_icon(r.status),run_summary(r),r.config_file]
         end
-        @content<< Ruport::Data::Table.new(:data=>dt,:column_names=>["status","description"]).to_html
+        @content<< Ruport::Data::Table.new(:data=>dt,:column_names=>["status","description","configuration"]).to_html
         @content<<"<br/>"
         @content<<run_page_link(page_number,total_pages)
         return @content
@@ -201,6 +221,7 @@ module Rutema
       end
 
       def error
+        @content="There was an error"
       end
 
       def settings
@@ -324,57 +345,102 @@ module Rutema
         return ((failures.to_f/scenarios.size)*100).round
       end
     end
-  
-    # class StatisticsController < Ramaze::Controller
-    #       include ViewUtilities
-    #       map '/statistics'
-    #       engine :Erubis
-    #       layout :layout
-    #       deny_layout :graph
-    #       view_root(File.expand_path(File.join(File.dirname(__FILE__),"view")))
-    #       def index
-    #         
-    #       end
-    #       def config_report configuration
-    #         @content="<img src=\"/statistics/graph/#{configuration}\""
-    #       end
-    #       def graph configuration
-    #         response.header['Content-type'] = "image/jpg"
-    #         successful=[]
-    #         failed=[]
-    #         labels=Hash.new
-    #         if configuration
-    #           #find all runs beloging to this configuration
-    #           runs=Rutema::Model::Run.find(:all)
-    #           runs=runs.select{|r| r.context[:config_file]==configuration if r.context.is_a?(Hash)}
-    #           #now extract the data
-    #           
-    #           counter=0
-    #           runs.each do |r|
-    #             fails=r.number_of_failed
-    #             successful<<r.scenarios.size-fails
-    #             failed<<fails
-    #             labels[counter]="R#{r.id}"
-    #             counter+=1
-    #           end
-    #         end
-    #         require 'rubygems'
-    #         require 'gruff'
-    # 
-    #         graph=Gruff::StackedBar.new(640)
-    # 
-    #         graph.data("successful",successful)
-    #         graph.data("failed",failed)
-    #         graph.labels=labels 
-    #         return graph.to_blob("JPG")
-    #       end
-    #      
-    #       private
-    #       #extract all the configuration names
-    #       def configurations
-    #         runs=Rutema::Model::Run.find(:all)
-    #         return runs.map{|r| r.context[:config_file] if r.context.is_a?(Hash)}.compact.uniq
-    #       end
-    #     end
+
+    class StatisticsController < Ramaze::Controller
+      include ViewUtilities
+      include Settings
+      def self.gruff_working= v
+        @@gruff_working= v
+      end
+      def self.gruff_working?
+        return @@gruff_working
+      end
+      begin
+        gem 'gruff',"=0.3.4"
+        require 'gruff'
+        self.gruff_working=true
+      rescue LoadError
+        self.gruff_working=false
+      end
+      map '/statistics'
+      engine :Erubis
+      layout :layout
+      deny_layout :graph
+      view_root(File.expand_path(File.join(File.dirname(__FILE__),"view")))
+      def index
+        @title="Rutema"
+        @panel_content=panel_configurations
+        @content_title="Statistics"
+        @content="<p>rutema statistics provide reports that present the results on a time axis<br/>At present you can see the ratio of successful vs. failed test cases over time grouped per configuration file.</p>"
+        @content<<"statistics reports require the <a href=\"\">gruff</a> gem. gruff does not appear to be available!<br/>rutemaweb will not be able to produce statistics reports" unless false
+        @content
+      end
+      def config_report configuration=nil
+        @title=configuration || "All configurations" 
+        @panel_content=panel_configurations
+        @content_title= configuration || "All configurations"
+        if StatisticsController.gruff_working?
+          @content="<img src=\"/statistics/graph/#{configuration}\"/>"
+        else
+          @content="Could not generate graph.<p>This is probably due to a missing gruff/RMagick installation.</p><p>You will need to restart rutemaweb once the issue is resolved.</p>"
+        end
+        return @content
+      end
+      def graph configuration=nil
+        response.header['Content-type'] = "image/png"
+        successful=[]
+        failed=[]
+        labels=Hash.new
+        runs=Rutema::Model::Run.find(:all)
+        #find all runs beloging to this configuration
+        runs=runs.select{|r| r.context[:config_file]==configuration if r.context.is_a?(Hash)} if configuration
+        #now extract the data
+        counter=0
+        #the normalizer thins out the labels on the x axis so that they won't overlap
+        normalizer = 1
+        normalizer=runs.size/11 unless runs.size<=11
+        runs.each do |r|
+          fails=r.number_of_failed
+          #the scenarios array includes setup and teardown scripts as well - we want only the actual testcases
+          #so we use the added number_of_tests method that filters setup and test scripts
+          successful<<r.number_of_tests-fails
+          failed<<fails
+          #every Nth label
+          labels[counter]="R#{r.id}" if counter%normalizer==0
+          counter+=1
+        end
+        respond runs_graph_jpg(successful,failed,labels)
+      end
+
+      private
+      #returns a jpg blob
+      def runs_graph_jpg successful,failed,labels
+        graph=Gruff::StackedBar.new(640)
+        graph.theme = {
+          :colors => %w(green red yellow blue),
+          :marker_color => 'black',
+          :background_colors => %w(white grey)
+        }
+        graph.x_axis_label="#{successful.size} runs"
+        graph.data("successful",successful)
+        graph.data("failed",failed)
+        graph.labels=labels 
+        graph.marker_font_size=12
+        return graph.to_blob("PNG")
+      end
+      #extract all the configuration names
+      def configurations
+        runs=Rutema::Model::Run.find(:all)
+        return runs.map{|r| r.context[:config_file] if r.context.is_a?(Hash)}.compact.uniq
+      end
+      def panel_configurations
+        ret="<a href=\"/statistics/config_report\">all</a><br/>"
+        configurations.each do |cfg|
+          ret<<cfg_link(cfg)
+          ret<<"<br/>"
+        end
+        return ret
+      end
+    end
   end
 end

data/lib/rutemaweb/view/layout.rhtml

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 	<meta name="author" content="Vassilis Rizopoulos" />
-	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+	<meta http-equiv="Content-Type" content="text/html; charset=utf8" />
 	<link rel="stylesheet" href="/css/style.css" type="text/css" />
 	<script src="/js/folding.js" type="text/javascript"></script>
 	<title><%=@title%></title>
@@ -21,7 +21,7 @@
 			</div>
 			<div id="menu">
 				<div align="right" class="smallwhitetext" style="padding:9px;">
-					<a href="/">Home</a> | <a href="/run">Runs</a> | <a href="/scenario">Scenarios</a>
+					<a href="/">Home</a> | <a href="/run">Runs</a> | <a href="/scenario">Scenarios</a> | <a href="/statistics">Statistics</a>
 				</div>
 			</div>
 			<div id="submenu">
@@ -41,7 +41,7 @@
 				<% end %>
 			</div>
 			<div id="footer" class="smallgraytext">
-				<a href="/">Home</a> | <a href="http://patir.rubyforge.org/rutema">about rutema</a> | 
+				rutemaweb v<%= RutemaWeb::Version::STRING %> | <a href="/">Home</a> | <a href="http://patir.rubyforge.org/rutema">about rutema</a> | 
 				&copy; 2008 <a href="http://www.braveworld.net/riva" target="_blank">Vassilis Rizopoulos</a> 
 			</div>
 		</div>

data/test/test_model.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'ostruct'
+require 'rutemaweb/ramaze_controller'
+require 'rubygems'
+require 'mocha'
+
+class TestModel <Test::Unit::TestCase
+  ActiveRecord::Base.establish_connection(:adapter  => "sqlite3",:database =>":memory:")
+  Rutema::Model::Schema.up
+  def setup
+    @stp=Rutema::Model::Scenario.new
+    @stp.name="test_setup"
+    @trd=Rutema::Model::Scenario.new
+    @trd.name="test_teardown"
+    @tst=Rutema::Model::Scenario.new
+    @tst.name="test"
+    @r=Rutema::Model::Run.new
+    @r.scenarios=[@stp,@tst,@trd]
+  end
+  def test_status
+    assert_equal(:success,@r.status)
+    t1=Rutema::Model::Scenario.new
+    t1.name="failed"
+    t1.stubs(:status).returns("error")
+    @r.scenarios<<t1
+    assert_equal(:error,@r.status)
+  end
+  def test_is_test?
+    assert(!@stp.is_test?, "Setup as test")
+    assert(!@trd.is_test?, "Teardown as test")
+    assert(@tst.is_test?, "Test not a test")
+  end
+  def test_number_of_tests
+    assert_equal(1, @r.number_of_tests)
+  end
+  def test_number_of_failed
+    t1=Rutema::Model::Scenario.new
+    t1.name="failed"
+    t1.stubs(:status).returns("error")
+    t2=Rutema::Model::Scenario.new
+    t2.name="not executed"
+    t2.stubs(:status).returns("not_executed")
+    @tst.stubs(:status).returns("success")
+    @r.scenarios<<t1
+    @r.scenarios<<t2
+    assert_equal(2,@r.number_of_failed)
+  end
+end

data/test/test_rutemaweb.rb

@@ -7,9 +7,7 @@ require 'mocha'
 
 class TestRutemaWeb <Test::Unit::TestCase
   ActiveRecord::Base.establish_connection(:adapter  => "sqlite3",:database =>":memory:")
-  def setup
 
-  end
   def test_loading
     controller=nil
     assert_nothing_raised() { controller = Rutema::UI::MainController.new }
@@ -19,8 +17,9 @@ class TestRutemaWeb <Test::Unit::TestCase
     cntlr=test_loading
     r=mock()
     r.expects(:id).returns(5).times(2)
-    r.expects(:context).returns(OpenStruct.new({:start_time=>Time.now}))
-    r.expects(:status).returns(:success)
+    r.stubs(:context).returns({:start_time=>Time.now,:config_file=>"test"})
+    r.stubs(:config_file).returns("test")
+    r.stubs(:status).returns(:success)
     t=mock()
     t.expects(:to_html).returns("mocked")
     Rutema::Model::Run.expects(:find).returns([r])
@@ -29,7 +28,7 @@ class TestRutemaWeb <Test::Unit::TestCase
     #Check nothing is raised when calling run (with everything mocked)
     assert_nothing_raised(){ cntlr.run}
   end
-  
+
   def test_runs
     cntlr=test_loading
     mock_12_runs
@@ -63,7 +62,7 @@ class TestRutemaWeb <Test::Unit::TestCase
     #Check nothing is raised when calling run with a page number that is not a number
     assert_nothing_raised(){ cntlr.runs("atttaaaaack!!")}
   end
-  
+
   #unit tests for scenarios
   def test_scenarios
     ctlr=test_loading
@@ -71,10 +70,9 @@ class TestRutemaWeb <Test::Unit::TestCase
     Rutema::Model::Run.expects(:find).returns("")
     assert_nothing_raised() { ctlr.scenarios }
   end
-  
+
   def test_scenario_wrong_arguments
     ctlr=test_loading
-    ctlr.expects(:error).returns("super")
     assert_raise(ArgumentError) { ctlr.scenario("bla","blu")  }
   end
   private 
@@ -84,9 +82,10 @@ class TestRutemaWeb <Test::Unit::TestCase
     Ruport::Data::Table.expects(:new).returns(t)
     runs=[mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock()]
     runs.each do |r|
-      r.expects(:id).returns(5).times(2)
-      r.expects(:context).returns(OpenStruct.new({:start_time=>Time.now}))
-      r.expects(:status).returns(:success)
+      r.stubs(:id).returns(5)
+      r.stubs(:context).returns({:start_time=>Time.now,:config_file=>"test"})
+      r.stubs(:status).returns(:success)
+      r.stubs(:config_file).returns("test")
     end
     Rutema::Model::Run.expects(:find).returns(runs)
     Rutema::Model::Run.expects(:count).returns(12)
@@ -98,10 +97,11 @@ class TestRutemaWeb <Test::Unit::TestCase
     Ruport::Data::Table.expects(:new).returns(t)
     scenarios=[mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock(),mock()]
     scenarios.each do |sc|
-      sc.expects(:name).returns(scenarios.index(sc).to_s).times(2)
+      sc.stubs(:name).returns(scenarios.index(sc).to_s)
+      sc.stubs(:status).returns(:success)
       sc.expects(:title).returns(scenarios.index(sc).to_s)
       sc.expects(:run).returns(scenarios.index(sc))
     end
-    Rutema::Model::Scenario.expects(:find).returns(scenarios).times(2)
+    Rutema::Model::Scenario.stubs(:find).returns(scenarios)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutemaweb
 version: !ruby/object:Gem::Version 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-07 00:00:00 +01:00
+date: 2008-11-28 00:00:00 +01:00
 default_executable: rutemaweb
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: gruff
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.3.4
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -92,7 +102,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.2
     version: 
-description: "== DESCRIPTION: rutemaweb is the web frontend for rutema.   It can be used as a viewer for database files created with the ActiveRecord reporter.  == FEATURES/PROBLEMS:  == SYNOPSIS: rutemaweb [results.db] and browse to http://localhost:7000 for the glorious view  == REQUIREMENTS: * patir (http://patir.rubyforge.org) * activerecord (http://ar.rubyonrails.com/) * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/) * ramaze (http://www.ramaze.net/) * ruport (http://rubyreports.org/) * acts_as_reportable * erubis"
+description: "== DESCRIPTION: rutemaweb is the web frontend for rutema.   It can be used as a viewer for database files created with the rutema ActiveRecord reporter. It also provides you with some basic statistics about the tests in your database in the form of  diagrams of debatable aesthetics but undoubtable value!  == FEATURES/PROBLEMS:  == SYNOPSIS: rutemaweb [results.db] and browse to http://localhost:7000 for the glorious view  == REQUIREMENTS: * patir (http://patir.rubyforge.org) * activerecord (http://ar.rubyonrails.com/) * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/) * ramaze (http://www.ramaze.net/) * ruport (http://rubyreports.org/) * acts_as_reportable * erubis * gruff/RMagick (optional, but needed if you want to see the statistics graphs)"
 email: riva@braveworld.net
 executables: 
 - rutemaweb
@@ -158,4 +168,5 @@ signing_key:
 specification_version: 2
 summary: rutemaweb is the web frontend for rutema
 test_files: 
+- test/test_model.rb
 - test/test_rutemaweb.rb