stan-dev/stan

promote logger and writer mock objects from pathfinder utils

Open

#3194 opened on Jun 4, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)R (1,476 stars) (270 forks)batch import
code cleanupfeaturegood first issuetesting

Description

Summary:

There are some generally useful testing classes in src/test/unit/services/pathfinder/util.hpp that'd be useful higher up. At that point, they should be renamed to something like mock_writer and mock_logger.

Description:

Also add doc.

Current Version:

v2.32.2

Contributor guide

Tech stack
cpp
Domain
testing
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C++ basicsStan project structureunit testing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the existing mock classes in src/test/unit/services/pathfinder/util.hpp. Determine the appropriate higher level directory for these utilities (e.g., src/test/unit/util/). Rename the classes to mock writer and mock logger, updating all references. Add documentation. Review the 6 comments on the issue for any discussion on preferred location or naming.