Skip to content

Conversation

@kaddujames501-ship-it
Copy link

@kaddujames501-ship-it kaddujames501-ship-it commented Nov 2, 2025

Task #6351

Contribution style:

Our Contribution agreements:

Changes (if applicable):

Link to ticket: https://redmine.openinfosecfoundation.org/issues/6351

Describe changes:
Add xbits keyword details to engine analysis output in DumpMatches function. Exposes cmd, name, track, and expire properties in JSON format, following the same pattern as byte_jump and flowbits.

This improves the engine analysis report by providing complete information about xbits usage in rules when running with --engine-analysis flag.

Provide values to any of the below to override the defaults.

  • To use a Suricata-Verify or Suricata-Update pull request,
    link to the pull request in the respective _BRANCH variable.
  • Leave unused overrides blank or remove.

SV_REPO=
SV_BRANCH=github.com/OISF/suricata-verify/pull/2741
SU_REPO=
SU_BRANCH=

James Kaddu: [email protected]

@victorjulien victorjulien added the outreachy Contributions made by Outreachy applicants label Nov 2, 2025
@github-actions
Copy link

github-actions bot commented Nov 2, 2025

NOTE: This PR may contain new authors.

@codecov
Copy link

codecov bot commented Nov 2, 2025

Codecov Report

❌ Patch coverage is 0% with 37 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.13%. Comparing base (cdd4ea0) to head (c20cb6a).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14252      +/-   ##
==========================================
- Coverage   84.14%   84.13%   -0.02%     
==========================================
  Files        1013     1013              
  Lines      262313   262350      +37     
==========================================
- Hits       220733   220732       -1     
- Misses      41580    41618      +38     
Flag Coverage Δ
fuzzcorpus 63.30% <0.00%> (-0.03%) ⬇️
livemode 18.71% <0.00%> (-0.06%) ⬇️
pcap 44.57% <0.00%> (+<0.01%) ⬆️
suricata-verify 64.85% <0.00%> (-0.03%) ⬇️
unittests 59.18% <0.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jufajardini
Copy link
Contributor

jufajardini commented Nov 4, 2025

Hello, thanks for this contribution. Could you please create SV tests to go with this patch? You can check OISF/suricata-verify#2717 for an overall idea of what type of test we are looking for, for these engine analysis tasks :)

Copy link
Contributor

@jufajardini jufajardini left a comment

Choose a reason for hiding this comment

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

Something happened with the commit message: the ticket number is aaaaaalll the way lost to the right :P

This looks good, but will be easier to judge once we have the SV test, so I'm marking it as changes requested, for the SV tests, and the commit message.

@kaddujames501-ship-it kaddujames501-ship-it marked this pull request as draft November 5, 2025 11:16
@kaddujames501-ship-it
Copy link
Author

kaddujames501-ship-it commented Nov 5, 2025

Hello, thanks for this contribution? Could you please create SV tests to go with this patch? You can check OISF/suricata-verify#2717 for an overall idea of what type of test we are looking for, for these engine analysis tasks :)

the PR is here as requested github.com/OISF/suricata-verify/pull/2741

Add xbits keyword details to engine analysis output in DumpMatches
function. Exposes cmd, name, track, and expire properties in JSON
format, following the same pattern as byte_jump and flowbits.

This improves the engine analysis report by providing complete
information about xbits usage in rules when running with
--engine-analysis flag.

Task OISF#6351
@kaddujames501-ship-it
Copy link
Author

Something happened with the commit message: the ticket number is aaaaaalll the way lost to the right :P

This looks good, but will be easier to judge once we have the SV test, so I'm marking it as changes requested, for the SV tests, and the commit message.
the commit message has now been catered for. thanks for the corrections

@kaddujames501-ship-it kaddujames501-ship-it marked this pull request as ready for review November 5, 2025 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

outreachy Contributions made by Outreachy applicants

Development

Successfully merging this pull request may close these issues.

4 participants