Merged revision(s) 173-181 from utplsql/branches/feature-1:

[feature-requests/1] "Add overall summary for test suite"

Author: PaulWalkerUK

documentation/src/reporter.html

@@ -98,6 +98,8 @@ <h2><a name="custom"></a>Writing your own Reporter</h2>
    PROCEDURE after_errors(run_id IN utr_error.run_id%TYPE);   
 
    PROCEDURE close;
+   
+   PROCEDURE before_suite_results(suite_id IN ut_suite.id%TYPE);
 
 END utMyRssReporter;
 /
@@ -164,6 +166,12 @@ <h3>show_error</h3>
    <h3>after_errors</h3>
    <p>This is called after any errors have been sent for output.</p>
 
+   <h3>before_suite_results</h3>
+   <p>
+      This is called only when a suite is executed. It displays the overall 
+      banner and suite execution statistics.
+   </p>
+
    <h2><a name="reportrecords"></a>Outcome and Error records</h2>
    <p>
       In order to keep the API as simple as possible, many of the procedures defined above take no parameters.  In particular, details of the outcome or error which

source/ut_htmlreporter.pkb

@@ -142,5 +142,27 @@ Added first version of pluggable reporter packages
      pl('</TABLE>');     
    END;   
 
+   
+  PROCEDURE before_suite_results(
+    suite_id       ut_suite.id%TYPE
+  )
+  IS
+    PROCEDURE showsuitebanner(
+      suite_id       ut_suite.id%TYPE
+    )
+    IS
+    BEGIN
+      pl('<H1>SUITE "'|| utsuite.name_from_id(id_in => suite_id) || '": ');
+      IF utresult.suite_success(suite_id => suite_id) THEN
+        pl_success;
+      ELSE
+        pl_failure;
+      END IF;
+      pl('</H1>');
+    END showsuitebanner;
+  BEGIN
+    
+    showsuitebanner(suite_id => suite_id);
+  END before_suite_results;
 END uthtmlreporter;
 /

source/ut_htmlreporter.pks

@@ -39,6 +39,9 @@ $Log
    PROCEDURE after_errors(run_id IN utr_error.run_id%TYPE);   
 
    PROCEDURE close;
+  PROCEDURE before_suite_results(
+    suite_id       ut_suite.id%TYPE
+  );
 
 END uthtmlreporter;
 /

source/ut_outputreporter.pkb

@@ -133,6 +133,7 @@ Added first version of pluggable reporter packages
       run_id_in    IN   utr_outcome.run_id%TYPE := NULL
    )
    IS
+     program_name_and_run_id  VARCHAR2(2000);
    BEGIN
       IF success_in
       THEN
@@ -196,32 +197,38 @@ Added first version of pluggable reporter packages
       END IF;
 
       utreport.pl ('. ');
-
-      IF run_id_in IS NOT NULL
+      program_name_and_run_id := '"'||NVL (program_in, 'Unnamed Test')||'"';
+      IF run_id_in IS NOT NULL THEN
+        program_name_and_run_id := program_name_and_run_id ||' Run ID: ' || run_id_in;
+      END IF;
+      IF success_in
       THEN
-         utreport.pl ('. Run ID: ' || run_id_in);
+         utreport.pl (' SUCCESS: ' || program_name_and_run_id);
       ELSE
-         IF success_in
-         THEN
-            utreport.pl (' SUCCESS: "' || NVL (program_in, 'Unnamed Test') || '"');
-         ELSE
-            utreport.pl (' FAILURE: "' || NVL (program_in, 'Unnamed Test') || '"');
-         END IF;
+         utreport.pl (' FAILURE: ' || program_name_and_run_id);
       END IF;
-
       utreport.pl ('. ');
    END;
 
    PROCEDURE pl (str VARCHAR2)
    IS
    BEGIN
      show(str);
-   END;   
-   
+   END;
+
    PROCEDURE before_results(run_id IN utr_outcome.run_id%TYPE)
    IS
+     v_packagename    ut_package.name%TYPE;
+     v_owner          ut_package.owner%TYPE;
    BEGIN
-      showbanner (utresult.success (run_id), utplsql.currpkg, run_id);
+     IF run_id IS NULL THEN
+       v_packagename := utplsql.currpkg;
+       v_owner :=  utplsql.currpkgowner;
+     ELSE
+       v_packagename := utpackage.name_from_last_run_id(last_run_id_in => run_id);
+       v_owner :=  utpackage.owner_from_last_run_id(last_run_id_in => run_id);
+     END IF;
+      showbanner (utresult.success (run_id), v_owner||'.'||v_packagename, run_id);
       utreport.pl ('> Individual Test Case Results:');
       utreport.pl ('>');
       norows := TRUE;
@@ -280,5 +287,66 @@ Added first version of pluggable reporter packages
      END IF;
    END;   
 
+   /*
+    proc: before_suite_results
+      Show suite overall result banner and suite run stats
+      
+    parameters:
+      suite_id - suite id
+  */
+  PROCEDURE before_suite_results(
+    suite_id       ut_suite.id%TYPE
+  )
+  IS
+    PROCEDURE show_suite_stats(
+      suite_id       ut_suite.id%TYPE
+    )
+    IS
+      SuiteStats utresult.TSuiteStats;
+    BEGIN
+      SuiteStats := utresult.get_suite_stats(suite_id => suite_id);
+      utreport.pl('SUITE STATS: '||to_char(SuiteStats.succeededpackages)||' of '||to_char(SuiteStats.totalpackages)||' packages succeeded.');
+      utreport.pl('SUITE STATS: '||to_char(SuiteStats.succeededasserts)||' of '||to_char(SuiteStats.totalasserts)||' individual test cases succeeded.');
+      utreport.pl('.');
+    END show_suite_stats;
+    
+    PROCEDURE showsuitebanner(
+      suite_id       ut_suite.id%TYPE
+    )
+    IS
+    BEGIN
+      IF utresult.suite_success(suite_id => suite_id) THEN
+        utreport.pl('.');
+        utreport.pl('>   SSSS   U     U  III  TTTTTTT EEEEEEE        SSSS   U     U   CCC     CCC   EEEEEEE   SSSS     SSSS   ');
+        utreport.pl('>  S    S  U     U   I      T    E             S    S  U     U  C   C   C   C  E        S    S   S    S  ');
+        utreport.pl('> S        U     U   I      T    E            S        U     U C     C C     C E       S        S        ');
+        utreport.pl('>  S       U     U   I      T    E             S       U     U C       C       E        S        S       ');
+        utreport.pl('>   SSSS   U     U   I      T    EEEE           SSSS   U     U C       C       EEEE      SSSS     SSSS   ');
+        utreport.pl('>       S  U     U   I      T    E                  S  U     U C       C       E             S        S  ');
+        utreport.pl('>        S U     U   I      T    E                   S U     U C     C C     C E              S        S ');
+        utreport.pl('>  S    S   U   U    I      T    E             S    S   U   U   C   C   C   C  E        S    S   S    S  ');
+        utreport.pl('>   SSSS     UUU    III     T    EEEEEEE        SSSS     UUU     CCC     CCC   EEEEEEE   SSSS     SSSS   ');
+        utreport.pl('.');
+        utreport.pl('SUITE SUCCESS: "'||utsuite.name_from_id(id_in => suite_id)||'"');
+      ELSE
+        utreport.pl('.');
+        utreport.pl('>    SSSS   U     U  III  TTTTTTT EEEEEEE     FFFFFFF   AA     III  L      U     U RRRRR   EEEEEEE ');
+        utreport.pl('>   S    S  U     U   I      T    E           F        A  A     I   L      U     U R    R  E       ');
+        utreport.pl('>  S        U     U   I      T    E           F       A    A    I   L      U     U R     R E       ');
+        utreport.pl('>   S       U     U   I      T    E           F      A      A   I   L      U     U R     R E       ');
+        utreport.pl('>    SSSS   U     U   I      T    EEEE        FFFF   A      A   I   L      U     U RRRRRR  EEEE    ');
+        utreport.pl('>        S  U     U   I      T    E           F      AAAAAAAA   I   L      U     U R   R   E       ');
+        utreport.pl('>         S U     U   I      T    E           F      A      A   I   L      U     U R    R  E       ');
+        utreport.pl('>   S    S   U   U    I      T    E           F      A      A   I   L       U   U  R     R E       ');
+        utreport.pl('>    SSSS     UUU    III     T    EEEEEEE     F      A      A  III  LLLLLLL  UUU   R     R EEEEEEE ');
+        utreport.pl('.');
+        utreport.pl('SUITE FAILURE: "'||utsuite.name_from_id(id_in => suite_id)||'"');
+      END IF;
+    END showsuitebanner;
+    
+  BEGIN
+    showsuitebanner(suite_id => suite_id);
+    show_suite_stats(suite_id => suite_id);
+  END before_suite_results;
 END;
 /

source/ut_outputreporter.pks

@@ -39,6 +39,7 @@ $Log
    PROCEDURE after_errors(run_id IN utr_error.run_id%TYPE);   
 
    PROCEDURE close;
+   PROCEDURE before_suite_results(suite_id ut_suite.id%TYPE);
 
 END;
 /

source/ut_package.pkb

@@ -74,6 +74,50 @@ Added Standard Headers
       THEN
          RETURN NULL;
    END;
+   /*
+     func: name_from_last_run_id
+       Return name of package using last run id. 
+       Return null if there is no package with given last run id.
+     params:
+       last_run_id_in - last run id of package
+   */
+   FUNCTION name_from_last_run_id (last_run_id_in IN ut_package.last_run_id%TYPE)
+      RETURN ut_package.name%TYPE
+   IS
+      retval   ut_package.name%TYPE;
+   BEGIN
+      SELECT name
+        INTO retval
+        FROM ut_package
+       WHERE last_run_id = last_run_id_in;
+      RETURN retval;
+   EXCEPTION
+      WHEN NO_DATA_FOUND
+      THEN
+         RETURN NULL;
+   END name_from_last_run_id;
+   /*
+     func:owner_from_last_run_id
+       Return owner of package using last run id. 
+       Return null if there is no package with given last run id.
+     params:
+       last_run_id_in - last run id of package
+   */
+   FUNCTION owner_from_last_run_id (last_run_id_in IN ut_package.last_run_id%TYPE)
+      RETURN ut_package.owner%TYPE
+   IS
+      retval   ut_package.owner%TYPE;
+   BEGIN
+      SELECT owner
+        INTO retval
+        FROM ut_package
+       WHERE last_run_id = last_run_id_in;
+      RETURN retval;
+   EXCEPTION
+      WHEN NO_DATA_FOUND
+      THEN
+         RETURN NULL;
+   END owner_from_last_run_id;
 
    PROCEDURE ADD (
       suite_in            IN   INTEGER,

source/ut_package.pks

@@ -38,6 +38,13 @@ Added Standard Headers
    FUNCTION id_from_name (name_in IN ut_package.name%TYPE,
        owner_in		  IN ut_package.owner%TYPE := NULL)
       RETURN ut_package.id%TYPE;
+   FUNCTION name_from_last_run_id(
+     last_run_id_in IN ut_package.last_run_id%TYPE
+   )
+   RETURN ut_package.name%TYPE;
+
+   FUNCTION owner_from_last_run_id (last_run_id_in IN ut_package.last_run_id%TYPE)
+      RETURN ut_package.owner%TYPE;
 
    PROCEDURE ADD (
       suite_in            IN   VARCHAR2,

source/ut_plsql.pkb

@@ -812,6 +812,18 @@ Added Standard Headers
    BEGIN
       RETURN testpkg.pkg;
    END;
+   
+   /*
+     func: currpkgowner
+       Return Owner of current package.
+   */
+   FUNCTION currpkgowner
+      RETURN VARCHAR2
+   IS
+   BEGIN
+      RETURN testpkg.owner;
+   END;
+
 
    PROCEDURE addtest (
       package_in      IN   VARCHAR2,
@@ -923,8 +935,11 @@ Added Standard Headers
       )
       IS
       BEGIN
-         utresult.show;
-
+        IF suite_in IS NULL THEN
+          utreport.open;
+          utresult.show;
+        END IF;
+        BEGIN
          IF NOT per_method_setup_in
          THEN
             runprog (
@@ -933,6 +948,21 @@ Added Standard Headers
                TRUE
             );
          END IF;
+        EXCEPTION
+          WHEN OTHERS THEN
+            utassert.this (
+                   'Unable to run '
+                ||  v_prefix || c_teardown
+                || ': '
+                || SQLERRM,
+                FALSE,
+                --same as in "runprog" call
+                null_ok_in=> NULL,
+                raise_exc_in=> TRUE,
+                register_in=> TRUE
+             );
+        END;
+
 
          utpackage.upd (
             suite_in,
@@ -1095,6 +1125,8 @@ Added Standard Headers
       v_pkg_start     DATE;
       v_override      VARCHAR2 (1000);
    BEGIN
+     utreport.open;
+     BEGIN
       IF v_suite IS NULL
       THEN
          utassert.this (
@@ -1153,13 +1185,25 @@ begin
             SYSDATE,
             v_success
          );
+         
+        utresult.showsuite(suite_id => v_suite);
+        
       END IF;
 
       IF reset_results_in
       THEN
          init;
       END IF;
-      
+      utreport.close;
+     EXCEPTION
+       WHEN OTHERS THEN
+         utassert.this (
+               'utPLSQL.testsuite failure: '
+            || SQLERRM,
+            FALSE
+         );
+         utreport.close;
+     END;
    END;
 
    /* Programs used in individual unit test programs. */

source/ut_plsql.pks

@@ -149,6 +149,9 @@ Added Standard Headers
 
    FUNCTION currpkg
       RETURN VARCHAR2;
+   
+   FUNCTION currpkgowner
+      RETURN VARCHAR2;
 
    PROCEDURE addtest (
       package_in      IN   VARCHAR2,

source/ut_report.pkb

@@ -201,6 +201,22 @@ Added first version of pluggable reporter packages
       call('close');
    END;
 
+  
+  /*
+     proc: before_suite_results
+       Show suite overall banner and suite run stats
+       
+     parameters:
+       suite_id - suite id
+   */
+  PROCEDURE before_suite_results(
+    suite_id       ut_suite.id%TYPE
+  )
+  IS
+  BEGIN
+    call('before_suite_results', suite_id);
+  END before_suite_results;
+  
 BEGIN
 
    g_reporter := NVL(utconfig.getreporter, DEFAULT_REPORTER);

source/ut_report.pks

@@ -47,6 +47,8 @@ $Log
    PROCEDURE after_errors(run_id IN utr_error.run_id%TYPE);
 
    PROCEDURE close;
+   
+   PROCEDURE before_suite_results(suite_id       ut_suite.id%TYPE);
 
 END;
 /