Bug 1290901 - [webext] Add xpcshell test cases on nested namespaces and null/empty api objects. r=aswan

MozReview-Commit-ID: HKh3gXTk09H

--HG--
extra : rebase_source : 4c2fa93c8fb43682ed4674bc7fe27ef2b1464efb

toolkit/components/extensions/test/xpcshell/test_ext_schemas.js

@@ -1176,3 +1176,90 @@ add_task(function* testPermissions() {
   equal(typeof root.fooPerm.noPerms, "function", "noPerms.noPerms method should exist");
   equal(typeof root.fooPerm.fooBarPerm, "function", "noPerms.fooBarPerm method should exist");
 });
+
+let nestedNamespaceJson = [
+  {
+    "namespace": "nested.namespace",
+    "types": [
+      {
+        "id": "CustomType",
+        "type": "object",
+        "events": [
+          {
+            "name": "onEvent",
+          },
+        ],
+        "properties": {
+          "url": {
+            "type": "string",
+          },
+        },
+        "functions": [
+          {
+            "name": "functionOnCustomType",
+            "type": "function",
+            "parameters": [
+              {
+                "name": "title",
+                "type": "string",
+              },
+            ],
+          },
+        ],
+      },
+    ],
+    "properties": {
+      "instanceOfCustomType": {
+        "$ref": "CustomType",
+      },
+    },
+    "functions": [
+      {
+        "name": "create",
+        "type": "function",
+        "parameters": [
+          {
+            "name": "title",
+            "type": "string",
+          },
+        ],
+      },
+    ],
+  },
+];
+
+add_task(function* testNestedNamespace() {
+  let url = "data:," + JSON.stringify(nestedNamespaceJson);
+
+  yield Schemas.load(url);
+
+  let root = {};
+  Schemas.inject(root, wrapper);
+
+  talliedErrors.length = 0;
+
+  ok(root.nested, "The root object contains the first namespace level");
+  ok(root.nested.namespace, "The first level object contains the second namespace level");
+
+  ok(root.nested.namespace.create, "Got the expected function in the nested namespace");
+  do_check_eq(typeof root.nested.namespace.create, "function",
+     "The property is a function as expected");
+
+  let {instanceOfCustomType} = root.nested.namespace;
+
+  ok(instanceOfCustomType,
+     "Got the expected instance of the CustomType defined in the schema");
+  ok(instanceOfCustomType.functionOnCustomType,
+     "Got the expected method in the CustomType instance");
+
+  // TODO: test support events and properties in a SubModuleType defined in the schema,
+  // once implemented, e.g.:
+  //
+  // ok(instanceOfCustomType.url,
+  //    "Got the expected property defined in the CustomType instance)
+  //
+  // ok(instanceOfCustomType.onEvent &&
+  //    instanceOfCustomType.onEvent.addListener &&
+  //    typeof instanceOfCustomType.onEvent.addListener == "function",
+  //    "Got the expected event defined in the CustomType instance");
+});

toolkit/components/extensions/test/xpcshell/test_ext_schemas_api_injection.js

@@ -0,0 +1,100 @@
+"use strict";
+
+Components.utils.import("resource://gre/modules/Schemas.jsm");
+
+let {
+  Management,
+} = Components.utils.import("resource://gre/modules/Extension.jsm", {});
+
+let nestedNamespaceJson = [
+  {
+    "namespace": "backgroundAPI.testnamespace",
+    "functions": [
+      {
+        "name": "create",
+        "type": "function",
+        "parameters": [
+          {
+            "name": "title",
+            "type": "string",
+          },
+        ],
+      },
+    ],
+  },
+  {
+    "namespace": "noBackgroundAPI.testnamespace",
+    "functions": [
+      {
+        "name": "create",
+        "type": "function",
+        "parameters": [
+          {
+            "name": "title",
+            "type": "string",
+          },
+        ],
+      },
+    ],
+  },
+];
+
+add_task(function* testSchemaAPIInjection() {
+  let url = "data:," + JSON.stringify(nestedNamespaceJson);
+
+  // Load the schema of the fake APIs.
+  yield Schemas.load(url);
+
+  // Register an API that will skip the background page.
+  Management.registerSchemaAPI("noBackgroundAPI.testnamespace", (extension, context) => {
+    if (context.type !== "background") {
+      return {
+        noBackgroundAPI: {
+          testnamespace: {
+            create(title) {},
+          },
+        },
+      };
+    }
+
+    // This API should not be available in this context, return null so that
+    // the schema wrapper is removed as well.
+    return null;
+  });
+
+  // Register an API that will skip any but the background page.
+  Management.registerSchemaAPI("backgroundAPI.testnamespace", (extension, context) => {
+    if (context.type === "background") {
+      return {
+        backgroundAPI: {
+          testnamespace: {
+            create(title) {
+              return title;
+            },
+          },
+        },
+      };
+    }
+
+    // This API should not be available in this context, return null so that
+    // the schema wrapper is removed as well.
+    return null;
+  });
+
+  let extension = ExtensionTestUtils.loadExtension({
+    background() {
+      if (browser.noBackgroundAPI) {
+        browser.test.notifyFail("skipAPIonNull.done");
+      } else {
+        const res = browser.backgroundAPI.testnamespace.create("param-value");
+        browser.test.assertEq("param-value", res,
+                              "Got the expected result from the fake API method");
+        browser.test.notifyPass("skipAPIonNull.done");
+      }
+    },
+  });
+
+  yield extension.startup();
+  yield extension.awaitFinish("skipAPIonNull.done");
+  yield extension.unload();
+});

toolkit/components/extensions/test/xpcshell/xpcshell.ini

@@ -41,6 +41,7 @@ skip-if = release_build
 [test_ext_runtime_sendMessage.js]
 [test_ext_runtime_sendMessage_no_receiver.js]
 [test_ext_schemas.js]
+[test_ext_schemas_api_injection.js]
 [test_ext_simple.js]
 [test_ext_storage.js]
 [test_getAPILevelForWindow.js]