google.golang.org/grpc v1.82.1: codes.Code

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/codes.Code in pkg:golang/google.golang.org/grpc@v1.82.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/google.golang.org/grpc@v1.82.1
Demonstrate these symbols/APIs:
  - google.golang.org/grpc/codes.Code

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:dd777c6a2deffdfbfc0fc79c0b1e8c447369e5579fad91f7577542212c84f99c","contract":["codes.Code formats canonical gRPC status codes (0 to 16) as PascalCase strings and unknown values as Code(N).","codes.Code.UnmarshalJSON parses canonical uppercase strings like INVALID_ARGUMENT and CANCELLED, parses numeric codes within range [0, 16], treats null as no-op, and rejects unknown strings, out-of-range numbers, or nil receivers.","status.Code extracts exact codes.Code from status errors, returns codes.OK for nil errors, and returns codes.Unknown for non-status errors."],"goal":"verify google.golang.org/grpc/codes.Code in pkg:golang/google.golang.org/grpc@v1.82.1","kind":"HOW","packages":["pkg:golang/google.golang.org/grpc@v1.82.1"],"schemaVersion":1,"symbols":["google.golang.org/grpc/codes.Code"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","language":"go","libc":"glibc","libcVersion":"2.39","moduleSystem":"go.mod","os":"linux","osVersionBucket":"24","packageManager":"go","packageManagerVersion":"1.26.6","runtime":"go","runtimeVersion":"1.26.6","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/google.golang.org/grpc@v1.82.1"],"schemaVersion":1,"subject":"pkg:golang/google.golang.org/grpc@v1.82.1","symbols":["google.golang.org/grpc/codes.Code"],"verifierAdapter":"golang@1"}

module example.com/grpccodes

go 1.26.6

require google.golang.org/grpc v1.82.1

require (
	golang.org/x/sys v0.43.0 // indirect
	google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478 // indirect
	google.golang.org/protobuf v1.36.11 // indirect
)

github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
github.com/golang/protobuf v1.5.4/go.mod h1:lnTiLA8Wa4RWRcIUkrtSVa5nRhsEGBg48fD6rSs7xps=
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
golang.org/x/net v0.53.0 h1:d+qAbo5L0orcWAr0a9JweQpjXF19LMXJE8Ey7hwOdUA=
golang.org/x/net v0.53.0/go.mod h1:JvMuJH7rrdiCfbeHoo3fCQU24Lf5JJwT9W3sJFulfgs=
golang.org/x/sys v0.43.0 h1:Rlag2XtaFTxp19wS8MXlJwTvoh8ArU6ezoyFsMyCTNI=
golang.org/x/sys v0.43.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
golang.org/x/text v0.36.0 h1:JfKh3XmcRPqZPKevfXVpI1wXPTqbkE5f7JA92a55Yxg=
golang.org/x/text v0.36.0/go.mod h1:NIdBknypM8iqVmPiuco0Dh6P5Jcdk8lJL0CUebqK164=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478 h1:RmoJA1ujG+/lRGNfUnOMfhCy5EipVMyvUE+KNbPbTlw=
google.golang.org/genproto/googleapis/rpc v0.0.0-20260414002931-afd174a4e478/go.mod h1:4Hqkh8ycfw05ld/3BWL7rJOSfebL2Q+DVDeRgYgxUU8=
google.golang.org/grpc v1.82.1 h1:NnAxzGRA0677vCa4BUkOAnO5+FfQqVl9iUXeD0IqcGE=
google.golang.org/grpc v1.82.1/go.mod h1:yzTZ1TB1Z3SG+LIYaI+WiE8D5+PZ3ArnrSp8zF3+/ZA=
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=

package grpccodes

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

// StatusCode returns the canonical gRPC Code associated with err.
func StatusCode(err error) codes.Code {
	return status.Code(err)
}

// FormatCode returns the string representation of a gRPC Code.
func FormatCode(c codes.Code) string {
	return c.String()
}

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

package contract_test

import (
	"encoding/json"
	"errors"
	"testing"

	grpccodes "example.com/grpccodes"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

func TestCodeStringFormatting(t *testing.T) {
	testCases := []struct {
		code codes.Code
		want string
	}{
		{codes.OK, "OK"},
		{codes.Canceled, "Canceled"},
		{codes.Unknown, "Unknown"},
		{codes.InvalidArgument, "InvalidArgument"},
		{codes.DeadlineExceeded, "DeadlineExceeded"},
		{codes.NotFound, "NotFound"},
		{codes.AlreadyExists, "AlreadyExists"},
		{codes.PermissionDenied, "PermissionDenied"},
		{codes.ResourceExhausted, "ResourceExhausted"},
		{codes.FailedPrecondition, "FailedPrecondition"},
		{codes.Aborted, "Aborted"},
		{codes.OutOfRange, "OutOfRange"},
		{codes.Unimplemented, "Unimplemented"},
		{codes.Internal, "Internal"},
		{codes.Unavailable, "Unavailable"},
		{codes.DataLoss, "DataLoss"},
		{codes.Unauthenticated, "Unauthenticated"},
		{codes.Code(999), "Code(999)"},
	}

	for _, tc := range testCases {
		if got := tc.code.String(); got != tc.want {
			t.Errorf("codes.Code(%d).String() = %q, want %q", tc.code, got, tc.want)
		}
		if got := grpccodes.FormatCode(tc.code); got != tc.want {
			t.Errorf("grpccodes.FormatCode(%d) = %q, want %q", tc.code, got, tc.want)
		}
	}
}

func TestCodeJSONUnmarshal(t *testing.T) {
	// 1. Valid uppercase string names
	var c codes.Code
	if err := json.Unmarshal([]byte(`"INVALID_ARGUMENT"`), &c); err != nil {
		t.Fatalf("json.Unmarshal INVALID_ARGUMENT failed: %v", err)
	}
	if c != codes.InvalidArgument {
		t.Fatalf("expected InvalidArgument, got %v", c)
	}

	if err := json.Unmarshal([]byte(`"CANCELLED"`), &c); err != nil {
		t.Fatalf("json.Unmarshal CANCELLED failed: %v", err)
	}
	if c != codes.Canceled {
		t.Fatalf("expected Canceled, got %v", c)
	}

	// 2. Numeric strings within valid range
	if err := json.Unmarshal([]byte(`5`), &c); err != nil {
		t.Fatalf("json.Unmarshal 5 failed: %v", err)
	}
	if c != codes.NotFound {
		t.Fatalf("expected NotFound, got %v", c)
	}

	// 3. "null" is a no-op
	c = codes.PermissionDenied
	if err := c.UnmarshalJSON([]byte("null")); err != nil {
		t.Fatalf("UnmarshalJSON null failed: %v", err)
	}
	if c != codes.PermissionDenied {
		t.Fatalf("expected c to remain PermissionDenied after null, got %v", c)
	}

	// 4. Out-of-range integer code returns an error
	if err := c.UnmarshalJSON([]byte("17")); err == nil {
		t.Fatalf("expected error unmarshaling 17, got nil")
	}

	// 5. Unknown string code returns an error
	if err := c.UnmarshalJSON([]byte(`"NON_EXISTENT_CODE"`)); err == nil {
		t.Fatalf("expected error unmarshaling NON_EXISTENT_CODE, got nil")
	}

	// 6. Nil receiver returns error
	var nilCode *codes.Code
	if err := nilCode.UnmarshalJSON([]byte(`"OK"`)); err == nil {
		t.Fatalf("expected error unmarshaling with nil receiver, got nil")
	}
}

func TestCodeStatusIntegration(t *testing.T) {
	// 1. Status creation and code extraction
	st := status.New(codes.NotFound, "resource not found")
	if st.Code() != codes.NotFound {
		t.Fatalf("expected st.Code() == codes.NotFound, got %v", st.Code())
	}
	if st.Message() != "resource not found" {
		t.Fatalf("expected message 'resource not found', got %q", st.Message())
	}

	// 2. Extract code from status error
	err := st.Err()
	if got := status.Code(err); got != codes.NotFound {
		t.Fatalf("expected status.Code(err) == codes.NotFound, got %v", got)
	}
	if got := grpccodes.StatusCode(err); got != codes.NotFound {
		t.Fatalf("expected grpccodes.StatusCode(err) == codes.NotFound, got %v", got)
	}

	// 3. Nil error maps to codes.OK
	if got := status.Code(nil); got != codes.OK {
		t.Fatalf("expected status.Code(nil) == codes.OK, got %v", got)
	}
	if got := grpccodes.StatusCode(nil); got != codes.OK {
		t.Fatalf("expected grpccodes.StatusCode(nil) == codes.OK, got %v", got)
	}

	// 4. Generic non-status error maps to codes.Unknown
	genericErr := errors.New("arbitrary error")
	if got := status.Code(genericErr); got != codes.Unknown {
		t.Fatalf("expected status.Code(genericErr) == codes.Unknown, got %v", got)
	}
	if got := grpccodes.StatusCode(genericErr); got != codes.Unknown {
		t.Fatalf("expected grpccodes.StatusCode(genericErr) == codes.Unknown, got %v", got)
	}
}