1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
// This file contains test helpers to manage and validate collection state. This is useful for
// round trip testing of entire collections.
//
// There are three stages represented in this file:
// 1. Data generation - CollectionDataGenerator class. This contains helpers to generate test data
// for a collection.
// 2. Data persistence - createCollectionWithData function. This class takes a
// CollectionDataGenerator and inserts the generated data into the given
// collection.
// 3. Data validation - CollectionDataValidator class. This class contains functions for saving
// the state of a collection and comparing a collection's state to the
// previously saved state.
//
// Common use case:
// 1. Create a CollectionDataGenerator
// 2. Save collection data using the createCollectionWithData function
// 3. Record collection state in an instance of the CollectionDataValidator class
// 4. Do round trip or other testing
// 5. Validate that collection has not changed using the CollectionDataValidator class
load('./jstests/multiVersion/libs/data_generators.js');
// Function to actually add the data generated by the given dataGenerator to a collection
createCollectionWithData = function(db, collectionName, dataGenerator) {
// Drop collection if exists
// TODO: add ability to control this
db.getCollection(collectionName).drop();
print("db.createCollection(\"" + collectionName + "\", " +
JSON.stringify(dataGenerator.collectionMetadata.get()) + ");");
assert.eq(db.createCollection(collectionName, dataGenerator.collectionMetadata.get()).ok, 1);
var collection = db.getCollection(collectionName);
var numIndexes = 0;
while (dataGenerator.indexes.hasNext()) {
var nextIndex = dataGenerator.indexes.next();
print("collection.ensureIndex(" + JSON.stringify(nextIndex.spec) + ", " +
JSON.stringify(nextIndex.options) + ");");
var ensureIndexResult = collection.ensureIndex(nextIndex.spec, nextIndex.options);
// XXX: Is this the real way to check for errors?
assert(ensureIndexResult === undefined, tojson(ensureIndexResult));
numIndexes++;
}
// Make sure we actually added all the indexes we think we added. +1 for the _id index.
assert.eq(collection.getIndexes().length, numIndexes + 1);
var numInserted = 0;
while (dataGenerator.data.hasNext()) {
var nextDoc = dataGenerator.data.next();
// Use _id as our ordering field just so we don't have to deal with sorting. This only
// matters here since we can use indexes
nextDoc._id = numInserted;
print("collection.insert(" + JSON.stringify(nextDoc) + ");");
var insertResult = collection.insert(nextDoc);
assert(db.getLastError() == null);
numInserted++;
}
assert.eq(collection.find().count(), numInserted, "counts not equal after inserts");
return db.getCollection(collectionName);
};
// Class to save the state of a collection and later compare the current state of a collection to
// the saved state
function CollectionDataValidator() {
var _initialized = false;
var _collectionInfo = {};
var _indexData = [];
var _collectionData = [];
// Returns the options of the specified collection.
this.getCollectionInfo = function(collection) {
var infoObj = collection.getDB().getCollectionInfos({name: collection.getName()});
assert.eq(1, infoObj.length, "expected collection '" + collection.getName() + "'to exist");
return infoObj[0];
};
// Saves the current state of the collection passed in
this.recordCollectionData = function(collection) {
// Save the metadata for this collection for later comparison.
_collectionInfo = this.getCollectionInfo(collection);
// Save the indexes for this collection for later comparison
_indexData = collection.getIndexes().sort(function(a, b) {
if (a.name > b.name)
return 1;
else
return -1;
});
// Save the data for this collection for later comparison
_collectionData = collection.find().sort({"_id": 1}).toArray();
_initialized = true;
return collection;
};
this.validateCollectionData = function(collection) {
if (!_initialized) {
throw Error("validateCollectionWithAllData called, but data is not initialized");
}
// Get the metadata for this collection
var newCollectionInfo = this.getCollectionInfo(collection);
assert.docEq(_collectionInfo, newCollectionInfo, "collection metadata not equal");
// Get the indexes for this collection
var newIndexData = collection.getIndexes().sort(function(a, b) {
if (a.name > b.name)
return 1;
else
return -1;
});
for (var i = 0; i < newIndexData.length; i++) {
assert.docEq(_indexData[i], newIndexData[i], "indexes not equal");
}
// Save the data for this collection for later comparison
var newCollectionData = collection.find().sort({"_id": 1}).toArray();
for (var i = 0; i < newCollectionData.length; i++) {
assert.docEq(_collectionData[i], newCollectionData[i], "data not equal");
}
return true;
};
}
// Tests of the functions and classes in this file
function collectionDataValidatorTests() {
// TODO: These tests are hackish and depend on implementation details, but they are good enough
// for now to convince us that the CollectionDataValidator is actually checking something
var myValidator;
var myGenerator;
var collection;
myGenerator = new CollectionDataGenerator({"capped": true});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
db.test.dropIndex(db.test.getIndexKeys().filter(function(key) {
return key.a != null;
})[0]);
assert.throws(myValidator.validateCollectionData,
[collection],
"Validation function should have thrown since we modified the collection");
myGenerator = new CollectionDataGenerator({"capped": true});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
db.test.update({_id: 0}, {dummy: 1});
assert.throws(myValidator.validateCollectionData,
[collection],
"Validation function should have thrown since we modified the collection");
myGenerator = new CollectionDataGenerator({"capped": true});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
assert(myValidator.validateCollectionData(collection), "Validation function failed");
myGenerator = new CollectionDataGenerator({"capped": false});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
db.test.dropIndex(db.test.getIndexKeys().filter(function(key) {
return key.a != null;
})[0]);
assert.throws(myValidator.validateCollectionData,
[collection],
"Validation function should have thrown since we modified the collection");
myGenerator = new CollectionDataGenerator({"capped": false});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
db.test.update({_id: 0}, {dummy: 1});
assert.throws(myValidator.validateCollectionData,
[collection],
"Validation function should have thrown since we modified the collection");
myGenerator = new CollectionDataGenerator({"capped": false});
collection = createCollectionWithData(db, "test", myGenerator);
myValidator = new CollectionDataValidator();
myValidator.recordCollectionData(collection);
assert(myValidator.validateCollectionData(collection), "Validation function failed");
print("collection data validator tests passed!");
}
|
