aarifullin/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Pull requests Activity

[#302] pkg/owner: 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:51:34 +03:00 committed by Alex Vanin
parent 12574469e5
commit c00cdd407d
2 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
pkg/owner/id.go
View file

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

19
pkg/owner/id_test.go
View file

@ -116,3 +116,22 @@ func TestID_ToV2(t *testing.T) {
require.Nil(t, x.ToV2()) require.Nil(t, x.ToV2())
}) })
} }
func TestID_String(t *testing.T) {
t.Run("nil", func(t *testing.T) {
id := NewID()
require.Empty(t, id.String())
})
}
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())
})
}