gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405: check.C, check.Equals, check.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 pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405

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:8d198598ad5f4637125a4a24a616cb1fc209d0b0bdc03380c07c188d51d83f75","contract":["check.Suite registers a test suite struct containing test methods","check.Run executes the test suite methods and reports test results","check.Equals checks equality between obtained and expected values","check.C provides assertion helpers such as Assert and Check within tests","check.TestingT runs all registered suites through Go testing framework"],"goal":"verify pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405","kind":"HOW","packages":["pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405"],"schemaVersion":1,"symbols":["check.C","check.Equals","check.Run","check.Suite","check.TestingT"]},"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/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405"],"schemaVersion":1,"subject":"pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405","symbols":["check.C","check.Equals","check.Run","check.Suite","check.TestingT"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405

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=

package sample

import (
	"gopkg.in/check.v1"
)

// Calculator provides basic arithmetic operations.
type Calculator struct{}

// Add returns the sum of two integers.
func (c *Calculator) Add(a, b int) int {
	return a + b
}

// Multiply returns the product of two integers.
func (c *Calculator) Multiply(a, b int) int {
	return a * b
}

// CalculatorSuite is a test suite exercising Calculator with gopkg.in/check.v1.
type CalculatorSuite struct {
	Calc *Calculator
}

// SetUpSuite initializes the test suite fixture before running tests.
func (s *CalculatorSuite) SetUpSuite(c *check.C) {
	s.Calc = &Calculator{}
}

// TestAdd tests the addition method using check.C and check.Equals.
func (s *CalculatorSuite) TestAdd(c *check.C) {
	result := s.Calc.Add(10, 20)
	c.Assert(result, check.Equals, 30)
}

// TestMultiply tests the multiplication method using check.C and check.Equals.
func (s *CalculatorSuite) TestMultiply(c *check.C) {
	result := s.Calc.Multiply(6, 7)
	c.Check(result, check.Equals, 42)
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405",
  "kind": "HOW",
  "packages": [
    "pkg:golang/gopkg.in/check.v1@v0.0.0-20161208181325-20d25e280405"
  ],
  "symbols": [
    "check.C",
    "check.Equals",
    "check.Run",
    "check.Suite",
    "check.TestingT"
  ]
}

package main

import (
	"fmt"
	"os"
	"testing"

	"gopkg.in/check.v1"
	"sample"
)

func main() {
	// 1. check.Suite registers a test suite struct with test methods
	suite := &sample.CalculatorSuite{}
	registered := check.Suite(suite)
	if registered == nil {
		fmt.Fprintf(os.Stderr, "expected non-nil registered suite\n")
		os.Exit(1)
	}

	// 2. check.Run executes a registered test suite and reports test results
	conf := &check.RunConf{}
	result := check.Run(suite, conf)
	if result == nil {
		fmt.Fprintf(os.Stderr, "expected non-nil run result\n")
		os.Exit(1)
	}
	if !result.Passed() {
		fmt.Fprintf(os.Stderr, "test suite run failed: %s\n", result.String())
		os.Exit(1)
	}
	if result.Succeeded < 2 {
		fmt.Fprintf(os.Stderr, "expected at least 2 succeeded tests, got %d\n", result.Succeeded)
		os.Exit(1)
	}

	// 3. check.Equals verifies equality between values directly
	match, errStr := check.Equals.Check([]interface{}{42, 42}, []string{"obtained", "expected"})
	if !match || errStr != "" {
		fmt.Fprintf(os.Stderr, "check.Equals failed on equal values: %s\n", errStr)
		os.Exit(1)
	}
	mismatch, _ := check.Equals.Check([]interface{}{42, 99}, []string{"obtained", "expected"})
	if mismatch {
		fmt.Fprintf(os.Stderr, "check.Equals succeeded on unequal values\n")
		os.Exit(1)
	}

	// 4. check.TestingT runs all registered suites through Go testing framework
	testingT := &testing.T{}
	check.TestingT(testingT)
	if testingT.Failed() {
		fmt.Fprintf(os.Stderr, "check.TestingT reported failure\n")
		os.Exit(1)
	}

	fmt.Println("All gopkg.in/check.v1 contract assertions passed.")
}