rutema_web 1.0.0 → 1.0.2

data/History.txt

@@ -1,3 +1,8 @@
+=== 1.0.2 / 2009-09-10
+* Cleared up the gem dependencies
+* Upgraded gruff
+=== 1.0.1 / 2009-07-31
+* not executed test cases now show up in the statistics graphs in yellow. This gives us the trend in test case numbers
 === 1.0.0 / 2009-07-17
 * updated gem dependencies for active_record (2.3.2)
 * renamed gem to rutema_web for consistency
@@ -6,6 +11,7 @@
 * gem dependencies are enforced in a separate file
 * fixed the folding javascript - now using jQuery
 * updated the project infrastructure (hoe etc.)
+
 === 0.9.5 / 2008-11-28
 * Overlooked conditional in Statistics index action fixed
 === 0.9.4 / 2008-11-28

data/README.txt

@@ -1,7 +1,7 @@
-rutemaweb http://patir.rubyforge.org/rutema
+rutema_web http://patir.rubyforge.org/rutema
 
 == DESCRIPTION:
-rutemaweb is the web frontend for rutema. 
+rutema_web 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 
@@ -10,25 +10,25 @@ diagrams of debatable aesthetics but undoubtable value!
 == FEATURES/PROBLEMS:
 
 == SYNOPSIS:
-rutemaweb [results.db] and browse to http://localhost:7000 for the glorious view
+rutema_web [results.db] and browse to http://localhost:7000 for the glorious view
 
 == REQUIREMENTS:
 * patir (http://patir.rubyforge.org)
+* rutema (http://patir.rubyforge.org/rutema)
 * activerecord (http://ar.rubyonrails.com/)
 * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/)
-* ramaze (http://www.ramaze.net/)
+* sinatra (http://www.sinatrarb.com/)
 * 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
+* sudo gem install rutema_web
 
 == LICENSE:
 (The Ruby License)
 
-rutema is copyright (c) 2007 Vassilis Rizopoulos
+rutema is copyright (c) 2007 - 2009 Vassilis Rizopoulos
 
 You can redistribute it and/or modify it under either the terms of the GPL
 (see COPYING.txt file), or the conditions below:

data/Rakefile

@@ -14,13 +14,10 @@ Hoe.spec('rutema_web') do |p|
   p.description = p.paragraphs_of('README.txt', 1..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.extra_deps<<['patir',">=0.6.0"]
-  p.extra_deps<<['rutema',"=1.0.5"]
-  p.extra_deps<<['activerecord','=2.3.2']
-  p.extra_deps<<['sinatra','=0.9.2']
+  p.extra_deps<<['rutema',"1.0.7"]
+  p.extra_deps<<['sinatra','0.9.2']
   p.extra_deps<<['ruport','1.6.1']
-  p.extra_deps<<['acts_as_reportable','=1.1.1']
-  p.extra_deps<<['gruff','0.3.4']
+  p.extra_deps<<['gruff','0.3.6']
   p.spec_extras={:executables=>["rutema_web"],
     :default_executable=>"rutema_web"}
 end

data/lib/rutema_web/gems.rb

@@ -1,10 +1,4 @@
-gem 'sinatra','=0.9.2'
-gem 'activerecord','=2.3.2'
-gem 'rutema',"=1.0.5"
-gem 'patir',"=0.6.1"
-gem 'ruport','=1.6.1'
-gem 'acts_as_reportable','=1.1.1'
-begin
-  gem 'gruff',"=0.3.4"
-rescue
-end
+gem 'sinatra','0.9.2'
+gem 'rutema',"1.0.7"
+gem 'ruport','1.6.1'
+gem 'gruff',"0.3.6"

data/lib/rutema_web/main.rb

@@ -8,7 +8,7 @@ module RutemaWeb
   module Version
     MAJOR=1
     MINOR=0
-    TINY=0
+    TINY=2
     STRING=[ MAJOR, MINOR, TINY ].join( "." )
   end
   #Starts App

data/lib/rutema_web/model.rb

@@ -36,7 +36,11 @@ module Rutema
       end
       #number of unsuccessful scenarios (does not count setup or teardown scripts)
       def number_of_failed
-        self.scenarios.select{|sc| !sc.success? && sc.is_test? }.size
+        self.scenarios.select{|sc| !sc.success? && !sc.not_executed? && sc.is_test? }.size
+      end
+      #number of scenarios that did not run (does not count setup or teardown scripts)
+      def number_of_not_executed
+        self.scenarios.select{|sc| sc.not_executed? && 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
@@ -69,6 +73,12 @@ module Rutema
       def success?
         return self.status=="success"
       end
+      def not_executed?
+        return self.status=="not_executed"
+      end
+      def fail?
+        return self.status=="error"
+      end
     end
   end
 end

data/lib/rutema_web/public/css/style.css

@@ -10,8 +10,7 @@ body {
 table {
 	font: 0.9em Tahoma, sans-serif;
 	color: #666666;
-	text-align: left;
-	
+	text-align: left;	
 }
 #logo{float:left; background-image:url(/images/tie_logo.gif); width:234px; height:213px;}
 #topheader{float:right; width:566px; height:97px; background-color:#F0F0F0; position:relative}
@@ -102,4 +101,34 @@ table {
 }
 .vtable tr td {
 	text-align: left;
+}
+td.success{
+	background-color:#00FF00;
+}
+td.error{
+	background-color:#FF0000;
+}
+td.not_executed{
+	background-color:#FFFF00;
+}
+table.timeline{
+	font: 0.9em Tahoma, sans-serif;
+	color: #666666;
+	text-align: center;
+}
+span.timeline{
+	text-align: center;
+}
+a.timeline{
+	font: 0.5em Tahoma, sans-serif;
+	font-size: 10px;
+	font-weight:bold;
+	color:#000000;
+	text-decoration:none;
+}
+.timeline {
+	font: 0.5em Tahoma, sans-serif;
+	font-size: 10px;
+	font-weight:bold;
+	color:#999999;
 }

data/lib/rutema_web/public/js/folding.js

@@ -1,16 +1,16 @@
-function toggleFolding(){
-	$(".scenario_output").hide();
-	$(".scenario_error").hide();
-	$(".scenario_output").parents("td").prepend("<a class=\"output_link\" href='' title='read the output log'>output</a>");
-	$(".scenario_error").parents("td").prepend("<a class=\"error_link\" href='' title='read the error log'>errors</a>");
-	$("a.output_link").click(function(event){
-		$(this).parents("td").children(".scenario_output").toggle();
+function toggleFolding(container,container_parent,prepend_txt,link){
+	$(container).hide();
+	$(container).parents(container_parent).prepend(prepend_txt);
+	$(link).click(function(event){
+		$(this).parents(container_parent).children(container).toggle();
 		// Stop the link click from doing its normal thing
 		event.preventDefault();
 	});
-	$("a.error_link").click(function(event){
-		$(this).parents("td").children(".scenario_error").toggle();
-		// Stop the link click from doing its normal thing
-		event.preventDefault();
-	});
-};
+};
+
+function setupFolding()
+{
+	toggleFolding(".scenario_output","td","<a class=\"output_link\" href='' title='read the output log'>output</a>","a.output_link");
+	toggleFolding(".scenario_error","td","<a class=\"error_link\" href='' title='read the error log'>errors</a>","a.error_link");
+	
+};

data/lib/rutema_web/sinatra.rb

@@ -60,7 +60,7 @@ module RutemaWeb
         end
         return msg
       end
-
+     
       def run_link r
         "<a class=\"smallgreytext\" href=\"#{run_url(r)}\">Run #{r.id}</a>"
       end
@@ -147,10 +147,10 @@ module RutemaWeb
       rescue LoadError
         self.gruff_working=false
       end
-    
+     
       private
       #returns a jpg blob
-      def runs_graph_jpg successful,failed,labels
+      def runs_graph_jpg successful,failed,not_executed,labels
         graph=Gruff::StackedBar.new(640)
         graph.theme = {
           :colors => %w(green red yellow blue),
@@ -160,6 +160,7 @@ module RutemaWeb
         graph.x_axis_label="#{successful.size} runs"
         graph.data("successful",successful)
         graph.data("failed",failed)
+        graph.data("not executed",not_executed)
         graph.labels=labels 
         graph.marker_font_size=12
         return graph.to_blob("PNG")
@@ -178,11 +179,12 @@ module RutemaWeb
         return ret
       end
     end
-    
+   
     class SinatraApp<Sinatra::Base
       include ViewUtilities
       include Settings
       include Statistics
+      attr_accessor :title,:panel_content,:content_title,:content
       enable :logging
       enable :run
       enable :static
@@ -194,28 +196,14 @@ module RutemaWeb
       @@logger = Patir.setup_logger
       
       get '/' do
-        @title="Rutema"
-        @panel_content=panel_runs
-        @content_title="Welcome to Rutema"
-        @content="<p>This is the rutema web interface.<br/>It allows you to browse the contents of the test results database.</p><p>Currently you can view the results for each separate run, the results for a specific scenario (a complete list of all steps executed in the scenario with standard and error output logs) or the complete execution history of a scenario.</p><p>The panel on the left shows a list of the ten most recent runs.</p>"
+        page_setup "Rutema",panel_runs,"Welcome to Rutema","<p>This is the rutema web interface.<br/>It allows you to browse the contents of the test results database.</p><p>Currently you can view the results for each separate run, the results for a specific scenario (a complete list of all steps executed in the scenario with standard and error output logs) or the complete execution history of a scenario.</p><p>The panel on the left shows a list of the ten most recent runs.</p>"
         erb :layout 
       end
-    
-      get '/runs/:page' do |page|
-        runs(page)
-        erb :layout
-      end
       #Displays the details of a run
       #
       #Routes to /runs if no id is provided
       get '/run/:run_id' do |run_id|
-        @panel_content=nil
-        if !run_id.empty?
-          @panel_content=panel_runs
-          @title="Run #{run_id}"
-          @content_title="Summary of run #{run_id}"
-          @content=single_run(run_id)
-        end
+        page_setup "Run #{run_id}",panel_runs,"Summary of run #{run_id}",single_run(run_id)
         erb :layout
       end
       
@@ -228,6 +216,11 @@ module RutemaWeb
         runs(0)
         erb :layout
       end
+      
+      get '/runs/:page' do |page|
+        runs(page)
+        erb :layout
+      end
       #Displays a paginated list of scenarios
       get '/scenarios/:page' do |page|
         scenarios(page)
@@ -235,13 +228,10 @@ module RutemaWeb
       end
       #Displays the details of a scenario
       get '/scenario/:scenario_id' do |scenario_id|
-        @panel_content=""
-        if !scenario_id.empty?
-          if scenario_id.to_i==0
-            @content=scenario_by_name(scenario_id)
-          else
-            @content=scenario_in_a_run(scenario_id.to_i)
-          end
+        if scenario_id.to_i==0
+          @content=scenario_by_name(scenario_id)
+        else
+          @content=scenario_in_a_run(scenario_id.to_i)
         end
         erb :layout
       end
@@ -255,20 +245,18 @@ module RutemaWeb
         scenarios(0)
         erb :layout
       end
-    
+      
       get '/statistics/?' do
-        @title="Rutema"
-        @panel_content=panel_configurations
-        @content_title="Statistics"
+        page_setup "Rutema",panel_configurations,"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 gruff gem which in turn depends on RMagick. gruff does not appear to be available!<br/>rutemaweb will not be able to produce statistics reports" unless Statistics.gruff_working?
         erb :layout
       end
-    
+
       get '/statistics/config_report/:configuration' do |configuration|
-        @title=configuration || "All configurations" 
-        @panel_content=panel_configurations
-        @content_title= configuration || "All configurations"
+        tt=configuration || "All configurations"
+        page_setup(tt,panel_configurations,tt)
+        
         if Statistics.gruff_working?
           @content="<img src=\"/statistics/graph/#{configuration}\"/>"
         else
@@ -276,37 +264,56 @@ module RutemaWeb
         end
         erb :layout
       end
-    
+
       get '/statistics/graph/:configuration' do |configuration|
         content_type "image/png"
         successful=[]
         failed=[]
+        not_executed=[]
         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
+        runs=all_runs_in_configuration(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
+        normalizer = calculate_normalizer(runs.size)
         runs.each do |r|
           fails=r.number_of_failed
+          no_exec = r.number_of_not_executed
           #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
+          successful<<r.number_of_tests-fails-no_exec
           failed<<fails
+          not_executed<<no_exec
           #every Nth label
           labels[counter]="R#{r.id}" if counter%normalizer==0
           counter+=1
         end
-        runs_graph_jpg(successful,failed,labels)
+        runs_graph_jpg(successful,failed,not_executed,labels)
       end
+      
       private
+      #calculates a divider to sparse out the laels in statistics graphs
+      def calculate_normalizer siz
+        #the normalizer thins out the labels on the x axis so that they won't overlap
+        return siz<=11 ? 1 : siz/11
+      end
+      #finds all the runs belonging to a specific configuration
+      def all_runs_in_configuration configuration
+        runs=Rutema::Model::Run.find(:all)
+        #find all runs beloging to this configuration
+        runs.select{|r| r.context[:config_file]==configuration if r.context.is_a?(Hash)} if configuration
+      end
+      #sets the variables used in the layout template
+      def page_setup title,panel_content,content_title,content=""
+        @title=title
+        @panel_content=panel_content
+        @content_title=content_title
+        @content=content
+      end
+      
       def runs page
-        @title="All runs"
-        @content_title="Runs"
-        @content=""
+        page_setup "All runs",nil,"All runs"
+
         dt=[]
         total_pages=(Rutema::Model::Run.count/page_size)+1
         page_number=validated_page_number(page,total_pages)
@@ -321,10 +328,7 @@ module RutemaWeb
       end
     
       def scenarios page
-        @title="All scenarios"
-        @content_title="Scenarios"
-        @content=""
-        @panel_content=panel_runs
+        page_setup "All scenarios",panel_runs,"All scenarios"
         runs=Hash.new
         #find which runs contain each scenario with the same name
         #Ramaze::Log.debug("Getting the runs for each scenario")
@@ -366,8 +370,7 @@ module RutemaWeb
       #Renders the summary of all runs for a single scenario
       def scenario_by_name scenario_id
         ret=""
-        @title="Runs for #{scenario_id}"
-        @content_title="Scenario #{scenario_id} runs"
+        page_setup "Runs for #{scenario_id}",nil,"Scenario #{scenario_id} runs"
         begin
           table=Rutema::Model::Scenario.report_table(:all,:conditions=>["name = :spec_name",{:spec_name=>scenario_id}],
           :order=>"run_id DESC")
@@ -384,8 +387,8 @@ module RutemaWeb
             ret<<table.to_html
           end
         rescue
-          @content_title="Error"
-          @title=@content_title
+          content_title="Error"
+          title=content_title
           #Ramaze::Log.error("Could not retrieve data for the scenario name '#{scenario_id}'")
           #Ramaze::Log.debug("#{$!.message}:\n#{$!.backtrace}")
           ret="<p>could not retrieve data for the given scenario name</p>"
@@ -395,11 +398,9 @@ module RutemaWeb
       #Renders the information for a specific executed scenario
       #giving a detailed list of the steps, with status and output
       def scenario_in_a_run scenario_id
-        @panel_content=panel_runs
         begin
           scenario=Rutema::Model::Scenario.find(scenario_id)
-          @content_title="Summary for #{scenario.name} in run #{scenario.run_id}"
-          @title=@content_title
+          page_setup "Summary for #{scenario.name} in run #{scenario.run_id}",panel_runs,"Summary for #{scenario.name} in run #{scenario.run_id}"
           table=Rutema::Model::Step.report_table(:all,
           :conditions=>["scenario_id = :scenario_id",{:scenario_id=>scenario_id}],
           :order=>"number ASC")
@@ -410,8 +411,8 @@ module RutemaWeb
             ret=table.to_vhtml
           end
         rescue
-          @content_title="Error"
-          @title=@content_title
+          content_title="Error"
+          title=content_title
           #Ramaze::Log.error("Could not find scenario with the id '#{scenario_id}'")
           @@logger.warn("#{$!.message}:\n#{$!.backtrace}")
           ret="<p>Could not find scenario with the given id.</p>"

data/lib/rutema_web/views/layout.erb

@@ -7,7 +7,7 @@
 	<script src="/js/jquery.js"></script>
 	<script src="/js/folding.js"></script>
 	<script type="text/javascript">
-	$(document).ready(toggleFolding);
+	$(document).ready(setupFolding);
 	</script>
 	<title><%=@title%></title>
 </head>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rutema_web
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors: 
 - Vassilis Rizopoulos
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-16 00:00:00 +02:00
+date: 2009-09-11 00:00:00 +02:00
 default_executable: rutema_web
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: patir
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: rutema
   type: :runtime
@@ -30,17 +20,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 1.0.5
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 2.3.2
+        version: 1.0.7
     version: 
 - !ruby/object:Gem::Dependency 
   name: sinatra
@@ -62,16 +42,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.6.1
     version: 
-- !ruby/object:Gem::Dependency 
-  name: acts_as_reportable
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        version: 1.1.1
-    version: 
 - !ruby/object:Gem::Dependency 
   name: gruff
   type: :runtime
@@ -80,7 +50,7 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.3.4
+        version: 0.3.6
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -90,11 +60,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.2
+        version: 2.3.3
     version: 
 description: |-
   == DESCRIPTION:
-  rutemaweb is the web frontend for rutema. 
+  rutema_web 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 
@@ -103,16 +73,16 @@ description: |-
   == FEATURES/PROBLEMS:
   
   == SYNOPSIS:
-  rutemaweb [results.db] and browse to http://localhost:7000 for the glorious view
+  rutema_web [results.db] and browse to http://localhost:7000 for the glorious view
   
   == REQUIREMENTS:
   * patir (http://patir.rubyforge.org)
+  * rutema (http://patir.rubyforge.org/rutema)
   * activerecord (http://ar.rubyonrails.com/)
   * sqlite3 (http://rubyforge.org/projects/sqlite-ruby/)
-  * ramaze (http://www.ramaze.net/)
+  * sinatra (http://www.sinatrarb.com/)
   * 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: 
@@ -176,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: patir
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: rutema_web is the web frontend for rutema