github.com/sirupsen/logrus v1.4.2: TextFormatter

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

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

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:25b64b89361646d66e3f7b2e6fae5663ae0b50b9596359eeb3a6f356d930a9be","contract":["TextFormatter formats log entries into key-value text pairs with level and message","TextFormatter omits timestamp when DisableTimestamp is true and formats timestamp with TimestampFormat when enabled","TextFormatter sorts additional structured fields alphabetically by key by default","TextFormatter remaps standard field keys such as level and msg using FieldMap","TextFormatter quotes field values containing spaces and empty string values when QuoteEmptyFields is true"],"goal":"verify github.com/sirupsen/logrus.TextFormatter in pkg:golang/github.com/sirupsen/logrus@v1.4.2","kind":"HOW","packages":["pkg:golang/github.com/sirupsen/logrus@v1.4.2"],"schemaVersion":1,"symbols":["github.com/sirupsen/logrus.TextFormatter"]},"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.4.2"],"schemaVersion":1,"subject":"pkg:golang/github.com/sirupsen/logrus@v1.4.2","symbols":["github.com/sirupsen/logrus.TextFormatter"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require github.com/sirupsen/logrus v1.4.2

require (
	github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
	golang.org/x/sys v0.0.0-20190422165155-953cdadca894 // indirect
)

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/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
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.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

package main

import (
	"os"

	"github.com/sirupsen/logrus"
)

func main() {
	logger := logrus.New()
	logger.SetOutput(os.Stdout)
	logger.SetFormatter(&logrus.TextFormatter{
		DisableColors:    true,
		DisableTimestamp: true,
	})

	logger.WithFields(logrus.Fields{
		"component": "auth",
		"status":    "active",
	}).Info("demonstrating logrus TextFormatter")
}

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

package main

import (
	"fmt"
	"os"
	"strings"
	"time"

	"github.com/sirupsen/logrus"
)

func main() {
	if err := runContractTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All contract assertions passed.")
}

func runContractTests() error {
	// Assertion 1: TextFormatter formats log entries into key-value text pairs with level and message
	{
		formatter := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: true,
		}
		entry := &logrus.Entry{
			Logger:  logrus.New(),
			Level:   logrus.InfoLevel,
			Message: "service initialized",
		}
		data, err := formatter.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 1 failed: error formatting: %v", err)
		}
		out := string(data)
		if !strings.Contains(out, "level=info") || !strings.Contains(out, "msg=\"service initialized\"") {
			return fmt.Errorf("assertion 1 failed: expected level=info and msg, got %q", out)
		}
	}

	// Assertion 2: TextFormatter omits timestamp when DisableTimestamp is true and formats timestamp with TimestampFormat when enabled
	{
		fixedTime := time.Date(2025, 5, 20, 14, 30, 0, 0, time.UTC)
		customFormat := "2006-01-02T15:04:05Z07:00"
		formatterWithTime := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: false,
			TimestampFormat:  customFormat,
		}
		entry := &logrus.Entry{
			Logger:  logrus.New(),
			Level:   logrus.WarnLevel,
			Time:    fixedTime,
			Message: "timed warning",
		}
		dataWithTime, err := formatterWithTime.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 2 failed with custom timestamp: %v", err)
		}
		outWithTime := string(dataWithTime)
		expectedTime := `time="2025-05-20T14:30:00Z"`
		if !strings.Contains(outWithTime, expectedTime) {
			return fmt.Errorf("assertion 2 failed: expected custom timestamp %q in %q", expectedTime, outWithTime)
		}

		formatterNoTime := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: true,
		}
		dataNoTime, err := formatterNoTime.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 2 failed with disabled timestamp: %v", err)
		}
		if strings.Contains(string(dataNoTime), "time=") {
			return fmt.Errorf("assertion 2 failed: time field should be omitted, got %q", string(dataNoTime))
		}
	}

	// Assertion 3: TextFormatter sorts additional structured fields alphabetically by key by default
	{
		formatter := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: true,
		}
		entry := &logrus.Entry{
			Logger:  logrus.New(),
			Level:   logrus.InfoLevel,
			Message: "sorting test",
			Data: logrus.Fields{
				"zeta":  "3",
				"alpha": "1",
				"mid":   "2",
			},
		}
		data, err := formatter.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 3 failed: %v", err)
		}
		out := string(data)
		alphaIdx := strings.Index(out, "alpha=1")
		midIdx := strings.Index(out, "mid=2")
		zetaIdx := strings.Index(out, "zeta=3")
		if alphaIdx == -1 || midIdx == -1 || zetaIdx == -1 || !(alphaIdx < midIdx && midIdx < zetaIdx) {
			return fmt.Errorf("assertion 3 failed: fields not sorted alphabetically: got %q", out)
		}
	}

	// Assertion 4: TextFormatter remaps standard field keys such as level and msg using FieldMap
	{
		formatter := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: true,
			FieldMap: logrus.FieldMap{
				logrus.FieldKeyLevel: "severity",
				logrus.FieldKeyMsg:   "payload",
			},
		}
		entry := &logrus.Entry{
			Logger:  logrus.New(),
			Level:   logrus.ErrorLevel,
			Message: "failure occurred",
		}
		data, err := formatter.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 4 failed: %v", err)
		}
		out := string(data)
		if !strings.Contains(out, "severity=error") || !strings.Contains(out, "payload=\"failure occurred\"") {
			return fmt.Errorf("assertion 4 failed: remapped keys not found, got %q", out)
		}
	}

	// Assertion 5: TextFormatter quotes field values containing spaces and empty string values when QuoteEmptyFields is true
	{
		formatter := &logrus.TextFormatter{
			DisableColors:    true,
			DisableTimestamp: true,
			QuoteEmptyFields: true,
		}
		entry := &logrus.Entry{
			Logger:  logrus.New(),
			Level:   logrus.InfoLevel,
			Message: "quote check",
			Data: logrus.Fields{
				"spaced": "multiple words here",
				"empty":  "",
			},
		}
		data, err := formatter.Format(entry)
		if err != nil {
			return fmt.Errorf("assertion 5 failed: %v", err)
		}
		out := string(data)
		if !strings.Contains(out, "spaced=\"multiple words here\"") || !strings.Contains(out, "empty=\"\"") {
			return fmt.Errorf("assertion 5 failed: quoting behavior missing, got %q", out)
		}
	}

	return nil
}