gecko/storage/test/unit/test_storage_statement_wrapper.js

229 lines
6.9 KiB
JavaScript
Raw Normal View History

/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
vim:set ts=2 sw=2 sts=2 et:
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Storage Test Code.
*
* The Initial Developer of the Original Code is
* Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2007
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Shawn Wilsher <me@shawnwilsher.com> (Original Author)
* Drew Willcoxon <adw@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
2007-09-03 07:30:45 -07:00
// This file tests the functions of mozIStorageStatementWrapper
function setup()
{
getOpenedDatabase().createTable("test", "id INTEGER PRIMARY KEY, val NONE," +
"alt_val NONE");
}
var wrapper = new Components.Constructor("@mozilla.org/storage/statement-wrapper;1",
Ci.mozIStorageStatementWrapper,
"initialize");
// we want to override the default function for this file
createStatement = function(aSQL) {
return new wrapper(getOpenedDatabase().createStatement(aSQL));
}
/**
* A convenience wrapper for do_check_eq. Calls do_check_eq on aActualVal
* and aReturnedVal, with one caveat.
*
* Date objects are converted before parameter binding to PRTime's (microsecs
* since epoch). They are not reconverted when retrieved from the database.
* This function abstracts away this reconversion so that you can pass in,
* for example:
*
* checkVal(new Date(), aReturnedVal) // this
* checkVal(new Date().valueOf() * 1000.0, aReturnedVal) // instead of this
*
* Should any other types require conversion in the future, their conversions
* may also be abstracted away here.
*
* @param aActualVal
* the value inserted into the database
* @param aReturnedVal
* the value retrieved from the database
*/
function checkVal(aActualVal, aReturnedVal)
{
if (aActualVal instanceof Date) aActualVal = aActualVal.valueOf() * 1000.0;
do_check_eq(aActualVal, aReturnedVal);
}
/**
* Removes all rows from our test table.
*/
function clearTable()
{
var stmt = createStatement("DELETE FROM test");
stmt.execute();
stmt.statement.finalize();
ensureNumRows(0);
}
/**
* Ensures that the number of rows in our test table is equal to aNumRows.
* Calls do_check_eq on aNumRows and the value retrieved by SELECT'ing COUNT(*).
*
* @param aNumRows
* the number of rows our test table should contain
*/
function ensureNumRows(aNumRows)
{
var stmt = createStatement("SELECT COUNT(*) AS number FROM test");
do_check_true(stmt.step());
do_check_eq(aNumRows, stmt.row.number);
stmt.reset();
stmt.statement.finalize();
}
/**
* Verifies that the properties exposed by a for-in loop over aObj are
* enumerable.
*
* @param aObj
* the object to check
*/
function checkEnumerableConsistency(aObj)
{
for (var p in aObj)
do_check_true(Object.prototype.propertyIsEnumerable.call(aObj, p));
}
/**
* Inserts aVal into our test table and checks that insertion was successful by
* retrieving the newly inserted value from the database and comparing it
* against aVal. aVal is bound to a single parameter.
*
* @param aVal
* value to insert into our test table and check
*/
function insertAndCheckSingleParam(aVal)
{
clearTable();
var stmt = createStatement("INSERT INTO test (val) VALUES (:val)");
stmt.params.val = aVal;
checkEnumerableConsistency(stmt.params);
stmt.execute();
stmt.statement.finalize();
ensureNumRows(1);
stmt = createStatement("SELECT val FROM test WHERE id = 1");
do_check_true(stmt.step());
checkVal(aVal, stmt.row.val);
stmt.reset();
stmt.statement.finalize();
}
/**
* Inserts aVal into our test table and checks that insertion was successful by
* retrieving the newly inserted value from the database and comparing it
* against aVal. aVal is bound to two separate parameters, both of which are
* checked against aVal.
*
* @param aVal
* value to insert into our test table and check
*/
function insertAndCheckMultipleParams(aVal)
{
clearTable();
var stmt = createStatement("INSERT INTO test (val, alt_val) " +
"VALUES (:val, :val)");
stmt.params.val = aVal;
checkEnumerableConsistency(stmt.params);
stmt.execute();
stmt.statement.finalize();
ensureNumRows(1);
stmt = createStatement("SELECT val, alt_val FROM test WHERE id = 1");
do_check_true(stmt.step());
checkVal(aVal, stmt.row.val);
checkVal(aVal, stmt.row.alt_val);
stmt.reset();
stmt.statement.finalize();
}
/**
* A convenience function that prints out a description of aVal using
* aVal.toString and aVal.toSource. Output is useful when the test fails.
*
* @param aVal
* a value inserted or to be inserted into our test table
*/
function printValDesc(aVal)
{
try
{
var toSource = aVal.toSource();
}
catch (exc)
{
toSource = "";
}
print("Testing value: toString=" + aVal +
(toSource ? " toSource=" + toSource : ""));
}
function run_test()
{
setup();
// function JSValStorageStatementBinder in
// storage/src/mozStorageStatementParams.cpp tells us that the following types
// and only the following types are valid as statement parameters:
var vals = [
1337, // int
3.1337, // double
"foo", // string
true, // boolean
null, // null
new Date(), // Date object
];
vals.forEach(function (val)
{
printValDesc(val);
print("Single parameter");
insertAndCheckSingleParam(val);
print("Multiple parameters");
insertAndCheckMultipleParams(val)
});
cleanup();
}