rutema_web 1.0.0

data/lib/rutema_web/ruport_formatter.rb

@@ -0,0 +1,31 @@
+$:.unshift File.join(File.dirname(__FILE__),"..")
+require 'ruport/acts_as_reportable'
+module Rutema
+  module UI
+    # Formats the test scenario data into a vertical folding structure
+    class VerticalTableFormatter < Ruport::Formatter::HTML 
+
+      renders :vhtml, :for => Ruport::Controller::Table
+
+      def build_table_body
+        data.each do |row|
+          build_row(row)
+        end
+      end
+
+      def build_table_header
+      end
+
+      def build_table_footer
+      end
+
+      def build_row(data = self.data)
+        output << "<table class=\"vtable\"><colgroup><col width=\"100\"><col></colgroup>\n"
+        output << "<tr><td>#{data['status']}</td><td colspan=\"2\"><h3>#{data['number']} - #{data['name']}</h3></td></tr>"
+        output << "<tr><td>duration:</td><td>#{data['duration']}</td></tr>\n"
+        %w(output error).each { |k| output << "<tr><td colspan=\"2\"><div class=\"scenario_#{k}\"><pre>#{data.get(k)}</pre></div></td></tr>\n" if data.get(k).size > 0 }
+        output << "</table>\n"
+      end
+    end
+  end
+end

data/lib/rutema_web/sinatra.rb

@@ -0,0 +1,467 @@
+#  Copyright (c) 2008 Vassilis Rizopoulos. All rights reserved.
+$:.unshift File.join(File.dirname(__FILE__),"..")
+require 'sinatra/base'
+require 'erb'
+require 'patir/configuration'
+require 'patir/command'
+require 'patir/base'
+require 'rutema_web/model'
+require 'rutema_web/ruport_formatter'
+
+module RutemaWeb
+  module UI
+    #Helper methods that create HTML snippets
+    module ViewUtilities
+      #image filename to use for succesfull scenarios
+      IMG_SCE_OK="/images/run_ok.png"
+      #image filename to use for failed scenarios
+      IMG_SCE_ERROR="/images/run_error.png"
+      #image filename to use for unexecuted scenarios
+      IMG_SCE_WARN="/images/run_warn.png"
+      #image filename to use for succesfull steps
+      IMG_STEP_OK="/images/step_ok.png"
+      #image filename to use for failed steps
+      IMG_STEP_ERROR="/images/step_error.png"
+      #image filename to use for unexecuted steps
+      IMG_STEP_WARN="/images/step_warn.png"
+      #Time format to use for the start and stop times
+      TIME_FORMAT="%d/%m/%Y\n%H:%M:%S"
+      #The left arrow
+      IMG_LEFT="/images/left.png"
+      #The right arrow
+      IMG_RIGHT="images/right.png"
+      # returns the image tag appropriate for the given status
+      def status_icon status
+        return case status
+        when :warning ,"not_executed" 
+          "<img src=\"#{IMG_STEP_WARN}\" align=\"center\"/>"
+        when :success, "success"
+          "<img src=\"#{IMG_STEP_OK}\" align=\"center\"/>"
+        when :error, "error"
+          "<img src=\"#{IMG_STEP_ERROR}\" align=\"center\"/>"
+        else
+          "<img src=\"#{IMG_STEP_WARN}\" align=\"center\"/>"
+        end
+      end
+      # Returns a string with the correct time format for display
+      def time_formatted time
+        time.strftime(TIME_FORMAT)
+      end
+      #Returns the URL of details page for a run
+      def run_url run
+        "/run/#{run.id}"
+      end
+
+      def run_summary r
+        #Ramaze::Log.debug("Summary snippet for #{r}") if @logger
+        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=""
+        if context.is_a?(Hash)
+          ret="<p>"
+          ret<<"Run configured from #{context[:config_file]}<br/>" if context[:config_file]
+          ret<<"Started at #{time_formatted(context[:start_time])}<br/>"
+          ret<<"Ended at #{time_formatted(context[:end_time])}<br/>"
+          ret<<"Total duration #{context[:end_time]-context[:start_time]} seconds</p>"
+        end
+        return ret
+      end
+
+      #returns the pagination HTML for runs
+      def run_page_link page_number,page_total
+        ret=""
+        unless page_total==1
+          ret<<"<a href=\"/runs/#{page_number-1}\">Previous</a>" unless page_number==0
+          ret<<" | Page #{page_number+1}"
+          ret<<" | <a href=\"/runs/#{page_number+1}\">Next</a>" unless page_number==page_total-1
+        end
+        return ret
+      end
+      #returns the pagination HTML for scenarios
+      def scenario_page_link page_number,page_total
+        ret=""
+        unless page_total==1
+          ret<<"<a href=\"/scenarios/#{page_number-1}\">Previous</a>" unless page_number==0
+          ret<<" | Page #{page_number+1}"
+          ret<<" | <a href=\"/scenarios/#{page_number+1}\">Next</a>" unless page_number==page_total-1
+        end
+        return ret
+      end
+
+      #Gives the HTML to use for the status column of a scenario list
+      def scenario_status r
+        img_src=IMG_SCE_WARN
+        img_src=IMG_SCE_OK if "success"==r.status
+        img_src=IMG_SCE_ERROR if "error"==r.status
+        "<img src=\"#{img_src}\" align=\"center\"/>"
+      end
+
+    end
+
+    #Contains all the settings that control the display of information for RutemaWeb's controllers 
+    module Settings
+      DEFAULT_PAGE_SIZE=10
+      @@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
+
+      def page_size= v
+        @@rutemaweb_settings[:page_size]=v
+      end
+
+      def page_size
+        @@rutemaweb_settings[:page_size]||=DEFAULT_PAGE_SIZE
+        return @@rutemaweb_settings[:page_size]
+      end
+    end
+  
+    module Statistics
+      def self.gruff_working= v
+        @@gruff_working= v
+      end
+      def self.gruff_working?
+        return @@gruff_working
+      end
+      begin
+        require 'gruff'
+        self.gruff_working=true
+      rescue LoadError
+        self.gruff_working=false
+      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
+    
+    class SinatraApp<Sinatra::Base
+      include ViewUtilities
+      include Settings
+      include Statistics
+      enable :logging
+      enable :run
+      enable :static
+      set :server, %w[thin mongrel webrick]
+      set :port, 7000
+      set :root, File.dirname(__FILE__)
+      set :public, File.dirname(__FILE__) + '/public'
+      
+      @@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>"
+        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
+        erb :layout
+      end
+      
+      get '/run/?' do
+        runs(0)
+        erb :layout
+      end
+      
+      get '/runs/?' do
+        runs(0)
+        erb :layout
+      end
+      #Displays a paginated list of scenarios
+      get '/scenarios/:page' do |page|
+        scenarios(page)
+        erb :layout
+      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
+        end
+        erb :layout
+      end
+      
+      get '/scenario/?' do
+        scenarios(0)
+        erb :layout
+      end
+    
+      get '/scenarios/?' do
+        scenarios(0)
+        erb :layout
+      end
+    
+      get '/statistics/?' do
+        @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 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"
+        if Statistics.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
+        erb :layout
+      end
+    
+      get '/statistics/graph/:configuration' do |configuration|
+        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
+        runs_graph_jpg(successful,failed,labels)
+      end
+      private
+      def runs page
+        @title="All runs"
+        @content_title="Runs"
+        @content=""
+        dt=[]
+        total_pages=(Rutema::Model::Run.count/page_size)+1
+        page_number=validated_page_number(page,total_pages)
+
+        runs=Rutema::Model::Run.find_on_page(page_number,page_size)
+        runs.each do |r| 
+          dt<<[status_icon(r.status),run_summary(r),r.config_file]
+        end
+        @content<< Ruport::Data::Table.new(:data=>dt,:column_names=>["status","description","configuration"]).to_html
+        @content<<"<br/>"
+        @content<<run_page_link(page_number,total_pages)
+      end
+    
+      def scenarios page
+        @title="All scenarios"
+        @content_title="Scenarios"
+        @content=""
+        @panel_content=panel_runs
+        runs=Hash.new
+        #find which runs contain each scenario with the same name
+        #Ramaze::Log.debug("Getting the runs for each scenario")
+        conditions="name NOT LIKE '%_teardown' AND name NOT LIKE '%_setup'"
+        Rutema::Model::Scenario.find(:all, :conditions=>conditions).each do |sc|
+          nm=sc.name
+          runs[nm]||=[]
+          runs[nm]<<sc.run.id
+        end
+        #the size of the hash is also the number of unique scenario names
+        total_pages=(runs.size / page_size)+1
+        page_number=validated_page_number(page,total_pages)
+        #Ramaze::Log.debug("Getting scenarios for page #{page_number}")
+        scens=Rutema::Model::Scenario.find_on_page(page_number,page_size,conditions)
+        #and now build the table data
+        dt=Array.new
+        scens.each do |sc|
+          nm=sc.name
+          #sort the run ids
+          runs[nm]=runs[nm].sort.reverse[0..4]
+          dt<<["<a href=\"/scenario/#{nm}\">#{nm}</a> : ",sc.title,runs[nm].map{|r| " <a href=\"/run/#{r}\">#{r}</a>"}.join(" "),"#{failure_rate(sc.name)}%"]
+        end
+        @content<<Ruport::Data::Table.new(:data=>dt,:column_names=>["name","title","last 5 runs","failure rate"]).to_html
+        @content<<"<br/>"
+        @content<<scenario_page_link(page_number,total_pages)
+      end
+      #Returns a valid page number no matter what __page__ is.
+      def validated_page_number page,total_pages
+        page_number=page.to_i if page
+        page_number||=0
+        #Ramaze::Log.debug("Total number of run pages is #{total_pages}")
+        if page_number<0 || page_number>total_pages-1
+          #Ramaze::Log.warn("Page number out of bounds: #{page_number}. Reseting")
+          page_number=0
+        end
+        return page_number
+      end
+
+      #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"
+        begin
+          table=Rutema::Model::Scenario.report_table(:all,:conditions=>["name = :spec_name",{:spec_name=>scenario_id}],
+          :order=>"run_id DESC")
+          if table.empty?
+            ret="<p>no results for the given name</p>"
+          else
+            table.replace_column("status"){|r| scenario_status(r)}
+            table.replace_column("name") { |r| "<a href=\"/scenario/#{r}\">#{r}</a>"}
+            table.replace_column("start_time"){|r| r.stop_time ? r.start_time.strftime(TIME_FORMAT) : nil}
+            table.replace_column("stop_time"){|r| r.stop_time ? r.stop_time.strftime(TIME_FORMAT) : nil}
+            table.replace_column("run_id"){|r| "<a class=\"smallgreytext\" href=\"/run/#{r.run_id}\">Run #{r.run_id}</a>"}
+            table.reorder("status","run_id","title","start_time","stop_time")
+            table.column_names=["status","run","title","started at","ended at"]
+            ret<<table.to_html
+          end
+        rescue
+          @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>"
+        end
+        return ret
+      end
+      #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
+          table=Rutema::Model::Step.report_table(:all,
+          :conditions=>["scenario_id = :scenario_id",{:scenario_id=>scenario_id}],
+          :order=>"number ASC")
+          if table.empty?
+            ret="<p>no results for the given id</p>"
+          else
+            table.replace_column("status"){|r| status_icon(r.status)}
+            ret=table.to_vhtml
+          end
+        rescue
+          @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>"
+        end
+        return ret
+      end
+
+      #Renders the information for a single run providing the context and a list of the scenarios
+      def single_run run_id
+        ret=""
+        begin
+          run=Rutema::Model::Run.find(run_id)
+        rescue
+          return "Could not find #{run_id}"
+        end
+        if run.context
+          ret<<context_table(run.context)
+        end
+        conditions="run_id = :run_id AND name NOT LIKE '%_teardown' AND name NOT LIKE '%_setup'"
+        table=Rutema::Model::Scenario.report_table(:all,
+        :conditions=>[conditions,{:run_id=>run_id}],:except=>["run_id"],
+        :order=>"name ASC")
+        if table.empty?
+          ret<<"No scenarios for run #{run_id}"
+        else
+          table.replace_column("status") {|r| scenario_status(r) }
+          table.replace_column("name"){ |r| "<a href=\"/scenario/#{r.id}\">#{r.name}</a>" }
+          table.replace_column("start_time"){|r| r.start_time ? r.start_time.strftime(TIME_FORMAT) : nil}
+          table.replace_column("stop_time"){|r| r.stop_time ? r.stop_time.strftime(TIME_FORMAT) : nil}
+          table.reorder("status","name","title","start_time","stop_time")
+          table.column_names=["status","name","title","started at","ended at"]
+          ret<<table.to_html
+        end
+        return ret
+      end
+
+      def panel_runs
+        ret=""
+        Rutema::Model::Run.find(:all,:limit=>10,:order=>"id DESC").each do |r|
+          ret<<"#{status_icon(r.status)} #{run_link(r)}<br/>"
+        end
+        return ret
+      end
+
+      def failure_rate scenario_name
+        scenarios=Rutema::Model::Scenario.find(:all,:conditions=>["name = :spec_name",{:spec_name=>scenario_name}])
+        failures=0
+        scenarios.each{|sc| failures+=1 unless sc.status=="success" }
+        return ((failures.to_f/scenarios.size)*100).round
+      end
+    end#SinatraApp
+  end#UI module
+end

data/lib/rutema_web/views/layout.erb

@@ -0,0 +1,54 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+	<meta name="author" content="Vassilis Rizopoulos" />
+	<meta http-equiv="Content-Type" content="text/html; charset=utf8" />
+	<link rel="stylesheet" href="/css/style.css" type="text/css" />
+	<script src="/js/jquery.js"></script>
+	<script src="/js/folding.js"></script>
+	<script type="text/javascript">
+	$(document).ready(toggleFolding);
+	</script>
+	<title><%=@title%></title>
+</head>
+<body>
+	<div id="page" align="center">
+		<div id="content" style="width:800px">
+			<div id="logo">
+				<div style="margin-top:70px" class="whitetitle">rutema</div>
+			</div>
+			<div id="topheader">
+				<div align="left" class="bodytext">
+				</div>
+				<div id="toplinks" class="smallgraytext">
+				</div>
+			</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="/statistics">Statistics</a>
+				</div>
+			</div>
+			<div id="submenu">
+				<div align="right" class="smallgraytext" style="padding:9px;"></div>
+			</div>
+			<div id="contenttext">
+				<div style="padding:10px">
+					<span class="titletext"><%=@content_title%></span>
+				</div>
+				<div class="bodytext" style="padding:12px;" align="justify"><%=@content%></div>
+			</div>
+			<div id="leftpanel">
+				<% if @panel_content && !@panel_content.empty? %>
+				<div align="justify" class="graypanel">
+					<%=@panel_content%>
+				</div>
+				<% end %>
+			</div>
+			<div id="footer" class="smallgraytext">
+				rutemaweb v<%= RutemaWeb::Version::STRING %> | <a href="/">Home</a> | <a href="http://patir.rubyforge.org/rutema">about rutema</a> | 
+				&copy; 2008 - 2009 <a href="http://www.braveworld.net/riva" target="_blank">Vassilis Rizopoulos</a> 
+			</div>
+		</div>
+	</div>
+</body>
+</html>

data/test/test_model.rb

@@ -0,0 +1,48 @@
+require 'test/unit'
+require 'ostruct'
+require 'rutema_web/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