X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=test%2Flib%2Fmystery-box.js;h=510362bd06c8ab3a7884909e41404e0350d40494;hb=HEAD;hp=dd54a88dae9bfbd67cf0cec3f168e4c78e6bbb81;hpb=2ef5f9c74d92c8eb8cc0bd03fecc9d1a1d306489;p=squeep-mystery-box diff --git a/test/lib/mystery-box.js b/test/lib/mystery-box.js index dd54a88..c0b5d9a 100644 --- a/test/lib/mystery-box.js +++ b/test/lib/mystery-box.js @@ -1,11 +1,10 @@ -/* eslint-env mocha */ -/* eslint-disable capitalized-comments */ 'use strict'; -const assert = require('assert'); -const sinon = require('sinon'); // eslint-disable-line node/no-unpublished-require +const assert = require('node:assert'); +const sinon = require('sinon'); const MysteryBox = require('../../lib/mystery-box'); -const crypto = require('crypto'); +const { MysteryBoxError } = require('../../lib/errors'); +const crypto = require('node:crypto'); function _verbose(mb) { if (process.env.VERBOSE_TESTS) { @@ -53,18 +52,35 @@ describe('MysteryBox', function () { it('covers bad flags', function () { options.defaultFlags = 300; - assert.rejects(() => new MysteryBox(options), RangeError); + assert.rejects(() => new MysteryBox(options), MysteryBoxError); }); it('covers missing ciphers', function () { sinon.stub(crypto, 'getCiphers').returns(['rot13']); - assert.rejects(() => new MysteryBox(options)); + assert.rejects(() => new MysteryBox(options), MysteryBoxError); }); }); // constructor + describe('_ensureArray', function () { + it('returns empty array for no data', function () { + const result = MysteryBox._ensureArray(); + assert.deepStrictEqual(result, []); + }); + it('returns same array passed in', function () { + const expected = [1, 2, 3, 'foo']; + const result = MysteryBox._ensureArray(expected); + assert.deepStrictEqual(result, expected); + }); + it('returns array containing non-array data', function () { + const data = 'bar'; + const result = MysteryBox._ensureArray(data); + assert.deepStrictEqual(result, [data]); + }); + }); // _ensureArray + describe('_keyFromSecret', function () { it('covers invalid', async function () { - assert.rejects(() => MysteryBox._keyFromSecret('unknown deriver', 'secret', 'salt', 32), RangeError); + assert.rejects(() => MysteryBox._keyFromSecret('unknown deriver', 'secret', 'salt', 32), MysteryBoxError); }); }); // _keyFromSecret @@ -123,7 +139,7 @@ describe('MysteryBox', function () { _check(0xfe, 8, 0x00); }); it('covers unsupported', function () { - assert.throws(() => MysteryBox._versionHeaderDecode(0xff), RangeError); + assert.throws(() => MysteryBox._versionHeaderDecode(0xff), MysteryBoxError); }); }); // _versionHeaderDecode @@ -172,7 +188,7 @@ describe('MysteryBox', function () { }); it('covers too big', function () { const buffer = Buffer.from([0xfc, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]); - assert.throws(() => MysteryBox._versionDecode(buffer), RangeError); + assert.throws(() => MysteryBox._versionDecode(buffer), MysteryBoxError); }); }); // _versionDecode @@ -213,22 +229,24 @@ describe('MysteryBox', function () { _checkEncodeRange(268435445, 268435455, 4, 0xe0); }); it('covers quintuple-byte-packable versions', function () { - _checkEncodeRange(268435456, 268435465, 5, 0xf0) + _checkEncodeRange(268435456, 268435465, 5, 0xf0); /* ... */ - _checkEncodeRange(4294967294, 4294967296, 5, 0xf0) + _checkEncodeRange(4294967294, 4294967296, 5, 0xf0); /* ... */ - _checkEncodeRange(34359738360, 34359738367, 5, 0xf0) + _checkEncodeRange(34359738360, 34359738367, 5, 0xf0); }); it('covers sextuple-byte-packable versions', function () { - _checkEncodeRange(34359738368, 34359738377, 6, 0xf8) + _checkEncodeRange(34359738368, 34359738377, 6, 0xf8); /* ... */ - _checkEncodeRange(4398046511093, 4398046511103, 6, 0xf8) + _checkEncodeRange(4398046511093, 4398046511103, 6, 0xf8); }); it('covers too large', function () { const version = 277076930199552; - assert.rejects(() => MysteryBox._versionEncode(version), RangeError); + assert.rejects(() => MysteryBox._versionEncode(version), MysteryBoxError); }); + /* eslint-disable array-element-newline */ it('recipricates', function () { + // eslint-disable array-element-newline [ 0, 127, 128, 16383, @@ -239,6 +257,7 @@ describe('MysteryBox', function () { ].forEach((v) => _cheeckReciprical(v)); }); }); // _versionEncode + /* eslint-enable array-element-newline */ describe('pack, unpack', function () { beforeEach(function () { @@ -247,14 +266,14 @@ describe('MysteryBox', function () { }); it('covers packing unsupported version', async function () { - assert.rejects(() => mb.pack({}, 0), RangeError); + assert.rejects(() => mb.pack({}, 0), MysteryBoxError); }); it('covers unpacking unsupported version', async function () { const badBuffer = Buffer.alloc(128); badBuffer.writeUInt8(0, 0); // No such thing as version 0 const badPayload = badBuffer.toString('base64url'); - assert.rejects(() => mb.unpack(badPayload), RangeError); + assert.rejects(() => mb.unpack(badPayload), MysteryBoxError); }); it('encrypts and decrypts default version', async function () { @@ -317,7 +336,9 @@ describe('MysteryBox', function () { }); it('encrypts and decrypts all available versions no compression', async function () { - Object.keys(mb.versionParameters).map((v) => Number(v)).forEach(async (version) => { + this.slow(Object.keys(mb.versionParameters).length * 200); + const availableVersions = Object.keys(mb.versionParameters).map((v) => Number(v)); + for await (const version of availableVersions) { object = { foo: 'bar', baz: 'quux', @@ -326,11 +347,13 @@ describe('MysteryBox', function () { const encryptedResult = await mb.pack(object, version, 0x00); const decryptedResult = await mb.unpack(encryptedResult); assert.deepStrictEqual(decryptedResult, object, `${version} results not symmetric`); - }); + } }); it('encrypts and decrypts all available versions +brotli', async function () { - Object.keys(mb.versionParameters).map((v) => Number(v)).forEach(async (version) => { + this.slow(Object.keys(mb.versionParameters).length * 200); + const availableVersions = Object.keys(mb.versionParameters).map((v) => Number(v)); + for await (const version of availableVersions) { object = { foo: 'bar', baz: 'quux', @@ -339,11 +362,13 @@ describe('MysteryBox', function () { const encryptedResult = await mb.pack(object, version, mb.Flags.Brotli); const decryptedResult = await mb.unpack(encryptedResult); assert.deepStrictEqual(decryptedResult, object, `${version} results not symmetric`); - }); + }; }); it('encrypts and decrypts all available versions +flate', async function () { - Object.keys(mb.versionParameters).map((v) => Number(v)).forEach(async (version) => { + this.slow(Object.keys(mb.versionParameters).length * 200); + const availableVersions = Object.keys(mb.versionParameters).map((v) => Number(v)); + for await (const version of availableVersions) { object = { foo: 'bar', baz: 'quux', @@ -352,7 +377,7 @@ describe('MysteryBox', function () { const encryptedResult = await mb.pack(object, version, mb.Flags.Flate); const decryptedResult = await mb.unpack(encryptedResult); assert.deepStrictEqual(decryptedResult, object, `${version} results not symmetric`); - }); + }; }); it('handles large object +brotli', async function () { @@ -361,7 +386,7 @@ describe('MysteryBox', function () { const firstChar = 32, lastChar = 126; const rnd = () => { return Math.floor(firstChar + (lastChar - firstChar + 1) * Math.random()); - } + }; object = { longProperty: 'x'.repeat(384 * 1024).split('').map(() => String.fromCharCode(rnd())).join(''), }; @@ -376,7 +401,7 @@ describe('MysteryBox', function () { const firstChar = 32, lastChar = 126; const rnd = () => { return Math.floor(firstChar + (lastChar - firstChar + 1) * Math.random()); - } + }; object = { longProperty: 'x'.repeat(384 * 1024).split('').map(() => String.fromCharCode(rnd())).join(''), }; @@ -386,19 +411,19 @@ describe('MysteryBox', function () { }); it('handles undefined', async function () { - assert.rejects(() => mb.unpack(), RangeError); + assert.rejects(() => mb.unpack(), MysteryBoxError); }); it('handles incomplete', async function () { this.slow(500); const encryptedResult = await mb.pack({ foo: 'bar' }); - assert.rejects(() => mb.unpack(encryptedResult.slice(0, 6)), RangeError); + assert.rejects(() => mb.unpack(encryptedResult.slice(0, 6)), MysteryBoxError); }); it('covers internal error, incorrect version byte size, pack', async function () { this.slow(500); const version = 1; - sinon.stub(mb.versionParameters[version], 'versionBytes').value(10); + sinon.stub(mb.versionParameters[version], 'versionBytes').value(10); // eslint-disable-line security/detect-object-injection assert.rejects(() => mb.pack({}, version), Error); }); @@ -406,7 +431,7 @@ describe('MysteryBox', function () { this.slow(500); const version = 1; const encryptedResult = await mb.pack({}, version); - sinon.stub(mb.versionParameters[version], 'versionBytes').value(10); + sinon.stub(mb.versionParameters[version], 'versionBytes').value(10); // eslint-disable-line security/detect-object-injection assert.rejects(() => mb.unpack(encryptedResult), Error); });