github.com/envoyproxy/go-control-plane/envoy v1.37.0: v3.GrpcService

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/envoy/config/core/v3.GrpcService in pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0
Demonstrate these symbols/APIs:
  - github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService

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:0668f1a2fad838b6d04aaea2bd4d41a430198f0965c3881cea128b70f53e6cb7","contract":["GrpcService initializes with EnvoyGrpc target specifier, cluster name, authority, request timeout, and initial metadata","GrpcService.ValidateAll succeeds for valid EnvoyGrpc service configuration","GrpcService.ValidateAll fails when TargetSpecifier is nil","GrpcService.ValidateAll fails when EnvoyGrpc cluster name is empty","GrpcService initializes with GoogleGrpc target specifier, target URI, and stat prefix","GrpcService.ValidateAll succeeds for valid GoogleGrpc service configuration","GrpcService.ValidateAll fails when GoogleGrpc target URI is empty"],"goal":"verify github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService in pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0","kind":"HOW","packages":["pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0"],"schemaVersion":1,"symbols":["github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","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/envoyproxy/go-control-plane/envoy@v1.37.0"],"schemaVersion":1,"subject":"pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0","symbols":["github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService"],"verifierAdapter":"golang@1"}

module sample

go 1.25.0

require (
	github.com/envoyproxy/go-control-plane/envoy v1.37.0
	google.golang.org/protobuf v1.36.11
)

require (
	github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2 // indirect
	github.com/envoyproxy/protoc-gen-validate v1.3.3 // indirect
	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
)

github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2 h1:aBangftG7EVZoUb69Os8IaYg++6uMOdKK83QtkkvJik=
github.com/cncf/xds/go v0.0.0-20260202195803-dba9d589def2/go.mod h1:qwXFYgsP6T7XnJtbKlf1HP8AjxZZyzxMmc+Lq5GjlU4=
github.com/envoyproxy/go-control-plane/envoy v1.37.0 h1:u3riX6BoYRfF4Dr7dwSOroNfdSbEPe9Yyl09/B6wBrQ=
github.com/envoyproxy/go-control-plane/envoy v1.37.0/go.mod h1:DReE9MMrmecPy+YvQOAOHNYMALuowAnbjjEMkkWOi6A=
github.com/envoyproxy/protoc-gen-validate v1.3.3 h1:MVQghNeW+LZcmXe7SY1V36Z+WFMDjpqGAGacLe2T0ds=
github.com/envoyproxy/protoc-gen-validate v1.3.3/go.mod h1:TsndJ/ngyIdQRhMcVVGDDHINPLWB7C82oDArY51KfB0=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 h1:GFCKgmp0tecUJ0sJuv4pzYCqS9+RGSn52M3FUwPs+uo=
github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10/go.mod h1:t/avpk3KcrXxUnYOhZhMXJlSEyie6gQbtLq5NM3loB8=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=

{
  "schemaVersion": 1,
  "goal": "verify github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService in pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/envoyproxy/go-control-plane/envoy@v1.37.0"
  ],
  "symbols": [
    "github.com/envoyproxy/go-control-plane/envoy/config/core/v3.GrpcService"
  ]
}

package main

import (
	"fmt"
	"os"
	"time"

	corev3 "github.com/envoyproxy/go-control-plane/envoy/config/core/v3"
	"google.golang.org/protobuf/types/known/durationpb"
)

func main() {
	if err := runContractTests(); err != nil {
		fmt.Fprintf(os.Stderr, "Contract test failed: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("All contract tests passed successfully.")
}

func runContractTests() error {
	// 1. GrpcService initializes with EnvoyGrpc target specifier, cluster name, authority, request timeout, and initial metadata
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_EnvoyGrpc_{
				EnvoyGrpc: &corev3.GrpcService_EnvoyGrpc{
					ClusterName: "grpc_backend_cluster",
					Authority:   "service.example.com",
				},
			},
			Timeout: durationpb.New(5 * time.Second),
			InitialMetadata: []*corev3.HeaderValue{
				{
					Key:   "x-client-id",
					Value: "client-worker-1",
				},
			},
		}

		envoyGrpc := service.GetEnvoyGrpc()
		if envoyGrpc == nil {
			return fmt.Errorf("expected non-nil EnvoyGrpc target specifier")
		}
		if envoyGrpc.GetClusterName() != "grpc_backend_cluster" {
			return fmt.Errorf("expected cluster name grpc_backend_cluster, got %q", envoyGrpc.GetClusterName())
		}
		if envoyGrpc.GetAuthority() != "service.example.com" {
			return fmt.Errorf("expected authority service.example.com, got %q", envoyGrpc.GetAuthority())
		}
		if service.GetTimeout().GetSeconds() != 5 {
			return fmt.Errorf("expected timeout of 5 seconds, got %d", service.GetTimeout().GetSeconds())
		}
		if len(service.GetInitialMetadata()) != 1 || service.GetInitialMetadata()[0].GetKey() != "x-client-id" {
			return fmt.Errorf("expected 1 initial metadata header with key x-client-id")
		}
	}

	// 2. GrpcService.ValidateAll succeeds for valid EnvoyGrpc service configuration
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_EnvoyGrpc_{
				EnvoyGrpc: &corev3.GrpcService_EnvoyGrpc{
					ClusterName: "grpc_backend_cluster",
					Authority:   "service.example.com",
				},
			},
			Timeout: durationpb.New(10 * time.Second),
			InitialMetadata: []*corev3.HeaderValue{
				{
					Key:   "x-trace-id",
					Value: "trace-abc-123",
				},
			},
		}
		if err := service.ValidateAll(); err != nil {
			return fmt.Errorf("expected ValidateAll to succeed, got error: %w", err)
		}
	}

	// 3. GrpcService.ValidateAll fails when TargetSpecifier is nil
	{
		service := &corev3.GrpcService{
			Timeout: durationpb.New(5 * time.Second),
		}
		if err := service.ValidateAll(); err == nil {
			return fmt.Errorf("expected ValidateAll to fail when TargetSpecifier is nil")
		}
	}

	// 4. GrpcService.ValidateAll fails when EnvoyGrpc cluster name is empty
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_EnvoyGrpc_{
				EnvoyGrpc: &corev3.GrpcService_EnvoyGrpc{
					ClusterName: "",
				},
			},
		}
		if err := service.ValidateAll(); err == nil {
			return fmt.Errorf("expected ValidateAll to fail when EnvoyGrpc cluster name is empty")
		}
	}

	// 5. GrpcService initializes with GoogleGrpc target specifier, target URI, and stat prefix
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_GoogleGrpc_{
				GoogleGrpc: &corev3.GrpcService_GoogleGrpc{
					TargetUri:  "dns:///localhost:50051",
					StatPrefix: "google_grpc_stats",
				},
			},
		}
		googleGrpc := service.GetGoogleGrpc()
		if googleGrpc == nil {
			return fmt.Errorf("expected non-nil GoogleGrpc target specifier")
		}
		if googleGrpc.GetTargetUri() != "dns:///localhost:50051" {
			return fmt.Errorf("expected target URI dns:///localhost:50051, got %q", googleGrpc.GetTargetUri())
		}
		if googleGrpc.GetStatPrefix() != "google_grpc_stats" {
			return fmt.Errorf("expected stat prefix google_grpc_stats, got %q", googleGrpc.GetStatPrefix())
		}
	}

	// 6. GrpcService.ValidateAll succeeds for valid GoogleGrpc service configuration
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_GoogleGrpc_{
				GoogleGrpc: &corev3.GrpcService_GoogleGrpc{
					TargetUri:  "dns:///localhost:50051",
					StatPrefix: "google_grpc_stats",
				},
			},
		}
		if err := service.ValidateAll(); err != nil {
			return fmt.Errorf("expected ValidateAll to succeed for GoogleGrpc, got: %w", err)
		}
	}

	// 7. GrpcService.ValidateAll fails when GoogleGrpc target URI is empty
	{
		service := &corev3.GrpcService{
			TargetSpecifier: &corev3.GrpcService_GoogleGrpc_{
				GoogleGrpc: &corev3.GrpcService_GoogleGrpc{
					TargetUri:  "",
					StatPrefix: "google_grpc_stats",
				},
			},
		}
		if err := service.ValidateAll(); err == nil {
			return fmt.Errorf("expected ValidateAll to fail when GoogleGrpc target URI is empty")
		}
	}

	return nil
}