-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Add E2E test for the TLSAdherence openshift/api field #31309
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
Open
richardsonnick
wants to merge
2
commits into
openshift:main
Choose a base branch
from
richardsonnick:tls-adherence-e2e
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+125
−3
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package apiserver | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
|
|
||
| g "github.com/onsi/ginkgo/v2" | ||
| o "github.com/onsi/gomega" | ||
| configv1 "github.com/openshift/api/config/v1" | ||
| k8serrors "k8s.io/apimachinery/pkg/api/errors" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
|
||
| exutil "github.com/openshift/origin/test/extended/util" | ||
| ) | ||
|
|
||
| // tlsAdherenceFeatureGateName is the name of the TLSAdherence feature gate as it | ||
| // appears in featuregate/cluster .status.featureGates[].enabled[].name. | ||
| const tlsAdherenceFeatureGateName = configv1.FeatureGateName("TLSAdherence") | ||
|
|
||
| // isTLSAdherenceFeatureGateEnabled returns true when the TLSAdherence feature gate is | ||
| // listed as enabled in the featuregate/cluster status. | ||
| func isTLSAdherenceFeatureGateEnabled(ctx context.Context, oc *exutil.CLI) (bool, error) { | ||
| fg, err := oc.AdminConfigClient().ConfigV1().FeatureGates().Get(ctx, "cluster", metav1.GetOptions{}) | ||
| if err != nil { | ||
| return false, fmt.Errorf("failed to get featuregate/cluster: %w", err) | ||
| } | ||
| for _, featureGateValues := range fg.Status.FeatureGates { | ||
| for _, enabledGate := range featureGateValues.Enabled { | ||
| if enabledGate.Name == tlsAdherenceFeatureGateName { | ||
| return true, nil | ||
| } | ||
| } | ||
| } | ||
| return false, nil | ||
| } | ||
|
|
||
| // These tests verify the TLSAdherence feature gate and the spec.tlsAdherence field on | ||
| // apiservers/cluster (config.openshift.io/v1). They are gated by [OCPFeatureGate:TLSAdherence] | ||
| // for automatic pre-run filtering and include [FeatureGate:TLSAdherence] in each It description | ||
| // so the test name matches the pattern queried by the openshift/api verify-feature-promotion | ||
| // CI check in Sippy. | ||
| var _ = g.Describe("[sig-api-machinery][OCPFeatureGate:TLSAdherence][Feature:TLSAdherence] TLSAdherence apiservers/cluster", func() { | ||
| defer g.GinkgoRecover() | ||
|
|
||
| oc := exutil.NewCLI("tls-adherence") | ||
|
|
||
| g.BeforeEach(func(ctx context.Context) { | ||
| enabled, err := isTLSAdherenceFeatureGateEnabled(ctx, oc) | ||
| o.Expect(err).NotTo(o.HaveOccurred()) | ||
| if !enabled { | ||
| g.Skip("TLSAdherence feature gate is not enabled on this cluster") | ||
| } | ||
| }) | ||
|
|
||
| // Test 1 – verify the API rejects an unrecognised spec.tlsAdherence value. | ||
| g.It("[FeatureGate:TLSAdherence] should reject an invalid spec.tlsAdherence value on apiservers/cluster [apigroup:config.openshift.io]", func(ctx context.Context) { | ||
| current, err := oc.AdminConfigClient().ConfigV1().APIServers().Get(ctx, "cluster", metav1.GetOptions{}) | ||
| o.Expect(err).NotTo(o.HaveOccurred(), "failed to get apiservers/cluster") | ||
|
|
||
| desired := current.DeepCopy() | ||
| desired.Spec.TLSAdherence = configv1.TLSAdherencePolicy("InvalidValue") | ||
|
|
||
| _, err = oc.AdminConfigClient().ConfigV1().APIServers().Update(ctx, desired, metav1.UpdateOptions{ | ||
| DryRun: []string{metav1.DryRunAll}, | ||
| }) | ||
| o.Expect(err).To(o.HaveOccurred(), | ||
| "apiservers/cluster should reject an invalid spec.tlsAdherence value") | ||
| o.Expect(k8serrors.IsInvalid(err)).To(o.BeTrue(), | ||
| "error should be a 422 Invalid, got: %v", err) | ||
| }) | ||
|
|
||
| // Test 2 – verify the API server accepts and reflects all valid spec.tlsAdherence values via dry-run. | ||
| g.It("[FeatureGate:TLSAdherence] should accept and reflect all valid spec.tlsAdherence values on apiservers/cluster [apigroup:config.openshift.io]", func(ctx context.Context) { | ||
| validValues := []configv1.TLSAdherencePolicy{ | ||
| configv1.TLSAdherencePolicyStrictAllComponents, | ||
| configv1.TLSAdherencePolicyLegacyAdheringComponentsOnly, | ||
| } | ||
|
|
||
| for _, value := range validValues { | ||
| current, err := oc.AdminConfigClient().ConfigV1().APIServers().Get(ctx, "cluster", metav1.GetOptions{}) | ||
| o.Expect(err).NotTo(o.HaveOccurred(), "failed to get apiservers/cluster") | ||
|
|
||
| desired := current.DeepCopy() | ||
| desired.Spec.TLSAdherence = value | ||
|
|
||
| result, err := oc.AdminConfigClient().ConfigV1().APIServers().Update(ctx, desired, metav1.UpdateOptions{ | ||
| DryRun: []string{metav1.DryRunAll}, | ||
| }) | ||
| o.Expect(err).NotTo(o.HaveOccurred(), | ||
| "apiservers/cluster should accept spec.tlsAdherence=%s", value) | ||
| o.Expect(result.Spec.TLSAdherence).To( | ||
| o.Equal(value), | ||
| "apiservers/cluster should reflect spec.tlsAdherence=%s", value) | ||
| } | ||
| }) | ||
|
|
||
| // Test 3 – verify that no cluster operator is degraded when the TLSAdherence feature gate is active. | ||
| g.It("[FeatureGate:TLSAdherence] should not have any degraded cluster operators [apigroup:config.openshift.io]", func(ctx context.Context) { | ||
| coList, err := oc.AdminConfigClient().ConfigV1().ClusterOperators().List(ctx, metav1.ListOptions{}) | ||
| o.Expect(err).NotTo(o.HaveOccurred(), "failed to list clusteroperators") | ||
|
|
||
| for _, co := range coList.Items { | ||
| for _, condition := range co.Status.Conditions { | ||
| if condition.Type == configv1.OperatorDegraded && condition.Status == configv1.ConditionTrue { | ||
| g.Fail(fmt.Sprintf("cluster operator %q is degraded: %s: %s", | ||
| co.Name, condition.Reason, condition.Message)) | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| }) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to test to make sure this can only be set by cluster-admins? Is there an RBAC in place to test?