fix:[CORE-1833] Insert audit logs when dangling issues are closed

ershad-paladin commented 2 weeks ago

Description

issue: audit log entry is missed when dangling issues are closed by policy executor
fix: made AuditUtils.postAuditTrail generic and used the same common method to insert audit log when dangling issues are closed

Problem

audit log entry is missed when dangling issues are closed by policy executor

Solution

made AuditUtils.postAuditTrail generic and used the same common method to insert audit log when dangling issues are closed

Fixes # (issue if any)

Type of change

Please delete options that are not relevant.

[X] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Chore (no code changes)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

[X] Replicate the issue first by disabling the policy 'Check for Publicly Accessible Cloud KMS Keys' and verify there is no audit log with status = closed
[X] enable the same policy again, apply fix and disable the policy
[X] verify there is an audit log with status = closed

Checklist:

[X] My code follows the style guidelines of this project
[X] My commit message/PR follows the contribution guidelines of this project
[X] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes

Other Information:

List any documentation updates that are needed for the Wiki

Summary by CodeRabbit

New Features
- Added a new constant POLICY_DISABLED_MSG to communicate disabled policy status.
Improvements
- Enhanced auditing by updating methods in AuditUtils to accept map structures instead of specific objects.
Bug Fixes
- Improved closing of dangling issues in PolicyExecutor with a new condition based on policy status.
Refactor
- Updated method signatures in AuditUtils and CommonUtils for accepting map structures.

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The changes introduce audit trail enhancement and policy handling improvements. Key modifications include updating AuditUtils methods to work with maps instead of Annotation objects, reordering imports, adding the POLICY_DISABLED_MSG constant, and additional logic in PolicyExecutor for closed audits when policies are disabled.

Changes

Files	Change Summary
`.../impl/AnnotationPublisher.java`	Imported `AuditUtils`, reordered imports, modified audit-related logic
`.../util/AuditUtils.java`	Refactored methods to accept maps instead of `Annotation` objects
`.../util/CommonUtils.java`	Modified `getUniqueAnnotationId` method to accept a map instead of an `Annotation` object
`.../common/PacmanSdkConstants.java`	Added `POLICY_DISABLED_MSG` constant
`.../executor/PolicyExecutor.java`	Included condition for `reasonToClose` for policy status and updated related method call

Assessment against linked issues

Objective	Addressed	Explanation
Missing audit log entry for "Closed" Status when policy is disabled (CORE-1833)	✅

Whiskers wiggled, code refined, Audit trails kept in mind. Policies now whisper "close", As maps replace the Annotation prose. Constants added, imports neat, Every line a tidy feat.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.