Skip to content

test(NODE-5327): fix handling of embedded nulls in spec runner matcher #3728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 20, 2023
Merged

test(NODE-5327): fix handling of embedded nulls in spec runner matcher #3728

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4b629c0
test(NODE-5327): debug test runner
durran Jun 15, 2023
ed97785
test: bring back null values
durran Jun 16, 2023
647ae9d
debug: check diff
durran Jun 16, 2023
5641761
test: remove null hack
durran Jun 16, 2023
51eecd3
test: bring back passing test
durran Jun 16, 2023
608bdfd
chore: remove debug and comment
durran Jun 16, 2023
bff9af5
test: update read write concern tests
durran Jun 16, 2023
c2c165f
fix: error message
durran Jun 16, 2023
742199b
Revert "test: update read write concern tests"
durran Jun 19, 2023
2e0cc3d
test: match on root
durran Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 15 additions & 10 deletions test/tools/spec-runner/matcher.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function is42(input) {
return valIs42(input) || valIs42(input.$numberInt) || valIs42(input.$numberLong);
}

function generateMatchAndDiffSpecialCase(key, expectedObj, actualObj, metadata) {
function generateMatchAndDiffSpecialCase(key, expectedObj, actualObj, metadata, isRoot) {
const expected = expectedObj[key];
const actual = actualObj[key];

Expand All @@ -44,11 +44,16 @@ function generateMatchAndDiffSpecialCase(key, expectedObj, actualObj, metadata)
};
}

const match = !Object.prototype.hasOwnProperty.call(actualObj, key);
// An expected null value is not the same as the value not being present
// so an exact match is forced here when not at the root level of the
// object.
const match = isRoot
? !Object.prototype.hasOwnProperty.call(actualObj, key)
: expected === actual;
return {
match,
expected: SYMBOL_DOES_NOT_EXIST,
actual: match ? SYMBOL_DOES_NOT_EXIST : actual
expected: expected,
actual: actual === undefined ? SYMBOL_DOES_NOT_EXIST : actual
};
}

Expand Down Expand Up @@ -88,7 +93,7 @@ function generateMatchAndDiffSpecialCase(key, expectedObj, actualObj, metadata)
// Case lsid - assert that session matches session in session data
const sessionData = metadata.sessionData;
const lsid = sessionData[expected];
return generateMatchAndDiff(lsid, actual, metadata);
return generateMatchAndDiff(lsid, actual, metadata, false);
} else if (key === 'getMore' && expectedIs42) {
// cursorid - explicitly ignore 42 values
return {
Expand Down Expand Up @@ -121,11 +126,11 @@ function generateMatchAndDiffSpecialCase(key, expectedObj, actualObj, metadata)
};
} else {
// default
return generateMatchAndDiff(expected, actual, metadata);
return generateMatchAndDiff(expected, actual, metadata, false);
}
}

function generateMatchAndDiff(expected, actual, metadata) {
function generateMatchAndDiff(expected, actual, metadata, isRoot) {
const typeOfExpected = typeof expected;

if (typeOfExpected === 'object' && expected._bsontype === 'Int32' && typeof actual === 'number') {
Expand Down Expand Up @@ -154,7 +159,7 @@ function generateMatchAndDiff(expected, actual, metadata) {
}

return expected
.map((val, idx) => generateMatchAndDiff(val, actual[idx], metadata))
.map((val, idx) => generateMatchAndDiff(val, actual[idx], metadata, false))
.reduce(
(ret, value) => {
ret.match = ret.match && value.match;
Expand All @@ -168,7 +173,7 @@ function generateMatchAndDiff(expected, actual, metadata) {

return Object.keys(expected).reduce(
(ret, key) => {
const check = generateMatchAndDiffSpecialCase(key, expected, actual, metadata);
const check = generateMatchAndDiffSpecialCase(key, expected, actual, metadata, isRoot);
ret.match = ret.match && check.match;
ret.expected[key] = check.expected;
ret.actual[key] = check.actual;
Expand All @@ -192,7 +197,7 @@ function matchMongoSpec(chai, utils) {

const sessionData = utils.flag(this, 'testRunnerSessionData');

const result = generateMatchAndDiff(expected, actual, { sessionData });
const result = generateMatchAndDiff(expected, actual, { sessionData }, true);

chai.Assertion.prototype.assert.call(
this,
Expand Down