tests(math): document unexpected behavior in nil values (#21806)

This commit is contained in:
Matt Kocubinski 2024-09-19 00:47:50 -05:00 committed by GitHub
parent 01212de2d9
commit b8014dfe68
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1025,3 +1025,36 @@ func TestQuoMut(t *testing.T) {
})
}
}
func Test_DocumentLegacyAsymmetry(t *testing.T) {
zeroDec := math.LegacyZeroDec()
emptyDec := math.LegacyDec{}
zeroDecBz, err := zeroDec.Marshal()
require.NoError(t, err)
zeroDecJSON := zeroDec.String()
emptyDecBz, err := emptyDec.Marshal()
require.NoError(t, err)
emptyDecJSON := emptyDec.String()
// makes sense, zero and empty are semantically different and render differently
require.NotEqual(t, zeroDecJSON, emptyDecJSON)
// but on the proto wire they encode to the same bytes
require.Equal(t, zeroDecBz, emptyDecBz)
// zero values are symmetrical
zeroDecRoundTrip := math.LegacyDec{}
err = zeroDecRoundTrip.Unmarshal(zeroDecBz)
require.NoError(t, err)
require.Equal(t, zeroDec.String(), zeroDecRoundTrip.String())
require.Equal(t, zeroDec, zeroDecRoundTrip)
// empty values are not
emptyDecRoundTrip := math.LegacyDec{}
err = emptyDecRoundTrip.Unmarshal(emptyDecBz)
require.NoError(t, err)
// !!! this is the key point, they are not equal, it looks like a bug
require.NotEqual(t, emptyDec.String(), emptyDecRoundTrip.String())
require.NotEqual(t, emptyDec, emptyDecRoundTrip)
}