-
Notifications
You must be signed in to change notification settings - Fork 293
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
Refactor RestApiComplianceAuditlogTest to use TestAuditLogImpl.doThenWaitForMessages #3733
Refactor RestApiComplianceAuditlogTest to use TestAuditLogImpl.doThenWaitForMessages #3733
Conversation
…WaitForMessages Signed-off-by: Craig Perkins <[email protected]>
@peternied This PR refactors the whole RestApiComplianceAuditLog test suite to make it more stable. This keeps the |
Signed-off-by: Craig Perkins <[email protected]>
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Show resolved
Hide resolved
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Signed-off-by: Craig Perkins <[email protected]>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #3733 +/- ##
==========================================
- Coverage 65.24% 65.21% -0.03%
==========================================
Files 297 297
Lines 21129 21129
Branches 3451 3451
==========================================
- Hits 13786 13780 -6
- Misses 5643 5652 +9
+ Partials 1700 1697 -3 |
Signed-off-by: Craig Perkins <[email protected]>
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/opensearch/security/auditlog/compliance/RestApiComplianceAuditlogTest.java
Show resolved
Hide resolved
The backport to
To backport manually, run these commands in your terminal: # Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/security/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/security/backport-2.x
# Create a new branch
git switch --create backport/backport-3733-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 6b8a3e494c7933b93f6ee4f1a7956b728ed48a43
# Push it to GitHub
git push --set-upstream origin backport/backport-3733-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/security/backport-2.x Then, create a pull request where the |
…WaitForMessages (opensearch-project#3733) Refactors RestApiComplianceAuditlogTest to make this test suite more stable and re-enable an ignored test. The primary problem in this test suite is that messages that are auto populated on startup get polluted with other audit log messages generated when a user calls REST APIs. To make this more stable, a sleep was added after `setup` to ignore the auto init messages and only isolate messages generated on the API calls in each test. `testAutoInit` is also updated to make it stable. There are 4 automatic messages generated on cluster startup that have to do with the seeding of the security index and audit log index. * Category (Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation) Test Fix opensearch-project#3730 - [ ] New functionality includes testing - [ ] New functionality has been documented - [ ] Commits are signed per the DCO using --signoff By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). --------- Signed-off-by: Craig Perkins <[email protected]> (cherry picked from commit 6b8a3e4)
…WaitForMessages (opensearch-project#3733) ### Description Refactors RestApiComplianceAuditlogTest to make this test suite more stable and re-enable an ignored test. The primary problem in this test suite is that messages that are auto populated on startup get polluted with other audit log messages generated when a user calls REST APIs. To make this more stable, a sleep was added after `setup` to ignore the auto init messages and only isolate messages generated on the API calls in each test. `testAutoInit` is also updated to make it stable. There are 4 automatic messages generated on cluster startup that have to do with the seeding of the security index and audit log index. * Category (Enhancement, New feature, Bug fix, Test fix, Refactoring, Maintenance, Documentation) Test Fix ### Issues Resolved opensearch-project#3730 ### Check List - [ ] New functionality includes testing - [ ] New functionality has been documented - [ ] Commits are signed per the DCO using --signoff By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). --------- Signed-off-by: Craig Perkins <[email protected]> Signed-off-by: Prabhas Kurapati <[email protected]>
Description
Refactors RestApiComplianceAuditlogTest to make this test suite more stable and re-enable an ignored test.
The primary problem in this test suite is that messages that are auto populated on startup get polluted with other audit log messages generated when a user calls REST APIs. To make this more stable, a sleep was added after
setup
to ignore the auto init messages and only isolate messages generated on the API calls in each test.testAutoInit
is also updated to make it stable. There are 4 automatic messages generated on cluster startup that have to do with the seeding of the security index and audit log index.Test Fix
Issues Resolved
#3730
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.