storage/test/unit/head_storage.js

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Storage Test Code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  *   Mozilla Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2007
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 const Ci = Components.interfaces;
  39 const Cc = Components.classes;
  40 const Cr = Components.results;
  41
  42 var dirSvc = Cc["@mozilla.org/file/directory_service;1"].
  43              getService(Ci.nsIProperties);
  44
  45 function getTestDB()
  46 {
  47   var db = dirSvc.get("CurProcD", Ci.nsIFile);
  48   db.append("test_storage.sqlite");
  49   return db;
  50 }
  51
  52 /**
  53  * Obtains a corrupt database to test against.
  54  */
  55 function getCorruptDB()
  56 {
  57   return do_get_file("storage/test/unit/corruptDB.sqlite");
  58 }
  59
  60 function cleanup()
  61 {
  62   // close the connection
  63   print("*** Storage Tests: Trying to close!");
  64   getOpenedDatabase().close();
  65
  66   // we need to null out the database variable to get a new connection the next
  67   // time getOpenedDatabase is called
  68   gDBConn = null;
  69
  70   // removing test db
  71   print("*** Storage Tests: Trying to remove file!");
  72   var dbFile = getTestDB();
  73   if (dbFile.exists())
  74     try { dbFile.remove(false); } catch(e) { /* stupid windows box */ }
  75 }
  76
  77 function getService()
  78 {
  79   return Cc["@mozilla.org/storage/service;1"].getService(Ci.mozIStorageService);
  80 }
  81
  82 var gDBConn = null;
  83
  84 /**
  85  * Get a connection to the test database.  Creates and caches the connection
  86  * if necessary, otherwise reuses the existing cached connection.
  87  *
  88  * @param unshared {boolean}
  89  *        whether or not to open a connection to the database that doesn't share
  90  *        its cache; if true, we use mozIStorageService::openUnsharedDatabase
  91  *        to create the connection; otherwise we use openDatabase.
  92  * @returns the mozIStorageConnection for the file.
  93  */
  94 function getOpenedDatabase(unshared)
  95 {
  96   if (!gDBConn) {
  97     gDBConn = getService()
  98               [unshared ? "openUnsharedDatabase" : "openDatabase"]
  99               (getTestDB());
 100   }
 101   return gDBConn;
 102 }
 103
 104 /**
 105  * Obtains a specific database to use.
 106  *
 107  * @param aFile
 108  *        The nsIFile representing the db file to open.
 109  * @returns the mozIStorageConnection for the file.
 110  */
 111 function getDatabase(aFile)
 112 {
 113   return getService().openDatabase(aFile);
 114 }
 115
 116 function createStatement(aSQL)
 117 {
 118   return getOpenedDatabase().createStatement(aSQL);
 119 }
 120
 121 cleanup();
 122