go-cmp from 0.4.1 to 0.5.0 #477

New issue

Closed

opened 2026-03-03 12:30:12 +03:00 by kerem · 0 comments

kerem commented

2026-03-03 12:30:12 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/fsouza/fake-gcs-server/pull/275
Author: @dependabot[bot]
Created: 6/18/2020
Status: ✅ Merged
Merged: 6/18/2020
Merged by: @dependabot[bot]

Base: master ← Head: dependabot/go_modules/github.com/google/go-cmp-0.5.0

📝 Commits (1)

cab0ef0 build(deps): bump github.com/google/go-cmp from 0.4.1 to 0.5.0

📊 Changes

2 files changed (+3 additions, -1 deletions)

View changed files

📝 go.mod (+1 -1)
📝 go.sum (+2 -0)

📄 Description

Bumps github.com/google/go-cmp from 0.4.1 to 0.5.0.

Release notes

Sourced from github.com/google/go-cmp's releases.

v0.5.0

The most notable changes in this release are improvements to the reporter output (i.e., the implementation that produces output for Diff). The changes seek to improve the signal-to-noise ratio such that differences of interest to the user are emphasized, while information that is less relevant are de-emphasized.

The reporter largely consists of a set of heuristics to determine what would be the best way to format the difference in the common case. If the output seems sub-par, please file an issue. The reports are highly valuable in improving its output (e.g., #195, #194, #202, #185).

Reporter changes:

(#201) Do not use custom format for nil slice. Previously, the reporter had a bug (#157) where it would fail to print the difference between empty slices that were nil versus non-nil, which is now fixed by this change.

(#212) Use custom triple-quote syntax for diffing string literals. This adds another way that strings are displayed. Previously, the reporter used a strings.Join({...}, "\n") syntax to show diffs between lines within a string. While this representation is unambiguous, the need to escape every line made the output visually distracting. Now, we add a new syntax where multiple lines are represented by a literal syntax using """ as delimiters. When possible, this syntax is preferred if it can unambiguously represent the difference.

(#208) Batch reporter output for simple lists of text elements. Previously, when formatting a slice of primitives, the reporter would print each element on a new line, causing the output to be long. Now, multiple elements are batched together into a single line to keep the output more dense.

(#210) Allow batched diffing of slices with a custom comparer. As a performance optimization, a user may choose to pass cmp.Comparer(bytes.Equal) so that large byte slices are compared using an efficient implementation. Previously, this would prevent the reporter from being able to use specialized logic to show the per-element difference between these two slices if they were different, but now it is able to.

(#213, #215) Limit verbosity of reporter output. For slices, maps, and structs, the reporter now imposes a limit on the number of elements, entries, and structs that it will print. The limit is chosen based on heuristics such as the depth of the tree and also whether the node represents an equal value or not, where inequal values are given a larger verbosity budget.

(#216) Disambiguate reporter output. Previously, there were certain edge cases where the reporter output failed to show a difference between two values that the comparer determined to be different. Now, the reporter works harder to ensure that the output is guaranteed to be different if a semantic difference is there. For example, it may try increasing the verbosity limit, printing pointer addresses, avoid calling the String method, using fully qualified type names, or some combination of the above.

(#217) Improve reporting of values with cycles. Previously, the reporter would simply truncate the result if it ever detected a cycle. While this prevents a stack overflow trying to print a graph, it failed to properly show the topology of the graph. Now, the reporter additionally provides reference markers so that the user can visually identify where a pointer refers to in the output.

(1776240f8f841dfa00cb72d811301dbb0298f983) Forcibly export fields for use by the reporter. This allows the reporter to use the String or Error method (if available) to format values within unexported fields. This occurs regardless of whether any cmp.Exporter or cmp.AllowUnexported options are used or not.

(#210) Use raw string literal syntax only for valid UTF-8. This fixes a minor bug in the reporter to ensure that the output is always valid UTF-8.

Feature changes:

(#203) Permit use of IgnoreFields with unexported fields. The cmpopts.IgnoreFields option now accepts unexported field names. Unlike exported fields, unexported field must be explicit specified as they do not respect forwarding due to struct embedding.

Comparer changes:

(#204) Optimize Diff for frequent equality. The cmp package is intended for use primarily within tests where the expected outcome is generally equality. Previously, even if the result is equal, cmp.Diff would construct an expensive diff tree only to discard the result since the values are equal. Now, optimize for the common case by first checking whether the values are equal first, and only construct a diff if they are not.

(#214) Introduce deliberate instability to difference output. The internal algorithm used for diffing elements of a slice is sub-optimal. It does not produce an optimal edit script (i.e., one with the fewest possible reported differences), but is guaranteed to run in O(n). To keep the future open for algorithmic improvements, introduce some degree of deliberate instability so that users do not accidentally rely on it's output being stable.

(#206) Avoid leaking implementation details of the exporter. In order for the current implementation to forcibly access unexported fields using unsafe, it requires that the parent struct be addressable. In Go, a struct field is only addressable if and only if the parent struct is addressable. To avoid leaking this internal implementation detail, we shallow copy the result to remove properties of addressability.

Commits

77ae86f Improve reporting of values with cycles (#217)
c49bfce Update test case names (#218)
1227731 Fix documentation on IgnoreFields (#220)
44914b3 Disambiguate reporter output (#216)
f1780cf Limit verbosity of reporter output (#215)
0d296f9 Limit number of printed differences for variable-length composites (#213)
7c9a834 Introduce deliberate instability to difference output (#214)
0cd6169 Use custom triple-quote syntax for diffing string literals (#212)
a171aa7 Use raw string literal syntax only for valid UTF-8 (#211)
88849e8 Allow batched diffing of slices with a custom comparer (#210)
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/fsouza/fake-gcs-server/pull/275 **Author:** [@dependabot[bot]](https://github.com/apps/dependabot) **Created:** 6/18/2020 **Status:** ✅ Merged **Merged:** 6/18/2020 **Merged by:** [@dependabot[bot]](https://github.com/apps/dependabot) **Base:** `master` ← **Head:** `dependabot/go_modules/github.com/google/go-cmp-0.5.0` --- ### 📝 Commits (1) - [`cab0ef0`](https://github.com/fsouza/fake-gcs-server/commit/cab0ef0f0f08c62458de16ff54654096c65c7d4f) build(deps): bump github.com/google/go-cmp from 0.4.1 to 0.5.0 ### 📊 Changes **2 files changed** (+3 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `go.mod` (+1 -1) 📝 `go.sum` (+2 -0) </details> ### 📄 Description Bumps [github.com/google/go-cmp](https://github.com/google/go-cmp) from 0.4.1 to 0.5.0. <details> <summary>Release notes</summary> Sourced from <a href="https://github.com/google/go-cmp/releases">github.com/google/go-cmp's releases</a>. <blockquote> <h2>v0.5.0</h2> The most notable changes in this release are improvements to the reporter output (i.e., the implementation that produces output for <a href="https://pkg.go.dev/github.com/google/go-cmp/cmp?tab=doc#Diff"><code>Diff</code></a>). The changes seek to improve the signal-to-noise ratio such that differences of interest to the user are emphasized, while information that is less relevant are de-emphasized. The reporter largely consists of a set of heuristics to determine what would be the best way to format the difference in the common case. If the output seems sub-par, please file an issue. The reports are highly valuable in improving its output (e.g., <a href="https://github-redirect.dependabot.com/google/go-cmp/issues/195">#195</a>, <a href="https://github-redirect.dependabot.com/google/go-cmp/issues/194">#194</a>, <a href="https://github-redirect.dependabot.com/google/go-cmp/issues/202">#202</a>, <a href="https://github-redirect.dependabot.com/google/go-cmp/issues/185">#185</a>). Reporter changes: <ul> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/201">#201</a>) Do not use custom format for nil slice. Previously, the reporter had a bug (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/157">#157</a>) where it would fail to print the difference between empty slices that were nil versus non-nil, which is now fixed by this change.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/212">#212</a>) Use custom triple-quote syntax for diffing string literals. This adds another way that strings are displayed. Previously, the reporter used a <code>strings.Join({...}, "\n")</code> syntax to show diffs between lines within a string. While this representation is unambiguous, the need to escape every line made the output visually distracting. Now, we add a new syntax where multiple lines are represented by a literal syntax using <code>"""</code> as delimiters. When possible, this syntax is preferred if it can unambiguously represent the difference.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/208">#208</a>) Batch reporter output for simple lists of text elements. Previously, when formatting a slice of primitives, the reporter would print each element on a new line, causing the output to be long. Now, multiple elements are batched together into a single line to keep the output more dense.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/210">#210</a>) Allow batched diffing of slices with a custom comparer. As a performance optimization, a user may choose to pass <code>cmp.Comparer(bytes.Equal)</code> so that large byte slices are compared using an efficient implementation. Previously, this would prevent the reporter from being able to use specialized logic to show the per-element difference between these two slices if they were different, but now it is able to.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/213">#213</a>, <a href="https://github-redirect.dependabot.com/google/go-cmp/issues/215">#215</a>) Limit verbosity of reporter output. For slices, maps, and structs, the reporter now imposes a limit on the number of elements, entries, and structs that it will print. The limit is chosen based on heuristics such as the depth of the tree and also whether the node represents an equal value or not, where inequal values are given a larger verbosity budget.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/216">#216</a>) Disambiguate reporter output. Previously, there were certain edge cases where the reporter output failed to show a difference between two values that the comparer determined to be different. Now, the reporter works harder to ensure that the output is guaranteed to be different if a semantic difference is there. For example, it may try increasing the verbosity limit, printing pointer addresses, avoid calling the <code>String</code> method, using fully qualified type names, or some combination of the above.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/217">#217</a>) Improve reporting of values with cycles. Previously, the reporter would simply truncate the result if it ever detected a cycle. While this prevents a stack overflow trying to print a graph, it failed to properly show the topology of the graph. Now, the reporter additionally provides reference markers so that the user can visually identify where a pointer refers to in the output.</li> <li>(1776240f8f841dfa00cb72d811301dbb0298f983) Forcibly export fields for use by the reporter. This allows the reporter to use the <code>String</code> or <code>Error</code> method (if available) to format values within unexported fields. This occurs regardless of whether any <code>cmp.Exporter</code> or <code>cmp.AllowUnexported</code> options are used or not.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/210">#210</a>) Use raw string literal syntax only for valid UTF-8. This fixes a minor bug in the reporter to ensure that the output is always valid UTF-8.</li> </ul> Feature changes: <ul> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/203">#203</a>) Permit use of IgnoreFields with unexported fields. The <code>cmpopts.IgnoreFields</code> option now accepts unexported field names. Unlike exported fields, unexported field must be explicit specified as they do not respect forwarding due to struct embedding.</li> </ul> Comparer changes: <ul> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/204">#204</a>) Optimize Diff for frequent equality. The <code>cmp</code> package is intended for use primarily within tests where the expected outcome is generally equality. Previously, even if the result is equal, <code>cmp.Diff</code> would construct an expensive diff tree only to discard the result since the values are equal. Now, optimize for the common case by first checking whether the values are equal first, and only construct a diff if they are not.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/214">#214</a>) Introduce deliberate instability to difference output. The internal algorithm used for diffing elements of a slice is sub-optimal. It does not produce an optimal edit script (i.e., one with the fewest possible reported differences), but is guaranteed to run in O(n). To keep the future open for algorithmic improvements, introduce some degree of deliberate instability so that users do not accidentally rely on it's output being stable.</li> <li>(<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/206">#206</a>) Avoid leaking implementation details of the exporter. In order for the current implementation to forcibly access unexported fields using <code>unsafe</code>, it requires that the parent struct be addressable. In Go, a struct field is only addressable if and only if the parent struct is addressable. To avoid leaking this internal implementation detail, we shallow copy the result to remove properties of addressability.</li> </ul> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/google/go-cmp/commit/77ae86f624cb174e21763cffcbbf070eb06cb016"><code>77ae86f</code></a> Improve reporting of values with cycles (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/217">#217</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/c49bfce0ac9115b09320b47c3b9534cc5afd4579"><code>c49bfce</code></a> Update test case names (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/218">#218</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/12277310d373db3799bcc3f14684adee17319122"><code>1227731</code></a> Fix documentation on IgnoreFields (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/220">#220</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/44914b370698a5a9ce868549d62d79473faebacc"><code>44914b3</code></a> Disambiguate reporter output (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/216">#216</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/f1780cfdde930250f45fbe0bb6e107be5b4e9514"><code>f1780cf</code></a> Limit verbosity of reporter output (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/215">#215</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/0d296f9f534978cc25de69216b23b74bbc10fad9"><code>0d296f9</code></a> Limit number of printed differences for variable-length composites (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/213">#213</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/7c9a834557ca73ca54b2f367316f4bd747217741"><code>7c9a834</code></a> Introduce deliberate instability to difference output (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/214">#214</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/0cd6169de14f4f3dc7550a908d8e4a5c69f85fd2"><code>0cd6169</code></a> Use custom triple-quote syntax for diffing string literals (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/212">#212</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/a171aa74446ac6ce47f4f09b10deb7d9afc7dc20"><code>a171aa7</code></a> Use raw string literal syntax only for valid UTF-8 (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/211">#211</a>)</li> <li><a href="https://github.com/google/go-cmp/commit/88849e8bc9a647e7dde31569a79f5ea1f624ef2b"><code>88849e8</code></a> Allow batched diffing of slices with a custom comparer (<a href="https://github-redirect.dependabot.com/google/go-cmp/issues/210">#210</a>)</li> <li>Additional commits viewable in <a href="https://github.com/google/go-cmp/compare/v0.4.1...v0.5.0">compare view</a></li> </ul> </details> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=github.com/google/go-cmp&package-manager=go_modules&previous-version=0.4.1&new-version=0.5.0)](https://help.github.com/articles/configuring-automated-security-fixes) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> --- 🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.