Update TestBpfmanConfigReconcileAndDelete unit test to verify that the OpenShift SCC is deployed #65
Conversation
This file contains 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
Introduce a new test helper function `setupTestEnvironment` to standardise the setup process for BpfmanConfigReconciler tests. This function handles the initialisation of the fake client, the registration of necessary types with the runtime scheme, and the configuration of the reconciler. The helper enables specific OpenShift testing by conditionally setting the RestrictedSCC field on the reconciler object. The logic is taken from the existing TestBpfmanConfigReconcileAndDelete function. The previous setup logic duplicated paths to various YAML files by pre-pending ../../. This new setup function dispenses with the duplicated paths by using the constants declared in the internal package and resolves the path at runtime to the actual files in the filesystem relative to the test directory. This allows us to refer to the canonical path without having to duplicate it, ensuring that if we ever change the filename then the test code doesn't need to be updated. This commit allows us to share the test setup logic so that we can subsequently modify TestBpfmanConfigReconcileAndDelete to verify that the Restricted SCC is created in the OpenShift test case, which was previously not tested. Signed-off-by: Andrew McDermott <[email protected]>
…Shift Refactor the TestBpfmanConfigReconcileAndDelete function to use a table-driven approach, enabling testing for both standard and OpenShift environments. This change introduces testing for OpenShift by verifying that the Restricted Security Context Constraints (SCC) is created and configured correctly when the isOpenShift flag is true. Additionally, this test identified that the Restricted SCC was not being deleted during the reconciliation process. The reconciler function has been updated to address this omission, ensuring proper cleanup of resources in the OpenShift case. The refactored test uses the new setupTestEnvironment helper function to standardise the setup process. Signed-off-by: Andrew McDermott <[email protected]>
frobware
force-pushed
the
issue-27/test/openshift-scc-deployment
branch
from
4f27d9f to
375cbf2
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #65 +/- ##
==========================================
+ Coverage 27.39% 27.66% +0.27%
==========================================
Files 81 81
Lines 6968 6986 +18
==========================================
+ Hits 1909 1933 +24
+ Misses 4873 4864 -9
- Partials 186 189 +3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
msherif1234
reviewed
Jul 25, 2024
| @@ -173,6 +173,20 @@ func (r *BpfmanConfigReconciler) ReconcileBpfmanConfig(ctx context.Context, req | |||
| return ctrl.Result{Requeue: true, RequeueAfter: retryDurationOperator}, nil | |||
| } | |||
|
|
|||
| if r.IsOpenshift { | |||
|
/LGTM Thanks @frobware |
msherif1234
approved these changes
Jul 31, 2024
msherif1234
pushed a commit
to msherif1234/bpfman-operator
that referenced
this pull request
Nov 6, 2024
…/ocp-bpfman-agent chore(deps): update ocp-bpfman-agent to 1211a10
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #27.
This pull request refactors the existing
TestBpfmanConfigReconcileAndDeletefunction to verify that the OpenShift Security Context Constraints (SCC) resource is created and deleted during reconciliation. The previous implementation did not test the OpenShift case.Summary
setupTestEnvironmenthelper function.TestBpfmanConfigReconcileAndDeleteto use a table-driven approach.These are the key changes:
Introduce
setupTestEnvironmentHelper Function:TestBpfmanConfigReconcileAndDeletetests.RestrictedSCCfield on the reconciler object.Refactor
TestBpfmanConfigReconcileAndDelete:isOpenShiftflag is true.setupTestEnvironmenthelper function to standardise the setup process.