aws / aws/universal-test-runner

Improve error messaging around missing executables

Open
#42 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
TypeScript
Stars
31
Forks
4
PR merge metrics
No merged PRs in 30d

Description

For now we assume that any executables required by adapters (jest, npm, yarn, maven, gradle, pytest, etc.) are available in the environment -- if they're not, the behaviour is currently undefined, but right now it will basically bubble up the error message from spawnSync to the user.

It would be nice to provide better error messages to the user to ease any debugging they have to do around tools that aren't installed.

Each adapter should also provide documentation as to what it expects to be present in the execution context when tests are being executed.

Contributor guide

Open the contributing guide

Research direction

Start by locating each adapter's executable invocation and the current spawnSync error handling. Review the adapters for jest, npm, yarn, maven, gradle, and pytest, then document their execution-context requirements. Done means missing tools produce useful user-facing errors and each adapter explains the executables it expects.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.