Skip to content

Commit

Permalink
satellite/overlay/placement: improve placement configurability with &…
Browse files Browse the repository at this point in the history 
…&, placement, region and ! support in country

This patch makes it easier to configure existing placement rules only with string.

 1. placement(n) rule can be used to reuse earlier definitions
 2 .&& can be used in addition to all(n1,n2)
 3. country(c) accepts exclusions (like '!RU'), regions ('EU','EEA'), all and none

See the 'full example' unit test, which uses all of these, in a realistic example.

#6126

Change-Id: Ica76f016ebd002eb7ea8103d4258bacd6a6d77bf
  • Loading branch information
@elek @andriikotko
elek authored and andriikotko committed Aug 18, 2023
1 parent e21c035 commit 6e5c168
Show file tree
Hide file tree
Showing 4 changed files with 192 additions and 35 deletions.
2 changes: 1 addition & 1 deletion satellite/nodeselection/filter_test.go
View file
Expand Up @@ -73,7 +73,7 @@ func TestCriteria_NodeIDAndSubnet(t *testing.T) {
}

func TestCriteria_Geofencing(t *testing.T) {
eu := NodeFilters{}.WithCountryFilter(EuCountries)
eu := NodeFilters{}.WithCountryFilter(location.NewSet(EuCountries...))
us := NodeFilters{}.WithCountryFilter(location.NewSet(location.UnitedStates))

cases := []struct {
Expand Down
10 changes: 5 additions & 5 deletions satellite/nodeselection/region.go
View file
Expand Up @@ -6,7 +6,7 @@ package nodeselection
import "storj.io/common/storj/location"

// EuCountries defines the member countries of European Union.
var EuCountries = location.NewSet(
var EuCountries = []location.CountryCode{
location.Austria,
location.Belgium,
location.Bulgaria,
Expand Down Expand Up @@ -34,11 +34,11 @@ var EuCountries = location.NewSet(
location.Slovakia,
location.Spain,
location.Sweden,
)
}

// EeaCountries defined the EEA countries.
var EeaCountries = EuCountries.With(
// EeaCountriesWithoutEu defined the EEA countries.
var EeaCountriesWithoutEu = []location.CountryCode{
location.Iceland,
location.Liechtenstein,
location.Norway,
)
}
45 changes: 39 additions & 6 deletions satellite/overlay/placement.go
View file
Expand Up @@ -66,8 +66,8 @@ func NewPlacementRules() *ConfigurablePlacementRule {

// AddLegacyStaticRules initializes all the placement rules defined earlier in static golang code.
func (d *ConfigurablePlacementRule) AddLegacyStaticRules() {
d.placements[storj.EEA] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(nodeselection.EeaCountries)}
d.placements[storj.EU] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(nodeselection.EuCountries)}
d.placements[storj.EEA] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(location.NewSet(nodeselection.EeaCountriesWithoutEu...).With(nodeselection.EuCountries...))}
d.placements[storj.EU] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(location.NewSet(nodeselection.EuCountries...))}
d.placements[storj.US] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(location.NewSet(location.UnitedStates))}
d.placements[storj.DE] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(location.NewSet(location.Germany))}
d.placements[storj.NR] = nodeselection.NodeFilters{nodeselection.NewCountryFilter(location.NewFullSet().Without(location.Russia, location.Belarus, location.None))}
Expand All @@ -84,21 +84,54 @@ func (d *ConfigurablePlacementRule) AddPlacementFromString(definitions string) e
"country": func(countries ...string) (nodeselection.NodeFilters, error) {
var set location.Set
for _, country := range countries {
code := location.ToCountryCode(country)
if code == location.None {
return nil, errs.New("invalid country code %q", code)
apply := func(modified location.Set, code ...location.CountryCode) location.Set {
return modified.With(code...)
}
if country[0] == '!' {
apply = func(modified location.Set, code ...location.CountryCode) location.Set {
return modified.Without(code...)
}
country = country[1:]
}
switch strings.ToLower(country) {
case "all", "*", "any":
set = location.NewFullSet()
case "none":
set = apply(set, location.None)
case "eu":
set = apply(set, nodeselection.EuCountries...)
case "eea":
set = apply(set, nodeselection.EuCountries...)
set = apply(set, nodeselection.EeaCountriesWithoutEu...)
default:
code := location.ToCountryCode(country)
if code == location.None {
return nil, errs.New("invalid country code %q", code)
}
set = apply(set, code)
}
set.Include(code)
}
return nodeselection.NodeFilters{nodeselection.NewCountryFilter(set)}, nil
},
"placement": func(ix int64) nodeselection.NodeFilter {
return d.placements[storj.PlacementConstraint(ix)]
},
"all": func(filters ...nodeselection.NodeFilters) (nodeselection.NodeFilters, error) {
res := nodeselection.NodeFilters{}
for _, filter := range filters {
res = append(res, filter...)
}
return res, nil
},
mito.OpAnd: func(env map[any]any, a, b any) (any, error) {
filter1, ok1 := a.(nodeselection.NodeFilter)
filter2, ok2 := b.(nodeselection.NodeFilter)
if !ok1 || !ok2 {
return nil, errs.New("&& is supported only between NodeFilter instances")
}
res := nodeselection.NodeFilters{filter1, filter2}
return res, nil
},
"tag": func(nodeIDstr string, key string, value any) (nodeselection.NodeFilters, error) {
nodeID, err := storj.NodeIDFromString(nodeIDstr)
if err != nil {
Expand Down
170 changes: 147 additions & 23 deletions satellite/overlay/placement_test.go
View file
Expand Up @@ -6,6 +6,7 @@ package overlay
import (
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

"storj.io/common/storj"
Expand All @@ -23,18 +24,30 @@ func TestPlacementFromString(t *testing.T) {
require.Error(t, err)
})

t.Run("single country", func(t *testing.T) {
p := NewPlacementRules()
err := p.AddPlacementFromString(`11:country("GB")`)
require.NoError(t, err)
filters := p.placements[storj.PlacementConstraint(11)]
require.NotNil(t, filters)
require.True(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.UnitedKingdom,
}))
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.Germany,
}))
t.Run("country tests", func(t *testing.T) {
countryTest := func(placementDef string, shouldBeIncluded []location.CountryCode, shouldBeExcluded []location.CountryCode) {
p := NewPlacementRules()
err := p.AddPlacementFromString("11:" + placementDef)
require.NoError(t, err)
filters := p.placements[storj.PlacementConstraint(11)]
require.NotNil(t, filters)
for _, code := range shouldBeExcluded {
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: code,
}), "%s shouldn't be included in placement %s", code, placementDef)
}
for _, code := range shouldBeIncluded {
require.True(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: code,
}), "%s is not included in placement %s", code, placementDef)
}
}
countryTest(`country("GB")`, []location.CountryCode{location.UnitedKingdom}, []location.CountryCode{location.Germany, location.UnitedStates})
countryTest(`country("EU")`, []location.CountryCode{location.Germany, location.Hungary}, []location.CountryCode{location.UnitedStates, location.Norway, location.Iceland})
countryTest(`country("EEA")`, []location.CountryCode{location.Germany, location.Hungary, location.Norway, location.Iceland}, []location.CountryCode{location.UnitedStates})
countryTest(`country("ALL","!EU")`, []location.CountryCode{location.Norway, location.India}, []location.CountryCode{location.Germany, location.Hungary})
countryTest(`country("ALL", "!RU", "!BY")`, []location.CountryCode{location.Norway, location.India, location.UnitedStates}, []location.CountryCode{location.Russia, location.Belarus})

})

t.Run("tag rule", func(t *testing.T) {
Expand All @@ -57,14 +70,12 @@ func TestPlacementFromString(t *testing.T) {
}))
})

t.Run("all rules", func(t *testing.T) {
t.Run("placement reuse", func(t *testing.T) {
p := NewPlacementRules()
err := p.AddPlacementFromString(`11:all(country("GB"),tag("12whfK1EDvHJtajBiAUeajQLYcWqxcQmdYQU5zX5cCf6bAxfgu4","foo","bar"))`)
err := p.AddPlacementFromString(`1:tag("12whfK1EDvHJtajBiAUeajQLYcWqxcQmdYQU5zX5cCf6bAxfgu4","foo","bar");2:exclude(placement(1))`)
require.NoError(t, err)
filters := p.placements[storj.PlacementConstraint(11)]
require.NotNil(t, filters)
require.True(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.UnitedKingdom,

require.True(t, p.placements[storj.PlacementConstraint(1)].MatchInclude(&nodeselection.SelectedNode{
Tags: nodeselection.NodeTags{
{
Signer: signer,
Expand All @@ -73,11 +84,9 @@ func TestPlacementFromString(t *testing.T) {
},
},
}))
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.UnitedKingdom,
}))
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.Germany,

placement2 := p.placements[storj.PlacementConstraint(2)]
require.False(t, placement2.MatchInclude(&nodeselection.SelectedNode{
Tags: nodeselection.NodeTags{
{
Signer: signer,
Expand All @@ -86,6 +95,51 @@ func TestPlacementFromString(t *testing.T) {
},
},
}))
require.True(t, placement2.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.Germany,
}))

})

t.Run("all rules", func(t *testing.T) {
for _, syntax := range []string{
`11:all(country("GB"),tag("12whfK1EDvHJtajBiAUeajQLYcWqxcQmdYQU5zX5cCf6bAxfgu4","foo","bar"))`,
`11:country("GB") && tag("12whfK1EDvHJtajBiAUeajQLYcWqxcQmdYQU5zX5cCf6bAxfgu4","foo","bar")`,
} {
p := NewPlacementRules()
err := p.AddPlacementFromString(syntax)
require.NoError(t, err)
filters := p.placements[storj.PlacementConstraint(11)]
require.NotNil(t, filters)
require.True(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.UnitedKingdom,
Tags: nodeselection.NodeTags{
{
Signer: signer,
Name: "foo",
Value: []byte("bar"),
},
},
}))
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.UnitedKingdom,
}))
require.False(t, filters.MatchInclude(&nodeselection.SelectedNode{
CountryCode: location.Germany,
Tags: nodeselection.NodeTags{
{
Signer: signer,
Name: "foo",
Value: []byte("bar"),
},
},
}))
}
t.Run("invalid", func(t *testing.T) {
p := NewPlacementRules()
err := p.AddPlacementFromString("10:1 && 2")
require.Error(t, err)
})
})

t.Run("multi rule", func(t *testing.T) {
Expand Down Expand Up @@ -168,4 +222,74 @@ func TestPlacementFromString(t *testing.T) {

})

t.Run("full example", func(t *testing.T) {
// this is a realistic configuration, compatible with legacy rules + using one node tag for specific placement

rules1 := NewPlacementRules()
err := rules1.AddPlacementFromString(`
10:tag("12whfK1EDvHJtajBiAUeajQLYcWqxcQmdYQU5zX5cCf6bAxfgu4","selected","true");
0:exclude(placement(10));
1:country("EU") && exclude(placement(10));
2:country("EEA") && exclude(placement(10));
3:country("US") && exclude(placement(10));
4:country("DE") && exclude(placement(10));
6:country("*","!BY", "!RU", "!NONE") && exclude(placement(10))`)
require.NoError(t, err)

// for countries, it should be the same as above
rules2 := NewPlacementRules()
rules2.AddLegacyStaticRules()

testCountries := []location.CountryCode{
location.Russia,
location.India,
location.Belarus,
location.UnitedStates,
location.Canada,
location.Brazil,
location.Ghana,
}
testCountries = append(testCountries, nodeselection.EeaCountriesWithoutEu...)
testCountries = append(testCountries, nodeselection.EuCountries...)

// check if old geofencing rules are working as before (and string based config is the same as the code base)
for _, placement := range []storj.PlacementConstraint{storj.EU, storj.EEA, storj.DE, storj.US, storj.NR} {
filter1 := rules1.CreateFilters(placement)
filter2 := rules2.CreateFilters(placement)
for _, country := range testCountries {
old := placement.AllowedCountry(country)
result1 := filter1.MatchInclude(&nodeselection.SelectedNode{
CountryCode: country,
})
result2 := filter2.MatchInclude(&nodeselection.SelectedNode{
CountryCode: country,
})
assert.Equal(t, old, result1, "old placement doesn't match string based configuration for placement %d and country %s", placement, country)
assert.Equal(t, old, result2, "old placement doesn't match code based configuration for placement %d and country %s", placement, country)
}
}

// make sure that new rules exclude location.None from NR
assert.False(t, rules1.CreateFilters(storj.NR).MatchInclude(&nodeselection.SelectedNode{}))
assert.False(t, rules2.CreateFilters(storj.NR).MatchInclude(&nodeselection.SelectedNode{}))

// make sure tagged nodes (even from EU) matches only the special placement
node := &nodeselection.SelectedNode{
CountryCode: location.Germany,
Tags: nodeselection.NodeTags{
{
Signer: signer,
Name: "selected",
Value: []byte("true"),
},
},
}

for _, placement := range []storj.PlacementConstraint{storj.EveryCountry, storj.EU, storj.EEA, storj.DE, storj.US, storj.NR} {
assert.False(t, rules1.CreateFilters(placement).MatchInclude(node))
}
assert.False(t, rules1.CreateFilters(6).MatchInclude(node))

})

}

0 comments on commit 6e5c168

Please sign in to comment.