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

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.ErrorKey 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.ErrorKey

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:83633702a8580300d7d298357d684fcb3ff937a4520a7a63242ea999c5e9b8aa","contract":["logrus.ErrorKey default value is \"error\"","logrus.WithError stores the error in Entry.Data using logrus.ErrorKey","Entry.WithError stores the error in Entry.Data using logrus.ErrorKey","logrus.ErrorKey can be reassigned to customize the field key used by WithError","logrus JSONFormatter serializes the error under the customized logrus.ErrorKey"],"goal":"verify github.com/sirupsen/logrus.ErrorKey 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.ErrorKey"]},"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/github.com/sirupsen/logrus@v1.9.3"],"schemaVersion":1,"subject":"pkg:golang/github.com/sirupsen/logrus@v1.9.3","symbols":["github.com/sirupsen/logrus.ErrorKey"],"verifierAdapter":"golang@1"}

module sample

go 1.23

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 (
	"bytes"
	"encoding/json"
	"errors"
	"fmt"
	"log"

	"github.com/sirupsen/logrus"
)

func main() {
	// Demonstrating logrus.ErrorKey default value
	fmt.Printf("Default logrus.ErrorKey: %q\n", logrus.ErrorKey)

	// Using default ErrorKey with WithError
	buf := &bytes.Buffer{}
	logger := logrus.New()
	logger.SetOutput(buf)
	logger.SetFormatter(&logrus.JSONFormatter{})

	sampleErr := errors.New("connection timed out")
	logger.WithError(sampleErr).Info("request failed")

	var output map[string]interface{}
	if err := json.Unmarshal(buf.Bytes(), &output); err != nil {
		log.Fatalf("failed to parse JSON log: %v", err)
	}

	fmt.Printf("Logged with default key %q: %v\n", logrus.ErrorKey, output[logrus.ErrorKey])

	// Customizing logrus.ErrorKey to "err_detail"
	originalKey := logrus.ErrorKey
	logrus.ErrorKey = "err_detail"
	defer func() {
		logrus.ErrorKey = originalKey
	}()

	buf.Reset()
	logger.WithError(sampleErr).Info("request failed with custom key")

	output = make(map[string]interface{})
	if err := json.Unmarshal(buf.Bytes(), &output); err != nil {
		log.Fatalf("failed to parse JSON log: %v", err)
	}

	fmt.Printf("Logged with customized logrus.ErrorKey %q: %v\n", logrus.ErrorKey, output[logrus.ErrorKey])
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/sirupsen/logrus.ErrorKey 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.ErrorKey"
  ]
}

package main

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

	"github.com/sirupsen/logrus"
)

func main() {
	// Ensure logrus.ErrorKey is restored after testing
	origErrorKey := logrus.ErrorKey
	defer func() {
		logrus.ErrorKey = origErrorKey
	}()

	sampleErr := errors.New("something went wrong")

	// 1. logrus.ErrorKey default value is "error"
	if logrus.ErrorKey != "error" {
		fmt.Fprintf(os.Stderr, "assertion 1 failed: expected ErrorKey == \"error\", got %q\n", logrus.ErrorKey)
		os.Exit(1)
	}

	// 2. logrus.WithError stores the error in Entry.Data using logrus.ErrorKey
	entry1 := logrus.WithError(sampleErr)
	if val, ok := entry1.Data[logrus.ErrorKey]; !ok {
		fmt.Fprintf(os.Stderr, "assertion 2 failed: key %q not found in entry1.Data\n", logrus.ErrorKey)
		os.Exit(1)
	} else if val != sampleErr {
		fmt.Fprintf(os.Stderr, "assertion 2 failed: expected %v, got %v\n", sampleErr, val)
		os.Exit(1)
	}

	// 3. Entry.WithError stores the error in Entry.Data using logrus.ErrorKey
	logger := logrus.New()
	logger.SetOutput(&bytes.Buffer{})
	baseEntry := logger.WithField("service", "payment")
	entry2 := baseEntry.WithError(sampleErr)
	if val, ok := entry2.Data[logrus.ErrorKey]; !ok {
		fmt.Fprintf(os.Stderr, "assertion 3 failed: key %q not found in entry2.Data\n", logrus.ErrorKey)
		os.Exit(1)
	} else if val != sampleErr {
		fmt.Fprintf(os.Stderr, "assertion 3 failed: expected %v, got %v\n", sampleErr, val)
		os.Exit(1)
	}
	if entry2.Data["service"] != "payment" {
		fmt.Fprintf(os.Stderr, "assertion 3 failed: expected service field to be retained\n")
		os.Exit(1)
	}

	// 4. logrus.ErrorKey can be reassigned to customize the field key used by WithError
	customKey := "err_msg"
	logrus.ErrorKey = customKey
	entry3 := logrus.WithError(sampleErr)
	if _, hasOld := entry3.Data["error"]; hasOld {
		fmt.Fprintf(os.Stderr, "assertion 4 failed: default key \"error\" should not be present\n")
		os.Exit(1)
	}
	if val, ok := entry3.Data[customKey]; !ok || val != sampleErr {
		fmt.Fprintf(os.Stderr, "assertion 4 failed: expected custom key %q with error, got %v\n", customKey, val)
		os.Exit(1)
	}

	// 5. logrus JSONFormatter serializes the error under the customized logrus.ErrorKey
	buf := &bytes.Buffer{}
	loggerJSON := logrus.New()
	loggerJSON.SetOutput(buf)
	loggerJSON.SetFormatter(&logrus.JSONFormatter{})

	loggerJSON.WithError(sampleErr).Error("an error occurred")

	var data map[string]interface{}
	if err := json.Unmarshal(buf.Bytes(), &data); err != nil {
		fmt.Fprintf(os.Stderr, "assertion 5 failed: JSON unmarshal error: %v\n", err)
		os.Exit(1)
	}
	if val, ok := data[customKey]; !ok {
		fmt.Fprintf(os.Stderr, "assertion 5 failed: expected custom key %q in JSON output\n", customKey)
		os.Exit(1)
	} else if val != sampleErr.Error() {
		fmt.Fprintf(os.Stderr, "assertion 5 failed: expected %q, got %v\n", sampleErr.Error(), val)
		os.Exit(1)
	}
	if _, hasOld := data["error"]; hasOld {
		fmt.Fprintf(os.Stderr, "assertion 5 failed: old key \"error\" should not be in JSON output\n")
		os.Exit(1)
	}

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