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 (25,958 stars) (1,704 forks)batch import
enhancementhelp wanted

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

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programming basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate how map diffs are rendered in the assert package of testify. Look at the diff generation code, likely in the 'internal/diff' or similar directory. The issue is that the last map element lacks a trailing comma in the expected output but has it in the actual, causing a false positive diff. Check the formatting logic for map differences to ensure consistent comma handling.