github.com/sirupsen/logrus v1.9.3: WithError

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/sirupsen/logrus.WithError in pkg:golang/github.com/sirupsen/logrus@v1.9.3
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/sirupsen/logrus@v1.9.3
Demonstrate these symbols/APIs:
  - github.com/sirupsen/logrus.WithError

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:17276868861e205d078beed9d65a26e59730983250dbe20922891c7cdbb1befe","contract":["logrus.WithError attaches the provided error to the entry Data map under logrus.ErrorKey","logrus.WithError returns a logrus.Entry containing the error that is rendered in formatted log output","logrus.WithError preserves the error field when additional fields are chained on the returned entry","logrus.WithError with nil error stores nil under logrus.ErrorKey in the entry Data map"],"goal":"verify github.com/sirupsen/logrus.WithError in pkg:golang/github.com/sirupsen/logrus@v1.9.3","kind":"HOW","packages":["pkg:golang/github.com/sirupsen/logrus@v1.9.3"],"schemaVersion":1,"symbols":["github.com/sirupsen/logrus.WithError"]},"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/sirupsen/logrus@v1.9.3"],"schemaVersion":1,"subject":"pkg:golang/github.com/sirupsen/logrus@v1.9.3","symbols":["github.com/sirupsen/logrus.WithError"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/sirupsen/logrus v1.9.3

require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // 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/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
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=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
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 (
	"errors"

	"github.com/sirupsen/logrus"
)

func main() {
	err := errors.New("example failure")
	entry := logrus.WithError(err)
	entry.Info("processing failed")
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/sirupsen/logrus.WithError in pkg:golang/github.com/sirupsen/logrus@v1.9.3",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/sirupsen/logrus@v1.9.3"
  ],
  "symbols": [
    "github.com/sirupsen/logrus.WithError"
  ]
}

package main

import (
	"bytes"
	"encoding/json"
	"errors"
	"fmt"
	"os"

	"github.com/sirupsen/logrus"
)

func main() {
	// Assertion 1: logrus.WithError attaches the provided error to the entry's Data map under logrus.ErrorKey
	{
		sampleErr := errors.New("database connection timeout")
		entry := logrus.WithError(sampleErr)
		if entry == nil {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected non-nil entry\n")
			os.Exit(1)
		}
		val, exists := entry.Data[logrus.ErrorKey]
		if !exists {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected key %q in entry.Data\n", logrus.ErrorKey)
			os.Exit(1)
		}
		errVal, ok := val.(error)
		if !ok || errVal.Error() != sampleErr.Error() {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected error %v, got %v\n", sampleErr, val)
			os.Exit(1)
		}
	}

	// Assertion 2: logrus.WithError returns a logrus.Entry containing the error that is rendered in formatted log output
	{
		var buf bytes.Buffer
		logger := logrus.New()
		logger.SetOutput(&buf)
		logger.SetFormatter(&logrus.JSONFormatter{})

		targetErr := errors.New("failed to read file")
		entry := logger.WithError(targetErr)
		entry.Error("operation aborted")

		var output map[string]interface{}
		if err := json.Unmarshal(buf.Bytes(), &output); err != nil {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: failed to parse JSON output: %v\n", err)
			os.Exit(1)
		}
		if output[logrus.ErrorKey] != targetErr.Error() {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected %q=%q in JSON output, got %v\n", logrus.ErrorKey, targetErr.Error(), output[logrus.ErrorKey])
			os.Exit(1)
		}
		if output["msg"] != "operation aborted" {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected msg='operation aborted', got %v\n", output["msg"])
			os.Exit(1)
		}
	}

	// Assertion 3: logrus.WithError preserves the error field when additional fields are chained on the returned entry
	{
		chainErr := errors.New("network unreachable")
		entry := logrus.WithError(chainErr).WithField("component", "transport").WithField("retry_count", 3)

		if entry.Data[logrus.ErrorKey] != chainErr {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected error %v in chained entry, got %v\n", chainErr, entry.Data[logrus.ErrorKey])
			os.Exit(1)
		}
		if entry.Data["component"] != "transport" {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected component='transport', got %v\n", entry.Data["component"])
			os.Exit(1)
		}
		if entry.Data["retry_count"] != 3 {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected retry_count=3, got %v\n", entry.Data["retry_count"])
			os.Exit(1)
		}
	}

	// Assertion 4: logrus.WithError with nil error stores nil under logrus.ErrorKey in the entry Data map
	{
		entry := logrus.WithError(nil)
		val, exists := entry.Data[logrus.ErrorKey]
		if !exists {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: expected key %q to exist for nil error\n", logrus.ErrorKey)
			os.Exit(1)
		}
		if val != nil {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: expected nil error value, got %v\n", val)
			os.Exit(1)
		}
	}

	fmt.Println("PASS: all logrus.WithError contract assertions passed")
}