google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9: errdetails.QuotaFailure

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 google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9
Demonstrate these symbols/APIs:
  - google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: esm
  - 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:331098661f488182466fbb3de5dc9e49fc4258f941dd3e36b6a0480d21298133","contract":["NewQuotaFailure creates a QuotaFailure with provided violations","QuotaFailure GetViolations returns the violation slice","QuotaFailure_Violation holds Subject and Description fields accessible via getters","AddViolation appends a violation to an existing QuotaFailure","GetViolationCount returns the total number of violations","QuotaFailure Reset clears violations to empty","QuotaFailure ProtoMessage satisfies proto.Message interface"],"goal":"verify google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9","kind":"HOW","packages":["pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"],"schemaVersion":1,"symbols":["google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure"]},"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/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"],"schemaVersion":1,"subject":"pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9","symbols":["google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require (
	google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9
	google.golang.org/protobuf v1.35.1
)

github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9 h1:QCqS/PdaHTSWGvupk2F/ehwHtGc0/GYkT+3GAcR1CCc=
google.golang.org/genproto/googleapis/rpc v0.0.0-20241007155032-5fefd90f89a9/go.mod h1:GX3210XPVPUjJbTUbvwI8f2IpZDMZuPJWDzDuebbviI=
google.golang.org/protobuf v1.35.1 h1:m3LfL6/Ca+fqnjnlqQXNpFPABW1UD7mjh8KO2mKFytA=
google.golang.org/protobuf v1.35.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=

package sample

import (
	"google.golang.org/genproto/googleapis/rpc/errdetails"
)

// NewQuotaFailure creates a QuotaFailure with the given violations.
func NewQuotaFailure(violations []*errdetails.QuotaFailure_Violation) *errdetails.QuotaFailure {
	return &errdetails.QuotaFailure{
		Violations: violations,
	}
}

// NewViolation creates a QuotaFailure_Violation with the given subject and description.
func NewViolation(subject, description string) *errdetails.QuotaFailure_Violation {
	return &errdetails.QuotaFailure_Violation{
		Subject:     subject,
		Description: description,
	}
}

// AddViolation appends a violation to an existing QuotaFailure.
func AddViolation(qf *errdetails.QuotaFailure, subject, description string) {
	if qf == nil {
		return
	}
	qf.Violations = append(qf.Violations, NewViolation(subject, description))
}

// GetViolationCount returns the number of violations in the QuotaFailure.
func GetViolationCount(qf *errdetails.QuotaFailure) int {
	if qf == nil {
		return 0
	}
	return len(qf.GetViolations())
}

{
  "schemaVersion": 1,
  "goal": "verify google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure in pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9",
  "kind": "HOW",
  "packages": [
    "pkg:golang/google.golang.org/genproto/googleapis/rpc@v0.0.0-20241007155032-5fefd90f89a9"
  ],
  "symbols": [
    "google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "esm",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

package main

import (
	"fmt"
	"os"

	"google.golang.org/genproto/googleapis/rpc/errdetails"
	"google.golang.org/protobuf/proto"
	"sample"
)

func main() {
	// Assertion 1: NewQuotaFailure creates a QuotaFailure with provided violations
	v1 := sample.NewViolation("project:12345", "Rate limit exceeded for daily API calls")
	qf := sample.NewQuotaFailure([]*errdetails.QuotaFailure_Violation{v1})
	if qf == nil {
		fmt.Fprintf(os.Stderr, "expected non-nil QuotaFailure\n")
		os.Exit(1)
	}

	// Assertion 2: QuotaFailure GetViolations returns the violation slice
	violations := qf.GetViolations()
	if len(violations) != 1 {
		fmt.Fprintf(os.Stderr, "expected 1 violation, got %d\n", len(violations))
		os.Exit(1)
	}

	// Assertion 3: QuotaFailure_Violation holds Subject and Description fields accessible via getters
	if violations[0].GetSubject() != "project:12345" {
		fmt.Fprintf(os.Stderr, "expected subject 'project:12345', got %q\n", violations[0].GetSubject())
		os.Exit(1)
	}
	if violations[0].GetDescription() != "Rate limit exceeded for daily API calls" {
		fmt.Fprintf(os.Stderr, "expected description 'Rate limit exceeded for daily API calls', got %q\n", violations[0].GetDescription())
		os.Exit(1)
	}

	// Assertion 4: AddViolation appends a violation to an existing QuotaFailure
	sample.AddViolation(qf, "client:user-abc", "Concurrent query limit exceeded")
	if len(qf.GetViolations()) != 2 {
		fmt.Fprintf(os.Stderr, "expected 2 violations after AddViolation, got %d\n", len(qf.GetViolations()))
		os.Exit(1)
	}

	// Assertion 5: GetViolationCount returns the total number of violations
	if count := sample.GetViolationCount(qf); count != 2 {
		fmt.Fprintf(os.Stderr, "expected GetViolationCount to return 2, got %d\n", count)
		os.Exit(1)
	}

	// Assertion 6: QuotaFailure Reset clears violations to empty
	qf.Reset()
	if len(qf.GetViolations()) != 0 {
		fmt.Fprintf(os.Stderr, "expected 0 violations after Reset, got %d\n", len(qf.GetViolations()))
		os.Exit(1)
	}

	// Assertion 7: QuotaFailure ProtoMessage satisfies proto.Message interface
	var msg proto.Message = qf
	if msg == nil {
		fmt.Fprintf(os.Stderr, "expected QuotaFailure to satisfy proto.Message\n")
		os.Exit(1)
	}

	fmt.Println("All google.golang.org/genproto/googleapis/rpc/errdetails.QuotaFailure contract assertions passed.")
}