From 166f2252f7236c602379bf348082156bbd6d05fb Mon Sep 17 00:00:00 2001 From: Lam Wei Li Date: Tue, 25 Jan 2022 16:12:40 +0800 Subject: [PATCH 1/2] refactor(test): replaced `tap.tearDown()` (deprecated) to `tap.teardown()` (backward-compatible) in preparation for tap v15 https://github.com/tapjs/node-tap/pull/649/files --- test/tap/configuration-validation-test.js | 2 +- test/tap/dateFileAppender-test.js | 8 ++++---- test/tap/file-descriptor-leak-test.js | 2 +- test/tap/file-sighup-test.js | 4 ++-- test/tap/fileAppender-test.js | 14 +++++++------- test/tap/fileSyncAppender-test.js | 12 ++++++------ test/tap/logLevelFilter-test.js | 2 +- test/tap/multi-file-appender-test.js | 14 +++++++------- test/tap/pause-test.js | 6 +++--- 9 files changed, 32 insertions(+), 32 deletions(-) diff --git a/test/tap/configuration-validation-test.js b/test/tap/configuration-validation-test.js index 5350eac..e977c6d 100644 --- a/test/tap/configuration-validation-test.js +++ b/test/tap/configuration-validation-test.js @@ -256,7 +256,7 @@ test("log4js configuration validation", batch => { batch.test("should not throw error if configure object is freezed", t => { const testFile = "test/tap/freeze-date-file-test"; - t.tearDown(() => { + t.teardown(() => { removeFiles(testFile); }); t.doesNotThrow(() => diff --git a/test/tap/dateFileAppender-test.js b/test/tap/dateFileAppender-test.js index 3964991..8baa968 100644 --- a/test/tap/dateFileAppender-test.js +++ b/test/tap/dateFileAppender-test.js @@ -25,7 +25,7 @@ test("../../lib/appenders/dateFile", batch => { const logger = log4js.getLogger("default-settings"); logger.info("This should be in the file."); - t.tearDown(() => { + t.teardown(() => { removeFile("date-appender-default.log"); }); @@ -72,7 +72,7 @@ test("../../lib/appenders/dateFile", batch => { ); }); - t.tearDown(() => { + t.teardown(() => { removeFile("date-file-test.log"); }); }); @@ -108,7 +108,7 @@ test("../../lib/appenders/dateFile", batch => { const logger = log4js.getLogger("tests"); logger.warn("this should be written to the file with the appended date"); - t.tearDown(() => { + t.teardown(() => { removeFile(testFile); }); @@ -140,7 +140,7 @@ test("../../lib/appenders/dateFile", batch => { logger.info("1"); logger.info("2"); logger.info("3"); - t.tearDown(() => { + t.teardown(() => { removeFile("date-appender-flush.log"); }); diff --git a/test/tap/file-descriptor-leak-test.js b/test/tap/file-descriptor-leak-test.js index 55a04b3..7436a8e 100644 --- a/test/tap/file-descriptor-leak-test.js +++ b/test/tap/file-descriptor-leak-test.js @@ -67,7 +67,7 @@ if (process.platform !== "win32") { }, 250); }); - batch.tearDown(async () => { + batch.teardown(async () => { log4js.shutdown(); const filenames = Object.values(config.appenders).map(appender => appender.filename); diff --git a/test/tap/file-sighup-test.js b/test/tap/file-sighup-test.js index c9682d9..cf059b2 100644 --- a/test/tap/file-sighup-test.js +++ b/test/tap/file-sighup-test.js @@ -38,7 +38,7 @@ test("file appender single SIGHUP handler", t => { const log4js = require("../../lib/log4js"); log4js.configure(config); - t.tearDown(async () => { + t.teardown(async () => { log4js.shutdown(); const filenames = Object.values(config.appenders).map(appender => appender.filename); @@ -120,7 +120,7 @@ test("file appender SIGHUP handler leak", t => { }, categories: { default: { appenders: ["file"], level: "info" } } }); - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("test.log"); }); t.plan(2); diff --git a/test/tap/fileAppender-test.js b/test/tap/fileAppender-test.js index 44d48b2..02eaca6 100644 --- a/test/tap/fileAppender-test.js +++ b/test/tap/fileAppender-test.js @@ -24,7 +24,7 @@ test("log4js fileAppender", batch => { const logger = log4js.getLogger("default-settings"); await removeFile(testFile); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await removeFile(testFile); }); @@ -50,7 +50,7 @@ test("log4js fileAppender", batch => { const testFile = path.join(__dirname, "fa-default-test.log"); await removeFile(testFile); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await removeFile(testFile); }); @@ -80,7 +80,7 @@ test("log4js fileAppender", batch => { const testFile = path.join(__dirname, "fa-maxFileSize-test.log"); const logger = log4js.getLogger("max-file-size"); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await removeFile(testFile); }); @@ -121,7 +121,7 @@ test("log4js fileAppender", batch => { const testFile = path.join(__dirname, "fa-maxFileSize-unit-test.log"); const logger = log4js.getLogger("max-file-size-unit"); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await Promise.all([removeFile(testFile), removeFile(`${testFile}.1`)]); }); @@ -174,7 +174,7 @@ test("log4js fileAppender", batch => { removeFile(`${testFile}.2`) ]); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await Promise.all([ removeFile(testFile), @@ -234,7 +234,7 @@ test("log4js fileAppender", batch => { removeFile(`${testFile}.2.gz`) ]); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await Promise.all([ removeFile(testFile), @@ -350,7 +350,7 @@ test("log4js fileAppender", batch => { await removeFile(testFilePlain); await removeFile(testFileAsIs); - t.tearDown(async () => { + t.teardown(async () => { await new Promise(resolve => log4js.shutdown(resolve)); await removeFile(testFilePlain); await removeFile(testFileAsIs); diff --git a/test/tap/fileSyncAppender-test.js b/test/tap/fileSyncAppender-test.js index b1c0188..bb068ad 100644 --- a/test/tap/fileSyncAppender-test.js +++ b/test/tap/fileSyncAppender-test.js @@ -18,7 +18,7 @@ test("log4js fileSyncAppender", batch => { const logger = log4js.getLogger("default-settings"); remove(testFile); - t.tearDown(() => { + t.teardown(() => { remove(testFile); }); @@ -44,7 +44,7 @@ test("log4js fileSyncAppender", batch => { const logger = log4js.getLogger("max-file-size"); remove(testFile); - t.tearDown(() => { + t.teardown(() => { remove(testFile); }); @@ -93,7 +93,7 @@ test("log4js fileSyncAppender", batch => { remove(testFile); remove(`${testFile}.1`); - t.tearDown(() => { + t.teardown(() => { remove(testFile); remove(`${testFile}.1`); }); @@ -148,7 +148,7 @@ test("log4js fileSyncAppender", batch => { remove(`${testFile}.1`); remove(`${testFile}.2`); - t.tearDown(() => { + t.teardown(() => { remove(testFile); remove(`${testFile}.1`); remove(`${testFile}.2`); @@ -218,7 +218,7 @@ test("log4js fileSyncAppender", batch => { const testFile = "tmp-sync-tests.log"; remove(testFile); - t.tearDown(() => { + t.teardown(() => { remove(testFile); }); @@ -252,7 +252,7 @@ test("log4js fileSyncAppender", batch => { const testFile = "tmp-options-tests.log"; remove(testFile); - t.tearDown(() => { + t.teardown(() => { remove(testFile); }); diff --git a/test/tap/logLevelFilter-test.js b/test/tap/logLevelFilter-test.js index c079e13..27e31f0 100644 --- a/test/tap/logLevelFilter-test.js +++ b/test/tap/logLevelFilter-test.js @@ -58,7 +58,7 @@ test("log4js logLevelFilter", batch => { remove(`${__dirname}/logLevelFilter-warnings.log`); remove(`${__dirname}/logLevelFilter-debugs.log`); - t.tearDown(() => { + t.teardown(() => { remove(`${__dirname}/logLevelFilter.log`); remove(`${__dirname}/logLevelFilter-warnings.log`); remove(`${__dirname}/logLevelFilter-debugs.log`); diff --git a/test/tap/multi-file-appender-test.js b/test/tap/multi-file-appender-test.js index aa93f7c..14cd42e 100644 --- a/test/tap/multi-file-appender-test.js +++ b/test/tap/multi-file-appender-test.js @@ -15,7 +15,7 @@ test("multiFile appender", batch => { batch.test( "should write to multiple files based on the loggingEvent property", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles(["logs/A.log", "logs/B.log"]); }); log4js.configure({ @@ -44,7 +44,7 @@ test("multiFile appender", batch => { batch.test( "should write to multiple files based on loggingEvent.context properties", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles(["logs/C.log", "logs/D.log"]); }); log4js.configure({ @@ -73,7 +73,7 @@ test("multiFile appender", batch => { ); batch.test("should close file after timeout", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("logs/C.log"); }); /* checking that the file is closed after a timeout is done by looking at the debug logs @@ -120,7 +120,7 @@ test("multiFile appender", batch => { batch.test( "should fail silently if loggingEvent property has no value", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("logs/E.log"); }); log4js.configure({ @@ -152,7 +152,7 @@ test("multiFile appender", batch => { ); batch.test("should pass options to rolling file stream", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles(["logs/F.log", "logs/F.log.1", "logs/F.log.2"]); }); log4js.configure({ @@ -186,7 +186,7 @@ test("multiFile appender", batch => { }); batch.test("should inherit config from category hierarchy", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("logs/test.someTest.log"); }); log4js.configure({ @@ -236,7 +236,7 @@ test("multiFile appender", batch => { }); }); - batch.tearDown(async () => { + batch.teardown(async () => { try { const files = fs.readdirSync("logs"); await removeFiles(files.map(filename => `logs/${filename}`)); diff --git a/test/tap/pause-test.js b/test/tap/pause-test.js index 37d1230..fc8ef6c 100644 --- a/test/tap/pause-test.js +++ b/test/tap/pause-test.js @@ -12,7 +12,7 @@ const removeFiles = async filenames => { tap.test("Drain event test", batch => { batch.test("Should emit pause event and resume when logging in a file with high frequency", t => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("logs/drain.log"); }); // Generate logger with 5k of highWaterMark config @@ -47,7 +47,7 @@ tap.test("Drain event test", batch => { batch.test("Should emit pause event and resume when logging in a date file with high frequency", (t) => { - t.tearDown(async () => { + t.teardown(async () => { await removeFiles("logs/date-file-drain.log"); }); // Generate date file logger with 5kb of highWaterMark config @@ -79,7 +79,7 @@ tap.test("Drain event test", batch => { t.end(); }); - batch.tearDown(async () => { + batch.teardown(async () => { try { const files = fs.readdirSync("logs"); await removeFiles(files.map(filename => `logs/${filename}`)); From 7376c40ad6f4e37f4344d945e78914cfa1259d89 Mon Sep 17 00:00:00 2001 From: Lam Wei Li Date: Tue, 25 Jan 2022 18:16:39 +0800 Subject: [PATCH 2/2] refactor(test): replaced deprecated synonyms (backward-compatible) in preparation for tap v15 https://github.com/tapjs/node-tap/pull/649/files https://github.com/coreyfarrell/node-tap/blob/6d9f5798a9700be6773b6fe8c1339796bdf6928b/lib/synonyms.js --- test/tap/configuration-inheritance-test.js | 34 +++++++++++----------- test/tap/logLevelFilter-test.js | 4 +-- test/tap/logging-test.js | 4 +-- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/test/tap/configuration-inheritance-test.js b/test/tap/configuration-inheritance-test.js index b9753d9..9c2b9a4 100644 --- a/test/tap/configuration-inheritance-test.js +++ b/test/tap/configuration-inheritance-test.js @@ -23,10 +23,10 @@ test("log4js category inherit all appenders from direct parent", batch => { const childLevel = categories.getLevelForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 2, "inherited 2 appenders"); + t.equal(childAppenders.length, 2, "inherited 2 appenders"); t.ok(childAppenders.some(a => a.label === "stdout1"), "inherited stdout1"); t.ok(childAppenders.some(a => a.label === "stdout2"), "inherited stdout2"); - t.isEqual(childLevel.levelStr, "DEBUG", "child level overrides parent"); + t.equal(childLevel.levelStr, "DEBUG", "child level overrides parent"); t.end(); }); @@ -54,12 +54,12 @@ test("log4js category inherit all appenders from direct parent", batch => { ); const child1Level = categories.getLevelForCategory(child1CategoryName); - t.isEqual(child1Appenders.length, 1, "inherited 1 appender"); + t.equal(child1Appenders.length, 1, "inherited 1 appender"); t.ok( child1Appenders.some(a => a.label === "stdout1"), "inherited stdout1" ); - t.isEqual(child1Level.levelStr, "DEBUG", "child level overrides parent"); + t.equal(child1Level.levelStr, "DEBUG", "child level overrides parent"); const child2CategoryName = "catA.catB.cat2"; const child2Appenders = categories.appendersForCategory( @@ -68,7 +68,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const child2Level = categories.getLevelForCategory(child2CategoryName); t.ok(child2Appenders); - t.isEqual( + t.equal( child2Appenders.length, 2, "inherited 1 appenders, plus its original" @@ -78,7 +78,7 @@ test("log4js category inherit all appenders from direct parent", batch => { "inherited stdout1" ); t.ok(child2Appenders.some(a => a.label === "stdout2"), "kept stdout2"); - t.isEqual(child2Level.levelStr, "INFO", "inherited parent level"); + t.equal(child2Level.levelStr, "INFO", "inherited parent level"); t.end(); } @@ -104,7 +104,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 2, "inherited 2 appenders"); + t.equal(childAppenders.length, 2, "inherited 2 appenders"); t.ok(childAppenders.some(a => a.label === "stdout1"), "inherited stdout1"); t.ok(childAppenders.some(a => a.label === "stdout1"), "inherited stdout1"); @@ -114,7 +114,7 @@ test("log4js category inherit all appenders from direct parent", batch => { ); t.ok(firstParentAppenders); - t.isEqual(firstParentAppenders.length, 2, "ended up with 2 appenders"); + t.equal(firstParentAppenders.length, 2, "ended up with 2 appenders"); t.ok( firstParentAppenders.some(a => a.label === "stdout1"), "inherited stdout1" @@ -146,7 +146,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 1, "inherited 1 appenders"); + t.equal(childAppenders.length, 1, "inherited 1 appenders"); t.ok( childAppenders.some(a => a.label === "stdout1"), "inherited stdout1" @@ -158,7 +158,7 @@ test("log4js category inherit all appenders from direct parent", batch => { ); t.ok(firstParentAppenders, "catA.catB got created implicitily"); - t.isEqual( + t.equal( firstParentAppenders.length, 1, "created with 1 inherited appender" @@ -191,7 +191,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 1); + t.equal(childAppenders.length, 1); t.ok(childAppenders.some(a => a.label === "stdout2")); t.end(); @@ -218,7 +218,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 2, "inherited 1 appender"); + t.equal(childAppenders.length, 2, "inherited 1 appender"); t.ok( childAppenders.some(a => a.label === "stdout1"), "still have stdout1" @@ -250,7 +250,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 1, "inherited no appender"); + t.equal(childAppenders.length, 1, "inherited no appender"); t.ok(childAppenders.some(a => a.label === "stdout2"), "kept stdout2"); t.end(); @@ -276,7 +276,7 @@ test("log4js category inherit all appenders from direct parent", batch => { const childAppenders = categories.appendersForCategory(childCategoryName); t.ok(childAppenders); - t.isEqual(childAppenders.length, 1, "inherited 1 appender"); + t.equal(childAppenders.length, 1, "inherited 1 appender"); t.ok(childAppenders.some(a => a.label === "stdout2"), "inherited stdout2"); const firstParentCategoryName = "catA.catB"; @@ -285,7 +285,7 @@ test("log4js category inherit all appenders from direct parent", batch => { ); t.ok(firstParentAppenders); - t.isEqual(firstParentAppenders.length, 1, "did not inherit new appenders"); + t.equal(firstParentAppenders.length, 1, "did not inherit new appenders"); t.ok(firstParentAppenders.some(a => a.label === "stdout2"), "kept stdout2"); t.end(); @@ -310,14 +310,14 @@ test("log4js category inherit all appenders from direct parent", batch => { const childCategoryName = "catA.catB.catC"; const childLevel = categories.getLevelForCategory(childCategoryName); - t.isEqual(childLevel.levelStr, "INFO", "inherited level"); + t.equal(childLevel.levelStr, "INFO", "inherited level"); const firstParentCategoryName = "catA.catB"; const firstParentLevel = categories.getLevelForCategory( firstParentCategoryName ); - t.isEqual( + t.equal( firstParentLevel.levelStr, "INFO", "generate parent inherited level from base" diff --git a/test/tap/logLevelFilter-test.js b/test/tap/logLevelFilter-test.js index 27e31f0..de022d9 100644 --- a/test/tap/logLevelFilter-test.js +++ b/test/tap/logLevelFilter-test.js @@ -134,7 +134,7 @@ test("log4js logLevelFilter", batch => { "utf8", (err, contents) => { const messages = contents.trim().split(EOL); - assert.deepEqual(messages, ["error", "warn"]); + assert.same(messages, ["error", "warn"]); assert.end(); } ); @@ -148,7 +148,7 @@ test("log4js logLevelFilter", batch => { "utf8", (err, contents) => { const messages = contents.trim().split(EOL); - assert.deepEqual(messages, ["debug", "debug", "trace"]); + assert.same(messages, ["debug", "debug", "trace"]); assert.end(); } ); diff --git a/test/tap/logging-test.js b/test/tap/logging-test.js index be39e7f..7943f0c 100644 --- a/test/tap/logging-test.js +++ b/test/tap/logging-test.js @@ -22,12 +22,12 @@ test("log4js", batch => { const configuredAppenders = deepCopyMap(appenders); const configuredCategories = deepCopyMap(categories); - t.notEqual( + t.not( stringifyMap(configuredAppenders), stringifyMap(initialAppenders), "appenders should be different from initial state" ); - t.notEqual( + t.not( stringifyMap(configuredCategories), stringifyMap(initialCategories), "categories should be different from initial state"