/*jshint globalstrict:false, strict:false */ /*global assertEqual, assertTypeOf, assertNotEqual, assertTrue, assertFalse, assertUndefined, fail */ //////////////////////////////////////////////////////////////////////////////// /// @brief test the collection interface /// /// @file /// /// DISCLAIMER /// /// Copyright 2010-2012 triagens GmbH, Cologne, Germany /// /// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 /// /// Unless required by applicable law or agreed to in writing, software /// distributed under the License is distributed on an "AS IS" BASIS, /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. /// See the License for the specific language governing permissions and /// limitations under the License. /// /// Copyright holder is triAGENS GmbH, Cologne, Germany /// /// @author Dr. Frank Celler /// @author Copyright 2012, triAGENS GmbH, Cologne, Germany //////////////////////////////////////////////////////////////////////////////// var jsunity = require("jsunity"); var arangodb = require("@arangodb"); var internal = require("internal"); var testHelper = require("@arangodb/test-helper"); var ArangoCollection = arangodb.ArangoCollection; var db = arangodb.db; var ERRORS = arangodb.errors; //////////////////////////////////////////////////////////////////////////////// /// @brief test suite: error handling //////////////////////////////////////////////////////////////////////////////// function CollectionSuiteErrorHandling () { return { //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (too long) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameTooLong : function () { try { // one char too long db._create(Array(258).join("a")); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (system name) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameSystem : function () { try { db._create("1234"); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (underscore) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameUnderscore : function () { try { db._create("_illegal"); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (empty) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameEmpty : function () { try { db._create(""); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (number) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameNumber : function () { try { db._create("12345"); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (underscore) (short-cut) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameUnderscoreShortCut : function () { try { var a = db._illegal; assertUndefined(a); } catch (err) { assertTrue(false); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (empty) (short-cut) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameEmptyShortCut : function () { try { var a = db[""]; assertUndefined(a); } catch (err) { assertTrue(false); } }, //////////////////////////////////////////////////////////////////////////////// /// @brief bad name (number) (short-cut) //////////////////////////////////////////////////////////////////////////////// testErrorHandlingBadNameNumberShortCut : function () { try { var a = db["12345"]; assertUndefined(a); } catch (err) { assertTrue(false); } } }; } //////////////////////////////////////////////////////////////////////////////// /// @brief test suite: collection //////////////////////////////////////////////////////////////////////////////// function CollectionSuite () { return { //////////////////////////////////////////////////////////////////////////////// /// @brief create with id //////////////////////////////////////////////////////////////////////////////// testCreateWithId : function () { var cn = "example", id = "1234567890"; db._drop(cn); db._drop(id); var c1 = db._create(cn, { id: id }); assertTypeOf("string", c1._id); assertEqual(id, c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); var c2 = db._collection(cn); assertEqual(c1._id, c2._id); assertEqual(c1.name(), c2.name()); assertEqual(c1.status(), c2.status()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief isSystem //////////////////////////////////////////////////////////////////////////////// testCreateWithIsSystem : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn, { isSystem: true }); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertFalse(c1.properties().isSystem); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief isSystem //////////////////////////////////////////////////////////////////////////////// testCreateWithUnderscoreNoIsSystem : function () { var cn = "_example"; db._drop(cn); try { db._create(cn, { isSystem: false }); fail(); } catch (err) { assertEqual(ERRORS.ERROR_ARANGO_ILLEGAL_NAME.code, err.errorNum); } db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief long name //////////////////////////////////////////////////////////////////////////////// testCreateLongName : function () { const cn = Array(129).join("a"); db._drop(cn); try { let c1 = db._create(cn); assertEqual(cn, c1.name()); } finally {} db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief long name //////////////////////////////////////////////////////////////////////////////// testCreateLongerName : function () { const cn = Array(257).join("a"); db._drop(cn); try { let c1 = db._create(cn); assertEqual(cn, c1.name()); } finally {} db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief read by name //////////////////////////////////////////////////////////////////////////////// testReadingByName : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); var c2 = db._collection(cn); assertEqual(c1._id, c2._id); assertEqual(c1.name(), c2.name()); assertEqual(c1.status(), c2.status()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief read by identifier //////////////////////////////////////////////////////////////////////////////// testReadingByIdentifier : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var c2 = db._collection(c1._id); assertEqual(c1._id, c2._id); assertEqual(c1.name(), c2.name()); assertEqual(c1.status(), c2.status()); assertEqual(c1.type(), c2.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief read by name (short-cut) //////////////////////////////////////////////////////////////////////////////// testReadingByNameShortCut : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var c2 = db[cn]; assertEqual(c1._id, c2._id); assertEqual(c1.name(), c2.name()); assertEqual(c1.status(), c2.status()); assertEqual(c1.type(), c2.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief read all //////////////////////////////////////////////////////////////////////////////// testReadingAll : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var l = db._collections(); assertNotEqual(0, l.length); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating document collection //////////////////////////////////////////////////////////////////////////////// testCreatingDocumentCollection : function () { var cn = "example"; db._drop(cn); var c1 = db._createDocumentCollection(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var p = c1.properties(); assertEqual(false, p.waitForSync); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating edge collection //////////////////////////////////////////////////////////////////////////////// testCreatingEdgeCollection : function () { var cn = "example"; db._drop(cn); var c1 = db._createEdgeCollection(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_EDGE, c1.type()); assertTypeOf("number", c1.type()); var p = c1.properties(); assertEqual(false, p.waitForSync); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief check type of document collection after unload //////////////////////////////////////////////////////////////////////////////// testTypeDocumentCollection : function () { var cn = "example"; db._drop(cn); var c1 = db._createDocumentCollection(cn); c1.unload(); c1 = null; var c2 = db[cn]; assertEqual(ArangoCollection.TYPE_DOCUMENT, c2.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief check type of edge collection after unload //////////////////////////////////////////////////////////////////////////////// testTypeEdgeCollection : function () { var cn = "example"; db._drop(cn); var c1 = db._createEdgeCollection(cn); c1.unload(); c1 = null; var c2 = db[cn]; assertEqual(ArangoCollection.TYPE_EDGE, c2.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating with defaults //////////////////////////////////////////////////////////////////////////////// testCreatingDefaults : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var p = c1.properties(); assertEqual(false, p.waitForSync); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating with properties //////////////////////////////////////////////////////////////////////////////// testCreatingProperties : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn, { waitForSync : true}); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); var p = c1.properties(); assertEqual(true, p.waitForSync); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating with type //////////////////////////////////////////////////////////////////////////////// testCreatingTypeDocument : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn, { }, "document"); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating with type //////////////////////////////////////////////////////////////////////////////// testCreatingTypeEdge : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn, { }, "edge"); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertEqual(ArangoCollection.TYPE_EDGE, c1.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief creating with type //////////////////////////////////////////////////////////////////////////////// testCreatingTypeInvalid : function () { var cn = "example"; db._drop(cn); // invalid type defaults to type "document" var c1 = db._create(cn, { }, "foobar"); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop new-born //////////////////////////////////////////////////////////////////////////////// testDroppingNewBorn : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.drop(); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop loaded //////////////////////////////////////////////////////////////////////////////// testDroppingLoaded : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.drop(); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop unloaded //////////////////////////////////////////////////////////////////////////////// testDroppingUnloaded : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); c1.unload(); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.drop(); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate new-born //////////////////////////////////////////////////////////////////////////////// testTruncatingNewBorn : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.truncate({ compact: false }); assertEqual(ArangoCollection.STATUS_LOADED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate loaded //////////////////////////////////////////////////////////////////////////////// testTruncatingLoaded : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.truncate({ compact: false }); assertEqual(ArangoCollection.STATUS_LOADED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate unloaded //////////////////////////////////////////////////////////////////////////////// testTruncatingUnloaded : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); c1.unload(); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); c1.truncate({ compact: false }); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief test revision id //////////////////////////////////////////////////////////////////////////////// testRevision1 : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); var r1 = c1.revision(); assertTypeOf("string", r1); c1.save({ a : 1 }); var r2 = c1.revision(); assertTypeOf("string", r2); assertEqual(1, testHelper.compareStringIds(r2, r1)); c1.save({ a : 2 }); var r3 = c1.revision(); assertTypeOf("string", r3); assertEqual(1, testHelper.compareStringIds(r3, r2)); // unload c1.unload(); c1 = null; internal.wait(5); c1 = db._collection(cn); var r4 = c1.revision(); assertTypeOf("string", r4); assertEqual(0, testHelper.compareStringIds(r3, r4)); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief test system collection dropping / renaming / unloading //////////////////////////////////////////////////////////////////////////////// testSystemSpecial : function () { var cn = "_users"; var c = db._collection(cn); // drop try { c.drop(); fail(); } catch (err1) { assertEqual(ERRORS.ERROR_FORBIDDEN.code, err1.errorNum); } } }; } //////////////////////////////////////////////////////////////////////////////// /// @brief test suite: collection //////////////////////////////////////////////////////////////////////////////// function CollectionDbSuite () { return { //////////////////////////////////////////////////////////////////////////////// /// @brief drop new-born (DB) //////////////////////////////////////////////////////////////////////////////// testCollections : function () { var cn1 = "example1"; var cn2 = "example2"; db._drop(cn1); db._drop(cn2); db._createDocumentCollection(cn1); db._createEdgeCollection(cn2); var collections = db._collections(); for (var i in collections) { if (collections.hasOwnProperty[i]) { var c = collections[i]; assertTypeOf("string", c.name()); assertTypeOf("number", c.status()); assertTypeOf("number", c.type()); if (c.name() === cn1) { assertEqual(ArangoCollection.TYPE_DOCUMENT, c.type()); } else if (c.name() === cn2) { assertEqual(ArangoCollection.TYPE_EDGE, c.type()); } } } db._drop(cn1); db._drop(cn2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop new-born (DB) //////////////////////////////////////////////////////////////////////////////// testDroppingNewBornDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._drop(cn); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop loaded (DB) //////////////////////////////////////////////////////////////////////////////// testDroppingLoadedDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._drop(cn); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief drop unloaded (DB) //////////////////////////////////////////////////////////////////////////////// testDroppingUnloadedDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); c1.unload(); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._drop(cn); assertEqual(ArangoCollection.STATUS_DELETED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); var c2 = db._collection(cn); assertEqual(null, c2); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate new-born (DB) //////////////////////////////////////////////////////////////////////////////// testTruncatingNewBornDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._truncate(cn); assertEqual(ArangoCollection.STATUS_LOADED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate loaded (DB) //////////////////////////////////////////////////////////////////////////////// testTruncatingLoadedDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._truncate(cn); assertEqual(ArangoCollection.STATUS_LOADED, c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); }, //////////////////////////////////////////////////////////////////////////////// /// @brief truncate unloaded (DB) //////////////////////////////////////////////////////////////////////////////// testTruncatingUnloadedDB : function () { var cn = "example"; db._drop(cn); var c1 = db._create(cn); c1.save({ a : 1 }); c1.unload(); assertTypeOf("string", c1._id); assertEqual(cn, c1.name()); assertTypeOf("number", c1.status()); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertTypeOf("number", c1.type()); db._truncate(cn); assertEqual(ArangoCollection.TYPE_DOCUMENT, c1.type()); assertEqual(0, c1.count()); db._drop(cn); } }; } //////////////////////////////////////////////////////////////////////////////// /// @brief executes the test suites //////////////////////////////////////////////////////////////////////////////// jsunity.run(CollectionSuiteErrorHandling); jsunity.run(CollectionSuite); jsunity.run(CollectionDbSuite); return jsunity.done();