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

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.RateLimitConfig 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.RateLimitConfig

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:bf5b919a3023343e08f12a939c76b222f5aed8d9dd8029894c9f0512fbc5d282","contract":["(*RateLimitConfig)(nil).GetName() == \"\", (*RateLimitConfig)(nil).GetDomain() == \"\", and (*RateLimitConfig)(nil).GetDescriptors() == nil","\u0026RateLimitConfig{Name, Domain, Descriptors} getters GetName(), GetDomain(), and GetDescriptors() return the configured fields and nested *RateLimitDescriptor values","RateLimitConfig.ProtoReflect().IsValid() returns true and String() returns a non-empty protobuf string representation","RateLimitConfig.Reset() clears Name, Domain, and Descriptors to their zero values"],"goal":"verify github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3.RateLimitConfig 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.RateLimitConfig"]},"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.RateLimitConfig"],"verifierAdapter":"golang@1"}

module example.com/sample

go 1.22

require github.com/envoyproxy/go-control-plane/ratelimit v0.1.0

require google.golang.org/protobuf v1.35.2 // indirect

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.RateLimitConfig 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.RateLimitConfig"
  ]
}

package main

import (
	"fmt"
	"os"

	ratelimitv3 "github.com/envoyproxy/go-control-plane/ratelimit/config/ratelimit/v3"
)

func main() {
	var nilCfg *ratelimitv3.RateLimitConfig
	if nilCfg.GetName() != "" || nilCfg.GetDomain() != "" || nilCfg.GetDescriptors() != nil {
		fmt.Fprintln(os.Stderr, "expected zero values from nil RateLimitConfig getters")
		os.Exit(1)
	}

	cfg := &ratelimitv3.RateLimitConfig{
		Name:   "edge-rate-limit",
		Domain: "edge-proxy",
		Descriptors: []*ratelimitv3.RateLimitDescriptor{
			{
				Key:   "route",
				Value: "login",
				RateLimit: &ratelimitv3.RateLimitPolicy{
					Unit:            ratelimitv3.RateLimitUnit_MINUTE,
					RequestsPerUnit: 60,
				},
			},
		},
	}

	if cfg.GetName() != "edge-rate-limit" {
		fmt.Fprintf(os.Stderr, "unexpected Name: %q\n", cfg.GetName())
		os.Exit(1)
	}
	if cfg.GetDomain() != "edge-proxy" {
		fmt.Fprintf(os.Stderr, "unexpected Domain: %q\n", cfg.GetDomain())
		os.Exit(1)
	}
	descs := cfg.GetDescriptors()
	if len(descs) != 1 {
		fmt.Fprintf(os.Stderr, "unexpected Descriptors length: %d\n", len(descs))
		os.Exit(1)
	}
	if descs[0].GetKey() != "route" || descs[0].GetValue() != "login" {
		fmt.Fprintf(os.Stderr, "unexpected descriptor key/value: %q=%q\n", descs[0].GetKey(), descs[0].GetValue())
		os.Exit(1)
	}
	if descs[0].GetRateLimit().GetUnit() != ratelimitv3.RateLimitUnit_MINUTE || descs[0].GetRateLimit().GetRequestsPerUnit() != 60 {
		fmt.Fprintln(os.Stderr, "unexpected descriptor rate limit policy")
		os.Exit(1)
	}
	if !cfg.ProtoReflect().IsValid() || cfg.String() == "" {
		fmt.Fprintln(os.Stderr, "expected valid protobuf reflection and non-empty string representation")
		os.Exit(1)
	}

	cfg.Reset()
	if cfg.GetName() != "" || cfg.GetDomain() != "" || len(cfg.GetDescriptors()) != 0 {
		fmt.Fprintln(os.Stderr, "expected empty fields after Reset()")
		os.Exit(1)
	}
}