stan-dev/stan

promote logger and writer mock objects from pathfinder utils

Open

#3,194 opened on Jun 4, 2023

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)C++ (385 forks)batch import
code cleanupfeaturegood first issuetesting

Repository metrics

Stars
 (2,760 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Identify the mock classes in src/test/unit/services/pathfinder/util.hpp, create a new header file at a higher directory (e.g., src/test/unit/mock writer.hpp), move and rename them to mock writer and mock logger, add documentation, and update all references throughout the codebase.
Tech stack
cpp
Domain
backend
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.
1-3 hours
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.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70