stretchr/testify

consider using String() method on types that implement fmt.Stringer

Open

#1 215 ouverte le 24 juin 2022

Voir sur GitHub
 (2 commentaires) (3 réactions) (0 assignés)Go (1 704 forks)batch import
help wantedinput neededpkg-assert

Métriques du dépôt

Stars
 (25 958 stars)
Métriques de merge PR
 (Merge moyen 6j 15h) (2 PRs mergées en 30 j)

Description

First of all, thanks for this great library! We use it quite extensively in go-libp2p.

We're running into the problem that the error output is unreadable for many types.

For example, we have a type peer.ID that's just a string (type peer.ID string), but the error output is practically unreadable:

Error:      	[]peer.ID{"\x12 \x92\xad \xd38\r\xadG\xf4\xd57\xee\xe5B\xa6\xffk\x80\xb2\xdda\xe5&\a\xc69\x80>D=\xfc}", "\x12 \f5;\xd7\xca\x12\xe6\x8cɷ\x00\xa71\x85\xb7|\x8brGO\xb2\xb0\xf9\xaa\"A\xee\xd3#eHH", "\x12 \xa8q3O\xd00\x16\x83JA\xa2L\x1e\xed2\x9a\xf87\x01~\xf8ڗ\x97\xdaT\xb1\xe2(\x89\xba\x15", "\x12 \xa3\xbb\xcb`\x8cV\xbb@Z\xd8%\xb3|}K\x90\a\xa7\xb5\xdeg\u0600|ʿ籐7\x8e\xc8"} does not contain "\x12 \xfd\x97\xf2?\x85?&\xc22el;\xac\xa4m\x1cj\xa4\xe3c\xcf\x00\x85u\xdb}:~3\xbf\x81\xaa"

Another example is a type that contains a byte slice, but has a nice string representation. But instead of using that one, require error message print the byte slice.

I'd be happy to contribute a PR, if this is something you would consider accepting.

Guide contributeur

Direction de recherche
Identifiez toutes les fonctions de formatage des echecs d'assertion dans le code et implementez un fallback pour appeler la methode String() sur les types implementant fmt.Stringer avant d'utiliser le formatage par defaut.
Stack technique
go
Domaine
testing qa
Type d'issue
Fonctionnalité
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-3 heures
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
Go
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75