stretchr/testify

Diffs are slightly off for assert.Equal on maps

Open

#288 opened on Mar 23, 2016

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (1,704 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (25,958 stars)
PR merge metrics
 (Avg merge 6d 15h) (2 merged PRs in 30d)

Description

It seems the map is rendered with no trailing , for the last element, so the diff catches that as a modified line.. but really the line isn't modified..

Diff:
            --- Expected
            +++ Actual
            @@ -1,5 +1,7 @@
            -(map[string]interface {}) (len=3) {
            +(map[string]interface {}) (len=5) {
              (string) (len=15) "installed.first": (string) (len=20) "2006-01-02T15:04:05Z",
              (string) (len=14) "installed.last": (string) (len=20) "2006-01-02T15:04:05Z",
            - (string) (len=23) "installed.windows.first": (string) (len=20) "2006-01-02T15:04:05Z"
            + (string) (len=23) "installed.windows.first": (string) (len=20) "2006-01-02T15:04:05Z",
            + (string) (len=22) "installed.windows.last": (string) (len=20) "2006-01-02T15:04:05Z",
            + (string) (len=30) "installed.windows.last_version": (string) (len=3) "8.1"
             }

See how installed.windows.first is different only in the trailing , !

Contributor guide

Research direction
Look at the map diff formatting code in the assert package. The issue is that the last key value pair in a map is printed without a trailing comma, causing a diff mismatch. To fix, ensure that all key value pairs are printed with a trailing comma, or adjust the diff algorithm to ignore trailing commas.
Tech stack
go
Domain
testing
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60