mgechev/revive

Replace existing tests that target unexported functions with tests for exported

Open

#1362 aperta il 20 mag 2025

Vedi su GitHub
 (7 commenti) (1 reazione) (1 assegnatario)Go (316 fork)github user discovery
good first issuehelp wantedlow priority

Metriche repository

Star
 (5517 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica le funzioni non esportate attualmente testate direttamente, trova funzioni esportate equivalenti che coprono la stessa logica e riscrivi i test utilizzando la convenzione del pacchetto test. Quindi abilita il linter testpackage nella configurazione di golangci lint.
Tech stack
go
Dominio
backendtoolingtesting
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gotesting
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65