github.com/stretchr/testify v1.3.0: assert.JSONEq

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

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

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:7a1c66d0f08becb70f5d64212a59af7e091b19e9528a2ec9f136586c88df391e","contract":["assert.JSONEq returns true and records no error when comparing JSON objects with matching keys in different order","assert.JSONEq returns true and records no error when comparing semantically equivalent JSON with different whitespace formatting","assert.JSONEq returns false and records an error when JSON values or field names do not match","assert.JSONEq returns false and records an error when JSON array element ordering differs","assert.JSONEq returns false and records an error when either string is malformed or invalid JSON"],"goal":"verify github.com/stretchr/testify/assert.JSONEq in pkg:golang/github.com/stretchr/testify@v1.3.0","kind":"HOW","packages":["pkg:golang/github.com/stretchr/testify@v1.3.0"],"schemaVersion":1,"symbols":["github.com/stretchr/testify/assert.JSONEq"]},"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.3.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/stretchr/testify@v1.3.0","symbols":["github.com/stretchr/testify/assert.JSONEq"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/stretchr/testify v1.3.0

require (
	github.com/davecgh/go-spew v1.1.0 // indirect
	github.com/pmezard/go-difflib v1.0.0 // indirect
)

github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/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/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=

package main

import (
	"fmt"

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

// Reporter implements assert.TestingT to record assertion errors without halting.
type Reporter struct {
	errors []string
	failed bool
}

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

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

	// Example 1: Comparing JSON objects with different key order
	expectedUser := `{"id": 1, "name": "sample-entity", "active": true}`
	actualUser := `{"active": true, "id": 1, "name": "sample-entity"}`

	if assert.JSONEq(reporter, expectedUser, actualUser, "JSON objects should match despite key ordering") {
		fmt.Println("Key ordering differences ignored successfully.")
	}

	// Example 2: Comparing JSON with different whitespace formatting
	expectedConfig := `{"host": "localhost", "port": 8080}`
	actualConfig := `{
		"host": "localhost",
		"port": 8080
	}`

	if assert.JSONEq(reporter, expectedConfig, actualConfig, "JSON with differing whitespace should match") {
		fmt.Println("Whitespace formatting differences ignored successfully.")
	}

	if !reporter.failed {
		fmt.Println("All JSONEq demonstrations completed without errors.")
	}
}

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

package main

import (
	"fmt"
	"os"

	"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.JSONEq returns true and records no error when comparing JSON objects with matching keys in different order
	{
		t := &contractTestingT{}
		expected := `{"a": 1, "b": "hello", "c": true}`
		actual := `{"c": true, "b": "hello", "a": 1}`
		if !assert.JSONEq(t, expected, actual) || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: JSONEq should succeed on key reordering\n")
			os.Exit(1)
		}
	}

	// Assertion 2: assert.JSONEq returns true and records no error when comparing semantically equivalent JSON with different whitespace formatting
	{
		t := &contractTestingT{}
		expected := `{"key": "value", "items": [1, 2, 3]}`
		actual := "{\n\t\"key\": \"value\",\n\t\"items\": [\n\t\t1,\n\t\t2,\n\t\t3\n\t]\n}"
		if !assert.JSONEq(t, expected, actual) || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: JSONEq should succeed with different whitespace formatting\n")
			os.Exit(1)
		}
	}

	// Assertion 3: assert.JSONEq returns false and records an error when JSON values or field names do not match
	{
		tMismatchValue := &contractTestingT{}
		expectedVal := `{"count": 10}`
		actualVal := `{"count": 20}`
		if assert.JSONEq(tMismatchValue, expectedVal, actualVal) || !tMismatchValue.failed || len(tMismatchValue.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: JSONEq should fail on value mismatch\n")
			os.Exit(1)
		}

		tMismatchKey := &contractTestingT{}
		expectedKey := `{"foo": "bar"}`
		actualKey := `{"baz": "bar"}`
		if assert.JSONEq(tMismatchKey, expectedKey, actualKey) || !tMismatchKey.failed || len(tMismatchKey.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: JSONEq should fail on key name mismatch\n")
			os.Exit(1)
		}
	}

	// Assertion 4: assert.JSONEq returns false and records an error when JSON array element ordering differs
	{
		t := &contractTestingT{}
		expectedArr := `{"tags": ["red", "blue", "green"]}`
		actualArr := `{"tags": ["green", "blue", "red"]}`
		if assert.JSONEq(t, expectedArr, actualArr) || !t.failed || len(t.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: JSONEq should fail when array element order differs\n")
			os.Exit(1)
		}
	}

	// Assertion 5: assert.JSONEq returns false and records an error when either string is malformed or invalid JSON
	{
		tInvalid := &contractTestingT{}
		validJSON := `{"valid": true}`
		malformedJSON := `{"invalid": `
		if assert.JSONEq(tInvalid, validJSON, malformedJSON) || !tInvalid.failed || len(tInvalid.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 5 failed: JSONEq should fail on malformed JSON\n")
			os.Exit(1)
		}
	}

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