Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix / clarify capabilities API #2952

Merged
merged 23 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix upgrade semantics bug, update tests
  • Loading branch information
faec committed Jun 27, 2023
commit b61de0ce40258b1fd815f4af2ef73c7b7cead5d2
12 changes: 4 additions & 8 deletions internal/pkg/capabilities/upgrade.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,11 @@ func allowUpgrade(
result, err := cap.condition.Eval(varStore, true)
if err != nil {
log.Errorf("failed evaluating eql formula %q, skipping: %v", cap.conditionStr, err)
return true
continue
}
if result && cap.rule == ruleTypeDeny {
// This rule blocks the attempted upgrade
return false
}
if !result && cap.rule == ruleTypeAllow {
// An "allow" rule failed its check, this also blocks the upgrade.
return false
if result {
// The check passed, either accept or deny as configured.
return cap.rule == ruleTypeAllow
}
}
// If nothing blocked the upgrade, allow it.
Expand Down
41 changes: 16 additions & 25 deletions internal/pkg/capabilities/upgrade_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,47 +53,37 @@ func TestUpgrade(t *testing.T) {

t.Run("valid action - version mismmatch", func(t *testing.T) {
log := logger.NewWithoutConfig("testing")
// allow version 7.12.0, reject anything else
caps := []*upgradeCapability{
mustNewUpgradeCapability(
"${version} == '7.12.0'",
ruleTypeAllow,
),
mustNewUpgradeCapability("${version} == '7.12.0'", ruleTypeAllow),
mustNewUpgradeCapability("", ruleTypeDeny),
}
assert.True(t, allowUpgrade(log, "7.12.0", "", caps))
assert.False(t, allowUpgrade(log, "7.12.1", "", caps))
assert.False(t, allowUpgrade(log, "8.0.0", "", caps))
})

t.Run("valid action - version bug allowed minor mismatch", func(t *testing.T) {
t.Run("version bug allowed minor mismatch", func(t *testing.T) {
log := logger.NewWithoutConfig("testing")
caps := []*upgradeCapability{
mustNewUpgradeCapability(
"match(${version}, '8.0.*')",
ruleTypeAllow,
),
mustNewUpgradeCapability("match(${version}, '8.0.*')", ruleTypeAllow),
mustNewUpgradeCapability("", ruleTypeDeny),
}
assert.True(t, allowUpgrade(log, "8.0.0", "", caps))
assert.True(t, allowUpgrade(log, "8.0.1", "", caps))
assert.False(t, allowUpgrade(log, "8.1.0", "", caps))
})

t.Run("valid action - version minor allowed major mismatch", func(t *testing.T) {
t.Run("version minor allowed major mismatch", func(t *testing.T) {
log := logger.NewWithoutConfig("testing")
caps := []*upgradeCapability{
mustNewUpgradeCapability(
"match(${version}, '8.*.*')",
ruleTypeAllow,
),
}
assert.False(t, allowUpgrade(log, "7.157.0", "", caps))
})

t.Run("valid action - version minor allowed minor upgrade", func(t *testing.T) {
log := logger.NewWithoutConfig("testing")
caps := []*upgradeCapability{
mustNewUpgradeCapability(
"match(${version}, '8.*.*')",
ruleTypeAllow,
),
mustNewUpgradeCapability("match(${version}, '8.*.*')", ruleTypeAllow),
mustNewUpgradeCapability("", ruleTypeDeny),
}
assert.True(t, allowUpgrade(log, "8.157.0", "", caps))
assert.True(t, allowUpgrade(log, "8.0.123", "", caps))
assert.True(t, allowUpgrade(log, "8.2.0", "", caps))
assert.False(t, allowUpgrade(log, "7.157.0", "", caps))
})

t.Run("require trusted url", func(t *testing.T) {
Expand All @@ -103,6 +93,7 @@ func TestUpgrade(t *testing.T) {
"startsWith(${sourceURI}, 'https')",
ruleTypeAllow,
),
mustNewUpgradeCapability("", ruleTypeDeny),
}
assert.True(t, allowUpgrade(log, "9.0.0", "https://artifacts.elastic.co", caps))
assert.False(t, allowUpgrade(log, "9.0.0", "http://artifacts.elastic.co", caps))
Expand Down