onivim/oni

Automation - CiTests: Make debugging easier

Open

#1438 opened on Feb 3, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
developmenthelp wantedinsider

Description

Debugging the CiTests isn't very straightforward today. Once #1436 and #1437 are addressed, and it's easier to run/iterate on them, this will definitely be the next pain point.

A few possibilities we could have to make this easier:

  • Add a npm run debug:test:integration command, that opens a debug window and stops at a debugger prior to executing the test.
  • All the npm run debug:test:integration to take some sort of filter that is scoped to a particular test (so we don't have to run them all).

Contributor guide

Tech stack
typescriptnodejs
Domain
testingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Resolve issues #1436 and #1437Understand integration test setup
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Review the current npm scripts in 'package.json' to understand existing test commands. Examine the test configuration and framework (likely Jest or Mocha) to implement a debug command that uses node's inspect flag. Also look at the discussion in #1436 and #1437 for context on test improvements.