Skip to content

[wip]OTA-1010: pull GetImplicitlyEnabledCapabilities from the cvo repo #1908

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[wip]OTA-1010: pull GetImplicitlyEnabledCapabilities from the cvo repo #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
82 changes: 82 additions & 0 deletions pkg/manifest/manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
utilerrors "k8s.io/apimachinery/pkg/util/errors"
"k8s.io/apimachinery/pkg/util/yaml"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/klog/v2"
)

const (
Expand Down Expand Up @@ -422,3 +423,84 @@ func addIfNotDuplicateResource(manifest Manifest, resourceIds map[resourceId]boo
}
return fmt.Errorf("duplicate resource: (%s)", manifest.id)
}

// InclusionConfiguration configures manifest inclusion, so
// callers can opt in to new filtering options instead of having to
// update existing call-sites, even if they do not need a new
// filtering option.
type InclusionConfiguration struct {
// ExcludeIdentifier, if non-nil, excludes manifests that match the exclusion identifier.
ExcludeIdentifier *string

// RequiredFeatureSet, if non-nil, excludes manifests unless they match the desired feature set.
RequiredFeatureSet *string

// Profile, if non-nil, excludes manifests unless they match the cluster profile.
Profile *string

// Capabilities, if non-nil, excludes manifests unless they match the enabled cluster capabilities.
Capabilities *configv1.ClusterVersionCapabilitiesStatus

// Overrides excludes manifests for overridden resources.
Overrides []configv1.ComponentOverride

// Platform, if non-nil, excludes CredentialsRequests manifests unless they match the infrastructure platform.
Platform *string
}

// GetImplicitlyEnabledCapabilities returns a set of capabilities that are implicitly enabled after a cluster update.
// The arguments are two sets of manifests, manifest inclusion configuration, and
// a set of capabilities that are implicitly enabled on the cluster, i.e., the capabilities
// that are NOT specified in the cluster version but has to considered enabled on the cluster.
// The manifest inclusion configuration is used to determine if a manifest should be included.
// In other words, whether, or not the cluster version operator reconcile that manifest on the cluster.
// The two sets of manifests are respectively from the release that the cluster is updated to and the
// release that is currently running on the cluster.
func GetImplicitlyEnabledCapabilities(
updatePayloadManifests []Manifest,
currentPayloadManifests []Manifest,
manifestInclusionConfiguration InclusionConfiguration,
currentImplicitlyEnabled sets.Set[configv1.ClusterVersionCapability],
) sets.Set[configv1.ClusterVersionCapability] {
ret := currentImplicitlyEnabled.Clone()
for _, updateManifest := range updatePayloadManifests {
updateManErr := updateManifest.IncludeAllowUnknownCapabilities(
manifestInclusionConfiguration.ExcludeIdentifier,
manifestInclusionConfiguration.RequiredFeatureSet,
manifestInclusionConfiguration.Profile,
manifestInclusionConfiguration.Capabilities,
manifestInclusionConfiguration.Overrides,
true,
)
// update manifest is enabled, no need to check
if updateManErr == nil {
continue
}
for _, currentManifest := range currentPayloadManifests {
if !updateManifest.SameResourceID(currentManifest) {
continue
}
// current manifest is disabled, no need to check
if err := currentManifest.IncludeAllowUnknownCapabilities(
manifestInclusionConfiguration.ExcludeIdentifier,
manifestInclusionConfiguration.RequiredFeatureSet,
manifestInclusionConfiguration.Profile,
manifestInclusionConfiguration.Capabilities,
manifestInclusionConfiguration.Overrides,
true,
); err != nil {
continue
}
newImplicitlyEnabled := sets.New[configv1.ClusterVersionCapability](updateManifest.GetManifestCapabilities()...).
Difference(sets.New[configv1.ClusterVersionCapability](currentManifest.GetManifestCapabilities()...)).
Difference(currentImplicitlyEnabled).
Difference(sets.New[configv1.ClusterVersionCapability](manifestInclusionConfiguration.Capabilities.EnabledCapabilities...))
ret = ret.Union(newImplicitlyEnabled)
if newImplicitlyEnabled.Len() > 0 {
klog.V(2).Infof("%s has changed and is now part of one or more disabled capabilities. The following capabilities will be implicitly enabled: %s",
updateManifest.String(), sets.List(newImplicitlyEnabled))
}
}
}
return ret
}
177 changes: 177 additions & 0 deletions pkg/manifest/manifest_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,11 @@ import (
"strings"
"testing"

"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/utils/ptr"

"github.com/davecgh/go-spew/spew"
"github.com/google/go-cmp/cmp"
configv1 "github.com/openshift/api/config/v1"
"github.com/stretchr/testify/assert"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
Expand Down Expand Up @@ -1009,3 +1011,178 @@ func TestSameResourceID(t *testing.T) {
})
}
}

func getManifest(kind, name, caps string) Manifest {
return Manifest{
id: resourceId{Kind: kind, Name: name, Namespace: "ns1"},
Obj: &unstructured.Unstructured{
Object: map[string]interface{}{
"metadata": map[string]interface{}{
"name": name,
"namespace": "ns1",
"annotations": map[string]interface{}{"capability.openshift.io/name": caps},
},
},
},
}
}

func TestGetImplicitlyEnabledCapabilities(t *testing.T) {
tests := []struct {
name string

currentPayloadManifests []Manifest
updatePayloadManifests []Manifest
status *configv1.ClusterVersionCapabilitiesStatus
currentImplicitlyEnabled sets.Set[configv1.ClusterVersionCapability]
expected sets.Set[configv1.ClusterVersionCapability]
}{
{
name: "basic",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
expected: sets.New[configv1.ClusterVersionCapability]("cap2"),
},
{
name: "basic with unknown cap",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
expected: sets.New[configv1.ClusterVersionCapability]("cap2"),
},
{
name: "different manifest",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Diff", "name1", "cap2")},
},
{
name: "current manifest not enabled",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap2"},
},
},
{
name: "new cap already enabled",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
},
},
{
name: "already implicitly enabled",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
currentImplicitlyEnabled: sets.New[configv1.ClusterVersionCapability]("cap2"),
expected: sets.New[configv1.ClusterVersionCapability]("cap2"),
},
{
name: "only add cap once",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1"),
getManifest("Test", "name2", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2"),
getManifest("Test", "name2", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
expected: sets.New[configv1.ClusterVersionCapability]("cap2"),
},
{
name: "complex",
currentPayloadManifests: []Manifest{
getManifest("Test", "name1", "cap1+cap3+cap5+cap7"),
getManifest("Test", "name2", "cap1+cap2+cap4+cap6+cap8"),
getManifest("Test", "name3", "cap2+cap9+cap11+cap13+cap15"),
getManifest("Test", "name4", "cap10+cap12+cap14+cap16"),
getManifest("Test", "name5", "cap17+cap19+cap21+cap23"),
getManifest("Test", "name6", "cap18+cap20+cap22+cap24"),
},
updatePayloadManifests: []Manifest{
getManifest("Test", "name1", "cap111+cap113+cap115+cap117"),
getManifest("Test", "name2", "cap111+cap112+cap114+cap116+cap118"),
getManifest("Test", "name3", "cap112+cap119+cap1111+cap1113+cap1115"),
getManifest("Test", "name4", "cap1110+cap1112+cap1114+cap1116"),
getManifest("Test", "name5", "cap17+cap19+cap21+cap23"),
getManifest("Test", "name6", "cap18+cap20+cap22+cap24"),
},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{
"cap1", "cap2", "cap3", "cap4", "cap5", "cap6",
"cap7", "cap8", "cap9", "cap10", "cap11", "cap12",
"cap13", "cap14", "cap15", "cap16", "cap17", "cap18",
"cap19", "cap20", "cap21", "cap22", "cap23", "cap24",
"cap111", "cap112", "cap113", "cap114", "cap115", "cap116",
"cap117", "cap118", "cap119", "cap1111", "cap1113", "cap1115",
"cap1110", "cap1112", "cap1114", "cap1116"},
EnabledCapabilities: []configv1.ClusterVersionCapability{
"cap1", "cap2", "cap3", "cap4", "cap5", "cap6",
"cap7", "cap8", "cap9", "cap10", "cap11", "cap12",
"cap13", "cap14", "cap15", "cap16", "cap17", "cap18",
"cap19", "cap20", "cap21", "cap22", "cap23", "cap24"},
},
currentImplicitlyEnabled: sets.New[configv1.ClusterVersionCapability](
"cap000", "cap111", "cap112", "cap113", "cap114"),
expected: sets.New[configv1.ClusterVersionCapability](
"cap000", "cap111", "cap112", "cap113", "cap114",
"cap115", "cap116", "cap117", "cap118", "cap119",
"cap1110", "cap1111", "cap1112", "cap1113", "cap1114",
"cap1115", "cap1116"),
},
{
name: "no update manifests",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
currentImplicitlyEnabled: sets.New[configv1.ClusterVersionCapability]("cap1"),
expected: sets.New[configv1.ClusterVersionCapability]("cap1"),
},
{
name: "no current manifests",
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
currentImplicitlyEnabled: sets.New[configv1.ClusterVersionCapability]("cap1"),
expected: sets.New[configv1.ClusterVersionCapability]("cap1"),
},
{
name: "duplicate manifests",
currentPayloadManifests: []Manifest{getManifest("Test", "name1", "cap1")},
updatePayloadManifests: []Manifest{getManifest("Test", "name1", "cap2"),
getManifest("Test", "name1", "cap2")},
status: &configv1.ClusterVersionCapabilitiesStatus{
KnownCapabilities: []configv1.ClusterVersionCapability{"cap1", "cap2"},
EnabledCapabilities: []configv1.ClusterVersionCapability{"cap1"},
},
expected: sets.New[configv1.ClusterVersionCapability]("cap2"),
},
}
for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
actual := GetImplicitlyEnabledCapabilities(test.updatePayloadManifests, test.currentPayloadManifests, InclusionConfiguration{Capabilities: test.status}, test.currentImplicitlyEnabled)
if diff := cmp.Diff(test.expected, actual); diff != "" {
t.Errorf("%s: actual differs from expected:\n%s", test.name, diff)
}

})
}
}