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 data sources to ruletype API #5019

Merged
merged 2 commits into from
Nov 22, 2024
Merged

Conversation

JAORMX
Copy link
Contributor

@JAORMX JAORMX commented Nov 21, 2024

Summary

This adds the ability for the eval engine to reference data sources to
be instantiated. this allows us to explicitly declare what data sources
a rule type needs which will in turn be used to keep track of
dependencies.

Only declared ruletypes will be registered in the per-rule data source
registry.

Data sources are declared in ruletypes by name. The API was built in a
way that we can eventually add other reference means other than names;
but names will do for now.

Note that name validation was also changed to reflect that we only
accept lowercase characters for data source names.

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Outline how the changes were tested, including steps to reproduce and any relevant configurations.
Attach screenshots if helpful.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@JAORMX JAORMX requested a review from a team as a code owner November 21, 2024 08:06
@coveralls
Copy link

coveralls commented Nov 21, 2024

Coverage Status

coverage: 54.63% (-0.001%) from 54.631%
when pulling 24f8f46 on JAORMX:ruletype-datasources
into 3cc4ae8 on mindersec:main.

This adds the ability for the eval engine to reference data sources to
be instantiated. this allows us to explicitly declare what data sources
a rule type needs which will in turn be used to keep track of
dependencies.

Only declared ruletypes will be registered in the per-rule data source
registry.

Data sources are declared in ruletypes by name. The API was built in a
way that we can eventually add other reference means other than names;
but names will do for now.

Note that name validation was also changed to reflect that we only
accept lowercase characters for data source names.

Signed-off-by: Juan Antonio Osorio <[email protected]>
@JAORMX JAORMX force-pushed the ruletype-datasources branch from 7802f3f to 24f8f46 Compare November 21, 2024 11:14
@JAORMX JAORMX requested a review from blkt November 22, 2024 07:25
@JAORMX JAORMX merged commit 0c315ea into mindersec:main Nov 22, 2024
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants