Skip to content

Commit

Permalink
test: skip some console tests on dumb terminal
Browse files Browse the repository at this point in the history
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 <ruben@bridgewater.de>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
AdamMajer authored and codebytere committed Jun 7, 2020
1 parent 9017bce commit 139eb6b
Show file tree
Hide file tree
Showing 16 changed files with 50 additions and 5 deletions.
8 changes: 8 additions & 0 deletions test/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,10 @@ Platform check for Advanced Interactive eXecutive (AIX).

Attempts to 'kill' `pid`

### `isDumbTerminal`

* [&lt;boolean>][]

### `isFreeBSD`

* [&lt;boolean>][]
Expand Down Expand Up @@ -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
Expand Down
10 changes: 10 additions & 0 deletions test/common/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 ?
Expand Down Expand Up @@ -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,
Expand All @@ -686,6 +694,7 @@ const common = {
invalidArgTypeHelper,
isAIX,
isAlive,
isDumbTerminal,
isFreeBSD,
isLinux,
isMainThread,
Expand All @@ -706,6 +715,7 @@ const common = {
runWithInvalidFD,
skip,
skipIf32Bits,
skipIfDumbTerminal,
skipIfEslintMissing,
skipIfInspectorDisabled,
skipIfWorker,
Expand Down
4 changes: 4 additions & 0 deletions test/common/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const {
isIBMi,
isLinuxPPCBE,
isSunOS,
isDumbTerminal,
isFreeBSD,
isOpenBSD,
isLinux,
Expand All @@ -31,6 +32,7 @@ const {
mustCall,
mustCallAtLeast,
hasMultiLocalhost,
skipIfDumbTerminal,
skipIfEslintMissing,
canCreateSymLink,
getCallSite,
Expand All @@ -57,6 +59,7 @@ export {
isIBMi,
isLinuxPPCBE,
isSunOS,
isDumbTerminal,
isFreeBSD,
isOpenBSD,
isLinux,
Expand All @@ -76,6 +79,7 @@ export {
mustCall,
mustCallAtLeast,
hasMultiLocalhost,
skipIfDumbTerminal,
skipIfEslintMissing,
canCreateSymLink,
getCallSite,
Expand Down
6 changes: 4 additions & 2 deletions test/parallel/test-console-clear.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'use strict';

require('../common');
const common = require('../common');
const assert = require('assert');

const stdoutWrite = process.stdout.write;
Expand All @@ -18,5 +18,7 @@ function doTest(isTTY, check) {
}

// Fake TTY
doTest(true, check);
if (!common.isDumbTerminal) {
doTest(true, check);
}
doTest(false, '');
1 change: 1 addition & 0 deletions test/parallel/test-readline-interface.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
// Flags: --expose-internals
'use strict';
const common = require('../common');
common.skipIfDumbTerminal();

const assert = require('assert');
const readline = require('readline');
Expand Down
4 changes: 3 additions & 1 deletion test/parallel/test-readline-position.js
Original file line number Diff line number Diff line change
@@ -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({
Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-readline-tab-complete.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
[
Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-readline-undefined-columns.js
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-readline.js
Original file line number Diff line number Diff line change
Expand Up @@ -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({
Expand Down
4 changes: 3 additions & 1 deletion test/parallel/test-repl-editor.js
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-repl-history-navigation.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ const fs = require('fs');
const path = require('path');
const { inspect } = require('util');

common.skipIfDumbTerminal();

const tmpdir = require('../common/tmpdir');
tmpdir.refresh();

Expand Down
4 changes: 3 additions & 1 deletion test/parallel/test-repl-load-multiline.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
'use strict';
require('../common');
const common = require('../common');
const ArrayStream = require('../common/arraystream');
const fixtures = require('../common/fixtures');
const assert = require('assert');
const repl = require('repl');

common.skipIfDumbTerminal();

const command = `.load ${fixtures.path('repl-load-multiline.js')}`;
const terminalCode = '\u001b[1G\u001b[0J \u001b[1G';
const terminalCodeRegex = new RegExp(terminalCode.replace(/\[/g, '\\['), 'g');
Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-repl-persistent-history.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ const path = require('path');
const os = require('os');
const util = require('util');

common.skipIfDumbTerminal();

const tmpdir = require('../common/tmpdir');
tmpdir.refresh();

Expand Down
1 change: 1 addition & 0 deletions test/parallel/test-repl-preview.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ const { Stream } = require('stream');
const { inspect } = require('util');

common.skipIfInspectorDisabled();
common.skipIfDumbTerminal();

const PROMPT = 'repl > ';

Expand Down
2 changes: 2 additions & 0 deletions test/parallel/test-repl-programmatic-history.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ const path = require('path');
const os = require('os');
const util = require('util');

common.skipIfDumbTerminal();

const tmpdir = require('../common/tmpdir');
tmpdir.refresh();

Expand Down
1 change: 1 addition & 0 deletions test/parallel/test-repl-reverse-search.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ const fs = require('fs');
const path = require('path');
const { inspect } = require('util');

common.skipIfDumbTerminal();
common.allowGlobals('aaaa');

const tmpdir = require('../common/tmpdir');
Expand Down

0 comments on commit 139eb6b

Please sign in to comment.