summaryrefslogtreecommitdiffstats
path: root/addon-sdk/source/test/addons/require/main.js
blob: 53391f08b675d78e40ddb3cbcd8bd58bc0bfcc44 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";

var { isNative } = require("@loader/options");

exports["test local vs sdk module"] = function (assert) {
  assert.notEqual(require("list"),
                  require("sdk/util/list"),
                  "Local module takes the priority over sdk modules");
  assert.ok(require("list").local,
            "this module is really the local one");
}

if (!isNative) {
  exports["test 3rd party vs sdk module"] = function (assert) {
    // We are testing with a 3rd party package called `tabs` with 3 modules
    // main, page-mod and third-party

    // the only way to require 3rd party package modules are to use absolute paths
    // require("tabs/main"), require("tabs/page-mod"),
    // require("tabs/third-party") and also require("tabs") which will refer
    // to tabs's main package module.

    // So require(page-mod) shouldn't map the 3rd party
    assert.equal(require("page-mod"),
                 require("sdk/page-mod"),
                 "Third party modules don't overload sdk modules");

    assert.ok(require("page-mod").PageMod,
              "page-mod module is really the sdk one");

    assert.equal(require("tabs/page-mod").id, "page-mod",
                 "tabs/page-mod is the 3rd party");

    // But require(tabs) will map to 3rd party main module
    // *and* overload the sdk module
    // and also any local module with the same name
    assert.equal(require("tabs").id, "tabs-main",
                 "Third party main module overload sdk modules");

    assert.equal(require("tabs"),
                 require("tabs/main"),
                 "require(tabs) maps to require(tabs/main)");

    // So that you have to use relative path to ensure getting the local module
    assert.equal(require("./tabs").id,
                 "local-tabs",
                 "require(./tabs) maps to the local module");

    // It should still be possible to require sdk module with absolute path
    assert.ok(require("sdk/tabs").open,
              "We can bypass this overloading with absolute path to sdk modules");

    assert.equal(require("sdk/tabs"),
                 require("addon-kit/tabs"),
                 "Old and new layout both work");
  }
}

// /!\ Always use distinct module for each test.
//     Otherwise, the linker can correctly parse and allow the first usage of it
//     but still silently fail on the second.

exports.testRelativeRequire = function (assert) {
  assert.equal(require('./same-folder').id, 'same-folder');
}

exports.testRelativeSubFolderRequire = function (assert) {
  assert.equal(require('./sub-folder/module').id, 'sub-folder');
}

exports.testMultipleRequirePerLine = function (assert) {
  var a=require('./multiple/a'),b=require('./multiple/b');
  assert.equal(a.id, 'a');
  assert.equal(b.id, 'b');
}

exports.testSDKRequire = function (assert) {
  assert.deepEqual(Object.keys(require('sdk/page-worker')), ['Page']);
  if (!isNative) {
    assert.equal(require('page-worker'), require('sdk/page-worker'));
  }
}

require("sdk/test/runner").runTestsFromModule(module);