github.com/envoyproxy/go-control-plane/ratelimit v0.1.0: v3.RateLimitDescriptor

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/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor in pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0
Demonstrate these symbols/APIs:
  - github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor

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:45cbdcefd210fb5c2eda820dbf01343eabe4ccd1ce90c649d3e79e1ec78b087f","contract":["RateLimitDescriptor initializes Key, Value, ShadowMode, DetailedMetric, RateLimit policy, and nested Descriptors and returns matching values via GetKey, GetValue, GetShadowMode, GetDetailedMetric, GetRateLimit, and GetDescriptors","proto.Marshal and proto.Unmarshal preserve RateLimitDescriptor fields and nested descriptors according to proto.Equal","RateLimitDescriptor.Reset clears all populated fields back to their zero values"],"goal":"verify github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor in pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0","kind":"HOW","packages":["pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0"],"schemaVersion":1,"symbols":["github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor"]},"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/envoyproxy/go-control-plane/ratelimit@v0.1.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0","symbols":["github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require (
	github.com/envoyproxy/go-control-plane/ratelimit v0.1.0
	google.golang.org/protobuf v1.35.2
)

github.com/envoyproxy/go-control-plane/ratelimit v0.1.0 h1:/G9QYbddjL25KvtKTv3an9lx6VBE2cnb8wp1vEGNYGI=
github.com/envoyproxy/go-control-plane/ratelimit v0.1.0/go.mod h1:Wk+tMFAFbCXaJPzVVHnPgRKdUdwW/KdbRt94AzgRee4=
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=
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.35.2 h1:8Ar7bF+apOIoThw1EdZl0p1oWvMqTHmpA2fRTyZO8io=
google.golang.org/protobuf v1.35.2/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=

{
  "schemaVersion": 1,
  "goal": "verify github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor in pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/envoyproxy/go-control-plane/ratelimit@v0.1.0"
  ],
  "symbols": [
    "github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitDescriptor"
  ]
}

package main

import (
	"fmt"
	"os"

	ratelimitv3 "github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3"
	"google.golang.org/protobuf/proto"
)

func main() {
	desc := &ratelimitv3.RateLimitDescriptor{
		Key:            "remote_address",
		Value:          "192.0.2.1",
		ShadowMode:     true,
		DetailedMetric: true,
		RateLimit: &ratelimitv3.RateLimitPolicy{
			Unit:            ratelimitv3.RateLimitUnit_MINUTE,
			RequestsPerUnit: 100,
			Unlimited:       false,
			Name:            "ip-limit",
		},
		Descriptors: []*ratelimitv3.RateLimitDescriptor{
			{
				Key:   "header_match",
				Value: "api-v1",
				RateLimit: &ratelimitv3.RateLimitPolicy{
					Unit:            ratelimitv3.RateLimitUnit_SECOND,
					RequestsPerUnit: 10,
				},
			},
		},
	}

	if desc.GetKey() != "remote_address" || desc.GetValue() != "192.0.2.1" {
		fmt.Fprintf(os.Stderr, "unexpected key/value: %s=%s\n", desc.GetKey(), desc.GetValue())
		os.Exit(1)
	}
	if !desc.GetShadowMode() || !desc.GetDetailedMetric() {
		fmt.Fprintf(os.Stderr, "expected shadow_mode and detailed_metric to be true\n")
		os.Exit(1)
	}
	if desc.GetRateLimit().GetUnit() != ratelimitv3.RateLimitUnit_MINUTE || desc.GetRateLimit().GetRequestsPerUnit() != 100 {
		fmt.Fprintf(os.Stderr, "unexpected rate limit policy\n")
		os.Exit(1)
	}
	if len(desc.GetDescriptors()) != 1 || desc.GetDescriptors()[0].GetKey() != "header_match" {
		fmt.Fprintf(os.Stderr, "unexpected nested descriptors\n")
		os.Exit(1)
	}

	wire, err := proto.Marshal(desc)
	if err != nil {
		fmt.Fprintf(os.Stderr, "marshal failed: %v\n", err)
		os.Exit(1)
	}

	var decoded ratelimitv3.RateLimitDescriptor
	if err := proto.Unmarshal(wire, &decoded); err != nil {
		fmt.Fprintf(os.Stderr, "unmarshal failed: %v\n", err)
		os.Exit(1)
	}

	if !proto.Equal(desc, &decoded) {
		fmt.Fprintf(os.Stderr, "roundtrip mismatch\n")
		os.Exit(1)
	}

	decoded.Reset()
	if decoded.GetKey() != "" || decoded.GetRateLimit() != nil || len(decoded.GetDescriptors()) != 0 {
		fmt.Fprintf(os.Stderr, "reset did not clear descriptor fields\n")
		os.Exit(1)
	}
}