mgechev/revive

Replace existing tests that target unexported functions with tests for exported

Open

#1.362 geöffnet am 20. Mai 2025

Auf GitHub ansehen
 (7 Kommentare) (1 Reaktion) (1 zugewiesene Person)Go (316 Forks)github user discovery
good first issuehelp wantedlow priority

Repository-Metriken

Stars
 (5.517 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Identifiziere derzeit direkt getestete nicht exportierte Funktionen, finde äquivalente exportierte Funktionen, die dieselbe Logik abdecken, und schreibe die Tests unter Verwendung der test Paketkonvention um. Aktiviere dann den testpackage Linter in der golangci lint Konfiguration.
Tech Stack
go
Domain
backendtoolingtesting
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Gotesting
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65