@revoloo/cypress6/packages/server/test/unit/tty_spec.js

Cypress.io end to end testing tool

require('../spec_helper')

const tty = require('tty')
const ttyUtil = require(`${root}lib/util/tty`)
const terminalSize = require(`${root}lib/util/terminal-size`)

const ttys = [process.stdin.isTTY, process.stdout.isTTY, process.stderr.isTTY]

describe('lib/util/tty', () => {
  context('getWindowSize', () => {
    // https://github.com/cypress-io/cypress/issues/1815
    // windows has undefined process.stdout.getWindowSize
    // when running in electron, even when stdio inherited
    beforeEach(() => {
      // need to delete both the initial module and the
      // "base.js" module with problematic tty.getWindowSize call
      delete require.cache[require.resolve('mocha-7.0.1/lib/reporters/base')]

      return delete require.cache[require.resolve('mocha-7.0.1/lib/reporters')]
    })

    it('polyfills stdout and stderr getWindowSize', () => {
      sinon.stub(tty, 'isatty').returns(true)
      sinon.stub(terminalSize, 'get').returns({ columns: 10, rows: 20 })

      sinon.stub(process.stdout, 'getWindowSize').value(undefined)
      sinon.stub(process.stderr, 'getWindowSize').value(undefined)

      ttyUtil.override()

      // forces mocha reporters base to use tty.getWindowSize()
      // check the terminal width - should be the ttyUtil hardcoded
      require('mocha-7.0.1/lib/reporters')
      const base = require('mocha-7.0.1/lib/reporters/base')

      expect(process.stdout.getWindowSize()).to.deep.eq([10, 20])
      expect(process.stderr.getWindowSize()).to.deep.eq([10, 20])

      expect(base.window.width).to.equal(10)
    })
  })

  context('.override', () => {
    beforeEach(() => {
      process.env.FORCE_STDIN_TTY = '1'
      process.env.FORCE_STDOUT_TTY = '1'
      process.env.FORCE_STDERR_TTY = '1'

      // do this so can we see when its modified
      process.stdin.isTTY = 'foo'
      process.stdout.isTTY = 'foo'
      process.stderr.isTTY = 'foo'
    })

    afterEach(() => {
      // restore sanity
      process.stdin.isTTY = ttys[0]
      process.stdout.isTTY = ttys[1]
      process.stderr.isTTY = ttys[2]
    })

    it('is noop when not forcing in env', () => {
      delete process.env.FORCE_STDIN_TTY
      delete process.env.FORCE_STDOUT_TTY
      delete process.env.FORCE_STDERR_TTY

      ttyUtil.override()

      expect(process.stdin.isTTY).to.eq('foo')
      expect(process.stdout.isTTY).to.eq('foo')

      expect(process.stderr.isTTY).to.eq('foo')
    })

    it('forces process.stderr.isTTY to be true', () => {
      ttyUtil.override()

      expect(process.stdin.isTTY).to.be.true
      expect(process.stdout.isTTY).to.be.true

      expect(process.stderr.isTTY).to.be.true
    })

    it('modifies isatty calls', () => {
      delete process.env.FORCE_STDERR_TTY

      const isatty = sinon.spy(tty, 'isatty')

      ttyUtil.override()

      // should slurp up the first two calls
      // and only proxy through the 3rd call
      // for stderr
      tty.isatty(0)
      tty.isatty(1)
      tty.isatty(2)

      expect(isatty.callCount).to.eq(1)

      expect(isatty.firstCall).to.be.calledWith(2)
    })
  })
})