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

[#302] pkg/version: Document default values set in NewVersion

Browse source 
Document field values of instance constructed via
`NewVersion`. 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:25:35 +03:00 committed by Alex Vanin
parent 768adfdd15
commit dc99d4edce
2 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
pkg/version.go
View file

@ -21,6 +21,10 @@ func NewVersionFromV2(v *refs.Version) *Version {
// NewVersion creates and initializes blank Version. // NewVersion creates and initializes blank Version.
// //
// Works similar as NewVersionFromV2(new(Version)). // Works similar as NewVersionFromV2(new(Version)).
//
// Defaults:
// - major: 0;
// - minor: 0.
func NewVersion() *Version { func NewVersion() *Version {
return NewVersionFromV2(new(refs.Version)) return NewVersionFromV2(new(refs.Version))
} }

16
pkg/version_test.go
View file

@ -8,6 +8,21 @@ import (
) )
func TestNewVersion(t *testing.T) { func TestNewVersion(t *testing.T) {
t.Run("default values", func(t *testing.T) {
v := NewVersion()
// check initial values
require.Zero(t, v.Major())
require.Zero(t, v.Minor())
// convert to v2 message
vV2 := v.ToV2()
require.Empty(t, vV2.GetMajor())
require.Empty(t, vV2.GetMinor())
})
t.Run("setting values", func(t *testing.T) {
v := NewVersion() v := NewVersion()
var mjr, mnr uint32 = 1, 2 var mjr, mnr uint32 = 1, 2
@ -22,6 +37,7 @@ func TestNewVersion(t *testing.T) {
require.Equal(t, mjr, ver.GetMajor()) require.Equal(t, mjr, ver.GetMajor())
require.Equal(t, mnr, ver.GetMinor()) require.Equal(t, mnr, ver.GetMinor())
})
} }
func TestSDKVersion(t *testing.T) { func TestSDKVersion(t *testing.T) {