The Tor Browser: addon-sdk/source/test/test-native-loader.js@b8a032363ba2 (annotated)

addon-sdk/source/test/test-native-loader.js@b8a032363ba2 (annotated)

addon-sdk/source/test/test-native-loader.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* 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';
 let {
   Loader, main, unload, parseStack, generateMap, resolve, nodeResolve
 } = require('toolkit/loader');
 let { readURI } = require('sdk/net/url');
 let { all } = require('sdk/core/promise');
 let testOptions = require('@test/options');
 let root = module.uri.substr(0, module.uri.lastIndexOf('/'))
 // The following adds Debugger constructor to the global namespace.
 const { Cu } = require('chrome');
 const { addDebuggerToGlobal } = Cu.import('resource://gre/modules/jsdebugger.jsm', {});
 addDebuggerToGlobal(this);
 exports['test nodeResolve'] = function (assert) {
   let rootURI = root + '/fixtures/native-addon-test/';
   let manifest = {};
   manifest.dependencies = {};
   // Handles extensions
   resolveTest('../package.json', './dir/c.js', './package.json');
   resolveTest('../dir/b.js', './dir/c.js', './dir/b.js');
   resolveTest('./dir/b', './index.js', './dir/b.js');
   resolveTest('../index', './dir/b.js', './index.js');
   resolveTest('../', './dir/b.js', './index.js');
   resolveTest('./dir/a', './index.js', './dir/a.js', 'Precedence dir/a.js over dir/a/');
   resolveTest('../utils', './dir/a.js', './utils/index.js', 'Requiring a directory defaults to dir/index.js');
   resolveTest('../newmodule', './dir/c.js', './newmodule/lib/file.js', 'Uses package.json main in dir to load appropriate "main"');
   resolveTest('test-math', './utils/index.js', './node_modules/test-math/index.js',
     'Dependencies default to their index.js');
   resolveTest('test-custom-main', './utils/index.js', './node_modules/test-custom-main/lib/custom-entry.js',
     'Dependencies use "main" entry');
   resolveTest('test-math/lib/sqrt', './utils/index.js', './node_modules/test-math/lib/sqrt.js',
     'Dependencies\' files can be consumed via "/"');
   resolveTest('sdk/tabs/utils', './index.js', undefined,
     'correctly ignores SDK references in paths');
   resolveTest('fs', './index.js', undefined,
     'correctly ignores built in node modules in paths');
   resolveTest('test-add', './node_modules/test-math/index.js',
     './node_modules/test-math/node_modules/test-add/index.js',
     'Dependencies\' dependencies can be found');
   function resolveTest (id, requirer, expected, msg) {
     let result = nodeResolve(id, requirer, { manifest: manifest, rootURI: rootURI });
     assert.equal(result, expected, 'nodeResolve ' + id + ' from ' + requirer + ' ' +msg);
   }
 }
 /*
 // TODO not working in current env
 exports['test bundle'] = function (assert, done) {
   loadAddon('/native-addons/native-addon-test/')
 };
 */
 exports['test generateMap()'] = function (assert, done) {
   getJSON('/fixtures/native-addon-test/expectedmap.json').then(expected => {
     generateMap({
       rootURI: root + '/fixtures/native-addon-test/'
     }, map => {
       assert.deepEqual(map, expected, 'generateMap returns expected mappings');
       assert.equal(map['./index.js']['./dir/a'], './dir/a.js',
         'sanity check on correct mappings');
       done();
     });
   }).then(null, (reason) => console.error(reason));
 };
 exports['test JSM loading'] = function (assert, done) {
   getJSON('/fixtures/jsm-package/package.json').then(manifest => {
     let rootURI = root + '/fixtures/jsm-package/';
     let loader = Loader({
       paths: makePaths(rootURI),
       rootURI: rootURI,
       manifest: manifest,
       isNative: true
     });
     let program = main(loader);
     assert.ok(program.localJSMCached, 'local relative JSMs are cached');
     assert.ok(program.isCachedJSAbsolute , 'absolute resource:// js are cached');
     assert.ok(program.isCachedPath, 'JSMs resolved in paths are cached');
     assert.ok(program.isCachedAbsolute, 'absolute resource:// JSMs are cached');
     assert.ok(program.localJSM, 'able to load local relative JSMs');
     all([
       program.isLoadedPath(10),
       program.isLoadedAbsolute(20),
       program.isLoadedJSAbsolute(30)
     ]).then(([path, absolute, jsabsolute]) => {
       assert.equal(path, 10, 'JSM files resolved from path work');
       assert.equal(absolute, 20, 'JSM files resolved from full resource:// work');
       assert.equal(jsabsolute, 30, 'JS files resolved from full resource:// work');
     }).then(done, console.error);
   }).then(null, console.error);
 };
 exports['test native Loader with mappings'] = function (assert, done) {
   all([
     getJSON('/fixtures/native-addon-test/expectedmap.json'),
     getJSON('/fixtures/native-addon-test/package.json')
   ]).then(([expectedMap, manifest]) => {
     // Override dummy module and point it to `test-math` to see if the
     // require is pulling from the mapping
     expectedMap['./index.js']['./dir/dummy'] = './dir/a.js';
     let rootURI = root + '/fixtures/native-addon-test/';
     let loader = Loader({
       paths: makePaths(rootURI),
       rootURI: rootURI,
       manifest: manifest,
       requireMap: expectedMap,
       isNative: true
     });
     let program = main(loader);
     assert.equal(program.dummyModule, 'dir/a',
       'The lookup uses the information given in the mapping');
     testLoader(program, assert);
     unload(loader);
     done();
   }).then(null, (reason) => console.error(reason));
 };
 exports['test native Loader without mappings'] = function (assert, done) {
   getJSON('/fixtures/native-addon-test/package.json').then(manifest => {
     let rootURI = root + '/fixtures/native-addon-test/';
     let loader = Loader({
       paths: makePaths(rootURI),
       rootURI: rootURI,
       manifest: manifest,
       isNative: true
     });
     let program = main(loader);
     testLoader(program, assert);
     unload(loader);
     done();
   }).then(null, (reason) => console.error(reason));
 };
 function testLoader (program, assert) {
   // Test 'main' entries
   // no relative custom main `lib/index.js`
   assert.equal(program.customMainModule, 'custom entry file',
     'a node_module dependency correctly uses its `main` entry in manifest');
   // relative custom main `./lib/index.js`
   assert.equal(program.customMainModuleRelative, 'custom entry file relative',
     'a node_module dependency correctly uses its `main` entry in manifest with relative ./');
   // implicit './index.js'
   assert.equal(program.defaultMain, 'default main',
     'a node_module dependency correctly defautls to index.js for main');
   // Test directory exports
   assert.equal(program.directoryDefaults, 'utils',
     '`require`ing a directory defaults to dir/index.js');
   assert.equal(program.directoryMain, 'main from new module',
     '`require`ing a directory correctly loads the `main` entry and not index.js');
   assert.equal(program.resolvesJSoverDir, 'dir/a',
     '`require`ing "a" resolves "a.js" over "a/index.js"');
   // Test dependency's dependencies
   assert.ok(program.math.add,
     'correctly defaults to index.js of a module');
   assert.equal(program.math.add(10, 5), 15,
     'node dependencies correctly include their own dependencies');
   assert.equal(program.math.subtract(10, 5), 5,
     'node dependencies correctly include their own dependencies');
   assert.equal(program.mathInRelative.subtract(10, 5), 5,
     'relative modules can also include node dependencies');
   // Test SDK natives
   assert.ok(program.promise.defer, 'main entry can include SDK modules with no deps');
   assert.ok(program.promise.resolve, 'main entry can include SDK modules with no deps');
   assert.ok(program.eventCore.on, 'main entry can include SDK modules that have dependencies');
   assert.ok(program.eventCore.off, 'main entry can include SDK modules that have dependencies');
   // Test JSMs
   assert.ok(program.promisejsm.defer, 'can require JSM files in path');
   assert.equal(program.localJSM.test, 'this is a jsm',
     'can require relative JSM files');
   // Other tests
   assert.equal(program.areModulesCached, true,
     'modules are correctly cached');
   assert.equal(program.testJSON.dependencies['test-math'], '*',
     'correctly requires JSON files');
 }
 function getJSON (uri) {
   return readURI(root + uri).then(manifest => JSON.parse(manifest));
 }
 function makePaths (uri) {
   // Uses development SDK modules if overloaded in loader
   let sdkPaths = testOptions.paths ? testOptions.paths[''] : 'resource://gre/modules/commonjs/';
   return {
     './': uri,
     'sdk/': sdkPaths + 'sdk/',
     'toolkit/': sdkPaths + 'toolkit/',
     'modules/': 'resource://gre/modules/'
   };
 }
 function loadAddon (uri, map) {
   let rootURI = root + uri;
   getJSON(uri + '/package.json').then(manifest => {
     let loader = Loader({
       paths: makePaths(rootURI),
       rootURI: rootURI,
       manifest: manifest,
       isNative: true,
       modules: {
         '@test/options': testOptions
       }
     });
     let program = main(loader);
   }).then(null, console.error);
 }
 require('test').run(exports);