/toolkit/content/tests/browser/common/mockTransfer.js

 1/* ***** BEGIN LICENSE BLOCK *****
 2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 3 *
 4 * The contents of this file are subject to the Mozilla Public License Version
 5 * 1.1 (the "License"); you may not use this file except in compliance with
 6 * the License. You may obtain a copy of the License at
 7 * http://www.mozilla.org/MPL/
 8 *
 9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
13 *
14 * The Original Code is Mozilla XUL Toolkit Testing Code.
15 *
16 * The Initial Developer of the Original Code is
17 * Paolo Amadini <http://www.amadzone.org/>.
18 * Portions created by the Initial Developer are Copyright (C) 2009
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37Cc["@mozilla.org/moz/jssubscript-loader;1"]
38  .getService(Ci.mozIJSSubScriptLoader)
39  .loadSubScript("chrome://mochikit/content/tests/SimpleTest/MockObjects.js", this);
40
41var mockTransferCallback;
42
43/**
44 * This "transfer" object implementation continues the currently running test
45 * when the download is completed, reporting true for success or false for
46 * failure as the first argument of the testRunner.continueTest function.
47 */
48function MockTransfer() {
49  this._downloadIsSuccessful = true;
50}
51
52MockTransfer.prototype = {
53  QueryInterface: XPCOMUtils.generateQI([
54    Ci.nsIWebProgressListener,
55    Ci.nsIWebProgressListener2,
56    Ci.nsITransfer,
57  ]),
58
59  /* nsIWebProgressListener */
60  onStateChange: function MTFC_onStateChange(aWebProgress, aRequest,
61                                             aStateFlags, aStatus) {
62    // If at least one notification reported an error, the download failed.
63    if (!Components.isSuccessCode(aStatus))
64      this._downloadIsSuccessful = false;
65
66    // If the download is finished
67    if ((aStateFlags & Ci.nsIWebProgressListener.STATE_STOP) &&
68        (aStateFlags & Ci.nsIWebProgressListener.STATE_IS_NETWORK))
69      // Continue the test, reporting the success or failure condition.
70      mockTransferCallback(this._downloadIsSuccessful);
71  },
72  onProgressChange: function () {},
73  onLocationChange: function () {},
74  onStatusChange: function MTFC_onStatusChange(aWebProgress, aRequest, aStatus,
75                                               aMessage) {
76    // If at least one notification reported an error, the download failed.
77    if (!Components.isSuccessCode(aStatus))
78      this._downloadIsSuccessful = false;
79  },
80  onSecurityChange: function () {},
81
82  /* nsIWebProgressListener2 */
83  onProgressChange64: function () {},
84  onRefreshAttempted: function () {},
85
86  /* nsITransfer */
87  init: function () {}
88};
89
90// Create an instance of a MockObjectRegisterer whose methods can be used to
91// temporarily replace the default "@mozilla.org/transfer;1" object factory with
92// one that provides the mock implementation above. To activate the mock object
93// factory, call the "register" method. Starting from that moment, all the
94// transfer objects that are requested will be mock objects, until the
95// "unregister" method is called.
96var mockTransferRegisterer =
97  new MockObjectRegisterer("@mozilla.org/transfer;1",  MockTransfer);