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

[#302] pkg/xheader: Document default values set in NewXHeader

Browse source 
Document field values of instance constructed via
`NewXHeader`. 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 21:31:15 +03:00 committed by Alex Vanin
parent 41307a5e00
commit 1542162657
2 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
pkg/xheader.go
View file

@ -15,6 +15,10 @@ func NewXHeaderFromV2(v *session.XHeader) *XHeader {
} }
// NewXHeader creates, initializes and returns blank XHeader instance. // NewXHeader creates, initializes and returns blank XHeader instance.
//
// Defaults:
// - key: "";
// - value: "".
func NewXHeader() *XHeader { func NewXHeader() *XHeader {
return NewXHeaderFromV2(new(session.XHeader)) return NewXHeaderFromV2(new(session.XHeader))
} }

16
pkg/xheader_test.go
View file

@ -40,3 +40,19 @@ func TestXHeader_ToV2(t *testing.T) {
require.Nil(t, x.ToV2()) require.Nil(t, x.ToV2())
}) })
} }
func TestNewXHeader(t *testing.T) {
t.Run("default values", func(t *testing.T) {
xh := NewXHeader()
// check initial values
require.Empty(t, xh.Value())
require.Empty(t, xh.Key())
// convert to v2 message
xhV2 := xh.ToV2()
require.Empty(t, xhV2.GetValue())
require.Empty(t, xhV2.GetKey())
})
}