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

[#302] pkg/container/id: Document default values set in New

Browse source 
Document field values of instance constructed via `New`.
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 15:15:45 +03:00 committed by Alex Vanin
parent 6ce8844654
commit 31ca5c14d3
2 changed files with 24 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
pkg/container/id/id.go
View file

@ -20,6 +20,9 @@ func NewFromV2(idV2 *refs.ContainerID) *ID {
} }
// New creates and initializes blank ID. // New creates and initializes blank ID.
//
// Defaults:
// - value: nil.
func New() *ID { func New() *ID {
return NewFromV2(new(refs.ContainerID)) return NewFromV2(new(refs.ContainerID))
} }
@ -31,7 +34,7 @@ func (id *ID) SetSHA256(v [sha256.Size]byte) {
// ToV2 returns the v2 container ID message. // ToV2 returns the v2 container ID message.
// //
// Nil Result converts to nil. // Nil ID converts to nil.
func (id *ID) ToV2() *refs.ContainerID { func (id *ID) ToV2() *refs.ContainerID {
return (*refs.ContainerID)(id) return (*refs.ContainerID)(id)
} }

16
pkg/container/id/id_test.go
View file

@ -33,6 +33,14 @@ func TestID_ToV2(t *testing.T) {
require.Nil(t, x.ToV2()) require.Nil(t, x.ToV2())
}) })
t.Run("default values", func(t *testing.T) {
cid := cid.New()
// convert to v2 message
cidV2 := cid.ToV2()
require.Nil(t, cidV2.GetValue())
})
} }
func TestID_Equal(t *testing.T) { func TestID_Equal(t *testing.T) {
@ -49,11 +57,19 @@ func TestID_Equal(t *testing.T) {
} }
func TestID_String(t *testing.T) { func TestID_String(t *testing.T) {
t.Run("Parse/String", func(t *testing.T) {
id := cidtest.Generate() id := cidtest.Generate()
id2 := cid.New() id2 := cid.New()
require.NoError(t, id2.Parse(id.String())) require.NoError(t, id2.Parse(id.String()))
require.Equal(t, id, id2) require.Equal(t, id, id2)
})
t.Run("nil", func(t *testing.T) {
id := cid.New()
require.Empty(t, id.String())
})
} }
func TestContainerIDEncoding(t *testing.T) { func TestContainerIDEncoding(t *testing.T) {