onivim/oni

Improve test failure explenation

Open

#2731 opened on Feb 28, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
good first issuehelp wantedinsiderlowering the bar

Description

Looking for help from the community regarding this issue.

Issue: Unclear CI test failure.

Expected behavior: Failed test would indicate the failure with some extra info for investigation.

Actual behavior: Prints Expected: true, Actual: false which is less than optimal.

Steps to reproduce: Run a failing test.

Would help to have more verbose logging for the tests instead of just 'timed out' and the like. Knowing how far it got / where it got stuck would help.

Contributor guide

Tech stack
typescript
Domain
testingdesktop
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with test runnerBasic knowledge of CI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by examining the CI configuration file (likely .travis.yml or similar) and the test runner setup (perhaps Jest or Mocha). Look at the test output format and identify where 'Expected: true, Actual: false' is printed. Consider modifying the test runner's reporter or adding custom error messages to provide more context about the failure, such as which assertion failed and where the test got stuck. Check existing issues or PRs that might have discussed this before.