Skip to content
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

Add the 'auditd-system' message_type choice to the logging resource module #459

Merged
merged 4 commits into from
Nov 20, 2024

Conversation

aida-shumburo
Copy link
Collaborator

@aida-shumburo aida-shumburo commented Oct 1, 2024

SUMMARY

Add new 'message_type' choice to the logging resource module.

GitHub Issues

"N/A".

ISSUE TYPE
  • Feature Pull Request
COMPONENT NAME

sonic_logging

OUTPUT
Ansible Report:

new_message_type.pdf

Raw Regression Test Output:

add_new_message_type.txt

Checklist:
  • I have performed a self-review of my own code to ensure there are no formatting, linting, or security issues
  • I have verified that new and existing unit tests pass locally with my changes
  • I have not allowed coverage numbers to degenerate
  • I have maintained at least 90% code coverage
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have maintained backward compatibility or have provided any relevant "breaking_changes" descriptions in a "fragment" file in the "changelogs/fragments" directory of this repository.
  • I have provided a summary for this PR in valid "fragment" file format in the "changelogs/fragments" directory of this repository branch. Reference : Ansible Change Log Document
How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • I ran different ansible playbooks to test that the new 'message_type' choice is being merged, replaced, deleted, and overriden the correct way.
  • Ran a regression test (attached above)

@aida-shumburo aida-shumburo marked this pull request as ready for review October 1, 2024 19:42
@kerry-meyer kerry-meyer changed the title Add new 'message_type' choice to the logging resource module Add the 'auditd-system' message_type choice to the logging resource module Oct 2, 2024
@aida-shumburo aida-shumburo added the enhancement New feature or request label Oct 29, 2024
Copy link
Collaborator

@kerry-meyer kerry-meyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The proposed changes in code and tests and the corresponding test results look good.

I have posted only a couple of minor change request comments (documentation only; no re-testing needed).

After addressing these comments, please resync your fork and this PR branch to eliminate the merge conflict that is currently flagged on this PR.

Thank you for your work to add Ansible support for the new auditd-system logging message type.

@@ -0,0 +1,2 @@
minor_changes:
- sonic-logging - Add new 'message_type' choice to the logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/459)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please describe the new choice here and add the required '.' at the end of the fragment:

Suggested change
- sonic-logging - Add new 'message_type' choice to the logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/459)
- sonic-logging - Add new 'auditd_system' choice to the 'message_type' choices for the logging resource module (https://github.com/ansible-collections/dellemc.enterprise_sonic/pull/459).

@@ -198,7 +199,7 @@
remote_port: 622
protocol: TCP
source_interface: Ethernet24
message_type: audit
message_type: auditd-system
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please show the corresponding changed result containing auditd-system in the "After state" display for this example.

Copy link
Collaborator

@kerry-meyer kerry-meyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making the additional incremental changes.

All of the current proposed changes and test results look good.

Approved.

@kerry-meyer kerry-meyer merged commit d439ba9 into ansible-collections:main Nov 20, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants