js/tests/userhookeach.js

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is JavaScript Engine testing utilities.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Mozilla Foundation.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s): Bob Clary
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /*
  39  * Spider hook function to check if an individual browser based JS test
  40  * has completed executing.
  41  */
  42
  43 var gCheckInterval = 1000;
  44 var gCurrentTestId;
  45 var gReport;
  46 var gCurrentTestStart;
  47 var gCurrentTestStop;
  48 var gCurrentTestValid;
  49 var gPageStart;
  50 var gPageStop;
  51
  52 function userOnStart()
  53 {
  54   try
  55   {
  56     dlog('userOnStart');
  57     registerDialogCloser();
  58   }
  59   catch(ex)
  60   {
  61     cdump('Spider: FATAL ERROR: userOnStart: ' + ex);
  62   }
  63 }
  64
  65 function userOnBeforePage()
  66 {
  67   try
  68   {
  69     dlog('userOnBeforePage');
  70     gPageStart = new Date();
  71
  72     gCurrentTestId = /test=(.*);language/.exec(gSpider.mCurrentUrl.mUrl)[1];
  73     gCurrentTestValid = true;
  74     gCurrentTestStart = new Date();
  75   }
  76   catch(ex)
  77   {
  78     cdump('Spider: WARNING ERROR: userOnBeforePage: ' + ex);
  79     gCurrentTestValid = false;
  80     gPageCompleted = true;
  81   }
  82 }
  83
  84 function userOnAfterPage()
  85 {
  86   try
  87   {
  88     dlog('userOnAfterPage');
  89     gPageStop = new Date();
  90
  91     checkTestCompleted();
  92   }
  93   catch(ex)
  94   {
  95     cdump('Spider: WARNING ERROR: userOnAfterPage: ' + ex);
  96     gCurrentTestValid = false;
  97     gPageCompleted = true;
  98   }
  99 }
 100
 101 function userOnStop()
 102 {
 103   try
 104   {
 105     // close any pending dialogs
 106     closeDialog();
 107     unregisterDialogCloser();
 108   }
 109   catch(ex)
 110   {
 111     cdump('Spider: WARNING ERROR: userOnStop: ' + ex);
 112   }
 113 }
 114
 115 function userOnPageTimeout()
 116 {
 117   gPageStop = new Date();
 118   if (typeof gSpider.mDocument != 'undefined')
 119   {
 120     try
 121     {
 122       var win = gSpider.mDocument.defaultView;
 123       if (win.wrappedJSObject)
 124       {
 125         win = win.wrappedJSObject;
 126       }
 127       gPageCompleted = win.gPageCompleted = true;
 128       checkTestCompleted();
 129     }
 130     catch(ex)
 131     {
 132       cdump('Spider: WARNING ERROR: userOnPageTimeout: ' + ex);
 133     }
 134   }
 135 }
 136
 137 function checkTestCompleted()
 138 {
 139   try
 140   {
 141     dlog('checkTestCompleted()');
 142
 143     var win = gSpider.mDocument.defaultView;
 144     if (win.wrappedJSObject)
 145     {
 146       win = win.wrappedJSObject;
 147     }
 148
 149     if (!gCurrentTestValid)
 150     {
 151       gPageCompleted = true;
 152     }
 153     else if (win.gPageCompleted)
 154     {
 155       gCurrentTestStop = new Date();
 156       // gc to flush out issues quickly
 157       collectGarbage();
 158
 159       dlog('Page Completed');
 160
 161       var gTestcases = win.gTestcases;
 162       if (typeof gTestcases == 'undefined')
 163       {
 164         cdump('JavaScriptTest: ' + gCurrentTestId +
 165               ' gTestcases array not defined. Possible test failure.');
 166         throw 'gTestcases array not defined. Possible test failure.';
 167       }
 168       else if (gTestcases.length == 0)
 169       {
 170         cdump('JavaScriptTest: ' + gCurrentTestId +
 171               ' gTestcases array is empty. Tests not run.');
 172         new win.TestCase(win.gTestFile, win.summary, 'Unknown', 'gTestcases array is empty. Tests not run..');
 173       }
 174       else
 175       {
 176       }
 177       cdump('JavaScriptTest: ' + gCurrentTestId + ' Elapsed time ' + ((gCurrentTestStop - gCurrentTestStart)/1000).toFixed(2) + ' seconds');
 178
 179       gPageCompleted = true;
 180     }
 181     else
 182     {
 183       dlog('page not completed, recheck');
 184       setTimeout(checkTestCompleted, gCheckInterval);
 185     }
 186   }
 187   catch(ex)
 188   {
 189     cdump('Spider: WARNING ERROR: checkTestCompleted: ' + ex);
 190     gPageCompleted = true;
 191   }
 192 }
 193
 194 gConsoleListener.onConsoleMessage =
 195   function userOnConsoleMessage(s)
 196 {
 197   dump(s);
 198 };