fyrchik/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Issues Pull requests 12 Projects Releases Packages Wiki Activity

[#302] pkg/object: Document default values set in NewID

Browse source 
Document field values of instance constructed via `NewID`.
Assert the values in corresponding unit test.

Signed-off-by: Pavel Karpy <carpawell@nspcc.ru>
This commit is contained in:
Pavel Karpy 2021-06-08 19:01:00 +03:00 committed by Alex Vanin
parent 245a55f715
commit 6c12b4dfb6
2 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
pkg/object/id.go
View file

@ -25,6 +25,9 @@ func NewIDFromV2(idV2 *refs.ObjectID) *ID {
// NewID creates and initializes blank ID. // NewID creates and initializes blank ID.
// //
// Works similar as NewIDFromV2(new(ObjectID)). // Works similar as NewIDFromV2(new(ObjectID)).
//
// Defaults:
// - value: nil.
func NewID() *ID { func NewID() *ID {
return NewIDFromV2(new(refs.ObjectID)) return NewIDFromV2(new(refs.ObjectID))
} }

16
pkg/object/id_test.go
View file

@ -71,6 +71,11 @@ func TestID_Parse(t *testing.T) {
} }
func TestID_String(t *testing.T) { func TestID_String(t *testing.T) {
t.Run("nil", func(t *testing.T) {
id := NewID()
require.Empty(t, id.String())
})
t.Run("should be equal", func(t *testing.T) { t.Run("should be equal", func(t *testing.T) {
for i := 0; i < 10; i++ { for i := 0; i < 10; i++ {
t.Run(strconv.Itoa(i), func(t *testing.T) { t.Run(strconv.Itoa(i), func(t *testing.T) {
@ -124,3 +129,14 @@ func TestID_ToV2(t *testing.T) {
require.Nil(t, x.ToV2()) require.Nil(t, x.ToV2())
}) })
} }
func TestNewID(t *testing.T) {
t.Run("default values", func(t *testing.T) {
id := NewID()
// convert to v2 message
idV2 := id.ToV2()
require.Nil(t, idV2.GetValue())
})
}