google.golang.org/grpc v1.31.0: status.Status

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/grpc/status.Status in pkg:golang/google.golang.org/grpc@v1.31.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/google.golang.org/grpc@v1.31.0
Demonstrate these symbols/APIs:
  - google.golang.org/grpc/status.Status

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:ba294b1a94df2fed29385d26e46402715dc06eb64c3757a388d7b2bb2243c901","contract":["status.New constructs a Status object with the given code and message","status.Newf constructs a formatted Status object with formatting arguments","Status.Err returns an error representing the Status and status.FromError retrieves the original Status","status.Code extracts the status code from error or returns OK for nil error","status.Convert converts errors into Status instances returning nil for nil error"],"goal":"verify google.golang.org/grpc/status.Status in pkg:golang/google.golang.org/grpc@v1.31.0","kind":"HOW","packages":["pkg:golang/google.golang.org/grpc@v1.31.0"],"schemaVersion":1,"symbols":["google.golang.org/grpc/status.Status"]},"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/grpc@v1.31.0"],"schemaVersion":1,"subject":"pkg:golang/google.golang.org/grpc@v1.31.0","symbols":["google.golang.org/grpc/status.Status"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

require google.golang.org/grpc v1.31.0

require (
	github.com/golang/protobuf v1.3.3 // indirect
	google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55 // indirect
)

cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
github.com/envoyproxy/go-control-plane v0.9.0/go.mod h1:YTl/9mNaCwkRvm6d1a2C3ymFceY/DCBVvsKhRF0iEA4=
github.com/envoyproxy/go-control-plane v0.9.4/go.mod h1:6rpuAdCZL397s3pYoYcLgu1mIlRU8Am5FuJP05cCM98=
github.com/envoyproxy/protoc-gen-validate v0.1.0/go.mod h1:iSmxcyjqTsJpI2R4NaDN7+kN2VEUnK/pcBlmesArF7c=
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q=
github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A=
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.2/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
github.com/golang/protobuf v1.3.3 h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I=
github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw=
github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=
github.com/google/go-cmp v0.4.0 h1:xsAVV57WRhGj6kEIi8ReJzQlHHqcBYCElAvkovg3B/4=
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc=
golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190213061140-3a22650c66bd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
golang.org/x/net v0.0.0-20190311183353-d8887717615a h1:oWX7TPOiFAMXLq8o0ikBYfCJVlRHBcsciT5bXOrH628=
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a h1:1BGLXjeY4akVXGgbC9HugT3Jv3hCI0z56oJR5vAMgBU=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/tools v0.0.0-20190114222345-bf090417da8b/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20190226205152-f727befe758c/go.mod h1:9Yl7xja0Znq3iFh3HoIrodX9oNMXvdceNzlUR8zjMvY=
golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBnxXauZ1Gv1EHHAz9KjViQ78xBX0Q=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
google.golang.org/genproto v0.0.0-20180817151627-c66870c02cf8/go.mod h1:JiN7NxoALGmiZfu7CAH4rXhgtRTLTxftemlI0sWmxmc=
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55 h1:gSJIx1SDwno+2ElGhA4+qG2zF97qiUzTM+rQ0klBOcE=
google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98Agz4BDEuKkezgsaosCRResVns1a3J2ZsMNc=
google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
google.golang.org/grpc v1.31.0 h1:T7P4R73V3SSDPhH7WW7ATbfViLtmamH0DKrP3f9AuDI=
google.golang.org/grpc v1.31.0/go.mod h1:N36X2cJ7JwdamYAgDz+s+rVMFjt3numwzf/HckM8pak=
honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=

{
  "schemaVersion": 1,
  "goal": "verify google.golang.org/grpc/status.Status in pkg:golang/google.golang.org/grpc@v1.31.0",
  "kind": "HOW",
  "packages": [
    "pkg:golang/google.golang.org/grpc@v1.31.0"
  ],
  "symbols": [
    "google.golang.org/grpc/status.Status"
  ]
}

package sample

import (
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

// NewStatus creates a new Status pointer with the given code and message.
func NewStatus(code codes.Code, msg string) *status.Status {
	return status.New(code, msg)
}

// NewStatusf creates a formatted Status pointer with the given code and format string.
func NewStatusf(code codes.Code, format string, args ...interface{}) *status.Status {
	return status.Newf(code, format, args...)
}

// StatusToError converts a Status to an error interface.
func StatusToError(s *status.Status) error {
	if s == nil {
		return nil
	}
	return s.Err()
}

// ErrorToStatus extracts a Status from an error if possible.
func ErrorToStatus(err error) (*status.Status, bool) {
	return status.FromError(err)
}

// ConvertError converts any error into a Status pointer.
func ConvertError(err error) *status.Status {
	return status.Convert(err)
}

// GetCode extracts the status code from an error.
func GetCode(err error) codes.Code {
	return status.Code(err)
}

package main

import (
	"errors"
	"fmt"
	"os"

	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
	"sample"
)

func main() {
	fmt.Println("Running contract tests for google.golang.org/grpc/status.Status...")

	// Assertion 1: status.New constructs a Status object with the given code and message
	{
		var st *status.Status = sample.NewStatus(codes.NotFound, "entity not found")
		if st == nil {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: status is nil\n")
			os.Exit(1)
		}
		if st.Code() != codes.NotFound {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected code NotFound, got %v\n", st.Code())
			os.Exit(1)
		}
		if st.Message() != "entity not found" {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected message 'entity not found', got '%s'\n", st.Message())
			os.Exit(1)
		}
		if st.Proto().GetCode() != int32(codes.NotFound) {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: proto code mismatch: %d\n", st.Proto().GetCode())
			os.Exit(1)
		}
		if st.Proto().GetMessage() != "entity not found" {
			fmt.Fprintf(os.Stderr, "Assertion 1 failed: proto message mismatch: '%s'\n", st.Proto().GetMessage())
			os.Exit(1)
		}
		fmt.Println("  ✓ Assertion 1 passed: status.New constructs Status with code and message")
	}

	// Assertion 2: status.Newf constructs a formatted Status object with formatting arguments
	{
		st := sample.NewStatusf(codes.InvalidArgument, "invalid item id: %d", 42)
		if st == nil {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: status is nil\n")
			os.Exit(1)
		}
		if st.Code() != codes.InvalidArgument {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected code InvalidArgument, got %v\n", st.Code())
			os.Exit(1)
		}
		if st.Message() != "invalid item id: 42" {
			fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected message 'invalid item id: 42', got '%s'\n", st.Message())
			os.Exit(1)
		}
		fmt.Println("  ✓ Assertion 2 passed: status.Newf constructs formatted Status")
	}

	// Assertion 3: Status.Err returns an error representing the Status and status.FromError retrieves the original Status
	{
		st := sample.NewStatus(codes.PermissionDenied, "access denied")
		err := sample.StatusToError(st)
		if err == nil {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected non-nil error from non-OK status\n")
			os.Exit(1)
		}
		expectedErrStr := "rpc error: code = PermissionDenied desc = access denied"
		if err.Error() != expectedErrStr {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected '%s', got '%s'\n", expectedErrStr, err.Error())
			os.Exit(1)
		}

		extracted, ok := sample.ErrorToStatus(err)
		if !ok || extracted == nil {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: status.FromError failed to extract status\n")
			os.Exit(1)
		}
		if extracted.Code() != codes.PermissionDenied {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: extracted code mismatch: %v\n", extracted.Code())
			os.Exit(1)
		}
		if extracted.Message() != "access denied" {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: extracted message mismatch: '%s'\n", extracted.Message())
			os.Exit(1)
		}

		// Also verify that OK status returns nil error
		okStatus := sample.NewStatus(codes.OK, "")
		if okErr := sample.StatusToError(okStatus); okErr != nil {
			fmt.Fprintf(os.Stderr, "Assertion 3 failed: OK status should produce nil error, got %v\n", okErr)
			os.Exit(1)
		}
		fmt.Println("  ✓ Assertion 3 passed: Status.Err and status.FromError bidirectional conversion")
	}

	// Assertion 4: status.Code extracts the status code from error or returns OK for nil error
	{
		if c := sample.GetCode(nil); c != codes.OK {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: nil error should return OK, got %v\n", c)
			os.Exit(1)
		}

		st := sample.NewStatus(codes.ResourceExhausted, "quota exceeded")
		if c := sample.GetCode(sample.StatusToError(st)); c != codes.ResourceExhausted {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: expected ResourceExhausted, got %v\n", c)
			os.Exit(1)
		}

		plainErr := errors.New("arbitrary standard error")
		if c := sample.GetCode(plainErr); c != codes.Unknown {
			fmt.Fprintf(os.Stderr, "Assertion 4 failed: plain error should return Unknown, got %v\n", c)
			os.Exit(1)
		}
		fmt.Println("  ✓ Assertion 4 passed: status.Code extracts code from errors")
	}

	// Assertion 5: status.Convert converts errors into Status instances returning nil for nil error
	{
		convNil := sample.ConvertError(nil)
		if convNil != nil {
			fmt.Fprintf(os.Stderr, "Assertion 5 failed: Convert(nil) should yield nil, got %v\n", convNil)
			os.Exit(1)
		}

		st := sample.NewStatus(codes.Unauthenticated, "missing bearer token")
		convGrpc := sample.ConvertError(sample.StatusToError(st))
		if convGrpc == nil || convGrpc.Code() != codes.Unauthenticated || convGrpc.Message() != "missing bearer token" {
			fmt.Fprintf(os.Stderr, "Assertion 5 failed: Convert(grpcErr) mismatch\n")
			os.Exit(1)
		}

		plainErr := errors.New("database timeout")
		convPlain := sample.ConvertError(plainErr)
		if convPlain == nil || convPlain.Code() != codes.Unknown || convPlain.Message() != "database timeout" {
			fmt.Fprintf(os.Stderr, "Assertion 5 failed: Convert(plainErr) mismatch\n")
			os.Exit(1)
		}
		fmt.Println("  ✓ Assertion 5 passed: status.Convert converts errors returning nil for nil error")
	}

	fmt.Println("All contract tests passed successfully!")
}