addon-sdk/source/test/test-require.js

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 'use strict';
   6
   7 const traceback = require('sdk/console/traceback');
   8 const REQUIRE_LINE_NO = 30;
   9
  10 exports.test_no_args = function(assert) {
  11   let passed = tryRequireModule(assert);
  12   assert.ok(passed, 'require() with no args should raise helpful error');
  13 };
  14
  15 exports.test_invalid_sdk_module = function (assert) {
  16   let passed = tryRequireModule(assert, 'sdk/does-not-exist');
  17   assert.ok(passed, 'require() with an invalid sdk module should raise');
  18 };
  19
  20 exports.test_invalid_relative_module = function (assert) {
  21   let passed = tryRequireModule(assert, './does-not-exist');
  22   assert.ok(passed, 'require() with an invalid relative module should raise');
  23 };
  24
  25
  26 function tryRequireModule(assert, module) {
  27   let passed = false;
  28   try {
  29     // This line number is important, referenced in REQUIRE_LINE_NO
  30     let doesNotExist = require(module);
  31   } catch(e) {
  32     checkError(assert, module, e);
  33     passed = true;
  34   }
  35   return passed;
  36 }
  37
  38 function checkError (assert, name, e) {
  39   let msg = e.toString();
  40   if (name) {
  41     assert.ok(/is not found at/.test(msg),
  42       'Error message indicates module not found');
  43     assert.ok(msg.indexOf(name.replace(/\./g,'')) > -1,
  44       'Error message has the invalid module name in the message');
  45   }
  46   else {
  47     assert.equal(msg.indexOf('Error: you must provide a module name when calling require() from '), 0);
  48     assert.ok(msg.indexOf("test-require") !== -1, msg);
  49   }
  50
  51   // we'd also like to assert that the right filename
  52   // and linenumber is in the stacktrace
  53   let tb = traceback.fromException(e);
  54
  55   // The last frame may be inside a loader
  56   let lastFrame = tb[tb.length - 1];
  57   if (lastFrame.fileName.indexOf("toolkit/loader.js") !== -1 ||
  58       lastFrame.fileName.indexOf("sdk/loader/cuddlefish.js") !== -1)
  59     lastFrame = tb[tb.length - 2];
  60
  61   assert.ok(lastFrame.fileName.indexOf("test-require.js") !== -1,
  62                           'Filename found in stacktrace');
  63   assert.equal(lastFrame.lineNumber, REQUIRE_LINE_NO,
  64                           'stacktrace has correct line number');
  65 }
  66
  67 require('test').run(exports);