test: skip some console tests on dumb terminal

Add capabilities to common test module to detect and skip tests
on dumb terminals.

In some of our build environments, like s390x, the terminal
is a dumb terminal meaning it has very rudimentary capabilities.
These in turn prevent some of the tests from completing with errors
as below.

    not ok 1777 parallel/test-readline-tab-complete
      ---
      duration_ms: 0.365
      severity: fail
      exitcode: 1
      stack: |-
        assert.js:103
          throw new AssertionError(obj);
          ^

        AssertionError [ERR_ASSERTION]: Expected values to be strictly equal:

        '\t' !== ''

            at /home/abuild/rpmbuild/BUILD/node-git.8698dd98bb/test/parallel/test-readline-tab-complete.js:63:14
            at Array.forEach (<anonymous>)
            at /home/abuild/rpmbuild/BUILD/node-git.8698dd98bb/test/parallel/test-readline-tab-complete.js:18:17
            at Array.forEach (<anonymous>)
            at Object.<anonymous> (/home/abuild/rpmbuild/BUILD/node-git.8698dd98bb/test/parallel/test-readline-tab-complete.js:17:3)
            at Module._compile (internal/modules/cjs/loader.js:1176:30)
            at Object.Module._extensions..js (internal/modules/cjs/loader.js:1196:10)
            at Module.load (internal/modules/cjs/loader.js:1040:32)
            at Function.Module._load (internal/modules/cjs/loader.js:929:14)
            at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:71:12) {
          generatedMessage: true,
          code: 'ERR_ASSERTION',
          actual: '\t',
          expected: '',
          operator: 'strictEqual'
        }
      ...

PR-URL: #33165
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>

Author: AdamMajer

test/common/README.md

@@ -222,6 +222,10 @@ Platform check for Advanced Interactive eXecutive (AIX).
 
 Attempts to 'kill' `pid`
 
+### `isDumbTerminal`
+
+* [<boolean>][]
+
 ### `isFreeBSD`
 
 * [<boolean>][]
@@ -384,6 +388,10 @@ will not be run.
 
 Logs '1..0 # Skipped: ' + `msg` and exits with exit code `0`.
 
+### `skipIfDumbTerminal()`
+
+Skip the rest of the tests if the current terminal is a dumb terminal
+
 ### `skipIfEslintMissing()`
 
 Skip the rest of the tests in the current file when `ESLint` is not available

test/common/index.js

@@ -112,6 +112,8 @@ const isOpenBSD = process.platform === 'openbsd';
 const isLinux = process.platform === 'linux';
 const isOSX = process.platform === 'darwin';
 
+const isDumbTerminal = process.env.TERM === 'dumb';
+
 const rootDir = isWindows ? 'c:\\' : '/';
 
 const buildType = process.config.target_defaults ?
@@ -666,6 +668,12 @@ function invalidArgTypeHelper(input) {
   return ` Received type ${typeof input} (${inspected})`;
 }
 
+function skipIfDumbTerminal() {
+  if (isDumbTerminal) {
+    skip('skipping - dumb terminal');
+  }
+}
+
 const common = {
   allowGlobals,
   buildType,
@@ -686,6 +694,7 @@ const common = {
   invalidArgTypeHelper,
   isAIX,
   isAlive,
+  isDumbTerminal,
   isFreeBSD,
   isLinux,
   isMainThread,
@@ -706,6 +715,7 @@ const common = {
   runWithInvalidFD,
   skip,
   skipIf32Bits,
+  skipIfDumbTerminal,
   skipIfEslintMissing,
   skipIfInspectorDisabled,
   skipIfWorker,

test/common/index.mjs

@@ -12,6 +12,7 @@ const {
   isIBMi,
   isLinuxPPCBE,
   isSunOS,
+  isDumbTerminal,
   isFreeBSD,
   isOpenBSD,
   isLinux,
@@ -31,6 +32,7 @@ const {
   mustCall,
   mustCallAtLeast,
   hasMultiLocalhost,
+  skipIfDumbTerminal,
   skipIfEslintMissing,
   canCreateSymLink,
   getCallSite,
@@ -57,6 +59,7 @@ export {
   isIBMi,
   isLinuxPPCBE,
   isSunOS,
+  isDumbTerminal,
   isFreeBSD,
   isOpenBSD,
   isLinux,
@@ -76,6 +79,7 @@ export {
   mustCall,
   mustCallAtLeast,
   hasMultiLocalhost,
+  skipIfDumbTerminal,
   skipIfEslintMissing,
   canCreateSymLink,
   getCallSite,

test/parallel/test-console-clear.js

@@ -1,6 +1,6 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 
 const stdoutWrite = process.stdout.write;
@@ -18,5 +18,7 @@ function doTest(isTTY, check) {
 }
 
 // Fake TTY
-doTest(true, check);
+if (!common.isDumbTerminal) {
+  doTest(true, check);
+}
 doTest(false, '');

test/parallel/test-readline-interface.js

@@ -22,6 +22,7 @@
 // Flags: --expose-internals
 'use strict';
 const common = require('../common');
+common.skipIfDumbTerminal();
 
 const assert = require('assert');
 const readline = require('readline');

test/parallel/test-readline-position.js

@@ -1,13 +1,15 @@
 // Flags: --expose-internals
 'use strict';
-require('../common');
+const common = require('../common');
 const { internalBinding } = require('internal/test/binding');
 const { PassThrough } = require('stream');
 const readline = require('readline');
 const assert = require('assert');
 
 const ctrlU = { ctrl: true, name: 'u' };
 
+common.skipIfDumbTerminal();
+
 {
   const input = new PassThrough();
   const rl = readline.createInterface({

test/parallel/test-readline-tab-complete.js

@@ -8,6 +8,8 @@ const assert = require('assert');
 const EventEmitter = require('events').EventEmitter;
 const { getStringWidth } = require('internal/util/inspect');
 
+common.skipIfDumbTerminal();
+
 // This test verifies that the tab completion supports unicode and the writes
 // are limited to the minimum.
 [

test/parallel/test-readline-undefined-columns.js

@@ -5,6 +5,8 @@ const assert = require('assert');
 const PassThrough = require('stream').PassThrough;
 const readline = require('readline');
 
+common.skipIfDumbTerminal();
+
 // Checks that tab completion still works
 // when output column size is undefined
 

test/parallel/test-readline.js

@@ -4,6 +4,8 @@ const { PassThrough } = require('stream');
 const readline = require('readline');
 const assert = require('assert');
 
+common.skipIfDumbTerminal();
+
 {
   const input = new PassThrough();
   const rl = readline.createInterface({

test/parallel/test-repl-editor.js

@@ -1,10 +1,12 @@
 'use strict';
 
-require('../common');
+const common = require('../common');
 const assert = require('assert');
 const repl = require('repl');
 const ArrayStream = require('../common/arraystream');
 
+common.skipIfDumbTerminal();
+
 // \u001b[nG - Moves the cursor to n st column
 // \u001b[0J - Clear screen
 // \u001b[0K - Clear to line end