web/test: shell suites fail when a test waits for something that never happens (exit guard)

Author: ndemianc

web/test/unit/shell-engine-build.test.js

@@ -9,6 +9,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const fs = require('fs');
 const os = require('os');
@@ -100,6 +103,8 @@ async function main() {
 			fs.mkdirSync(path.join(root, 'web', 'test', 'unit'), { recursive: true });
 			fs.cpSync(ENGINE, path.join(root, 'web', 'shell', 'engine'), { recursive: true });
 			fs.copyFileSync(__filename, path.join(root, 'web', 'test', 'unit', 'shell-engine-build.test.js'));
+			fs.mkdirSync(path.join(root, 'web', 'test', 'helpers'), { recursive: true });
+			fs.copyFileSync(path.join(__dirname, '..', 'helpers', 'shell-exit-guard.js'), path.join(root, 'web', 'test', 'helpers', 'shell-exit-guard.js'));
 			const run = (env) => spawnSync(process.execPath, [path.join(root, 'web', 'test', 'unit', 'shell-engine-build.test.js')], { encoding: 'utf8', env: Object.assign({}, process.env, { LEVELCODE_VSCODE: '', LEVELCODE_REQUIRE_BUILD: '', LC_BUILD_TEST_COPY: '1' }, env) });
 			const quiet = run({});
 			assert.strictEqual(quiet.status, 0, quiet.stdout + quiet.stderr);

web/test/unit/shell-engine-compat.test.js

@@ -9,6 +9,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 // `touch -t`, `date` and `stat` read local time as GNU does, and the shell's is UTC (or the command's TZ): the process's
 // zone, the visitor's in a browser, is never asked. The whole suite is run under three of them.
 const ZONES = ['UTC', 'America/New_York', 'Asia/Tokyo'];

web/test/unit/shell-engine-consistency.test.js

@@ -14,6 +14,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const fs = require('fs');
 const path = require('path');

web/test/unit/shell-engine-core.test.js

@@ -13,6 +13,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const path = require('path');
 

web/test/unit/shell-engine-cpmv.test.js

@@ -16,6 +16,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const fs = require('fs');
 const path = require('path');

web/test/unit/shell-engine-fuzz.test.js

@@ -10,6 +10,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 // the zone of the process is the visitor's, and the shell does not ask it: the first run is in UTC, the others in two
 // that are not (a smaller count each, from other seeds)
 const ZONES = [['UTC', 3000, 20261011], ['America/New_York', 800, 20261012], ['Asia/Tokyo', 800, 20261013]];

web/test/unit/shell-engine-golden.test.js

@@ -16,6 +16,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 // The reference ran with TZ unset, which is UTC, and so does the shell: whatever zone the process (the visitor's
 // browser) is in is never asked. Every case is run under three of them and must give the same answer.
 const ZONES = ['UTC', 'America/New_York', 'Asia/Tokyo'];

web/test/unit/shell-engine-overlay.test.js

@@ -12,6 +12,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const path = require('path');
 

web/test/unit/shell-engine-patches.test.js

@@ -12,6 +12,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const crypto = require('crypto');
 const fs = require('fs');

web/test/unit/shell-engine-text.test.js

@@ -8,6 +8,9 @@
 // @ts-check
 'use strict';
 
+// A test that waits for something that never happens must fail the suite, not end it silently with status 0.
+require('../helpers/shell-exit-guard.js');
+
 const assert = require('assert');
 const path = require('path');