How do you debug your tests?

I’m trying to debug the following simple test. My tests run just fine and pass but I never get an opportunity to debug anything. What exactly is app.client.debug() supposed to do? It doesn’t seem to do anything for me. Am I supposed to connect a debugger externally somehow instead? Here is my test file:

const Application = require('spectron').Application
const path = require('path')
const chai = require('chai')
const chaiAsPromised = require('chai-as-promised')

let appPath = path.join(__dirname, '..', 'Gistbar-darwin-x64', 'Gistbar.app', 'Contents', 'MacOS', 'Gistbar')

if (process.platform === 'win32') {
  appPath += '.cmd'
}

const app = new Application({
  path: appPath,
})

global.before(function () {
  chai.should()
  chai.use(chaiAsPromised)
})

describe('Base Tests', function () {
  beforeEach(function () {
    return app.start()
  })

  afterEach(function () {
    return app.stop()
  })

  it('opens a window', function () {
    app.client.debug()
    return app.client.waitUntilWindowLoaded()
      .getWindowCount().should.eventually.equal(1)
  })
})

Can anybody shed some light on how to properly debug spectron tests? I think that the documentation around “How to debug tests” could be improved a bit. I wouldn’t mind submitting a PR for “How to debug tests” to the main readme if someone teaches me how first 😃

[Michenux]

You can also do:

it('opens a window', function () {
     app.browserWindow.openDevTools();
     return app.client.debug();
  })

[stepbeta]

Using VSCode this is my launch.json entry for testing spectron tests:

{
    "name": "debug E2E Tests",
    "type": "node",
    "request": "launch",
    "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
    "stopOnEntry": false,
    "args": ["test/**/*.e2e.js", "--no-timeouts", "--require", "babel-polyfill", "--compilers", "js:babel-register"],
    "cwd": "${workspaceRoot}",
    "runtimeExecutable": null,
    "env": {}
}

Hope this helps.