google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9: errdetails.DebugInfo

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 google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9
Demonstrate these symbols/APIs:
  - google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo

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:4729220e1695678ac0cbb02c7c828964a36dec8815148e6add49c6b2ea63476f","contract":["DebugInfo fields StackEntries and Detail can be populated and read using GetStackEntries and GetDetail getters.","GetDetail returns empty string and GetStackEntries returns nil when called on a nil *DebugInfo pointer.","DebugInfo serializes to and deserializes from protocol buffer binary format while preserving StackEntries and Detail.","DebugInfo.Reset clears all fields, setting Detail to empty string and StackEntries to empty.","DebugInfo.ProtoReflect returns a protoreflect.Message with descriptor full name google.rpc.DebugInfo."],"goal":"verify google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9","kind":"HOW","packages":["pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"],"schemaVersion":1,"symbols":["google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","executionContext":"go","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","runtime":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"],"schemaVersion":1,"subject":"pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9","symbols":["google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo"],"verifierAdapter":"golang@1"}

module example.com/debuginfo

go 1.26.6

require (
	google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9
	google.golang.org/protobuf v1.35.1
)

github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9 h1:QCqS/PdaHTSWGvupk2F/ehwHtGc0/GYkT+3GAcR1CCc=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9/go.mod h1:GX3210XPVPUjJbTUbvwI8f2IpZDMZuPJWDzDuebbviI=
google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=

package main

import (
	"fmt"

	"google.golang.org/genproto/googleapis/rpc/errdetails"
	"google.golang.org/protobuf/proto"
)

func main() {
	info := &errdetails.DebugInfo{
		StackEntries: []string{
			"service.go:45: error handling request",
			"handler.go:12: connection timeout",
		},
		Detail: "failed to connect to upstream service",
	}

	fmt.Printf("Detail: %s\n", info.GetDetail())
	fmt.Printf("Stack Entries: %v\n", info.GetStackEntries())

	data, err := proto.Marshal(info)
	if err != nil {
		panic(err)
	}

	var decoded errdetails.DebugInfo
	if err := proto.Unmarshal(data, &decoded); err != nil {
		panic(err)
	}

	fmt.Printf("Decoded Detail: %s\n", decoded.GetDetail())
}

{
  "schemaVersion": 1,
  "goal": "verify google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9",
  "kind": "HOW",
  "packages": [
    "pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"
  ],
  "symbols": [
    "google.golang.org/genproto/googleapis/rpc/errdetails.DebugInfo"
  ]
}

package test

import (
	"reflect"
	"testing"

	"google.golang.org/genproto/googleapis/rpc/errdetails"
	"google.golang.org/protobuf/proto"
)

func TestDebugInfoFieldsAndGetters(t *testing.T) {
	entries := []string{"frame1", "frame2"}
	detail := "internal server error"

	info := &errdetails.DebugInfo{
		StackEntries: entries,
		Detail:       detail,
	}

	if info.GetDetail() != detail {
		t.Errorf("GetDetail() = %q, want %q", info.GetDetail(), detail)
	}

	if !reflect.DeepEqual(info.GetStackEntries(), entries) {
		t.Errorf("GetStackEntries() = %v, want %v", info.GetStackEntries(), entries)
	}
}

func TestDebugInfoNilSafeGetters(t *testing.T) {
	var nilInfo *errdetails.DebugInfo

	if got := nilInfo.GetDetail(); got != "" {
		t.Errorf("(*DebugInfo)(nil).GetDetail() = %q, want %q", got, "")
	}

	if got := nilInfo.GetStackEntries(); got != nil {
		t.Errorf("(*DebugInfo)(nil).GetStackEntries() = %v, want nil", got)
	}
}

func TestDebugInfoProtoSerialization(t *testing.T) {
	original := &errdetails.DebugInfo{
		StackEntries: []string{"trace.go:10", "main.go:50"},
		Detail:       "unexpected EOF",
	}

	data, err := proto.Marshal(original)
	if err != nil {
		t.Fatalf("proto.Marshal failed: %v", err)
	}

	var decoded errdetails.DebugInfo
	if err := proto.Unmarshal(data, &decoded); err != nil {
		t.Fatalf("proto.Unmarshal failed: %v", err)
	}

	if decoded.GetDetail() != original.GetDetail() {
		t.Errorf("decoded.GetDetail() = %q, want %q", decoded.GetDetail(), original.GetDetail())
	}

	if !reflect.DeepEqual(decoded.GetStackEntries(), original.GetStackEntries()) {
		t.Errorf("decoded.GetStackEntries() = %v, want %v", decoded.GetStackEntries(), original.GetStackEntries())
	}
}

func TestDebugInfoReset(t *testing.T) {
	info := &errdetails.DebugInfo{
		StackEntries: []string{"err.go:1"},
		Detail:       "some detail",
	}

	info.Reset()

	if info.GetDetail() != "" {
		t.Errorf("after Reset(), GetDetail() = %q, want empty string", info.GetDetail())
	}

	if len(info.GetStackEntries()) != 0 {
		t.Errorf("after Reset(), len(GetStackEntries()) = %d, want 0", len(info.GetStackEntries()))
	}
}

func TestDebugInfoProtoReflect(t *testing.T) {
	info := &errdetails.DebugInfo{}
	msg := info.ProtoReflect()

	fullName := string(msg.Descriptor().FullName())
	expectedFullName := "google.rpc.DebugInfo"
	if fullName != expectedFullName {
		t.Errorf("Descriptor().FullName() = %q, want %q", fullName, expectedFullName)
	}
}