github.com/go-stack/stack v1.8.0: CallStack.TrimAbove

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/github.com/go-stack/stack@v1.8.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/go-stack/stack@v1.8.0
Demonstrate these symbols/APIs:
  - stack.CallStack.TrimAbove

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.

package sample

import (
	"testing"

	"github.com/go-stack/stack"
)

func levelThree() (stack.Call, stack.CallStack) {
	// target is the caller of levelThree, i.e., levelTwo
	trace := stack.Trace()
	if len(trace) < 2 {
		panic("trace too short")
	}
	target := trace[1]
	return target, trace
}

func levelTwo() (stack.Call, stack.CallStack) {
	return levelThree()
}

func levelOne() (stack.Call, stack.CallStack) {
	return levelTwo()
}

func unrelatedCall() stack.Call {
	return stack.Caller(0)
}

func TestTrimAboveRemovesFramesAfterSpecifiedCall(t *testing.T) {
	target, trace := levelOne()
	if len(trace) < 3 {
		t.Fatalf("expected trace to have at least 3 frames, got %d", len(trace))
	}

	trimmed := trace.TrimAbove(target)
	if len(trimmed) == 0 {
		t.Fatalf("expected trimmed trace to be non-empty")
	}

	// target should be the outermost (last) frame in trimmed
	if trimmed[len(trimmed)-1].Frame().Function != target.Frame().Function {
		t.Fatalf("expected last frame to be %q, got %q", target.Frame().Function, trimmed[len(trimmed)-1].Frame().Function)
	}

	// Ensure frames above target were actually removed
	if len(trimmed) >= len(trace) {
		t.Fatalf("expected trimmed length (%d) to be strictly less than trace length (%d)", len(trimmed), len(trace))
	}
}

func TestTrimAbovePreservesCalleeFramesBelowSpecifiedCall(t *testing.T) {
	target, trace := levelOne()
	trimmed := TrimAboveCall(trace, target)

	// Target was trace[1], so trimmed should match trace[:2] (length 2: levelThree at 0, levelTwo at 1)
	if len(trimmed) != 2 {
		t.Fatalf("expected trimmed length 2, got %d", len(trimmed))
	}

	for i := range trimmed {
		orig := trace[i].Frame()
		curr := trimmed[i].Frame()
		if curr.Function != orig.Function || curr.File != orig.File || curr.Line != orig.Line {
			t.Fatalf("mismatch at frame %d: expected %s:%d, got %s:%d", i, orig.Function, orig.Line, curr.Function, curr.Line)
		}
	}
}

func TestTrimAboveEmptyWhenCallNotFound(t *testing.T) {
	unrelated := unrelatedCall()
	trace := stack.Trace()

	trimmed := trace.TrimAbove(unrelated)
	if len(trimmed) != 0 {
		t.Fatalf("expected empty CallStack when target is not present, got length %d", len(trimmed))
	}
}

{"case":{"caseId":"case:sha256:908d0ac354ff5628bded1e0b7eade1c4ac010bbf1398d29f4e4a820d33d82c6f","contract":["stack.CallStack.TrimAbove removes frames after the specified Call making it the outermost frame","stack.CallStack.TrimAbove preserves all callee frames below the specified Call","stack.CallStack.TrimAbove produces an empty stack when the specified Call is not present in the trace"],"goal":"verify pkg:golang/github.com/go-stack/stack@v1.8.0","kind":"HOW","packages":["pkg:golang/github.com/go-stack/stack@v1.8.0"],"schemaVersion":1,"symbols":["stack.CallStack.TrimAbove"]},"contractCommand":["go","test","./..."],"environment":{"arch":"amd64","compiler":"go","compilerVersion":"1.26.6","distro":"ubuntu","ecosystem":"golang","language":"go","languageVersion":"1.26.6","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/go-stack/stack@v1.8.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/go-stack/stack@v1.8.0","symbols":["stack.CallStack.TrimAbove"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.26.6

require github.com/go-stack/stack v1.8.0

github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk=
github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY=

package sample

import (
	"github.com/go-stack/stack"
)

// TrimAboveCaller captures the current trace and trims all frames above the specified Call.
// If the target Call is present in the stack, it becomes the last (outermost) frame of the returned CallStack.
func TrimAboveCaller(target stack.Call) stack.CallStack {
	trace := stack.Trace()
	return trace.TrimAbove(target)
}

// TrimAboveCall trims frames from an existing CallStack above the specified target Call.
func TrimAboveCall(cs stack.CallStack, target stack.Call) stack.CallStack {
	return cs.TrimAbove(target)
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/github.com/go-stack/stack@v1.8.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/go-stack/stack@v1.8.0"
  ],
  "symbols": [
    "stack.CallStack.TrimAbove"
  ]
}