google.golang.org/protobuf v1.26.0-rc.1: proto.Equal

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 proto.Equal in pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1
Demonstrate these symbols/APIs:
  - proto.Equal

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:80ab0df695adde9d4277bc4486bc53dca3b03b73bcc2e06c04326f0cb6df49a5","contract":["proto.Equal returns true when comparing two identical protobuf messages","proto.Equal returns false when messages have different field values","proto.Equal returns true when comparing two nil message pointers of identical types","proto.Equal returns false when comparing a nil message pointer with a non-nil message","proto.Equal returns false when comparing messages of different types","proto.Equal correctly compares complex structpb.Struct messages"],"goal":"verify proto.Equal in pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1","kind":"HOW","packages":["pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1"],"schemaVersion":1,"symbols":["proto.Equal"]},"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/protobuf@v1.26.0-rc.1"],"schemaVersion":1,"subject":"pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1","symbols":["proto.Equal"],"verifierAdapter":"golang@1"}

module sample

go 1.23

require google.golang.org/protobuf v1.26.0-rc.1

github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/protobuf v1.26.0-rc.1 h1:7QnIQpGRHE5RnLKnESfDoxm2dTapTZua5a0kS0A+VXQ=
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=

package sample

import (
	"google.golang.org/protobuf/proto"
)

// CheckEqual reports whether two protobuf messages are equal using proto.Equal.
func CheckEqual(a, b proto.Message) bool {
	return proto.Equal(a, b)
}

{
  "schemaVersion": 1,
  "goal": "verify proto.Equal in pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1",
  "kind": "HOW",
  "packages": [
    "pkg:golang/google.golang.org/protobuf@v1.26.0-rc.1"
  ],
  "symbols": [
    "proto.Equal"
  ]
}

package main

import (
	"fmt"
	"os"

	"sample"

	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/known/structpb"
	"google.golang.org/protobuf/types/known/wrapperspb"
)

func main() {
	// 1. proto.Equal returns true when comparing two identical protobuf messages
	msg1 := wrapperspb.String("hello")
	msg2 := wrapperspb.String("hello")
	if !proto.Equal(msg1, msg2) {
		fmt.Fprintf(os.Stderr, "FAIL: expected identical messages to be equal\n")
		os.Exit(1)
	}
	if !sample.CheckEqual(msg1, msg2) {
		fmt.Fprintf(os.Stderr, "FAIL: sample.CheckEqual expected true for identical messages\n")
		os.Exit(1)
	}

	// 2. proto.Equal returns false when messages have different field values
	msg3 := wrapperspb.String("world")
	if proto.Equal(msg1, msg3) {
		fmt.Fprintf(os.Stderr, "FAIL: expected different messages to not be equal\n")
		os.Exit(1)
	}
	if sample.CheckEqual(msg1, msg3) {
		fmt.Fprintf(os.Stderr, "FAIL: sample.CheckEqual expected false for different messages\n")
		os.Exit(1)
	}

	// 3. proto.Equal returns true when comparing two nil message pointers of identical types
	var nil1, nil2 *wrapperspb.StringValue
	if !proto.Equal(nil1, nil2) {
		fmt.Fprintf(os.Stderr, "FAIL: expected two nil pointers to be equal\n")
		os.Exit(1)
	}

	// 4. proto.Equal returns false when comparing a nil message pointer with a non-nil message
	if proto.Equal(nil1, msg1) || proto.Equal(msg1, nil1) {
		fmt.Fprintf(os.Stderr, "FAIL: expected nil and non-nil messages to not be equal\n")
		os.Exit(1)
	}

	// 5. proto.Equal returns false when comparing messages of different types
	msgInt := wrapperspb.Int32(42)
	if proto.Equal(msg1, msgInt) {
		fmt.Fprintf(os.Stderr, "FAIL: expected different message types to not be equal\n")
		os.Exit(1)
	}

	// 6. proto.Equal correctly compares complex structpb.Struct messages
	s1, err := structpb.NewStruct(map[string]any{
		"key": "value",
		"num": float64(123),
	})
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: error creating structpb s1: %v\n", err)
		os.Exit(1)
	}
	s2, err := structpb.NewStruct(map[string]any{
		"key": "value",
		"num": float64(123),
	})
	if err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: error creating structpb s2: %v\n", err)
		os.Exit(1)
	}
	if !proto.Equal(s1, s2) {
		fmt.Fprintf(os.Stderr, "FAIL: expected identical structs to be equal\n")
		os.Exit(1)
	}

	fmt.Println("PASS")
}