mgechev/revive

Replace existing tests that target unexported functions with tests for exported

Open

#1,362 opened on May 20, 2025

View on GitHub
 (7 comments) (1 reaction) (1 assignee)Go (316 forks)github user discovery
good first issuehelp wantedlow priority

Repository metrics

Stars
 (5,517 stars)
PR merge metrics
 (PR metrics pending)

Description

From https://github.com/mgechev/revive/pull/1353#issuecomment-2887129427:

I'm not sure we should test unexported functions. They are internals and a matter to be freely changed with the refactoring. Testing them makes code less flexible for refactoring and tests more fragile. In my current project, for example, we have this strongly discouraged (with some legacy exceptions).

To improve test structure and enforce better package boundaries, we should refactor our current test suite:

  1. Replace existing tests that target unexported functions with equivalent tests targeting exported functions. Ensure the functionality is still covered by indirectly testing through public APIs.
  2. Adopt _test package convention.
  3. Enable testpackage linter in the golangci-lint config.

Contributor guide

Research direction
Identify unexported functions currently tested directly, find equivalent exported functions that cover the same logic, and rewrite tests using the test package convention. Then enable the testpackage linter in the golangci lint config.
Tech stack
go
Domain
backendtoolingtesting
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.
1-2 days
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
Gotesting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65