github.com/google/go-cmp v0.5.7: cmp.Diff, cmp.Equal, cmpopts.EquateEmpty

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:golang/github.com/google/go-cmp@v0.5.7
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/google/go-cmp@v0.5.7

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:e549c01cd2c615d11f462bf12f2b87dfc045bd6b9a53509b562c560978a8fee5","contract":["assert cmp.Equal panics at runtime when comparing structs containing unexported fields without an explicit option","assert cmpopts.IgnoreUnexported prevents unexported field panics while preserving inequality on unordered slices and nil vs empty maps","assert combining cmpopts.IgnoreUnexported, cmpopts.EquateEmpty, and cmpopts.SortSlices makes structs with reordered slices and nil vs empty maps compare equal under cmp.Equal and return an empty string from cmp.Diff","assert cmp.Diff returns a non-empty diff string and cmp.Equal returns false when exported fields genuinely differ under those options"],"goal":"verify pkg:golang/github.com/google/go-cmp@v0.5.7","kind":"HOW","packages":["pkg:golang/github.com/google/go-cmp@v0.5.7"],"schemaVersion":1,"symbols":["cmp.Diff","cmp.Equal","cmpopts.EquateEmpty","cmpopts.IgnoreUnexported","cmpopts.SortSlices"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/google/go-cmp@v0.5.7"],"schemaVersion":1,"subject":"pkg:golang/github.com/google/go-cmp@v0.5.7","symbols":["cmp.Diff","cmp.Equal","cmpopts.EquateEmpty","cmpopts.IgnoreUnexported","cmpopts.SortSlices"],"verifierAdapter":"golang@1"}

module sample

go 1.21

require github.com/google/go-cmp v0.5.7

require golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 // indirect

github.com/google/go-cmp v0.5.7 h1:81/ik6ipDQS2aGcBfIN5dHDB36BwrStyeAQquSYCV4o=
github.com/google/go-cmp v0.5.7/go.mod h1:n+brtR0CgQNWTVd5ZUFpTBC8YFBDLK/h/bpaJ8/DtOE=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/github.com/google/go-cmp@v0.5.7",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/google/go-cmp@v0.5.7"
  ]
}

package main

import (
	"fmt"
	"os"

	"github.com/google/go-cmp/cmp"
	"github.com/google/go-cmp/cmp/cmpopts"
)

type record struct {
	ID      int
	Tags    []string
	Meta    map[string]string
	private string
}

func panics(fn func()) (caught bool) {
	defer func() {
		if r := recover(); r != nil {
			caught = true
		}
	}()
	fn()
	return false
}

func main() {
	a := record{
		ID:      7,
		Tags:    []string{"beta", "alpha"},
		Meta:    nil,
		private: "secret-a",
	}
	b := record{
		ID:      7,
		Tags:    []string{"alpha", "beta"},
		Meta:    map[string]string{},
		private: "secret-b",
	}

	// 1. Comparing structs with unexported fields without an explicit option panics at runtime.
	if !panics(func() { cmp.Equal(a, b) }) {
		fmt.Fprintln(os.Stderr, "expected cmp.Equal without IgnoreUnexported to panic on unexported fields")
		os.Exit(1)
	}

	// 2. With cmpopts.IgnoreUnexported alone, unordered slices and nil vs empty maps still compare unequal.
	ignoreOpt := cmpopts.IgnoreUnexported(record{})
	if cmp.Equal(a, b, ignoreOpt) {
		fmt.Fprintln(os.Stderr, "expected cmp.Equal to return false when slices are unordered and map is nil vs empty")
		os.Exit(1)
	}

	// 3. Combining IgnoreUnexported, EquateEmpty, and SortSlices makes them compare equal and produces an empty diff.
	opts := cmp.Options{
		ignoreOpt,
		cmpopts.EquateEmpty(),
		cmpopts.SortSlices(func(x, y string) bool { return x < y }),
	}
	if !cmp.Equal(a, b, opts) {
		fmt.Fprintln(os.Stderr, "expected cmp.Equal to return true with combined options")
		os.Exit(1)
	}
	if diff := cmp.Diff(a, b, opts); diff != "" {
		fmt.Fprintf(os.Stderr, "expected empty diff, got:\n%s\n", diff)
		os.Exit(1)
	}

	// 4. When exported fields genuinely differ, cmp.Equal returns false and cmp.Diff returns a non-empty diff.
	changed := b
	changed.ID = 100
	if cmp.Equal(a, changed, opts) {
		fmt.Fprintln(os.Stderr, "expected cmp.Equal to return false when exported field differs")
		os.Exit(1)
	}
	if diff := cmp.Diff(a, changed, opts); diff == "" {
		fmt.Fprintln(os.Stderr, "expected non-empty diff when exported field differs")
		os.Exit(1)
	}
}