jonny
/
Signal-Desktop
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Prohibit Chai `expect` or `should`; prefer `assert`

This commit is contained in:
Evan Hahn 2022-01-19 13:19:08 -06:00 committed by GitHub
parent 885b4d4d2e
commit c1e3e87b99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 57 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.eslintrc.js
View File

@ -1,4 +1,4 @@
// Copyright 2018-2021 Signal Messenger, LLC
// Copyright 2018-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
// For reference: https://github.com/airbnb/javascript
@ -128,6 +128,12 @@ const typescriptRules = {
message: 'Please use createBrowserWindow',
allowTypeImports: true,
},
{
name: 'chai',
importNames: ['expect', 'should', 'Should'],
message: 'Please use assert',
allowTypeImports: true,
},
],
},
],

8
ts/test-both/util/assert_test.ts
View File

@ -1,7 +1,7 @@
// Copyright 2021 Signal Messenger, LLC
// Copyright 2021-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
import * as chai from 'chai';
import { assert as chaiAssert } from 'chai';
import { assert, strictAssert } from '../../util/assert';
@ -12,7 +12,7 @@ describe('assert utilities', () => {
});
it("throws if the assertion fails, because we're in a test environment", () => {
chai.assert.throws(() => {
chaiAssert.throws(() => {
assert(false, 'foo bar');
}, 'foo bar');
});
@ -24,7 +24,7 @@ describe('assert utilities', () => {
});
it('throws if the assertion fails', () => {
chai.assert.throws(() => {
chaiAssert.throws(() => {
strictAssert(false, 'foo bar');
}, 'foo bar');
});

17
ts/test-node/.eslintrc.js
View File

@ -1,8 +1,21 @@
// Copyright 2021 Signal Messenger, LLC
// Copyright 2021-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
const { update } = require('lodash/fp');
const topLevelEslintrc = require('../../.eslintrc');
const typescriptRules = topLevelEslintrc.overrides.find(override =>
override.files.some(glob => glob.endsWith('.ts'))
).rules;
const noRestrictedImportsRule =
typescriptRules['@typescript-eslint/no-restricted-imports'];
module.exports = {
rules: {
'@typescript-eslint/no-restricted-imports': 'off',
'@typescript-eslint/no-restricted-imports': update(
[1, 'paths'],
(paths = []) => paths.filter(path => path.name !== 'electron'),
noRestrictedImportsRule
),
},
};

51
ts/test-node/logging_test.ts
View File

@ -1,4 +1,4 @@
// Copyright 2018-2021 Signal Messenger, LLC
// Copyright 2018-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
// NOTE: Temporarily allow `then` until we convert the entire file to `async` / `await`:
@ -8,7 +8,7 @@ import * as fs from 'fs';
import * as fse from 'fs-extra';
import * as os from 'os';
import * as path from 'path';
import { expect } from 'chai';
import { assert } from 'chai';
import {
eliminateOutOfDateFiles,
@ -49,34 +49,34 @@ describe('logging', () => {
describe('#isLineAfterDate', () => {
it('returns false if falsy', () => {
const actual = isLineAfterDate('', new Date());
expect(actual).to.equal(false);
assert.isFalse(actual);
});
it('returns false if invalid JSON', () => {
const actual = isLineAfterDate('{{}', new Date());
expect(actual).to.equal(false);
assert.isFalse(actual);
});
it('returns false if date is invalid', () => {
const line = JSON.stringify({ time: '2018-01-04T19:17:05.014Z' });
const actual = isLineAfterDate(line, new Date('try6'));
expect(actual).to.equal(false);
assert.isFalse(actual);
});
it('returns false if log time is invalid', () => {
const line = JSON.stringify({ time: 'try7' });
const date = new Date('2018-01-04T19:17:00.000Z');
const actual = isLineAfterDate(line, date);
expect(actual).to.equal(false);
assert.isFalse(actual);
});
it('returns false if date before provided date', () => {
const line = JSON.stringify({ time: '2018-01-04T19:17:00.000Z' });
const date = new Date('2018-01-04T19:17:05.014Z');
const actual = isLineAfterDate(line, date);
expect(actual).to.equal(false);
assert.isFalse(actual);
});
it('returns true if date is after provided date', () => {
const line = JSON.stringify({ time: '2018-01-04T19:17:05.014Z' });
const date = new Date('2018-01-04T19:17:00.000Z');
const actual = isLineAfterDate(line, date);
expect(actual).to.equal(true);
assert.isTrue(actual);
});
});
@ -88,7 +88,7 @@ describe('logging', () => {
fs.writeFileSync(target, log);
return eliminateOutOfDateFiles(tmpDir, date).then(() => {
expect(fs.existsSync(target)).to.equal(false);
assert.isFalse(fs.existsSync(target));
});
});
it('deletes a file with invalid JSON lines', () => {
@ -98,7 +98,7 @@ describe('logging', () => {
fs.writeFileSync(target, log);
return eliminateOutOfDateFiles(tmpDir, date).then(() => {
expect(fs.existsSync(target)).to.equal(false);
assert.isFalse(fs.existsSync(target));
});
});
it('deletes a file with all dates before provided date', () => {
@ -113,7 +113,7 @@ describe('logging', () => {
fs.writeFileSync(target, contents);
return eliminateOutOfDateFiles(tmpDir, date).then(() => {
expect(fs.existsSync(target)).to.equal(false);
assert.isFalse(fs.existsSync(target));
});
});
it('keeps a file with first line date before provided date', () => {
@ -128,7 +128,7 @@ describe('logging', () => {
fs.writeFileSync(target, contents);
return eliminateOutOfDateFiles(tmpDir, date).then(() => {
expect(fs.existsSync(target)).to.equal(true);
assert.isTrue(fs.existsSync(target));
});
});
it('keeps a file with last line date before provided date', () => {
@ -143,7 +143,7 @@ describe('logging', () => {
fs.writeFileSync(target, contents);
return eliminateOutOfDateFiles(tmpDir, date).then(() => {
expect(fs.existsSync(target)).to.equal(true);
assert.isTrue(fs.existsSync(target));
});
});
});
@ -179,7 +179,7 @@ describe('logging', () => {
.map(line => line.trim())
.filter(Boolean)
.map(line => JSON.parse(line));
expect(actualEntries).to.deep.equal(expected);
assert.deepStrictEqual(actualEntries, expected);
});
});
it('preserves all lines if before target date', () => {
@ -203,7 +203,8 @@ describe('logging', () => {
return eliminateOldEntries(files, date).then(() => {
// There should only be 1 line, so we can parse it safely.
expect(JSON.parse(fs.readFileSync(target, 'utf8'))).to.deep.equal(
assert.deepStrictEqual(
JSON.parse(fs.readFileSync(target, 'utf8')),
expected
);
});
@ -218,9 +219,7 @@ describe('logging', () => {
throw new Error('Expected an error!');
},
error => {
expect(error)
.to.have.property('message')
.that.match(/random_file/);
assert.match(error.message, /random_file/);
}
);
});
@ -231,7 +230,7 @@ describe('logging', () => {
fs.writeFileSync(target, contents);
return fetchLog(target).then(result => {
expect(result).to.deep.equal([]);
assert.isEmpty(result);
});
});
it('returns just three fields in each returned line', () => {
@ -270,7 +269,7 @@ describe('logging', () => {
fs.writeFileSync(target, contents);
return fetchLog(target).then(result => {
expect(result).to.deep.equal(expected);
assert.deepStrictEqual(result, expected);
});
});
});
@ -278,8 +277,8 @@ describe('logging', () => {
describe('#fetchLogs', () => {
it('returns single entry if no files', () => {
return fetchLogs(tmpDir).then(results => {
expect(results).to.have.length(1);
expect(results[0].msg).to.match(/Loaded this list/);
assert.lengthOf(results, 1);
assert.match(results[0]?.msg || '', /Loaded this list/);
});
});
it('returns sorted entries from all files', () => {
@ -297,10 +296,10 @@ describe('logging', () => {
fs.writeFileSync(path.join(tmpDir, 'second.log'), second);
return fetchLogs(tmpDir).then(results => {
expect(results).to.have.length(4);
expect(results[0].msg).to.equal('1');
expect(results[1].msg).to.equal('2');
expect(results[2].msg).to.equal('3');
assert.lengthOf(results, 4);
assert.strictEqual(results[0]?.msg, '1');
assert.strictEqual(results[1]?.msg, '2');
assert.strictEqual(results[2]?.msg, '3');
});
});
});

10
ts/test-node/util/getTextWithMentions_test.ts
View File

@ -1,7 +1,7 @@
// Copyright 2020 Signal Messenger, LLC
// Copyright 2020-2022 Signal Messenger, LLC
// SPDX-License-Identifier: AGPL-3.0-only
import { expect } from 'chai';
import { assert } from 'chai';
import { getTextWithMentions } from '../../util/getTextWithMentions';
describe('getTextWithMentions', () => {
@ -16,7 +16,8 @@ describe('getTextWithMentions', () => {
},
];
const text = "Hey \uFFFC, I'm here";
expect(getTextWithMentions(bodyRanges, text)).to.eql(
assert.strictEqual(
getTextWithMentions(bodyRanges, text),
"Hey @fred, I'm here"
);
});
@ -37,7 +38,8 @@ describe('getTextWithMentions', () => {
},
];
const text = "\uFFFC says \uFFFC, I'm here";
expect(getTextWithMentions(bodyRanges, text)).to.eql(
assert.strictEqual(
getTextWithMentions(bodyRanges, text),
"@jerry says @fred, I'm here"
);
});