github.com/stretchr/testify v1.7.0: assert.Eventually

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

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

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:f9ef53cf94c2a287af784646b04fbdf1619896b63ba2cc0b9b905fdfb09be17d","contract":["assert.Eventually returns true and does not record an error when the condition succeeds before the timeout","assert.Eventually returns false and records an error when the condition is never satisfied within waitFor duration","assert.Eventually repeatedly polls the condition at the specified tick interval until it becomes true","assert.Eventually formats and includes custom message arguments when reporting condition timeout"],"goal":"verify github.com/stretchr/testify/assert.Eventually in pkg:golang/github.com/stretchr/testify@v1.7.0","kind":"HOW","packages":["pkg:golang/github.com/stretchr/testify@v1.7.0"],"schemaVersion":1,"symbols":["github.com/stretchr/testify/assert.Eventually"]},"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.7.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/stretchr/testify@v1.7.0","symbols":["github.com/stretchr/testify/assert.Eventually"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/stretchr/testify v1.7.0

require (
	github.com/davecgh/go-spew v1.1.0 // indirect
	github.com/pmezard/go-difflib v1.0.0 // indirect
	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // 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.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
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 h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

package main

import (
	"fmt"
	"sync/atomic"
	"time"

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

// Reporter implements assert.TestingT to capture assertion failure details.
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: Polling an asynchronous condition until it succeeds
	var completed int32
	go func() {
		time.Sleep(30 * time.Millisecond)
		atomic.StoreInt32(&completed, 1)
	}()

	success := assert.Eventually(reporter, func() bool {
		return atomic.LoadInt32(&completed) == 1
	}, 200*time.Millisecond, 10*time.Millisecond, "expected background task to complete")

	if success && !reporter.failed {
		fmt.Println("Asynchronous operation succeeded within timeout.")
	}

	// Example 2: Verifying timeout failure reporting
	failingReporter := &Reporter{}
	failed := assert.Eventually(failingReporter, func() bool {
		return false
	}, 50*time.Millisecond, 10*time.Millisecond, "operation should time out")

	if !failed && failingReporter.failed {
		fmt.Printf("Condition timed out as expected with %d error recorded.\n", len(failingReporter.errors))
	}
}

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

package main

import (
	"fmt"
	"os"
	"strings"
	"sync/atomic"
	"time"

	"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.Eventually returns true and does not record an error when the condition succeeds before the timeout
	{
		t := &contractTestingT{}
		var flag int32
		go func() {
			time.Sleep(20 * time.Millisecond)
			atomic.StoreInt32(&flag, 1)
		}()

		ok := assert.Eventually(t, func() bool {
			return atomic.LoadInt32(&flag) == 1
		}, 300*time.Millisecond, 10*time.Millisecond)

		if !ok || t.failed || len(t.errors) != 0 {
			fmt.Fprintf(os.Stderr, "assertion 1 failed: Eventually should return true and not report error on success\n")
			os.Exit(1)
		}
	}

	// Assertion 2: assert.Eventually returns false and records an error when the condition is never satisfied within waitFor duration
	{
		t := &contractTestingT{}
		ok := assert.Eventually(t, func() bool {
			return false
		}, 50*time.Millisecond, 10*time.Millisecond)

		if ok || !t.failed || len(t.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: Eventually should return false and report error on timeout\n")
			os.Exit(1)
		}
		if !strings.Contains(t.errors[0], "Condition never satisfied") {
			fmt.Fprintf(os.Stderr, "assertion 2 failed: expected 'Condition never satisfied' in error message, got: %s\n", t.errors[0])
			os.Exit(1)
		}
	}

	// Assertion 3: assert.Eventually repeatedly polls the condition at the specified tick interval until it becomes true
	{
		t := &contractTestingT{}
		var pollCount int32
		ok := assert.Eventually(t, func() bool {
			count := atomic.AddInt32(&pollCount, 1)
			return count >= 3
		}, 300*time.Millisecond, 10*time.Millisecond)

		finalCount := atomic.LoadInt32(&pollCount)
		if !ok || t.failed || len(t.errors) != 0 || finalCount < 3 {
			fmt.Fprintf(os.Stderr, "assertion 3 failed: Eventually should poll at least 3 times before returning true (polled: %d)\n", finalCount)
			os.Exit(1)
		}
	}

	// Assertion 4: assert.Eventually formats and includes custom message arguments when reporting condition timeout
	{
		t := &contractTestingT{}
		customArg := 42
		ok := assert.Eventually(t, func() bool {
			return false
		}, 40*time.Millisecond, 10*time.Millisecond, "expected status %d within deadline", customArg)

		if ok || !t.failed || len(t.errors) == 0 {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: Eventually should fail with custom message\n")
			os.Exit(1)
		}
		if !strings.Contains(t.errors[0], "expected status 42 within deadline") {
			fmt.Fprintf(os.Stderr, "assertion 4 failed: error did not contain formatted custom message, got: %s\n", t.errors[0])
			os.Exit(1)
		}
	}

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