github.com/prometheus/client_model v0.6.1: go.Bucket

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/prometheus/client_model/go.Bucket in pkg:golang/github.com/prometheus/client_model@v0.6.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/prometheus/client_model@v0.6.1
Demonstrate these symbols/APIs:
  - github.com/prometheus/client_model/go.Bucket
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - runtime: node@22.23.2

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:258b503ec13421c4a068b6d24c86141dbb65b3b594097c325e106cec3ce2ea90","contract":["dto.Bucket getters return default zero/nil values for nil Bucket and empty Bucket instances.","dto.Bucket stores and retrieves cumulative count, floating-point cumulative count, and upper bound values.","dto.Bucket associates with Exemplar containing label pairs, value, and timestamp.","dto.Bucket.Reset clears all fields back to zero or nil values."],"goal":"verify github.com/prometheus/client_model/go.Bucket in pkg:golang/github.com/prometheus/client_model@v0.6.1","kind":"HOW","packages":["pkg:golang/github.com/prometheus/client_model@v0.6.1"],"schemaVersion":1,"symbols":["github.com/prometheus/client_model/go.Bucket"]},"contractCommand":["go","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/prometheus/client_model@v0.6.1"],"schemaVersion":1,"subject":"pkg:golang/github.com/prometheus/client_model@v0.6.1","symbols":["github.com/prometheus/client_model/go.Bucket"],"verifierAdapter":"golang@1"}

module example.com/bucket

go 1.26.6

require (
	github.com/prometheus/client_model v0.6.1
	google.golang.org/protobuf v1.33.0
)

github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/prometheus/client_model v0.6.1 h1:ZKSh/rekM+n3CeS952MLRAdFwIKqeY8b62p8ais2e9E=
github.com/prometheus/client_model v0.6.1/go.mod h1:OrxVMOVHjw3lKMa8+x6HeMGkHMQyHDk9E3jmP2AmGiY=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=

package main

import (
	"fmt"

	dto "github.com/prometheus/client_model/go"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/timestamppb"
)

func main() {
	exemplar := &dto.Exemplar{
		Label: []*dto.LabelPair{
			{
				Name:  proto.String("trace_id"),
				Value: proto.String("abc-123"),
			},
		},
		Value:     proto.Float64(1.5),
		Timestamp: timestamppb.Now(),
	}

	bucket := &dto.Bucket{
		CumulativeCount:      proto.Uint64(15),
		CumulativeCountFloat: proto.Float64(15.0),
		UpperBound:           proto.Float64(5.0),
		Exemplar:             exemplar,
	}

	fmt.Printf("CumulativeCount: %d\n", bucket.GetCumulativeCount())
	fmt.Printf("CumulativeCountFloat: %f\n", bucket.GetCumulativeCountFloat())
	fmt.Printf("UpperBound: %f\n", bucket.GetUpperBound())
	if ex := bucket.GetExemplar(); ex != nil {
		fmt.Printf("Exemplar value: %f\n", ex.GetValue())
	}
}

{
  "schemaVersion": 1,
  "goal": "verify github.com/prometheus/client_model/go.Bucket in pkg:golang/github.com/prometheus/client_model@v0.6.1",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/prometheus/client_model@v0.6.1"
  ],
  "symbols": [
    "github.com/prometheus/client_model/go.Bucket"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

package test

import (
	"testing"
	"time"

	dto "github.com/prometheus/client_model/go"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/timestamppb"
)

func TestBucketNilAndEmptyDefaults(t *testing.T) {
	var nilBucket *dto.Bucket
	if got := nilBucket.GetCumulativeCount(); got != 0 {
		t.Errorf("nilBucket.GetCumulativeCount() = %v, want 0", got)
	}
	if got := nilBucket.GetCumulativeCountFloat(); got != 0.0 {
		t.Errorf("nilBucket.GetCumulativeCountFloat() = %v, want 0.0", got)
	}
	if got := nilBucket.GetUpperBound(); got != 0.0 {
		t.Errorf("nilBucket.GetUpperBound() = %v, want 0.0", got)
	}
	if got := nilBucket.GetExemplar(); got != nil {
		t.Errorf("nilBucket.GetExemplar() = %v, want nil", got)
	}

	emptyBucket := &dto.Bucket{}
	if got := emptyBucket.GetCumulativeCount(); got != 0 {
		t.Errorf("emptyBucket.GetCumulativeCount() = %v, want 0", got)
	}
	if got := emptyBucket.GetCumulativeCountFloat(); got != 0.0 {
		t.Errorf("emptyBucket.GetCumulativeCountFloat() = %v, want 0.0", got)
	}
	if got := emptyBucket.GetUpperBound(); got != 0.0 {
		t.Errorf("emptyBucket.GetUpperBound() = %v, want 0.0", got)
	}
	if got := emptyBucket.GetExemplar(); got != nil {
		t.Errorf("emptyBucket.GetExemplar() = %v, want nil", got)
	}
}

func TestBucketStoresAndRetrievesCountsAndBound(t *testing.T) {
	bucket := &dto.Bucket{
		CumulativeCount:      proto.Uint64(42),
		CumulativeCountFloat: proto.Float64(42.5),
		UpperBound:           proto.Float64(10.0),
	}

	if got := bucket.GetCumulativeCount(); got != 42 {
		t.Errorf("bucket.GetCumulativeCount() = %v, want 42", got)
	}
	if got := bucket.GetCumulativeCountFloat(); got != 42.5 {
		t.Errorf("bucket.GetCumulativeCountFloat() = %v, want 42.5", got)
	}
	if got := bucket.GetUpperBound(); got != 10.0 {
		t.Errorf("bucket.GetUpperBound() = %v, want 10.0", got)
	}
}

func TestBucketAssociatesWithExemplar(t *testing.T) {
	ts := timestamppb.New(time.Unix(1700000000, 0))
	exemplar := &dto.Exemplar{
		Label: []*dto.LabelPair{
			{
				Name:  proto.String("trace_id"),
				Value: proto.String("tx-999"),
			},
		},
		Value:     proto.Float64(3.14),
		Timestamp: ts,
	}

	bucket := &dto.Bucket{
		CumulativeCount: proto.Uint64(100),
		UpperBound:      proto.Float64(25.0),
		Exemplar:        exemplar,
	}

	ex := bucket.GetExemplar()
	if ex == nil {
		t.Fatalf("bucket.GetExemplar() is nil, want non-nil")
	}
	if got := ex.GetValue(); got != 3.14 {
		t.Errorf("ex.GetValue() = %v, want 3.14", got)
	}
	labels := ex.GetLabel()
	if len(labels) != 1 {
		t.Fatalf("len(ex.GetLabel()) = %v, want 1", len(labels))
	}
	if labels[0].GetName() != "trace_id" || labels[0].GetValue() != "tx-999" {
		t.Errorf("label mismatch: name=%v, value=%v", labels[0].GetName(), labels[0].GetValue())
	}
	if ex.GetTimestamp().GetSeconds() != 1700000000 {
		t.Errorf("timestamp seconds = %v, want 1700000000", ex.GetTimestamp().GetSeconds())
	}
}

func TestBucketReset(t *testing.T) {
	bucket := &dto.Bucket{
		CumulativeCount:      proto.Uint64(50),
		CumulativeCountFloat: proto.Float64(50.0),
		UpperBound:           proto.Float64(100.0),
		Exemplar: &dto.Exemplar{
			Value: proto.Float64(99.0),
		},
	}

	bucket.Reset()

	if got := bucket.GetCumulativeCount(); got != 0 {
		t.Errorf("after Reset(), bucket.GetCumulativeCount() = %v, want 0", got)
	}
	if got := bucket.GetCumulativeCountFloat(); got != 0.0 {
		t.Errorf("after Reset(), bucket.GetCumulativeCountFloat() = %v, want 0.0", got)
	}
	if got := bucket.GetUpperBound(); got != 0.0 {
		t.Errorf("after Reset(), bucket.GetUpperBound() = %v, want 0.0", got)
	}
	if got := bucket.GetExemplar(); got != nil {
		t.Errorf("after Reset(), bucket.GetExemplar() = %v, want nil", got)
	}
}