github.com/stretchr/testify v1.8.1: assert.Equal

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 github.com/stretchr/testify/assert.Equal in pkg:golang/github.com/stretchr/testify@v1.8.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/stretchr/testify@v1.8.1
Demonstrate these symbols/APIs:
  - github.com/stretchr/testify/assert.Equal

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:a504abd3aacecd87c99562a16d681e8b8840931490fa8663121b9b9d65b1c12e","contract":["assert.Equal returns true and records no error on identical primitive values","assert.Equal returns false and reports error when primitive values differ","assert.Equal reports failure when numeric types differ even if values match","assert.Equal performs deep comparison of slices and maps and returns true on equivalence","assert.Equal returns true when comparing untyped nil values","assert.Equal formats failure message using provided msgAndArgs"],"goal":"verify github.com/stretchr/testify/assert.Equal in pkg:golang/github.com/stretchr/testify@v1.8.1","kind":"HOW","packages":["pkg:golang/github.com/stretchr/testify@v1.8.1"],"schemaVersion":1,"symbols":["github.com/stretchr/testify/assert.Equal"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/stretchr/testify@v1.8.1"],"schemaVersion":1,"subject":"pkg:golang/github.com/stretchr/testify@v1.8.1","symbols":["github.com/stretchr/testify/assert.Equal"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/stretchr/testify v1.8.1

require (
	github.com/davecgh/go-spew v1.1.1 // indirect
	github.com/pmezard/go-difflib v1.0.0 // indirect
	gopkg.in/yaml.v3 v3.0.1 // indirect
)

github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"fmt"

	"github.com/stretchr/testify/assert"
)

// Reporter implements assert.TestingT to record assertion results.
type Reporter struct {
	Errors []string
	Passed int
	Failed int
}

func (r *Reporter) Errorf(format string, args ...interface{}) {
	r.Errors = append(r.Errors, fmt.Sprintf(format, args...))
	r.Failed++
}

func main() {
	reporter := &Reporter{}

	// Verify equal values
	if assert.Equal(reporter, "alpha", "alpha", "expected strings to match") {
		reporter.Passed++
	}

	// Verify mismatched values fail the assertion and record an error
	if !assert.Equal(reporter, "alpha", "beta", "expected strings to differ") {
		// As expected, inequality records a failure on reporter
	}

	fmt.Printf("Evaluation complete: %d passed, %d failed as expected\n", reporter.Passed, reporter.Failed)
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/stretchr/testify/assert.Equal in pkg:golang/github.com/stretchr/testify@v1.8.1",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/stretchr/testify@v1.8.1"
  ],
  "symbols": [
    "github.com/stretchr/testify/assert.Equal"
  ]
}

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/stretchr/testify/assert"
)

type contractTestingT struct {
	errors []string
	failed bool
}

func (t *contractTestingT) Errorf(format string, args ...interface{}) {
	t.failed = true
	t.errors = append(t.errors, fmt.Sprintf(format, args...))
}

func main() {
	// Assertion 1: assert.Equal returns true and records no error on identical primitive values
	{
		t := &contractTestingT{}
		res := assert.Equal(t, "hello", "hello")
		if !res || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: assert.Equal should return true with no error on matching strings\n")
			os.Exit(1)
		}

		resInt := assert.Equal(t, 12345, 12345)
		if !resInt || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: assert.Equal should return true with no error on matching ints\n")
			os.Exit(1)
		}
	}

	// Assertion 2: assert.Equal returns false and reports error when primitive values differ
	{
		t := &contractTestingT{}
		res := assert.Equal(t, "expected", "actual")
		if res || !t.failed || len(t.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: assert.Equal should return false and report error on mismatch\n")
			os.Exit(1)
		}
	}

	// Assertion 3: assert.Equal reports failure when numeric types differ even if values match
	{
		t := &contractTestingT{}
		res := assert.Equal(t, int(100), int64(100))
		if res || !t.failed || len(t.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: assert.Equal should return false on int vs int64 type mismatch\n")
			os.Exit(1)
		}
	}

	// Assertion 4: assert.Equal performs deep comparison of slices and maps and returns true on equivalence
	{
		t := &contractTestingT{}
		slice1 := []string{"foo", "bar"}
		slice2 := []string{"foo", "bar"}
		if !assert.Equal(t, slice1, slice2) || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: assert.Equal should return true on matching slices\n")
			os.Exit(1)
		}

		map1 := map[string]int{"a": 1, "b": 2}
		map2 := map[string]int{"a": 1, "b": 2}
		if !assert.Equal(t, map1, map2) || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: assert.Equal should return true on matching maps\n")
			os.Exit(1)
		}

		tDiff := &contractTestingT{}
		slice3 := []string{"foo", "baz"}
		if assert.Equal(tDiff, slice1, slice3) || !tDiff.failed || len(tDiff.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: assert.Equal should return false on mismatched slices\n")
			os.Exit(1)
		}
	}

	// Assertion 5: assert.Equal returns true when comparing untyped nil values
	{
		t := &contractTestingT{}
		if !assert.Equal(t, nil, nil) || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 5 failed: assert.Equal should return true on nil == nil\n")
			os.Exit(1)
		}

		tNilMismatch := &contractTestingT{}
		if assert.Equal(tNilMismatch, nil, "non-nil") || !tNilMismatch.failed || len(tNilMismatch.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 5 failed: assert.Equal should return false on nil vs non-nil\n")
			os.Exit(1)
		}
	}

	// Assertion 6: assert.Equal formats failure message using provided msgAndArgs
	{
		t := &contractTestingT{}
		customMsg := "custom verification message: value mismatch"
		assert.Equal(t, 1, 2, customMsg)
		if !t.failed || len(t.errors) == 0 || !strings.Contains(t.errors[0], customMsg) {
			fmt.Fprintf(os.Stderr, "assertion 6 failed: assert.Equal should include custom message in error output\n")
			os.Exit(1)
		}
	}

	fmt.Println("All contract assertions passed successfully.")
}