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 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:
  - google.golang.org/protobuf/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.

package sample

import (
	"math"
	"testing"

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

// TestEqual_NilAndTypedNil verifies proto.Equal behavior on untyped nil vs typed nil message pointers.
func TestEqual_NilAndTypedNil(t *testing.T) {
	// Both untyped nil evaluate to true
	if !proto.Equal(nil, nil) {
		t.Fatal("expected proto.Equal(nil, nil) to be true")
	}

	// Two typed nil pointers of the same type evaluate to true
	var a, b *wrapperspb.StringValue
	if !proto.Equal(a, b) {
		t.Fatal("expected proto.Equal(typedNil, typedNil) of same type to be true")
	}

	// Untyped nil compared with a typed nil pointer evaluates to false in Go interface semantics
	if proto.Equal(nil, a) || proto.Equal(a, nil) {
		t.Fatal("expected proto.Equal between untyped nil and typed nil pointer to be false")
	}
}

// TestEqual_NilAndNonNil verifies proto.Equal returns false when one message is nil and the other is non-nil.
func TestEqual_NilAndNonNil(t *testing.T) {
	msg := wrapperspb.String("test")
	if proto.Equal(nil, msg) {
		t.Fatal("expected proto.Equal(nil, msg) to be false")
	}
	if proto.Equal(msg, nil) {
		t.Fatal("expected proto.Equal(msg, nil) to be false")
	}

	var typedNil *wrapperspb.StringValue
	if proto.Equal(typedNil, msg) || proto.Equal(msg, typedNil) {
		t.Fatal("expected proto.Equal(typedNil, msg) to be false")
	}
}

// TestEqual_IdenticalValues verifies proto.Equal returns true for distinct message instances with identical populated field values.
func TestEqual_IdenticalValues(t *testing.T) {
	ts1 := &timestamppb.Timestamp{Seconds: 1700000000, Nanos: 123456}
	ts2 := &timestamppb.Timestamp{Seconds: 1700000000, Nanos: 123456}

	if ts1 == ts2 {
		t.Fatal("expected distinct pointer instances")
	}
	if !proto.Equal(ts1, ts2) {
		t.Fatal("expected proto.Equal(ts1, ts2) to be true for identical field values")
	}
}

// TestEqual_DifferentDescriptors verifies proto.Equal returns false when comparing messages belonging to different message descriptors.
func TestEqual_DifferentDescriptors(t *testing.T) {
	emptyMsg := &emptypb.Empty{}
	strMsg := &wrapperspb.StringValue{}

	if proto.Equal(emptyMsg, strMsg) {
		t.Fatal("expected proto.Equal to be false when descriptors differ")
	}

	// Different descriptors even if both are typed nil
	var nilEmpty *emptypb.Empty
	var nilStr *wrapperspb.StringValue
	if proto.Equal(nilEmpty, nilStr) {
		t.Fatal("expected proto.Equal to be false for typed nils of different descriptors")
	}
}

// TestEqual_DifferingValues verifies proto.Equal returns false when messages of the same type contain differing field values.
func TestEqual_DifferingValues(t *testing.T) {
	s1 := wrapperspb.String("apple")
	s2 := wrapperspb.String("banana")

	if proto.Equal(s1, s2) {
		t.Fatal("expected proto.Equal(s1, s2) to be false for different field values")
	}

	ts1 := &timestamppb.Timestamp{Seconds: 100, Nanos: 0}
	ts2 := &timestamppb.Timestamp{Seconds: 100, Nanos: 1}
	if proto.Equal(ts1, ts2) {
		t.Fatal("expected proto.Equal to be false when nanos differ")
	}
}

// TestEqual_FloatingPointNaN verifies proto.Equal treats floating-point NaN values as equal unlike standard IEEE 754 float comparison.
func TestEqual_FloatingPointNaN(t *testing.T) {
	d1 := wrapperspb.Double(math.NaN())
	d2 := wrapperspb.Double(math.NaN())

	if d1.GetValue() == d2.GetValue() {
		t.Fatal("expected standard float comparison to evaluate NaN == NaN as false")
	}

	if !proto.Equal(d1, d2) {
		t.Fatal("expected proto.Equal to evaluate NaNs as equal")
	}
}

{"case":{"caseId":"case:sha256:29c3293bcce949a61ef828f239bb4e15d3fda98907eaa0f354630d5886bde5ae","contract":["proto.Equal returns true when both messages are untyped nil or typed nil pointers of the same type","proto.Equal returns false when comparing an untyped nil interface with a typed nil message pointer","proto.Equal returns false when one message is nil and the other is a populated non-nil message","proto.Equal returns true for distinct message instances with identical populated field values","proto.Equal returns false when comparing messages belonging to different message descriptors","proto.Equal returns false when messages of the same type contain differing field values","proto.Equal treats floating-point NaN values as equal unlike standard IEEE 754 float comparison"],"goal":"verify 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":["google.golang.org/protobuf/proto.Equal"]},"contractCommand":["go","test","./..."],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"golang","executionContext":"go","language":"go","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"go","runtime":"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":["google.golang.org/protobuf/proto.Equal"],"verifierAdapter":"golang@1"}

module sample

go 1.26.6

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=

{
  "schemaVersion": 1,
  "goal": "verify 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": [
    "google.golang.org/protobuf/proto.Equal"
  ]
}