Add initial locale unit tests for the MozLoopService

browser/components/loop/MozLoopService.jsm

@@ -9,8 +9,16 @@ Cu.import("resource://gre/modules/XPCOMUtils.jsm");
 
 this.EXPORTED_SYMBOLS = ["MozLoopService"];
 
-// Internal helper methods and state
+/**
+ * Internal helper methods and state
+ */
 let MozLoopServiceInternal = {
+  /**
+   * A getter to obtain and store the strings for loop. This is structured
+   * for use by l10n.js.
+   *
+   * @returns {Object} a map of element ids with attributes to set.
+   */
   get localizedStrings() {
     var stringBundle =
       Services.strings.createBundle('chrome://browser/locale/loop/loop.properties');
@@ -36,17 +44,33 @@ let MozLoopServiceInternal = {
 };
 
 
-// Public API
+/**
+ * Public API
+ */
 this.MozLoopService = {
+  /**
+   * Returns the strings for the specified element. Designed for use
+   * with l10n.js.
+   *
+   * @param {key} The element id to get strings for.
+   * @return {String} A JSON string containing the localized
+   *                  attribute/value pairs for the element.
+   */
   getStrings: function(key) {
-    try {
-      return JSON.stringify(MozLoopServiceInternal.localizedStrings[key]);
-    } catch (ex) {
-      Cu.reportError('Unable to retrive localized strings: ' + e);
-      return null;
-    }
+      var stringData = MozLoopServiceInternal.localizedStrings;
+      if (!(key in stringData)) {
+        Cu.reportError('No string for key: ' + key + 'found');
+        return "";
+      }
+
+      return JSON.stringify(stringData[key]);
   },
 
+  /**
+   * Returns the current locale
+   *
+   * @return {String} The code of the current locale.
+   */
   get locale() {
     try {
       return Services.prefs.getComplexValue("general.useragent.locale",

browser/components/loop/moz.build

@@ -8,6 +8,8 @@ JAR_MANIFESTS += ['jar.mn']
 
 JS_MODULES_PATH = 'modules/loop'
 
+XPCSHELL_TESTS_MANIFESTS += ['test/xpcshell/xpcshell.ini']
+
 EXTRA_JS_MODULES += [
     'MozLoopService.jsm',
 ]

browser/components/loop/test/xpcshell/test_loopservice_locales.js

@@ -0,0 +1,36 @@
+/* Any copyright is dedicated to the Public Domain.
+   http://creativecommons.org/publicdomain/zero/1.0/ */
+
+const {classes: Cc, interfaces: Ci, utils: Cu, results: Cr} = Components;
+
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+Cu.import("resource://gre/modules/Services.jsm");
+
+XPCOMUtils.defineLazyModuleGetter(this, "MozLoopService",
+                                  "resource:///modules/loop/MozLoopService.jsm");
+
+
+function test_locale() {
+  // Set the pref to something controlled.
+  Services.prefs.setCharPref("general.useragent.locale", "ab-CD");
+
+  do_check_eq(MozLoopService.locale, "ab-CD");
+
+  Services.prefs.clearUserPref("general.useragent.locale");
+}
+
+function test_getStrings() {
+  // Try an invalid string
+  do_check_eq(MozLoopService.getStrings("invalid_not_found_string"), "");
+
+  // Get a string that has sub-items to test the function more fully.
+  // XXX This depends on the L10n values, which I'd prefer not to do, but is the
+  // simplest way for now.
+  do_check_eq(MozLoopService.getStrings("caller"), '{"placeholder":"Identify this call"}');
+}
+
+function run_test()
+{
+  test_locale();
+  test_getStrings();
+}

browser/components/loop/test/xpcshell/xpcshell.ini

@@ -0,0 +1,6 @@
+[DEFAULT]
+head =
+tail =
+firefox-appdir = browser
+
+[test_loopservice_locales.js]