[#412] ir/locode: Disallow explicit setting of LOCODE-derived attributes

Make `Validator.VerifyAndUpdate` method to return an error if at least one
of LOCODE-derived attributes is set explicitly. Thus, IR will not confirm
the candidates for the network map who independently set these attributes.

Cover `Validator.VerifyAndUpdate` method with unit tests.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2021-06-09 13:47:12 +03:00 committed by Alex Vanin
parent 75d6702d2e
commit 68e85e4b33
2 changed files with 203 additions and 2 deletions

View file

@ -13,8 +13,10 @@ var errMissingRequiredAttr = errors.New("missing required attribute in DB record
// VerifyAndUpdate validates UN-LOCODE attribute of n // VerifyAndUpdate validates UN-LOCODE attribute of n
// and adds a group of related attributes. // and adds a group of related attributes.
// //
// If n does not contain UN-LOCODE attribute, nil is returned // If n contains at least one of the LOCODE-derived attributes,
// without any actions. Otherwise, if UN-LOCODE value does not // an error returns.
//
// If n contains UN-LOCODE attribute and its value does not
// match the UN/LOCODE format, an error returns. // match the UN/LOCODE format, an error returns.
// //
// New attributes are formed from the record of DB instance (Prm). // New attributes are formed from the record of DB instance (Prm).
@ -30,6 +32,16 @@ var errMissingRequiredAttr = errors.New("missing required attribute in DB record
func (v *Validator) VerifyAndUpdate(n *netmap.NodeInfo) error { func (v *Validator) VerifyAndUpdate(n *netmap.NodeInfo) error {
mAttr := uniqueAttributes(n.Attributes()) mAttr := uniqueAttributes(n.Attributes())
// check if derived attributes are presented
for attrKey := range v.mAttr {
if _, ok := mAttr[attrKey]; ok {
return fmt.Errorf("attribute derived from %s is presented: %s",
netmap.AttrUNLOCODE,
attrKey,
)
}
}
attrLocode, ok := mAttr[netmap.AttrUNLOCODE] attrLocode, ok := mAttr[netmap.AttrUNLOCODE]
if !ok { if !ok {
return nil return nil

View file

@ -0,0 +1,189 @@
package locode_test
import (
"errors"
"fmt"
"testing"
"github.com/nspcc-dev/neofs-api-go/pkg/netmap"
"github.com/nspcc-dev/neofs-node/pkg/innerring/processors/netmap/nodevalidation/locode"
locodestd "github.com/nspcc-dev/neofs-node/pkg/util/locode"
locodedb "github.com/nspcc-dev/neofs-node/pkg/util/locode/db"
"github.com/stretchr/testify/require"
)
type record struct {
*locodedb.Key
*locodedb.Record
}
type db struct {
items map[locodestd.LOCODE]locode.Record
}
func (x db) add(lc locodestd.LOCODE, rec locode.Record) {
x.items[lc] = rec
}
func (x db) Get(lc *locodestd.LOCODE) (locode.Record, error) {
r, ok := x.items[*lc]
if !ok {
return nil, errors.New("record not found")
}
return r, nil
}
func addAttrKV(n *netmap.NodeInfo, key, val string) {
a := netmap.NewNodeAttribute()
a.SetKey(key)
a.SetValue(val)
n.SetAttributes(append(n.Attributes(), a)...)
}
func addLocodeAttrValue(n *netmap.NodeInfo, val string) {
addAttrKV(n, netmap.AttrUNLOCODE, val)
}
func addLocodeAttr(n *netmap.NodeInfo, lc locodestd.LOCODE) {
addLocodeAttrValue(n, fmt.Sprintf("%s %s", lc[0], lc[1]))
}
func nodeInfoWithSomeAttrs() *netmap.NodeInfo {
n := netmap.NewNodeInfo()
addAttrKV(n, "key1", "val1")
addAttrKV(n, "key2", "val2")
return n
}
func containsAttr(n *netmap.NodeInfo, key, val string) bool {
for _, a := range n.Attributes() {
if a.Key() == key && a.Value() == val {
return true
}
}
return false
}
func TestValidator_VerifyAndUpdate(t *testing.T) {
db := &db{
items: make(map[locodestd.LOCODE]locode.Record),
}
// test record with valid but random values
r := locodestd.Record{
LOCODE: locodestd.LOCODE{"RU", "MOW"},
NameWoDiacritics: "Moskva",
SubDiv: "MSK",
}
k, err := locodedb.NewKey(r.LOCODE)
require.NoError(t, err)
rdb, err := locodedb.NewRecord(r)
require.NoError(t, err)
rdb.SetCountryName("Russia")
rdb.SetSubDivName("Moskva oblast")
var cont locodedb.Continent = locodedb.ContinentEurope
rdb.SetContinent(&cont)
rec := record{
Key: k,
Record: rdb,
}
db.add(r.LOCODE, rec)
var p locode.Prm
p.DB = db
validator := locode.New(p)
t.Run("w/ derived attributes", func(t *testing.T) {
fn := func(withLocode bool) {
for _, derivedAttr := range []string{
netmap.AttrCountryCode,
netmap.AttrCountry,
netmap.AttrLocation,
netmap.AttrSubDivCode,
netmap.AttrSubDiv,
netmap.AttrContinent,
} {
n := nodeInfoWithSomeAttrs()
addAttrKV(n, derivedAttr, "some value")
if withLocode {
addLocodeAttr(n, r.LOCODE)
}
err := validator.VerifyAndUpdate(n)
require.Error(t, err)
}
}
fn(true)
fn(false)
})
t.Run("w/o locode", func(t *testing.T) {
n := nodeInfoWithSomeAttrs()
attrs := n.Attributes()
err := validator.VerifyAndUpdate(n)
require.NoError(t, err)
require.Equal(t, attrs, n.Attributes())
})
t.Run("w/ locode", func(t *testing.T) {
t.Run("invalid locode", func(t *testing.T) {
n := nodeInfoWithSomeAttrs()
addLocodeAttrValue(n, "WRONG LOCODE")
err := validator.VerifyAndUpdate(n)
require.Error(t, err)
})
t.Run("missing DB record", func(t *testing.T) {
n := nodeInfoWithSomeAttrs()
addLocodeAttr(n, locodestd.LOCODE{"RU", "SPB"})
err := validator.VerifyAndUpdate(n)
require.Error(t, err)
})
n := nodeInfoWithSomeAttrs()
addLocodeAttr(n, r.LOCODE)
attrs := n.Attributes()
err := validator.VerifyAndUpdate(n)
require.NoError(t, err)
outAttrs := n.Attributes()
for _, a := range attrs {
require.Contains(t, outAttrs, a)
}
require.True(t, containsAttr(n, netmap.AttrCountryCode, rec.CountryCode().String()))
require.True(t, containsAttr(n, netmap.AttrCountry, rec.CountryName()))
require.True(t, containsAttr(n, netmap.AttrLocation, rec.LocationName()))
require.True(t, containsAttr(n, netmap.AttrSubDivCode, rec.SubDivCode()))
require.True(t, containsAttr(n, netmap.AttrSubDiv, rec.SubDivName()))
require.True(t, containsAttr(n, netmap.AttrContinent, rec.Continent().String()))
})
}