Skip to content

Add support for custom fields in data compliance rules #206

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.

Sign up for GitHub

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

Open
johanek wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Add support for custom fields in data compliance rules #206

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5ecb6a
Truncate attribute_value to 255 characters, the maximum size allowed
Jul 2, 2025
92ab979
Add datacompliance support for custom field attributes
Jul 2, 2025
57580fc
Update docs and tests for custom field validation
Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions nautobot_data_validation_engine/custom_validators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,10 @@ def compliance_result(self, message, attribute=None, valid=True):
"""Generate a DataCompliance object based on the given parameters."""
instance = self.context["object"]
attribute_value = None
if attribute:
if attribute and attribute.startswith("cf_"):
# Custom field attributes are prefixed with 'cf_'
attribute_value = instance.cf.get(attribute[3:], None)
elif attribute:
attribute_value = getattr(instance, attribute)
else:
attribute = "__all__"
Expand All @@ -295,7 +298,7 @@ def compliance_result(self, message, attribute=None, valid=True):
defaults={
"last_validation_date": self.result_date,
"validated_object_str": str(instance),
"validated_attribute_value": str(attribute_value) if attribute_value else "",
"validated_attribute_value": str(attribute_value)[:254] if attribute_value else "",
Copy link
Contributor

@glennmatthews glennmatthews Jul 2, 2025

Choose a reason for hiding this comment

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

Good catch! We should probably (at least in core/3.0) change this from a CharField to a TextField for more capability/flexibility.

"message": message,
"valid": valid,
},
Expand Down