From 19cf3c2d0b0305e6725610c5eb6c6002b2ec790b Mon Sep 17 00:00:00 2001 From: Pavel Karpy Date: Tue, 8 Jun 2021 17:11:11 +0300 Subject: [PATCH] [#302] pkg/netmap: Document default values set in `NewNetworkInfo` Document field values of instance constructed via `NewNetworkInfo`. Assert the values in corresponding unit test. Signed-off-by: Pavel Karpy --- pkg/netmap/network_info.go | 4 ++++ pkg/netmap/network_info_test.go | 14 ++++++++++++++ 2 files changed, 18 insertions(+) diff --git a/pkg/netmap/network_info.go b/pkg/netmap/network_info.go index d4a6bdb..609c9cc 100644 --- a/pkg/netmap/network_info.go +++ b/pkg/netmap/network_info.go @@ -16,6 +16,10 @@ func NewNetworkInfoFromV2(iV2 *netmap.NetworkInfo) *NetworkInfo { } // NewNetworkInfo creates and initializes blank NetworkInfo. +// +// Defaults: +// - curEpoch: 0; +// - magicNum: 0. func NewNetworkInfo() *NetworkInfo { return NewNetworkInfoFromV2(new(netmap.NetworkInfo)) } diff --git a/pkg/netmap/network_info_test.go b/pkg/netmap/network_info_test.go index 04234e8..c5d9461 100644 --- a/pkg/netmap/network_info_test.go +++ b/pkg/netmap/network_info_test.go @@ -65,3 +65,17 @@ func TestNetworkInfo_ToV2(t *testing.T) { require.Nil(t, x.ToV2()) }) } + +func TestNewNetworkInfo(t *testing.T) { + ni := NewNetworkInfo() + + // check initial values + require.Zero(t, ni.CurrentEpoch()) + require.Zero(t, ni.MagicNumber()) + + // convert to v2 message + niV2 := ni.ToV2() + + require.Zero(t, niV2.GetCurrentEpoch()) + require.Zero(t, niV2.GetMagicNumber()) +}