test: update to expect promises instead of streams

Author: mdeanjones

package.json

@@ -53,7 +53,7 @@
     "istanbul": "^0.4.5",
     "mocha": "^10.0.0",
     "prettier": "2.8.1",
-    "rimraf": "^2.6.3",
+    "rimraf": "^5.0.1",
     "semantic-release": "^19.0.3"
   },
   "engines": {

test/helpers/index.js

@@ -0,0 +1,76 @@
+const { dirname, join } = require('node:path');
+const { mkdtemp, readFile } = require('node:fs/promises');
+const { tmpdir } = require('node:os');
+const execa = require('execa');
+const { rimraf } = require('rimraf');
+
+/**
+ * Run the lcov-result-merger command in a child process. If no glob pattern
+ * is provided, the "basic" test fixtures are targeted.
+ *
+ * @param {string[]} [commands]
+ * @param {string} [pattern]
+ *
+ * @returns {Promise<string>}
+ */
+async function runCli(commands, pattern) {
+  const executable = join(__dirname, '../../bin/lcov-result-merger.js');
+  const sourceGlob =
+    pattern || `"${join(__dirname, '..', 'fixtures/basic/*/lcov.info')}"`;
+  const args = [executable, sourceGlob, ...(commands || [])];
+
+  return (await execa('node', args)).stdout.trim();
+}
+
+/**
+ * Read the contents from the relevant "expected" fixture file.
+ *
+ * @param {'basic'|'prepended'|'prepended-path-fix'} type
+ *
+ * @returns {Promise<string>}
+ */
+async function getExpected(type) {
+  const filePath = join(__dirname, '..', 'expected', type, 'lcov.info');
+  return (await readFile(filePath, 'utf-8')).toString().trim();
+}
+
+/**
+ * Returns the contents of the provided file as UTF-8 encoded text.
+ *
+ * @param {string} filePath
+ *
+ * @return {Promise<string>}
+ */
+async function getActual(filePath) {
+  return (await readFile(filePath, 'utf-8')).toString().trim();
+}
+
+/**
+ * Create a temporary directory to output lcov content into, and
+ * return a full string path to the lcov file that will be written.
+ *
+ * @returns {Promise<string>}
+ */
+async function getTempLcovFilePath() {
+  const filePath = await mkdtemp(join(tmpdir(), 'lcov-result-merger-'));
+  return join(filePath, 'lcov.info');
+}
+
+/**
+ * Empties the directory that the given file is in.
+ *
+ * @param {string} filePath
+ *
+ * @returns {Promise<boolean>}
+ */
+async function cleanFileDirectory(filePath) {
+  return rimraf(dirname(filePath));
+}
+
+module.exports = {
+  runCli,
+  getExpected,
+  getActual,
+  getTempLcovFilePath,
+  cleanFileDirectory,
+};

test/lcov-result-merger-cmd-spec.js

@@ -1,117 +1,97 @@
 /* eslint-env mocha */
 
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
 const chai = require('chai');
-const execa = require('execa');
-const rimraf = require('rimraf');
 
-chai.should();
+const {
+  runCli,
+  getExpected,
+  getActual,
+  getTempLcovFilePath,
+  cleanFileDirectory,
+} = require('./helpers');
 
-/**
- * Run the lcov-result-merger command in a child process.
- *
- * @param {string[]} [commands]
- * @returns {Promise<string>}
- */
-async function runCli(commands, sourceFiles) {
-  const args = [
-    './bin/lcov-result-merger.js',
-    sourceFiles || '"./test/fixtures/basic/*/lcov.info"',
-  ].concat(commands || []);
-
-  const { stdout } = await execa('node', args);
-  return stdout.trim();
-}
-
-/**
- * Read the contents from the relevant "expected" fixture file.
- *
- * @param {'basic'|'prepended'|'prepended-path-fix'} type
- * @returns {string}
- */
-function getExpected(type) {
-  return fs.readFileSync(`./test/expected/${type}/lcov.info`, 'utf-8').trim();
-}
-
-/**
- * Create a temporary directory to output lcov content into, and
- * return a full string path to the lcov file that will be written.
- *
- * @returns {string}
- */
-function makeTmpFilePath() {
-  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'lcov-result-merger-'));
-  return path.join(tmpDir, 'lcov.info');
-}
-
-/**
- * Clean up the temporary directory.
- *
- * @param {string} tmpFilePath
- */
-function cleanTmpDirectory(tmpFilePath) {
-  rimraf.sync(path.dirname(tmpFilePath));
-}
+chai.should();
 
 describe('lcovResultMerger CLI', function () {
   it('should combine the given records into one', async function () {
     const actual = await runCli();
-    actual.should.equal(getExpected('basic'));
+    const expect = await getExpected('basic');
+
+    actual.should.equal(expect);
   });
 
   it('should ignore paths with the --ignore option', async function () {
-    const actual = await runCli(
-      ['--ignore="**/extra.info"'],
-      '"./test/fixtures/ignore/*/*.info"'
-    );
-    actual.should.equal(getExpected('basic'));
+    const options = ['--ignore="**/extra.info"'];
+    const pattern = '"./test/fixtures/ignore/*/*.info"';
+
+    const actual = await runCli(options, pattern);
+    const expect = await getExpected('basic');
+
+    actual.should.equal(expect);
   });
 
   it('should optionally prepend source file lines', async function () {
-    const actual = await runCli([
-      '--prepend-source-files',
-      '--prepend-path-fix=""',
-    ]);
-    actual.should.equal(getExpected('prepended'));
+    const options = ['--prepend-source-files', '--prepend-path-fix=""'];
+
+    const actual = await runCli(options);
+    const expect = await getExpected('prepended');
+
+    actual.should.equal(expect);
   });
 
   it('should optionally prepend source file lines with corrected pathing', async function () {
-    const actual = await runCli(
-      ['--prepend-source-files'],
-      '"./test/fixtures/coverage-subfolder/*/coverage/lcov.info"'
-    );
-    actual.should.equal(getExpected('prepended-path-fix'));
+    const options = ['--prepend-source-files'];
+    const pattern = '"./test/fixtures/coverage-subfolder/*/coverage/lcov.info"';
+
+    const actual = await runCli(options, pattern);
+    const expect = await getExpected('prepended-path-fix');
+
+    actual.should.equal(expect);
   });
 
   it('should combine to given records into one output file', async function () {
-    const tmpFile = makeTmpFilePath();
-    await runCli([tmpFile]);
-    const actual = fs.readFileSync(tmpFile, 'utf-8');
+    const outfile = await getTempLcovFilePath();
+
+    await runCli([outfile]);
 
-    actual.trim().should.equal(getExpected('basic'));
-    cleanTmpDirectory(tmpFile);
+    const actual = await getActual(outfile);
+    const expect = await getExpected('basic');
+
+    await cleanFileDirectory(outfile);
+
+    actual.should.equal(expect);
   });
 
   it('should optionally prepend source file lines into one output file', async function () {
-    const tmpFile = makeTmpFilePath();
-    await runCli([tmpFile, '--prepend-source-files', '--prepend-path-fix=""']);
-    const actual = fs.readFileSync(tmpFile, 'utf-8');
+    const outfile = await getTempLcovFilePath();
+    const options = [
+      outfile,
+      '--prepend-source-files',
+      '--prepend-path-fix=""',
+    ];
+
+    await runCli(options);
+
+    const actual = await getActual(outfile);
+    const expect = await getExpected('prepended');
 
-    actual.trim().should.equal(getExpected('prepended'));
-    cleanTmpDirectory(tmpFile);
+    await cleanFileDirectory(outfile);
+
+    actual.should.equal(expect);
   });
 
   it('should optionally prepend source file lines into one output file with corrected pathing', async function () {
-    const tmpFile = makeTmpFilePath();
-    await runCli(
-      [tmpFile, '--prepend-source-files'],
-      '"./test/fixtures/coverage-subfolder/*/coverage/lcov.info"'
-    );
-    const actual = fs.readFileSync(tmpFile, 'utf-8');
-
-    actual.trim().should.equal(getExpected('prepended-path-fix'));
-    cleanTmpDirectory(tmpFile);
+    const outfile = await getTempLcovFilePath();
+    const options = [outfile, '--prepend-source-files'];
+    const pattern = '"./test/fixtures/coverage-subfolder/*/coverage/lcov.info"';
+
+    await runCli(options, pattern);
+
+    const actual = await getActual(outfile);
+    const expect = await getExpected('prepended-path-fix');
+
+    await cleanFileDirectory(outfile);
+
+    actual.should.equal(expect);
   });
 });

test/lcov-result-merger-spec.js

@@ -3,7 +3,7 @@
 const fg = require('fast-glob');
 const fs = require('fs');
 const chai = require('chai');
-const lcovResultMerger = require('../index.js');
+const { mergeCoverageReportFilesStream } = require('../index.js');
 
 chai.should();
 
@@ -14,7 +14,7 @@ describe('lcovResultMerger', function () {
 
     await new Promise((res) => {
       fg.stream('./test/fixtures/basic/*/lcov.info')
-        .pipe(lcovResultMerger())
+        .pipe(mergeCoverageReportFilesStream())
         .on('data', (tmpFile) => {
           tmpFilePath = tmpFile;
         })
@@ -25,20 +25,6 @@ describe('lcovResultMerger', function () {
     return actual.should.equal(expected);
   });
 
-  it('should ignore null files', function (callback) {
-    const stream = lcovResultMerger();
-    stream.on('data', function (file) {
-      const fileContentStr = fs.readFileSync(file, 'utf8');
-      fileContentStr.should.equal('');
-      callback();
-    });
-    stream.write({
-      cwd: './',
-      path: '/meow.html',
-    });
-    stream._flush();
-  });
-
   it('should handle a record with : in the name', async function () {
     const expected = fs.readFileSync(
       './test/expected/windows/lcov.info',
@@ -48,7 +34,7 @@ describe('lcovResultMerger', function () {
 
     await new Promise((res) => {
       fg.stream('./test/fixtures/windows/lcov.info')
-        .pipe(lcovResultMerger())
+        .pipe(mergeCoverageReportFilesStream())
         .on('data', (tmpFile) => {
           tmpFilePath = tmpFile;
         })
@@ -69,7 +55,7 @@ describe('lcovResultMerger', function () {
     await new Promise((res) => {
       fg.stream('./test/fixtures/basic/*/lcov.info')
         .pipe(
-          lcovResultMerger({
+          mergeCoverageReportFilesStream({
             'prepend-source-files': true,
             'prepend-path-fix': '',
           })
@@ -93,7 +79,7 @@ describe('lcovResultMerger', function () {
 
     await new Promise((res) => {
       fg.stream('./test/fixtures/coverage-subfolder/*/coverage/lcov.info')
-        .pipe(lcovResultMerger({ 'prepend-source-files': true }))
+        .pipe(mergeCoverageReportFilesStream({ 'prepend-source-files': true }))
         .on('data', (tmpFile) => {
           tmpFilePath = tmpFile;
         })