github.com/stretchr/testify v1.7.0: suite.Run

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/suite.Run 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/suite.Run

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:01ad9409e45eeb55925b7914127dc62693a11bfec09e208c9c5d7839356118b7","contract":["suite.Run executes all exported methods beginning with Test on the testing suite","suite.Run ignores unexported methods and non-test helper methods not prefixed with Test","suite.Run invokes SetupSuite once before any tests run and TearDownSuite once after all tests complete","suite.Run invokes SetupTest and TearDownTest around each individual test method execution in order","suite.Run binds the active test context accessible via T() during test execution"],"goal":"verify github.com/stretchr/testify/suite.Run 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/suite.Run"]},"contractCommand":["go","test","-v","./..."],"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/suite.Run"],"verifierAdapter":"golang@1"}

module sample

go 1.26

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"

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

// CounterSuite demonstrates test suite structure with testify/suite.
type CounterSuite struct {
	suite.Suite
	count int
}

// SetupTest initializes state before each test method runs.
func (s *CounterSuite) SetupTest() {
	s.count = 10
}

// TestIncrement verifies that the counter increments correctly.
func (s *CounterSuite) TestIncrement() {
	s.count++
	s.Equal(11, s.count)
}

func main() {
	fmt.Println("suite.Run executes test suites containing Setup/Teardown hooks and Test methods.")
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/stretchr/testify/suite.Run 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/suite.Run"
  ]
}

package test

import (
	"strings"
	"testing"

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

// ExecutionSuite verifies that all exported Test methods are executed.
type ExecutionSuite struct {
	suite.Suite
	firstExecuted  bool
	secondExecuted bool
}

func (s *ExecutionSuite) TestFirst() {
	s.firstExecuted = true
}

func (s *ExecutionSuite) TestSecond() {
	s.secondExecuted = true
}

// FilteringSuite verifies that non-Test methods and unexported methods are not executed.
type FilteringSuite struct {
	suite.Suite
	helperExecuted     bool
	unexportedExecuted bool
}

func (s *FilteringSuite) HelperMethod() {
	s.helperExecuted = true
}

func (s *FilteringSuite) testUnexported() {
	s.unexportedExecuted = true
}

func (s *FilteringSuite) TestValid() {
	// regular test method
}

// SuiteLifecycleSuite verifies SetupSuite and TearDownSuite lifecycle invocations.
type SuiteLifecycleSuite struct {
	suite.Suite
	setupSuiteCount    int
	tearDownSuiteCount int
	testsRun           int
}

func (s *SuiteLifecycleSuite) SetupSuite() {
	s.setupSuiteCount++
}

func (s *SuiteLifecycleSuite) TestAlpha() {
	s.testsRun++
}

func (s *SuiteLifecycleSuite) TestBeta() {
	s.testsRun++
}

func (s *SuiteLifecycleSuite) TearDownSuite() {
	s.tearDownSuiteCount++
}

// MethodLifecycleSuite verifies per-test SetupTest and TearDownTest ordering.
type MethodLifecycleSuite struct {
	suite.Suite
	executionOrder []string
}

func (s *MethodLifecycleSuite) SetupTest() {
	s.executionOrder = append(s.executionOrder, "SetupTest")
}

func (s *MethodLifecycleSuite) TestOne() {
	s.executionOrder = append(s.executionOrder, "TestOne")
}

func (s *MethodLifecycleSuite) TestTwo() {
	s.executionOrder = append(s.executionOrder, "TestTwo")
}

func (s *MethodLifecycleSuite) TearDownTest() {
	s.executionOrder = append(s.executionOrder, "TearDownTest")
}

// ContextBindingSuite verifies that T() provides access to the active test context.
type ContextBindingSuite struct {
	suite.Suite
	capturedT   *testing.T
	contextName string
}

func (s *ContextBindingSuite) TestActiveContext() {
	s.capturedT = s.T()
	if s.T() != nil {
		s.contextName = s.T().Name()
	}
}

func TestContract(t *testing.T) {
	// Assertion 1: suite.Run executes all exported methods beginning with Test on the testing suite
	{
		s := new(ExecutionSuite)
		suite.Run(t, s)
		if !s.firstExecuted || !s.secondExecuted {
			t.Fatalf("assertion 1 failed: suite.Run did not execute all exported Test methods")
		}
	}

	// Assertion 2: suite.Run ignores unexported methods and non-test helper methods not prefixed with Test
	{
		s := new(FilteringSuite)
		suite.Run(t, s)
		if s.helperExecuted || s.unexportedExecuted {
			t.Fatalf("assertion 2 failed: suite.Run executed non-Test or unexported helper method")
		}
	}

	// Assertion 3: suite.Run invokes SetupSuite once before any tests run and TearDownSuite once after all tests complete
	{
		s := new(SuiteLifecycleSuite)
		suite.Run(t, s)
		if s.setupSuiteCount != 1 || s.tearDownSuiteCount != 1 || s.testsRun != 2 {
			t.Fatalf("assertion 3 failed: SetupSuite or TearDownSuite invocation count mismatch")
		}
	}

	// Assertion 4: suite.Run invokes SetupTest and TearDownTest around each individual test method execution in order
	{
		s := new(MethodLifecycleSuite)
		suite.Run(t, s)
		expected := []string{
			"SetupTest",
			"TestOne",
			"TearDownTest",
			"SetupTest",
			"TestTwo",
			"TearDownTest",
		}
		if len(s.executionOrder) != len(expected) {
			t.Fatalf("assertion 4 failed: execution order count mismatch (%d vs %d)", len(s.executionOrder), len(expected))
		}
		for i, v := range expected {
			if s.executionOrder[i] != v {
				t.Fatalf("assertion 4 failed: step %d expected %s, got %s", i, v, s.executionOrder[i])
			}
		}
	}

	// Assertion 5: suite.Run binds the active test context accessible via T() during test execution
	{
		s := new(ContextBindingSuite)
		suite.Run(t, s)
		if s.capturedT == nil || !strings.Contains(s.contextName, "TestActiveContext") {
			t.Fatalf("assertion 5 failed: active test context was not bound to suite.T()")
		}
	}
}