google.golang.org/grpc v1.31.0: codes.Unavailable

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.Unavailable 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/codes.Unavailable

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:479edb2ce1c2249877660ae5492790763912598e2d03ef3912fc3a6e543e83a1","contract":["codes.Unavailable represents transient service unavailability with integer code 14 and string representation 'Unavailable'.","codes.Code.UnmarshalJSON unmarshals string 'UNAVAILABLE' and numeric 14 to codes.Unavailable.","status.Error and status.FromError associate errors with codes.Unavailable, verifiable via status.Code."],"goal":"verify google.golang.org/grpc/codes.Unavailable 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/codes.Unavailable"]},"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/codes.Unavailable"],"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=

package sample

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

// UnavailableCode returns the codes.Unavailable constant.
func UnavailableCode() codes.Code {
	return codes.Unavailable
}

// NewUnavailableError creates a gRPC error with status code Unavailable.
func NewUnavailableError(msg string) error {
	return status.Error(codes.Unavailable, msg)
}

// IsUnavailable reports whether err has gRPC status code Unavailable.
func IsUnavailable(err error) bool {
	return status.Code(err) == codes.Unavailable
}

{
  "schemaVersion": 1,
  "goal": "verify google.golang.org/grpc/codes.Unavailable 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/codes.Unavailable"
  ]
}

package main

import (
	"encoding/json"
	"errors"
	"fmt"
	"os"

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

func main() {
	// Assertion 1: codes.Unavailable represents transient service unavailability with numeric code 14 and string representation "Unavailable".
	if got := sample.UnavailableCode(); got != codes.Unavailable {
		fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected UnavailableCode() == codes.Unavailable, got %v\n", got)
		os.Exit(1)
	}
	if codes.Unavailable != 14 {
		fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected codes.Unavailable == 14, got %d\n", codes.Unavailable)
		os.Exit(1)
	}
	if got := codes.Unavailable.String(); got != "Unavailable" {
		fmt.Fprintf(os.Stderr, "Assertion 1 failed: expected codes.Unavailable.String() == %q, got %q\n", "Unavailable", got)
		os.Exit(1)
	}

	// Assertion 2: codes.Code.UnmarshalJSON unmarshals string "UNAVAILABLE" and numeric 14 to codes.Unavailable.
	var cStr codes.Code
	if err := json.Unmarshal([]byte(`"UNAVAILABLE"`), &cStr); err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: json.Unmarshal UNAVAILABLE failed: %v\n", err)
		os.Exit(1)
	}
	if cStr != codes.Unavailable {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected codes.Unavailable, got %v\n", cStr)
		os.Exit(1)
	}

	var cNum codes.Code
	if err := json.Unmarshal([]byte(`14`), &cNum); err != nil {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: json.Unmarshal 14 failed: %v\n", err)
		os.Exit(1)
	}
	if cNum != codes.Unavailable {
		fmt.Fprintf(os.Stderr, "Assertion 2 failed: expected codes.Unavailable, got %v\n", cNum)
		os.Exit(1)
	}

	// Assertion 3: status.Error and status.FromError associate errors with codes.Unavailable, verifiable via status.Code.
	msg := "service temporarily unavailable"
	err := sample.NewUnavailableError(msg)
	if err == nil {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected non-nil error\n")
		os.Exit(1)
	}
	if !sample.IsUnavailable(err) {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected IsUnavailable(err) to be true\n")
		os.Exit(1)
	}
	st, ok := status.FromError(err)
	if !ok || st == nil {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected status.FromError to succeed\n")
		os.Exit(1)
	}
	if st.Code() != codes.Unavailable {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected status code %v, got %v\n", codes.Unavailable, st.Code())
		os.Exit(1)
	}
	if st.Message() != msg {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected message %q, got %q\n", msg, st.Message())
		os.Exit(1)
	}
	if sample.IsUnavailable(status.Error(codes.Internal, "internal error")) {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected false for Internal error\n")
		os.Exit(1)
	}
	if sample.IsUnavailable(errors.New("plain error")) {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected false for plain error\n")
		os.Exit(1)
	}
	if sample.IsUnavailable(nil) {
		fmt.Fprintf(os.Stderr, "Assertion 3 failed: expected false for nil error\n")
		os.Exit(1)
	}

	fmt.Println("All contract assertions passed.")
}