stan-dev / stan-dev/stan

promote logger and writer mock objects from pathfinder utils

Open
#3,194 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

code cleanup feature good first issue testing
Dominant language
C++
Stars
2.8k
Forks
388
Avg merge
2d 17h
Merged PRs (30d)
15

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/test/unit/services/pathfinder/util.hpp and inspect the logger and writer mock classes described in the issue. Trace where they are used, promote them to a higher-level location, rename them to mock_writer and mock_logger, and add the requested documentation; done means the shared mocks are available there under the new names.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
testing
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 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.