WordPress/phpunit-test-runner

Make Environment Information Reporting Less Brittle

Open

#111 opened on Feb 27, 2020

View on GitHub
 (2 comments) (0 reactions) (1 assignee)PHP (75 forks)github user discovery
WCEU26enhancementhelp wanted

Repository metrics

Stars
 (76 stars)
PR merge metrics
 (Avg merge 5d 16h) (1 merged PR in 30d)

Description

Environment information collection happens via a string replacement on https://github.com/WordPress/phpunit-test-runner/blob/master/prepare.php#L91.

This means that if the comments in wp-tests-config-sample.php are changed in core, environment reporting in the test runner breaks. This ticket is a follow-up to when this happened in #105.

We should make this reporting less brittle so that it doesn't break when minor changes are made in core.

See #105 #109.

Contributor guide

Research direction
Examine prepare.php line 91 to understand the current string replacement method for environment information collection. Investigate how changes in wp tests config sample.php break the reporting. Propose a less brittle approach, such as using a configuration file or parsing comments more robustly.
Tech stack
php
Domain
testingbackend
Issue type
Refactor
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PHPWordPress testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60