Skip to content
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.

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

update test messages for assert.strictEqual #15995

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
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
20 changes: 10 additions & 10 deletions test/parallel/test-crypto-cipher-decipher.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function testCipher1(key) {
let txt = decipher.update(ciph, 'hex', 'utf8');
txt += decipher.final('utf8');

assert.strictEqual(txt, plaintext, 'encryption and decryption');
assert.strictEqual(txt, plaintext, `${txt} is encrypted, ${plaintext} is unencrypted`);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally would prefer to just remove the error message overall instead of using the individual ones in all these cases. The reason is that it could theoretically be a different case than the description value (the test should pass and we do not know the real reason why the test would not pass).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @BridgeAR. I think it's better to just remove the custom messages (third argument) here and use the default one.


// streaming cipher interface
// NB: In real life, it's not guaranteed that you can get all of it
Expand All @@ -39,7 +39,7 @@ function testCipher1(key) {
dStream.end(ciph);
txt = dStream.read().toString('utf8');

assert.strictEqual(txt, plaintext, 'encryption and decryption with streams');
assert.strictEqual(txt, plaintext, `${txt} is the deciphered stream of ${ciph}`);
}


Expand All @@ -61,7 +61,7 @@ function testCipher2(key) {
let txt = decipher.update(ciph, 'base64', 'utf8');
txt += decipher.final('utf8');

assert.strictEqual(txt, plaintext, 'encryption and decryption with Base64');
assert.strictEqual(txt, plaintext, `${txt} is the decryption with Base64, ${plaintext} is the encryption`);
}

testCipher1('MySecretKey123');
Expand All @@ -74,7 +74,7 @@ testCipher2(Buffer.from('0123456789abcdef'));
{
const c = crypto.createCipher('aes-256-cbc', 'secret');
const s = c.update('test', 'utf8', 'base64') + c.final('base64');
assert.strictEqual(s, '375oxUQCIocvxmC5At+rvA==');
assert.strictEqual(s, '375oxUQCIocvxmC5At+rvA==', `${s} is updated to be base64 instead utf8`);
}

// Calling Cipher.final() or Decipher.final() twice should error but
Expand Down Expand Up @@ -125,17 +125,17 @@ testCipher2(Buffer.from('0123456789abcdef'));
let txt;
assert.doesNotThrow(() => txt = decipher.update(ciph, 'base64', 'ucs2'));
assert.doesNotThrow(() => txt += decipher.final('ucs2'));
assert.strictEqual(txt, plaintext, 'decrypted result in ucs2');
assert.strictEqual(txt, plaintext, `${plaintext} has decrypted ${txt} in ucs2`);

decipher = crypto.createDecipher('aes192', key);
assert.doesNotThrow(() => txt = decipher.update(ciph, 'base64', 'ucs-2'));
assert.doesNotThrow(() => txt += decipher.final('ucs-2'));
assert.strictEqual(txt, plaintext, 'decrypted result in ucs-2');
assert.strictEqual(txt, plaintext, `${plaintext} has decrypted ${txt} in ucs-2`);

decipher = crypto.createDecipher('aes192', key);
assert.doesNotThrow(() => txt = decipher.update(ciph, 'base64', 'utf-16le'));
assert.doesNotThrow(() => txt += decipher.final('utf-16le'));
assert.strictEqual(txt, plaintext, 'decrypted result in utf-16le');
assert.strictEqual(txt, plaintext, `${plaintext} decrypted ${txt} in utf-16le`);
}

// setAutoPadding/setAuthTag/setAAD should return `this`
Expand All @@ -144,9 +144,9 @@ testCipher2(Buffer.from('0123456789abcdef'));
const tagbuf = Buffer.from('tagbuf');
const aadbuf = Buffer.from('aadbuf');
const decipher = crypto.createDecipher('aes-256-gcm', key);
assert.strictEqual(decipher.setAutoPadding(), decipher);
assert.strictEqual(decipher.setAuthTag(tagbuf), decipher);
assert.strictEqual(decipher.setAAD(aadbuf), decipher);
assert.strictEqual(decipher.setAutoPadding(), decipher, `${decipher} will be set to the appropriate block size with autopadding`);
assert.strictEqual(decipher.setAuthTag(tagbuf), decipher, `${tagbuf} is the a authenticated tag of ${decipher}`);
assert.strictEqual(decipher.setAAD(aadbuf), decipher, `${decipher} has set the additional authenticated data param for ${aadbuf}`);
}

// error throwing in setAAD/setAuthTag/getAuthTag/setAutoPadding
Expand Down