mgechev/revive

Replace existing tests that target unexported functions with tests for exported

Open

#1 362 ouverte le 20 mai 2025

Voir sur GitHub
 (7 commentaires) (1 réaction) (1 assigné)Go (316 forks)github user discovery
good first issuehelp wantedlow priority

Métriques du dépôt

Stars
 (5 517 stars)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Identifiez les fonctions non exportées actuellement testées directement, trouvez des fonctions exportées équivalentes couvrant la même logique et réécrivez les tests en utilisant la convention du package test. Activez ensuite le linter testpackage dans la configuration de golangci lint.
Stack technique
go
Domaine
backendtoolingtesting
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Gotesting
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65