michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: const PREF_INVALID = 0;
michael@0: const PREF_BOOL    = 128;
michael@0: const PREF_INT     = 64;
michael@0: const PREF_STRING  = 32;
michael@0: 
michael@0: const MAX_PREF_LENGTH = 1 * 1024 * 1024;
michael@0: 
michael@0: function makeList(a)
michael@0: {
michael@0:   var o = {};
michael@0:   for(var i=0; i<a.length; i++)
michael@0:   {
michael@0:     o[a[i]] = '';
michael@0:   }
michael@0:   return o;
michael@0: }
michael@0: 
michael@0: function run_test() {
michael@0: 
michael@0:   var ps = Cc["@mozilla.org/preferences-service;1"].
michael@0:             getService(Ci.nsIPrefService);
michael@0: 
michael@0:   var pb2= Cc["@mozilla.org/preferences-service;1"].
michael@0:             getService(Ci.nsIPrefBranch);
michael@0: 
michael@0:   var pb = Cc["@mozilla.org/preferences-service;1"].
michael@0:             getService(Ci.nsIPrefBranch);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // Nullsafety
michael@0: 
michael@0:   do_check_throws(function() {
michael@0:     pb.getPrefType(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.getBoolPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.setBoolPref(null, false); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.getIntPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.setIntPref(null, 0); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.getCharPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.setCharPref(null, null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.getComplexValue(null, Components.interfaces.nsISupportsString); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.setComplexValue(null, Components.interfaces.nsISupportsString, pb); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.clearUserPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.prefHasUserValue(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.lockPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.prefIsLocked(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.unlockPref(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.deleteBranch(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0:   do_check_throws(function() {
michael@0:     pb.getChildList(null); },  Cr.NS_ERROR_INVALID_ARG);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // Nonexisting user preferences
michael@0: 
michael@0:   do_check_eq(pb.prefHasUserValue("UserPref.nonexistent.hasUserValue"), false);
michael@0:   pb.clearUserPref("UserPref.nonexistent.clearUserPref"); // shouldn't throw
michael@0:   do_check_eq(pb.getPrefType("UserPref.nonexistent.getPrefType"), PREF_INVALID);
michael@0:   do_check_eq(pb.root, "");
michael@0: 
michael@0:   // bool...
michael@0:   do_check_throws(function() {
michael@0:     pb.getBoolPref("UserPref.nonexistent.getBoolPref");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   pb.setBoolPref("UserPref.nonexistent.setBoolPref", false);
michael@0:   do_check_eq(pb.getBoolPref("UserPref.nonexistent.setBoolPref"), false);
michael@0: 
michael@0:   // int...
michael@0:   do_check_throws(function() {
michael@0:     pb.getIntPref("UserPref.nonexistent.getIntPref");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   pb.setIntPref("UserPref.nonexistent.setIntPref", 5);
michael@0:   do_check_eq(pb.getIntPref("UserPref.nonexistent.setIntPref"), 5);
michael@0: 
michael@0:   // char
michael@0:   do_check_throws(function() {
michael@0:     pb.getCharPref("UserPref.nonexistent.getCharPref");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   pb.setCharPref("UserPref.nonexistent.setCharPref", "_test");
michael@0:   do_check_eq(pb.getCharPref("UserPref.nonexistent.setCharPref"), "_test");
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // Existing user Prefs and data integrity test (round-trip match)
michael@0: 
michael@0:   pb.setBoolPref("UserPref.existing.bool", true);
michael@0:   pb.setIntPref("UserPref.existing.int", 23);
michael@0:   pb.setCharPref("UserPref.existing.char", "hey");
michael@0: 
michael@0:   // getPref should return the pref value
michael@0:   do_check_eq(pb.getBoolPref("UserPref.existing.bool"), true);
michael@0:   do_check_eq(pb.getIntPref("UserPref.existing.int"), 23);
michael@0:   do_check_eq(pb.getCharPref("UserPref.existing.char"), "hey");
michael@0: 
michael@0:   // setPref should not complain and should change the value of the pref
michael@0:   pb.setBoolPref("UserPref.existing.bool", false);
michael@0:   do_check_eq(pb.getBoolPref("UserPref.existing.bool"), false);
michael@0:   pb.setIntPref("UserPref.existing.int", 24);
michael@0:   do_check_eq(pb.getIntPref("UserPref.existing.int"), 24);
michael@0:   pb.setCharPref("UserPref.existing.char", "hej då!");
michael@0:   do_check_eq(pb.getCharPref("UserPref.existing.char"), "hej då!");
michael@0: 
michael@0:   // prefHasUserValue should return true now
michael@0:   do_check_true(pb.prefHasUserValue("UserPref.existing.bool"));
michael@0:   do_check_true(pb.prefHasUserValue("UserPref.existing.int"));
michael@0:   do_check_true(pb.prefHasUserValue("UserPref.existing.char"));
michael@0: 
michael@0:   // clearUserPref should remove the pref
michael@0:   pb.clearUserPref("UserPref.existing.bool");
michael@0:   do_check_false(pb.prefHasUserValue("UserPref.existing.bool"));
michael@0:   pb.clearUserPref("UserPref.existing.int");
michael@0:   do_check_false(pb.prefHasUserValue("UserPref.existing.int"));
michael@0:   pb.clearUserPref("UserPref.existing.char");
michael@0:   do_check_false(pb.prefHasUserValue("UserPref.existing.char"));
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // Large value test
michael@0: 
michael@0:   let largeStr = new Array(MAX_PREF_LENGTH + 1).join('x');
michael@0:   pb.setCharPref("UserPref.large.char", largeStr);
michael@0:   largeStr += 'x';
michael@0:   do_check_throws(function() {
michael@0:     pb.setCharPref("UserPref.large.char", largeStr); }, Cr.NS_ERROR_ILLEGAL_VALUE);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // getPrefType test
michael@0: 
michael@0:   // bool...
michael@0:   pb.setBoolPref("UserPref.getPrefType.bool", true);
michael@0:   do_check_eq(pb.getPrefType("UserPref.getPrefType.bool"), PREF_BOOL);
michael@0: 
michael@0:   // int...
michael@0:   pb.setIntPref("UserPref.getPrefType.int", -234);
michael@0:   do_check_eq(pb.getPrefType("UserPref.getPrefType.int"), PREF_INT);
michael@0: 
michael@0:   // char...
michael@0:   pb.setCharPref("UserPref.getPrefType.char", "testing1..2");
michael@0:   do_check_eq(pb.getPrefType("UserPref.getPrefType.char"), PREF_STRING);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // getBranch tests
michael@0:   
michael@0:   do_check_eq(ps.root, "");
michael@0: 
michael@0:   // bool ...
michael@0:   pb.setBoolPref("UserPref.root.boolPref", true);
michael@0:   let pb_1 = ps.getBranch("UserPref.root.");
michael@0:   do_check_eq(pb_1.getBoolPref("boolPref"), true);
michael@0:   let pb_2 = ps.getBranch("UserPref.root.boolPref");
michael@0:   do_check_eq(pb_2.getBoolPref(""), true);
michael@0:   pb_2.setBoolPref(".anotherPref", false);
michael@0:   let pb_3 = ps.getBranch("UserPref.root.boolPre");
michael@0:   do_check_eq(pb_3.getBoolPref("f.anotherPref"), false);
michael@0: 
michael@0:   // int ...
michael@0:   pb.setIntPref("UserPref.root.intPref", 23);
michael@0:   let pb_1 = ps.getBranch("UserPref.root.");
michael@0:   do_check_eq(pb_1.getIntPref("intPref"), 23);
michael@0:   let pb_2 = ps.getBranch("UserPref.root.intPref");
michael@0:   do_check_eq(pb_2.getIntPref(""), 23);
michael@0:   pb_2.setIntPref(".anotherPref", 69);
michael@0:   let pb_3 = ps.getBranch("UserPref.root.intPre");
michael@0:   do_check_eq(pb_3.getIntPref("f.anotherPref"), 69);
michael@0: 
michael@0:   // char...
michael@0:   pb.setCharPref("UserPref.root.charPref", "_char");
michael@0:   let pb_1 = ps.getBranch("UserPref.root.");
michael@0:   do_check_eq(pb_1.getCharPref("charPref"), "_char");
michael@0:   let pb_2 = ps.getBranch("UserPref.root.charPref");
michael@0:   do_check_eq(pb_2.getCharPref(""), "_char");
michael@0:   pb_2.setCharPref(".anotherPref", "_another");
michael@0:   let pb_3 = ps.getBranch("UserPref.root.charPre");
michael@0:   do_check_eq(pb_3.getCharPref("f.anotherPref"), "_another");
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // getChildlist tests
michael@0: 
michael@0:   // get an already set prefBranch
michael@0:   pb1 = ps.getBranch("UserPref.root.");
michael@0:   let prefList = pb1.getChildList("");
michael@0:   do_check_eq(prefList.length, 6);
michael@0: 
michael@0:   // check for specific prefs in the array : the order is not important
michael@0:   do_check_true("boolPref" in makeList(prefList));
michael@0:   do_check_true("intPref" in makeList(prefList));
michael@0:   do_check_true("charPref" in makeList(prefList));
michael@0:   do_check_true("boolPref.anotherPref" in makeList(prefList));
michael@0:   do_check_true("intPref.anotherPref" in makeList(prefList));
michael@0:   do_check_true("charPref.anotherPref" in makeList(prefList));
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // Default branch tests
michael@0: 
michael@0:   // bool...
michael@0:   pb1 = ps.getDefaultBranch("");
michael@0:   pb1.setBoolPref("DefaultPref.bool", true);
michael@0:   do_check_eq(pb1.getBoolPref("DefaultPref.bool"), true);  
michael@0:   do_check_false(pb1.prefHasUserValue("DefaultPref.bool"));
michael@0:   ps.setBoolPref("DefaultPref.bool", false);
michael@0:   do_check_true(pb1.prefHasUserValue("DefaultPref.bool"));
michael@0:   do_check_eq(ps.getBoolPref("DefaultPref.bool"), false); 
michael@0: 
michael@0:   // int...
michael@0:   pb1 = ps.getDefaultBranch("");
michael@0:   pb1.setIntPref("DefaultPref.int", 100);
michael@0:   do_check_eq(pb1.getIntPref("DefaultPref.int"), 100);  
michael@0:   do_check_false(pb1.prefHasUserValue("DefaultPref.int"));
michael@0:   ps.setIntPref("DefaultPref.int", 50);
michael@0:   do_check_true(pb1.prefHasUserValue("DefaultPref.int"));
michael@0:   do_check_eq(ps.getIntPref("DefaultPref.int"), 50); 
michael@0: 
michael@0:   // char...
michael@0:   pb1 = ps.getDefaultBranch("");
michael@0:   pb1.setCharPref("DefaultPref.char", "_default");
michael@0:   do_check_eq(pb1.getCharPref("DefaultPref.char"), "_default");  
michael@0:   do_check_false(pb1.prefHasUserValue("DefaultPref.char"));
michael@0:   ps.setCharPref("DefaultPref.char", "_user");
michael@0:   do_check_true(pb1.prefHasUserValue("DefaultPref.char"));
michael@0:   do_check_eq(ps.getCharPref("DefaultPref.char"), "_user"); 
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // pref Locking/Unlocking tests
michael@0: 
michael@0:   // locking and unlocking a nonexistent pref should throw
michael@0:   do_check_throws(function() {
michael@0:     ps.lockPref("DefaultPref.nonexistent");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     ps.unlockPref("DefaultPref.nonexistent");}, Cr.NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   // getting a locked pref branch should return the "default" value
michael@0:   do_check_false(ps.prefIsLocked("DefaultPref.char"));
michael@0:   ps.lockPref("DefaultPref.char");
michael@0:   do_check_eq(ps.getCharPref("DefaultPref.char"), "_default"); 
michael@0:   do_check_true(ps.prefIsLocked("DefaultPref.char"));
michael@0: 
michael@0:   // getting an unlocked pref branch should return the "user" value 
michael@0:   ps.unlockPref("DefaultPref.char");
michael@0:   do_check_eq(ps.getCharPref("DefaultPref.char"), "_user"); 
michael@0:   do_check_false(ps.prefIsLocked("DefaultPref.char"));
michael@0: 
michael@0:   // setting the "default" value to a user pref branch should
michael@0:   // make prefHasUserValue return false (documented behavior)
michael@0:   ps.setCharPref("DefaultPref.char", "_default");
michael@0:   do_check_false(pb1.prefHasUserValue("DefaultPref.char"));
michael@0: 
michael@0:   // unlocking and locking multiple times shouldn't throw
michael@0:   ps.unlockPref("DefaultPref.char");
michael@0:   ps.lockPref("DefaultPref.char");
michael@0:   ps.lockPref("DefaultPref.char");
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // resetBranch test
michael@0: 
michael@0:   // NOT IMPLEMENTED YET in module/libpref. So we're not testing !
michael@0:   // uncomment the following if resetBranch ever gets implemented.
michael@0:   /*ps.resetBranch("DefaultPref");
michael@0:   do_check_eq(ps.getBoolPref("DefaultPref.bool"), true);
michael@0:   do_check_eq(ps.getIntPref("DefaultPref.int"), 100);
michael@0:   do_check_eq(ps.getCharPref("DefaultPref.char"), "_default");*/
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // deleteBranch tests
michael@0: 
michael@0:   // TODO : Really, this should throw!, by documentation.
michael@0:   // do_check_throws(function() {
michael@0:   // ps.deleteBranch("UserPref.nonexistent.deleteBranch");}, Cr.NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   ps.deleteBranch("DefaultPref");
michael@0:   pb = ps.getBranch("DefaultPref");
michael@0:   pb1 = ps.getDefaultBranch("DefaultPref");
michael@0: 
michael@0:   // getting prefs on deleted user branches should throw
michael@0:   do_check_throws(function() {
michael@0:     pb.getBoolPref("DefaultPref.bool");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     pb.getIntPref("DefaultPref.int");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     pb.getCharPref("DefaultPref.char");}, Cr.NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   // getting prefs on deleted default branches should throw
michael@0:   do_check_throws(function() {
michael@0:     pb1.getBoolPref("DefaultPref.bool");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     pb1.getIntPref("DefaultPref.int");}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     pb1.getCharPref("DefaultPref.char");}, Cr.NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // savePrefFile & readPrefFile tests
michael@0: 
michael@0:   // set some prefs
michael@0:   ps.setBoolPref("ReadPref.bool", true);
michael@0:   ps.setIntPref("ReadPref.int", 230);
michael@0:   ps.setCharPref("ReadPref.char", "hello");
michael@0: 
michael@0:   // save those prefs in a file
michael@0:   let savePrefFile = do_get_cwd();
michael@0:   savePrefFile.append("data");
michael@0:   savePrefFile.append("savePref.js");
michael@0:   if (savePrefFile.exists())
michael@0:     savePrefFile.remove(false);
michael@0:   savePrefFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
michael@0:   ps.savePrefFile(savePrefFile);
michael@0:   ps.resetPrefs();
michael@0: 
michael@0:   // load a preexisting pref file
michael@0:   let prefFile = do_get_file("data/testPref.js");
michael@0:   ps.readUserPrefs(prefFile);
michael@0: 
michael@0:   // former prefs should have been replaced/lost
michael@0:   do_check_throws(function() {
michael@0:     do_check_eq(pb.getBoolPref("ReadPref.bool"));}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     do_check_eq(pb.getIntPref("ReadPref.int"));}, Cr.NS_ERROR_UNEXPECTED);
michael@0:   do_check_throws(function() {
michael@0:     do_check_eq(pb.getCharPref("ReadPref.char"));}, Cr.NS_ERROR_UNEXPECTED);
michael@0: 
michael@0:   // loaded prefs should read ok.
michael@0:   pb = ps.getBranch("testPref.");
michael@0:   do_check_eq(pb.getBoolPref("bool1"), true);
michael@0:   do_check_eq(pb.getBoolPref("bool2"), false);
michael@0:   do_check_eq(pb.getIntPref("int1"), 23);
michael@0:   do_check_eq(pb.getIntPref("int2"), -1236);
michael@0:   do_check_eq(pb.getCharPref("char1"), "_testPref");
michael@0:   do_check_eq(pb.getCharPref("char2"), "älskar");
michael@0: 
michael@0:   // loading our former savePrefFile should allow us to read former prefs
michael@0:   ps.readUserPrefs(savePrefFile);
michael@0:   // cleanup the file now we don't need it
michael@0:   savePrefFile.remove(false);
michael@0:   do_check_eq(ps.getBoolPref("ReadPref.bool"), true);
michael@0:   do_check_eq(ps.getIntPref("ReadPref.int"), 230);
michael@0:   do_check_eq(ps.getCharPref("ReadPref.char"), "hello");
michael@0: 
michael@0:   // ... and still be able to access "prior-to-readUserPrefs" preferences
michael@0:   do_check_eq(pb.getBoolPref("bool1"), true);
michael@0:   do_check_eq(pb.getBoolPref("bool2"), false);
michael@0:   do_check_eq(pb.getIntPref("int1"), 23);
michael@0: 
michael@0:   //**************************************************************************//
michael@0:   // preference Observers
michael@0: 
michael@0:   // an observer...
michael@0:   var observer = {
michael@0:     QueryInterface: function QueryInterface(aIID) {
michael@0:       if (aIID.equals(Ci.nsIObserver) ||
michael@0:           aIID.equals(Ci.nsISupports))
michael@0:          return this;
michael@0:       throw Components.results.NS_NOINTERFACE;
michael@0:     },
michael@0: 
michael@0:     observe: function observe(aSubject, aTopic, aState) {
michael@0:       do_check_eq(aTopic, "nsPref:changed");
michael@0:       do_check_eq(aState, "ReadPref.int");
michael@0:       do_check_eq(ps.getIntPref(aState), 76);
michael@0:       ps.removeObserver("ReadPref.int", this);
michael@0: 
michael@0:       // notification received, we may go on...
michael@0:       do_test_finished();
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   pb2.addObserver("ReadPref.int", observer, false);
michael@0:   ps.setIntPref("ReadPref.int", 76);
michael@0: 
michael@0:   // test will continue upon notification...
michael@0:   do_test_pending();
michael@0: 
michael@0:   // removed observer should not fire
michael@0:   pb2.removeObserver("ReadPref.int", observer);
michael@0:   ps.setIntPref("ReadPref.int", 32);
michael@0: 
michael@0:   // let's test observers once more with a non-root prefbranch
michael@0:   pb2.getBranch("ReadPref.");
michael@0:   pb2.addObserver("int", observer, false);
michael@0:   ps.setIntPref("ReadPref.int", 76);
michael@0: 
michael@0:   // test will complete upon notification...
michael@0:   do_test_pending();
michael@0: }