taken from TinderDB::Build.pm

webtools/tinderbox2/src/lib/BuildStatus.pm

@@ -0,0 +1,216 @@
+
+# $Revision: 1.1 $ 
+# $Date: 2000/11/09 19:44:47 $ 
+# $Author: kestes%staff.mail.com $ 
+# $Source: /home/hwine/cvs_conversion/cvsroot/mozilla/webtools/tinderbox2/src/lib/Attic/BuildStatus.pm,v $ 
+# $Name:  $ 
+
+
+# The contents of this file are subject to the Mozilla Public
+# License Version 1.1 (the "License"); you may not use this file
+# except in compliance with the License. You may obtain a copy of
+# the License at http://www.mozilla.org/NPL/
+#
+# Software distributed under the License is distributed on an "AS
+# IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
+# implied. See the License for the specific language governing
+# rights and limitations under the License.
+#
+# The Original Code is the Tinderbox build tool.
+#
+# The Initial Developer of the Original Code is Netscape Communications
+# Corporation. Portions created by Netscape are
+# Copyright (C) 1998 Netscape Communications Corporation. All
+# Rights Reserved.
+#
+
+# complete rewrite by Ken Estes, Mail.com (kestes@staff.mail.com).
+# Contributor(s): 
+
+
+package BuildStatus;
+
+
+
+
+
+# for each Build status we have:
+
+# color: to display it in on the buildpage
+# handler: to execute actions each time the status is reported.
+# description: to put in the legend
+# order: to show us the how well this build did compared with other builds, 
+#	bigger numbers means more progress
+
+# The Tinderbox code should not depend on the set of status values in
+# case we need to add more types later.
+
+# possible new types include: unit-test-failed,
+# perforance-test-failed, coverage-failed, lint-failed
+
+# The Tinderbox code only hardcodes the values of: 'not_running',
+# 'building' to determine if the build in question has completed and
+# 'success' to dertermine if the build finished all that it was
+# intended to do.  The various gradations of failure are not tracked
+# inside tinerbox but are useful for project managment.
+
+
+# If new types are added, try and keep to a small set of colors or the
+# display will get confusing.  You may find it convienent to keep a
+# distinction between different kinds of warnings or different kinds
+# of tests but we suggest keeping all warnings and all tests get the
+# same color.
+
+# Each time a build update is sent to the tinderbox server, a handler
+# function is run.  This allows the local administrator to specify an
+# arbitrary action to take each time a particular status is reported.
+
+# This handler could be used to open a trouble ticket each time the
+# build fails.  There could be a new web page where developers could
+# request notification (email, page) when the next build is done.
+# This would allow developers to not watch the tinderbox webpage so
+# intently but be informed when an interesting change has occured.
+
+# Please send us interesting uses for the handler.  We would like to
+# make examples availible.
+
+%STATUS = (
+
+           'not_running'=> {
+
+                            # You may want this to be 'aqua' if you
+                            # need to distinguish from 'building'
+
+                            'html_color'=>  'yellow',
+                            'hdml_char'=> '.',
+                            'handler'=> \&main::null,
+                            'description'=>  'Build is not running',
+                            'order'=>  0,
+                           },
+           
+           'building' => {
+                          'html_color'=>  'yellow',
+                          'hdml_char'=> '.',
+                          'handler'=> \&main::null,
+                          'description'=>  'Build in progress',
+                          'order'=>  1,
+                         },
+           
+           'build_failed' => {
+                        'html_color' => 'red',
+                        'hdml_char'=> '!',
+                        'handler' => \&main::null,
+                        'description' => 'Build failed',
+                        'order' => 2
+                       },
+
+           'test_failed' => {
+                            'html_color' => 'orange',
+                            'hdml_char'=> '~',
+                            'handler' => \&main::null,
+                            'description' => 'Build succeded but tests failed',
+                            'order' => 3,
+                           },
+
+           'success' => {
+                         'html_color' => 'lime',
+                         'hdml_char'=> '+',
+                         'handler' => \&main::null,
+                         'description'=> 'Build and all tests were successful',
+                         'order' => 4,
+                        },
+          );
+
+
+sub run_status_handler {
+  my ($record) = @_;
+
+  my ($buildstatus) = $record->{'status'};
+
+  # run status dependent hook.
+  &{$BuildStatus::STATUS{$buildstatus}{'handler'}}($record);
+
+  # notice handlers never return any values.
+
+  return ;
+}
+
+sub is_status_valid {
+  my ($status) = @_;
+
+  if ( defined ($STATUS{$status}) ) {
+    return 1;
+  } else {
+    return 0;
+  }
+
+}
+
+
+sub get_all_status {
+  my (@status) = keys %STATUS;
+
+  return @status;
+}
+
+
+# return the states in an order sorted by $STATUS{*}{'order'}
+
+sub get_all_sorted_status {
+  my @sorted_status = (
+		       map { $_->[0] }
+		       sort{ $a->[1] <=> $b->[1] }	
+		       map { [ $_, $STATUS{$_}{'order'} ] }
+		       (keys %STATUS ) 
+		      );
+
+  return @sorted_status;
+}
+
+
+# convert a list of status strings into a list of html_colors
+
+sub status2html_colors {
+  my (@latest_status) = @_;
+  my @out;
+
+  for ($i=0; $i <= $#latest_status; $i++) {
+    my ($status) = $latest_status[$i];
+    my ($out) = $STATUS{$status}{'html_color'};
+    push @out, $out;
+  }
+
+  return @out;
+}
+
+
+# convert a list of status strings into a list of hdml_chars
+
+sub status2hdml_chars {
+  my (@latest_status) = @_;
+  my @out;
+
+  for ($i=0; $i <= $#latest_status; $i++) {
+    my ($status) = $latest_status[$i];
+    my ($out) = $STATUS{$status}{'hdml_char'};
+    push @out, $out;
+  }
+
+  return @out;
+}
+
+# convert a list of status strings into a list of hdml_chars
+
+sub status2descriptions {
+  my (@latest_status) = @_;
+  my @out;
+
+  for ($i=0; $i <= $#latest_status; $i++) {
+    my ($status) = $latest_status[$i];
+    my ($out) = $STATUS{$status}{'description'};
+    push @out, $out;
+  }
+
+  return @out;
+}
+