+
-
+
@@ -28,13 +28,13 @@
{% if perms.nautobot_data_validation.add_regularexpressionvalidationrule %}
- {% include 'buttons/clone.html' with url=clone_url %}
+ {% clone_button object %}
{% endif %}
{% if perms.nautobot_data_validation.change_regularexpressionvalidationrule %}
- {% include 'buttons/edit.html' with url=edit_url %}
+ {% edit_button object %}
{% endif %}
{% if perms.nautobot_data_validation.delete_regularexpressionvalidationrule %}
- {% include 'buttons/delete.html' with url=delete_url %}
+ {% delete_button object %}
{% endif %}
{{ object }}
@@ -45,7 +45,7 @@
{{ object }}
{% if perms.extras.view_objectchange %}
- Change Log
+ Change Log
{% endif %}
diff --git a/nautobot_data_validation_engine/templates/nautobot_data_validation_engine/regularexpressionvalidationrule_list.html b/nautobot_data_validation_engine/templates/nautobot_data_validation_engine/regularexpressionvalidationrule_list.html
deleted file mode 100644
index c7b3de2..0000000
--- a/nautobot_data_validation_engine/templates/nautobot_data_validation_engine/regularexpressionvalidationrule_list.html
+++ /dev/null
@@ -1,21 +0,0 @@
-{% extends 'base.html' %}
-{% load buttons %}
-
-{% block content %}
-
- {% if permissions.add %}
- {% add_button 'plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_add' %}
- {% import_button 'plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_import' %}
- {% export_button %}
- {% endif %}
-
-
{% block title %}Regular Expression Rules{% endblock %}
-
-
- {% include 'utilities/obj_table.html' with bulk_delete_url="plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_bulk_delete" bulk_edit_url="plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_bulk_edit" %}
-
-
- {% include 'inc/search_panel.html' %}
-
-
-{% endblock %}
\ No newline at end of file
diff --git a/nautobot_data_validation_engine/tests/__init__.py b/nautobot_data_validation_engine/tests/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/nautobot_data_validation_engine/tests/test_api.py b/nautobot_data_validation_engine/tests/test_api.py
new file mode 100644
index 0000000..d7bd54c
--- /dev/null
+++ b/nautobot_data_validation_engine/tests/test_api.py
@@ -0,0 +1,181 @@
+"""
+API test cases
+"""
+from django.contrib.contenttypes.models import ContentType
+from django.urls import reverse
+
+from nautobot.dcim.models import PowerFeed, Site
+from nautobot.utilities.testing import APITestCase, APIViewTestCases
+
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
+
+
+class AppTest(APITestCase):
+ """
+ Test base path for app
+ """
+
+ def test_root(self):
+ """
+ Test the root view
+ """
+ url = reverse("plugins-api:nautobot_data_validation_engine-api:api-root")
+ response = self.client.get("{}?format=api".format(url), **self.header)
+
+ self.assertEqual(response.status_code, 200)
+
+
+class RegularExpressionValidationRuleTest(APIViewTestCases.APIViewTestCase):
+ """
+ API view test cases for the RegularExpressionValidationRule model
+ """
+
+ model = RegularExpressionValidationRule
+ brief_fields = [
+ "content_type",
+ "created",
+ "display",
+ "enabled",
+ "error_message",
+ "field",
+ "id",
+ "last_updated",
+ "name",
+ "regular_expression",
+ "slug",
+ "url",
+ ]
+
+ create_data = [
+ {
+ "name": "Regex rule 4",
+ "slug": "regex-rule-4",
+ "content_type": "dcim.site",
+ "field": "contact_name",
+ "regular_expression": "^.*$",
+ },
+ {
+ "name": "Regex rule 5",
+ "slug": "regex-rule-5",
+ "content_type": "dcim.site",
+ "field": "physical_address",
+ "regular_expression": "^.*$",
+ },
+ {
+ "name": "Regex rule 6",
+ "slug": "regex-rule-6",
+ "content_type": "dcim.site",
+ "field": "shipping_address",
+ "regular_expression": "^.*$",
+ },
+ ]
+ bulk_update_data = {
+ "enabled": False,
+ }
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="name",
+ regular_expression="^.*$",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 2",
+ slug="regex-rule-2",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="description",
+ regular_expression="^.*$",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 3",
+ slug="regex-rule-3",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="comments",
+ regular_expression="^.*$",
+ )
+
+
+class MinMaxValidationRuleTest(APIViewTestCases.APIViewTestCase):
+ """
+ API view test cases for the MinMaxValidationRule model
+ """
+
+ model = MinMaxValidationRule
+ brief_fields = [
+ "content_type",
+ "created",
+ "display",
+ "enabled",
+ "error_message",
+ "field",
+ "id",
+ "last_updated",
+ "max",
+ "min",
+ "name",
+ "slug",
+ "url",
+ ]
+
+ create_data = [
+ {
+ "name": "Min max rule 4",
+ "slug": "min-max-rule-4",
+ "content_type": "dcim.device",
+ "field": "vc_position",
+ "min": 0,
+ "max": 1,
+ },
+ {
+ "name": "Min max rule 5",
+ "slug": "min-max-rule-5",
+ "content_type": "dcim.device",
+ "field": "vc_priority",
+ "min": -5.6,
+ "max": 0,
+ },
+ {
+ "name": "Min max rule 6",
+ "slug": "min-max-rule-6",
+ "content_type": "dcim.device",
+ "field": "position",
+ "min": 5,
+ "max": 6,
+ },
+ ]
+ bulk_update_data = {
+ "enabled": False,
+ }
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ min=1,
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 2",
+ slug="min-max-rule-2",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="max_utilization",
+ min=1,
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 3",
+ slug="min-max-rule-3",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="voltage",
+ min=1,
+ )
diff --git a/nautobot_data_validation_engine/tests/test_custom_validators.py b/nautobot_data_validation_engine/tests/test_custom_validators.py
new file mode 100644
index 0000000..b6fa2ca
--- /dev/null
+++ b/nautobot_data_validation_engine/tests/test_custom_validators.py
@@ -0,0 +1,209 @@
+"""
+Model test cases
+"""
+from django.contrib.contenttypes.models import ContentType
+from django.core.validators import ValidationError
+from django.test import TestCase
+
+from nautobot.dcim.models import Site
+
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
+
+
+class RegularExpressionValidationRuleModelTestCase(TestCase):
+ """
+ Test cases related to the RegularExpressionValidationRule model
+ """
+
+ def test_invalid_regex_matches_raise_validation_error(self):
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="name",
+ regular_expression="^ABC$",
+ )
+
+ site = Site(name="does not match the regex", slug="site")
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+ def test_valid_regex_matches_do_not_raise_validation_error(self):
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="name",
+ regular_expression="^ABC$",
+ )
+
+ site = Site(name="ABC", slug="site")
+
+ try:
+ site.clean()
+ except ValidationError as e:
+ self.fail(f"rule.clean() failed validation: {e}")
+
+ def test_empty_field_values_coerced_to_empty_string(self):
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="description",
+ regular_expression="^ABC$",
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ description=None, # empty value not allowed by the regex
+ )
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+
+class MinMaxValidationRuleModelTestCase(TestCase):
+ """
+ Test cases related to the MinMaxValidationRule model
+ """
+
+ def test_empty_field_values_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=1,
+ max=1,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=None, # empty value not allowed by the rule
+ )
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+ def test_field_value_type_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=1,
+ max=1,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude="foobar", # wrong type
+ )
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+ def test_min_violation_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=5,
+ max=10,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=4, # less than min of 5
+ )
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+ def test_max_violation_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=5,
+ max=10,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=11, # more than max of 10
+ )
+
+ with self.assertRaises(ValidationError):
+ site.clean()
+
+ def test_unbounded_min_does_not_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=None, # unbounded
+ max=10,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=-5,
+ )
+
+ try:
+ site.clean()
+ except ValidationError as e:
+ self.fail(f"rule.clean() failed validation: {e}")
+
+ def test_unbounded_max_does_not_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=5,
+ max=None, # unbounded
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=30,
+ )
+
+ try:
+ site.clean()
+ except ValidationError as e:
+ self.fail(f"rule.clean() failed validation: {e}")
+
+ def test_valid_bounded_value_does_not_raise_validation_error(self):
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="latitude",
+ min=5,
+ max=10,
+ )
+
+ site = Site(
+ name="does not match the regex",
+ slug="site",
+ latitude=8, # within bounds
+ )
+
+ try:
+ site.clean()
+ except ValidationError as e:
+ self.fail(f"rule.clean() failed validation: {e}")
diff --git a/nautobot_data_validation_engine/tests/test_filters.py b/nautobot_data_validation_engine/tests/test_filters.py
new file mode 100644
index 0000000..c3266e1
--- /dev/null
+++ b/nautobot_data_validation_engine/tests/test_filters.py
@@ -0,0 +1,148 @@
+"""
+Filterset test cases
+"""
+from logging import error
+from django.contrib.contenttypes.models import ContentType
+from django.test import TestCase
+
+from nautobot.dcim.models import PowerFeed, Rack, Region, Site
+
+from nautobot_data_validation_engine.filters import (
+ MinMaxValidationRuleFilterSet,
+ RegularExpressionValidationRuleFilterSet,
+)
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
+
+
+class RegularExpressionValidationRuleFilterTestCase(TestCase):
+ """
+ Filterset test cases for the RegularExpressionValidationRule model
+ """
+
+ queryset = RegularExpressionValidationRule.objects.all()
+ filterset = RegularExpressionValidationRuleFilterSet
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Rack),
+ field="name",
+ regular_expression="^ABC$",
+ error_message="A",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 2",
+ slug="regex-rule-2",
+ content_type=ContentType.objects.get_for_model(Region),
+ field="description",
+ regular_expression="DEF$",
+ error_message="B",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 3",
+ slug="regex-rule-3",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="comments",
+ regular_expression="GHI",
+ error_message="C",
+ )
+
+ def test_id(self):
+ """Test ID lookups."""
+ params = {"id": self.queryset.values_list("pk", flat=True)[:2]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_name(self):
+ """Test name lookups."""
+ params = {"name": ["Regex rule 1", "Regex rule 2"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_content_type(self):
+ """Test content type lookups."""
+ params = {"content_type": ["dcim.rack", "dcim.site"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_regular_expression(self):
+ """Test regex lookups."""
+ # TODO(john): revisit this once this is sorted: https://github.com/nautobot/nautobot/issues/477
+ params = {"regular_expression": "^ABC$"}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1)
+
+ def test_error_message(self):
+ """Test error message lookups."""
+ params = {"error_message": ["A", "B"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_field(self):
+ """Test field lookups."""
+ params = {"field": ["name", "description"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+
+class MinMaxValidationRuleFilterTestCase(TestCase):
+ """
+ Filterset test cases for the MinMaxValidationRule model
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ filterset = MinMaxValidationRuleFilterSet
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ min=1,
+ error_message="A",
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 2",
+ slug="min-max-rule-2",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="max_utilization",
+ min=1,
+ error_message="B",
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 3",
+ slug="min-max-rule-3",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="voltage",
+ min=1,
+ error_message="C",
+ )
+
+ def test_id(self):
+ """Test ID lookups."""
+ params = {"id": self.queryset.values_list("pk", flat=True)[:2]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_name(self):
+ """Test name lookups."""
+ params = {"name": ["Min max rule 1", "Min max rule 2"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_content_type(self):
+ """Test content type lookups."""
+ params = {"content_type": ["dcim.powerfeed"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3)
+
+ def test_error_message(self):
+ """Test error message lookups."""
+ params = {"error_message": ["A", "B"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
+
+ def test_field(self):
+ """Test field lookups."""
+ params = {"field": ["voltage", "max_utilization"]}
+ self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2)
diff --git a/nautobot_data_validation_engine/tests/test_models.py b/nautobot_data_validation_engine/tests/test_models.py
new file mode 100644
index 0000000..56aef15
--- /dev/null
+++ b/nautobot_data_validation_engine/tests/test_models.py
@@ -0,0 +1,169 @@
+"""
+Model test cases
+"""
+from django.contrib.contenttypes.models import ContentType
+from django.core.validators import ValidationError
+from django.test import TestCase
+
+from nautobot.dcim.models import Cable, Device, PowerFeed
+from nautobot.extras.models import Job
+
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
+
+
+class RegularExpressionValidationRuleModelTestCase(TestCase):
+ """
+ Test cases related to the RegularExpressionValidationRule model
+ """
+
+ def test_invalid_field_name(self):
+ """Test that a non-existent model field is rejected."""
+ rule = RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Device),
+ field="afieldthatdoesnotexist",
+ regular_expression="^.*$",
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_private_fields_cannot_be_used(self):
+ """Test that a private model field is rejected."""
+ rule = RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Device),
+ field="_name", # _name is a private field
+ regular_expression="^.*$",
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_non_editable_fields_cannot_be_used(self):
+ """Test that a non-editable model field is rejected."""
+ rule = RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Device),
+ field="created", # created has auto_now_add=True, making it editable=False
+ regular_expression="^.*$",
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_blacklisted_fields_cannot_be_used(self):
+ """Test that a blacklisted model field is rejected."""
+ rule = RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Device),
+ field="id", # id is a uuid field which is blacklisted
+ regular_expression="^.*$",
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_invalid_regex_fails_validation(self):
+ """Test that an invalid regex string fails validation."""
+ rule = RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Device),
+ field="name",
+ regular_expression="[", # this is an invalid regex pattern
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.full_clean()
+
+
+class MinMaxValidationRuleModelTestCase(TestCase):
+ """
+ Test cases related to the MinMaxValidationRule model
+ """
+
+ def test_invalid_field_name(self):
+ """Test that a non-existent model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="afieldthatdoesnotexist",
+ min=1,
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_private_fields_cannot_be_used(self):
+ """Test that a private model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Cable),
+ field="_abs_length", # this is a private field used for caching a denormalized value
+ min=1,
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_blacklisted_fields_cannot_be_used(self):
+ """Test that a blacklisted model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(Job),
+ field="id", # Job.id is an AutoField which is blacklisted
+ min=1,
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_min_or_max_must_be_set(self):
+ """Test that a blacklisted model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_min_must_be_less_than_max(self):
+ """Test that a blacklisted model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ min=1,
+ max=0,
+ )
+
+ with self.assertRaises(ValidationError):
+ rule.clean()
+
+ def test_min__and_max_can_be_equal(self):
+ """Test that a blacklisted model field is rejected."""
+ rule = MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ min=1,
+ max=1,
+ )
+
+ try:
+ rule.clean()
+ except ValidationError as e:
+ self.fail(f"rule.clean() failed validation: {e}")
diff --git a/nautobot_data_validation_engine/tests/test_views.py b/nautobot_data_validation_engine/tests/test_views.py
new file mode 100644
index 0000000..d4c8912
--- /dev/null
+++ b/nautobot_data_validation_engine/tests/test_views.py
@@ -0,0 +1,123 @@
+"""
+View test cases
+"""
+from django.contrib.contenttypes.models import ContentType
+
+from nautobot.dcim.models import Device, PowerFeed, Site
+from nautobot.utilities.testing import ViewTestCases
+
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
+
+
+class RegularExpressionValidationRuleTestCase(ViewTestCases.PrimaryObjectViewTestCase):
+ """
+ View test cases for the RegularExpressionValidationRule model
+ """
+
+ model = RegularExpressionValidationRule
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 1",
+ slug="regex-rule-1",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="name",
+ regular_expression="^.*$",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 2",
+ slug="regex-rule-2",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="description",
+ regular_expression="^.*$",
+ )
+ RegularExpressionValidationRule.objects.create(
+ name="Regex rule 3",
+ slug="regex-rule-3",
+ content_type=ContentType.objects.get_for_model(Site),
+ field="comments",
+ regular_expression="^.*$",
+ )
+
+ cls.form_data = {
+ "name": "Regex rule x",
+ "slug": "regex-rule-x",
+ "content_type": ContentType.objects.get_for_model(Site).pk,
+ "field": "contact_name",
+ "regular_expression": "^.*$",
+ }
+
+ cls.csv_data = (
+ "name,slug,content_type,field,regular_expression",
+ "Regex rule 4,regex-rule-4,dcim.site,contact_phone,^.*$",
+ "Regex rule 5,regex-rule-5,dcim.site,physical_address,^.*$",
+ "Regex rule 6,regex-rule-6,dcim.site,shipping_address,^.*$",
+ )
+
+ cls.bulk_edit_data = {
+ "regular_expression": "^.*.*$",
+ "enabled": False,
+ "error_message": "no soup",
+ }
+
+
+class MinMaxValidationRuleTestCase(ViewTestCases.PrimaryObjectViewTestCase):
+ """
+ View test cases for the MinMaxValidationRule model
+ """
+
+ model = MinMaxValidationRule
+
+ @classmethod
+ def setUpTestData(cls):
+ """
+ Create test data
+ """
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 1",
+ slug="min-max-rule-1",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="amperage",
+ min=1,
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 2",
+ slug="min-max-rule-2",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="max_utilization",
+ min=1,
+ )
+ MinMaxValidationRule.objects.create(
+ name="Min max rule 3",
+ slug="min-max-rule-3",
+ content_type=ContentType.objects.get_for_model(PowerFeed),
+ field="voltage",
+ min=1,
+ )
+
+ cls.form_data = {
+ "name": "Min max rule x",
+ "slug": "min-max-rule-x",
+ "content_type": ContentType.objects.get_for_model(Device).pk,
+ "field": "position",
+ "min": 5.0,
+ "max": 6.0,
+ }
+
+ cls.csv_data = (
+ "name,slug,content_type,field,min,max",
+ "Min max rule 4,min-max-rule-4,dcim.device,vc_position,5,6",
+ "Min max rule 5,min-max-rule-5,dcim.device,vc_priority,5,6",
+ "Min max rule 6,min-max-rule-6,dcim.site,longitude,5,6",
+ )
+
+ cls.bulk_edit_data = {
+ "min": 5.0,
+ "max": 6.0,
+ "enabled": False,
+ "error_message": "no soup",
+ }
diff --git a/nautobot_data_validation_engine/urls.py b/nautobot_data_validation_engine/urls.py
index 7b54cfb..4be0099 100644
--- a/nautobot_data_validation_engine/urls.py
+++ b/nautobot_data_validation_engine/urls.py
@@ -1,59 +1,109 @@
"""
Django url patterns.
"""
-from django.urls import path
+from django.urls import path, include
from nautobot.extras.views import ObjectChangeLogView
from nautobot_data_validation_engine import views
-from nautobot_data_validation_engine.models import RegularExpressionValidationRule
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
-urlpatterns = [
+rule_patterns = [
path(
- "regex-rules/",
+ "regex/",
views.RegularExpressionValidationRuleListView.as_view(),
name="regularexpressionvalidationrule_list",
),
path(
- "regex-rules/add/",
+ "regex/add/",
views.RegularExpressionValidationRuleEditView.as_view(),
name="regularexpressionvalidationrule_add",
),
path(
- "regex-rules/import/",
+ "regex/import/",
views.RegularExpressionValidationRuleBulkImportView.as_view(),
name="regularexpressionvalidationrule_import",
),
path(
- "regex-rules/edit/",
+ "regex/edit/",
views.RegularExpressionValidationRuleBulkEditView.as_view(),
name="regularexpressionvalidationrule_bulk_edit",
),
path(
- "regex-rules/delete/",
+ "regex/delete/",
views.RegularExpressionValidationRuleBulkDeleteView.as_view(),
name="regularexpressionvalidationrule_bulk_delete",
),
path(
- "regex-rules/
/",
+ "regex//",
views.RegularExpressionValidationRuleView.as_view(),
name="regularexpressionvalidationrule",
),
path(
- "regex-rules//edit/",
+ "regex//edit/",
views.RegularExpressionValidationRuleEditView.as_view(),
name="regularexpressionvalidationrule_edit",
),
path(
- "regex-rules//delete/",
+ "regex//delete/",
views.RegularExpressionValidationRuleDeleteView.as_view(),
name="regularexpressionvalidationrule_delete",
),
path(
- "regex-rules//changelog/",
+ "regex//changelog/",
ObjectChangeLogView.as_view(),
name="regularexpressionvalidationrule_changelog",
kwargs={"model": RegularExpressionValidationRule},
),
+ path(
+ "min-max/",
+ views.MinMaxValidationRuleListView.as_view(),
+ name="minmaxvalidationrule_list",
+ ),
+ path(
+ "min-max/add/",
+ views.MinMaxValidationRuleEditView.as_view(),
+ name="minmaxvalidationrule_add",
+ ),
+ path(
+ "min-max/import/",
+ views.MinMaxValidationRuleBulkImportView.as_view(),
+ name="minmaxvalidationrule_import",
+ ),
+ path(
+ "min-max/edit/",
+ views.MinMaxValidationRuleBulkEditView.as_view(),
+ name="minmaxvalidationrule_bulk_edit",
+ ),
+ path(
+ "min-max/delete/",
+ views.MinMaxValidationRuleBulkDeleteView.as_view(),
+ name="minmaxvalidationrule_bulk_delete",
+ ),
+ path(
+ "min-max//",
+ views.MinMaxValidationRuleView.as_view(),
+ name="minmaxvalidationrule",
+ ),
+ path(
+ "min-max//edit/",
+ views.MinMaxValidationRuleEditView.as_view(),
+ name="minmaxvalidationrule_edit",
+ ),
+ path(
+ "min-max//delete/",
+ views.MinMaxValidationRuleDeleteView.as_view(),
+ name="minmaxvalidationrule_delete",
+ ),
+ path(
+ "min-max//changelog/",
+ ObjectChangeLogView.as_view(),
+ name="minmaxvalidationrule_changelog",
+ kwargs={"model": MinMaxValidationRule},
+ ),
+]
+
+urlpatterns = [
+ path("rules/", include(rule_patterns)),
]
diff --git a/nautobot_data_validation_engine/views.py b/nautobot_data_validation_engine/views.py
index 0194eda..1eb4914 100644
--- a/nautobot_data_validation_engine/views.py
+++ b/nautobot_data_validation_engine/views.py
@@ -1,13 +1,10 @@
"""
Django views.
"""
-from django.shortcuts import reverse
-
from nautobot.core.views import generic
-from nautobot.utilities.utils import prepare_cloned_fields
from nautobot_data_validation_engine import filters, forms, tables
-from nautobot_data_validation_engine.models import RegularExpressionValidationRule
+from nautobot_data_validation_engine.models import MinMaxValidationRule, RegularExpressionValidationRule
#
@@ -24,7 +21,6 @@ class RegularExpressionValidationRuleListView(generic.ObjectListView):
filterset = filters.RegularExpressionValidationRuleFilterSet
filterset_form = forms.RegularExpressionValidationRuleFilterForm
table = tables.RegularExpressionValidationRuleTable
- template_name = "nautobot_data_validation_engine/regularexpressionvalidationrule_list.html"
class RegularExpressionValidationRuleView(generic.ObjectView):
@@ -33,29 +29,6 @@ class RegularExpressionValidationRuleView(generic.ObjectView):
"""
queryset = RegularExpressionValidationRule.objects.all()
- template_name = "nautobot_data_validation_engine/regularexpressionvalidationrule.html"
-
- def get_extra_context(self, request, instance):
- """
- Generate the urls for the UI buttons since the core templatetags do not understand the plugins namespace.
- """
- clone_url = reverse("plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_add")
- cloned_param_string = prepare_cloned_fields(instance)
- if cloned_param_string:
- clone_url = f"{clone_url}?{cloned_param_string}"
-
- edit_url = reverse(
- "plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_edit", args=[instance.pk]
- )
- delete_url = reverse(
- "plugins:nautobot_data_validation_engine:regularexpressionvalidationrule_delete", args=[instance.pk]
- )
-
- return {
- "clone_url": clone_url,
- "edit_url": edit_url,
- "delete_url": delete_url,
- }
class RegularExpressionValidationRuleEditView(generic.ObjectEditView):
@@ -104,3 +77,75 @@ class RegularExpressionValidationRuleBulkDeleteView(generic.BulkDeleteView):
queryset = RegularExpressionValidationRule.objects.all()
filterset = filters.RegularExpressionValidationRuleFilterSet
table = tables.RegularExpressionValidationRuleTable
+
+
+#
+# MinMaxValidationRules
+#
+
+
+class MinMaxValidationRuleListView(generic.ObjectListView):
+ """
+ Base list view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ filterset = filters.MinMaxValidationRuleFilterSet
+ filterset_form = forms.MinMaxValidationRuleFilterForm
+ table = tables.MinMaxValidationRuleTable
+
+
+class MinMaxValidationRuleView(generic.ObjectView):
+ """
+ Base detail view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+
+
+class MinMaxValidationRuleEditView(generic.ObjectEditView):
+ """
+ Base edit view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ model_form = forms.MinMaxValidationRuleForm
+
+
+class MinMaxValidationRuleDeleteView(generic.ObjectDeleteView):
+ """
+ Base delete view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+
+
+class MinMaxValidationRuleBulkImportView(generic.BulkImportView):
+ """
+ Base bulk import view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ model_form = forms.MinMaxValidationRuleCSVForm
+ table = tables.MinMaxValidationRuleTable
+
+
+class MinMaxValidationRuleBulkEditView(generic.BulkEditView):
+ """
+ Base bulk edit view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ filterset = filters.MinMaxValidationRuleFilterSet
+ table = tables.MinMaxValidationRuleTable
+ form = forms.MinMaxValidationRuleBulkEditForm
+
+
+class MinMaxValidationRuleBulkDeleteView(generic.BulkDeleteView):
+ """
+ Base bulk delete view for the MinMaxValidationRule model.
+ """
+
+ queryset = MinMaxValidationRule.objects.all()
+ filterset = filters.MinMaxValidationRuleFilterSet
+ table = tables.MinMaxValidationRuleTable
diff --git a/poetry.lock b/poetry.lock
index 70ca9dc..09916af 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -108,14 +108,15 @@ smmap = ">=3.0.1,<4"
[[package]]
name = "gitpython"
-version = "3.1.13"
+version = "3.1.17"
description = "Python Git Library"
category = "dev"
optional = false
-python-versions = ">=3.4"
+python-versions = ">=3.5"
[package.dependencies]
gitdb = ">=4.0.1,<5"
+typing-extensions = {version = ">=3.7.4.0", markers = "python_version < \"3.8\""}
[[package]]
name = "importlib-metadata"
@@ -393,7 +394,6 @@ bandit = [
{file = "bandit-1.7.0.tar.gz", hash = "sha256:8a4c7415254d75df8ff3c3b15cfe9042ecee628a1e40b44c15a98890fbfc2608"},
]
black = [
- {file = "black-20.8b1-py3-none-any.whl", hash = "sha256:70b62ef1527c950db59062cda342ea224d772abdf6adc58b86a45421bab20a6b"},
{file = "black-20.8b1.tar.gz", hash = "sha256:1c02557aa099101b9d21496f8a914e9ed2222ef70336404eeeac8edba836fbea"},
]
click = [
@@ -417,8 +417,8 @@ gitdb = [
{file = "gitdb-4.0.5.tar.gz", hash = "sha256:c9e1f2d0db7ddb9a704c2a0217be31214e91a4fe1dea1efad19ae42ba0c285c9"},
]
gitpython = [
- {file = "GitPython-3.1.13-py3-none-any.whl", hash = "sha256:c5347c81d232d9b8e7f47b68a83e5dc92e7952127133c5f2df9133f2c75a1b29"},
- {file = "GitPython-3.1.13.tar.gz", hash = "sha256:8621a7e777e276a5ec838b59280ba5272dd144a18169c36c903d8b38b99f750a"},
+ {file = "GitPython-3.1.17-py3-none-any.whl", hash = "sha256:29fe82050709760081f588dd50ce83504feddbebdc4da6956d02351552b1c135"},
+ {file = "GitPython-3.1.17.tar.gz", hash = "sha256:ee24bdc93dce357630764db659edaf6b8d664d4ff5447ccfeedd2dc5c253f41e"},
]
importlib-metadata = [
{file = "importlib_metadata-3.4.0-py3-none-any.whl", hash = "sha256:ace61d5fc652dc280e7b6b4ff732a9c2d40db2c0f92bc6cb74e07b73d53a1771"},
@@ -506,18 +506,26 @@ pyyaml = [
{file = "PyYAML-5.4.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185"},
{file = "PyYAML-5.4.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253"},
{file = "PyYAML-5.4.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc"},
+ {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:72a01f726a9c7851ca9bfad6fd09ca4e090a023c00945ea05ba1638c09dc3347"},
+ {file = "PyYAML-5.4.1-cp36-cp36m-manylinux2014_s390x.whl", hash = "sha256:895f61ef02e8fed38159bb70f7e100e00f471eae2bc838cd0f4ebb21e28f8541"},
{file = "PyYAML-5.4.1-cp36-cp36m-win32.whl", hash = "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5"},
{file = "PyYAML-5.4.1-cp36-cp36m-win_amd64.whl", hash = "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df"},
{file = "PyYAML-5.4.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018"},
{file = "PyYAML-5.4.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63"},
+ {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:cb333c16912324fd5f769fff6bc5de372e9e7a202247b48870bc251ed40239aa"},
+ {file = "PyYAML-5.4.1-cp37-cp37m-manylinux2014_s390x.whl", hash = "sha256:fe69978f3f768926cfa37b867e3843918e012cf83f680806599ddce33c2c68b0"},
{file = "PyYAML-5.4.1-cp37-cp37m-win32.whl", hash = "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b"},
{file = "PyYAML-5.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf"},
{file = "PyYAML-5.4.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46"},
{file = "PyYAML-5.4.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb"},
+ {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:fd7f6999a8070df521b6384004ef42833b9bd62cfee11a09bda1079b4b704247"},
+ {file = "PyYAML-5.4.1-cp38-cp38-manylinux2014_s390x.whl", hash = "sha256:bfb51918d4ff3d77c1c856a9699f8492c612cde32fd3bcd344af9be34999bfdc"},
{file = "PyYAML-5.4.1-cp38-cp38-win32.whl", hash = "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc"},
{file = "PyYAML-5.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696"},
{file = "PyYAML-5.4.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77"},
{file = "PyYAML-5.4.1-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183"},
+ {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:d483ad4e639292c90170eb6f7783ad19490e7a8defb3e46f97dfe4bacae89122"},
+ {file = "PyYAML-5.4.1-cp39-cp39-manylinux2014_s390x.whl", hash = "sha256:fdc842473cd33f45ff6bce46aea678a54e3d21f1b61a7750ce3c498eedfe25d6"},
{file = "PyYAML-5.4.1-cp39-cp39-win32.whl", hash = "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10"},
{file = "PyYAML-5.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db"},
{file = "PyYAML-5.4.1.tar.gz", hash = "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e"},
diff --git a/tasks.py b/tasks.py
index 32217fd..430ffe0 100644
--- a/tasks.py
+++ b/tasks.py
@@ -1,55 +1,49 @@
-"""Tasks for use with Invoke.
-
-(c) 2020-2021 Network To Code
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
+"""Tasks for use with Invoke."""
import os
from invoke import task
PYTHON_VER = os.getenv("PYTHON_VER", "3.7")
-NAUTOBOT_VER = os.getenv("NAUTOBOT_VER", "master")
+NAUTOBOT_VER = os.getenv("NAUTOBOT_VER", "1.0.2")
+NAUTOBOT_SRC_URL = os.getenv("NAUTOBOT_SRC_URL", f"https://github.com/nautobot/nautobot/archive/{NAUTOBOT_VER}.tar.gz")
# Name of the docker image/container
NAME = os.getenv("IMAGE_NAME", "nautobot-data-validation-engine")
PWD = os.getcwd()
COMPOSE_FILE = "development/docker-compose.yml"
+COMPOSE_OVERRIDE = "docker-compose.override.yml"
BUILD_NAME = "nautobot_data_validation_engine"
+DEFAULT_ENV = {
+ "NAUTOBOT_VER": NAUTOBOT_VER,
+ "PYTHON_VER": PYTHON_VER,
+ "NAUTOBOT_SRC_URL": NAUTOBOT_SRC_URL,
+}
+COMPOSE_APPEND = ""
+if os.path.isfile(COMPOSE_OVERRIDE):
+ COMPOSE_APPEND = f"-f {COMPOSE_OVERRIDE}"
+COMPOSE_COMMAND = f"docker-compose -f {COMPOSE_FILE} {COMPOSE_APPEND} -p {BUILD_NAME}"
+
+environment = DEFAULT_ENV
# ------------------------------------------------------------------------------
# BUILD
# ------------------------------------------------------------------------------
@task
-def build(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER, nocache=False, forcerm=False):
+def build(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Build all docker images.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
- nocache (bool): Do not use cache when building the image
- forcerm (bool): Always remove intermediate containers
"""
- command = "build"
-
- if nocache:
- command += " --no-cache"
- if forcerm:
- command += " --force-rm"
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} {command}",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} build",
+ env=DEFAULT_ENV,
)
@@ -59,67 +53,75 @@ def build(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER, nocache=Fal
@task
def debug(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Start Nautobot and its dependencies in debug mode.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
print("Starting Nautobot .. ")
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} up",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} up",
+ env=DEFAULT_ENV,
)
@task
def start(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Start Nautobot and its dependencies in detached mode.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
print("Starting Nautobot in detached mode.. ")
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} up -d",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} up -d",
+ env=DEFAULT_ENV,
)
@task
def stop(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Stop Nautobot and its dependencies.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
print("Stopping Nautobot .. ")
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} down",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} down",
+ env=DEFAULT_ENV,
)
@task
def destroy(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Destroy all containers and volumes.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} down",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} down",
+ env=DEFAULT_ENV,
)
context.run(
f"docker volume rm -f {BUILD_NAME}_pgdata_nautobot_data_validation_engine",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ env=DEFAULT_ENV,
)
@@ -129,15 +131,17 @@ def destroy(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def nbshell(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Launch a nbshell session.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot nautobot-server nbshell",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} run nautobot nautobot-server nbshell",
+ env=DEFAULT_ENV,
pty=True,
)
@@ -145,15 +149,17 @@ def nbshell(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def cli(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Launch a bash shell inside the running Nautobot container.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot bash",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} run nautobot bash",
+ env=DEFAULT_ENV,
pty=True,
)
@@ -161,16 +167,18 @@ def cli(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def create_user(context, user="admin", nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Create a new user in django (default: admin), will prompt for password.
-
Args:
context (obj): Used to run specific commands
user (str): name of the superuser to create
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot nautobot-server createsuperuser --username {user}",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} run nautobot nautobot-server createsuperuser --username {user}",
+ env=DEFAULT_ENV,
pty=True,
)
@@ -178,32 +186,34 @@ def create_user(context, user="admin", nautobot_ver=NAUTOBOT_VER, python_ver=PYT
@task
def makemigrations(context, name="", nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run Make Migration in Django.
-
Args:
context (obj): Used to run specific commands
name (str): Name of the migration to be created
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} up -d postgres",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} up -d postgres",
+ env=DEFAULT_ENV,
)
if name:
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot nautobot-server makemigrations --name {name}",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} run nautobot nautobot-server makemigrations nautobot_data_validation_engine --name {name}",
+ env=DEFAULT_ENV,
)
else:
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot nautobot-server makemigrations",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} run nautobot nautobot-server makemigrations nautobot_data_validation_engine",
+ env=DEFAULT_ENV,
)
context.run(
- f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} down",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{COMPOSE_COMMAND} down",
+ env=DEFAULT_ENV,
)
@@ -213,16 +223,18 @@ def makemigrations(context, name="", nautobot_ver=NAUTOBOT_VER, python_ver=PYTHO
@task
def unittest(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run Django unit tests for the plugin.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
+ docker = f"{COMPOSE_COMMAND} run --entrypoint='' nautobot "
context.run(
f'{docker} sh -c "nautobot-server test nautobot_data_validation_engine"',
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ env=DEFAULT_ENV,
pty=True,
)
@@ -230,17 +242,20 @@ def unittest(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def pylint(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run pylint code analysis.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
+ docker = f"{COMPOSE_COMMAND} run --entrypoint='' nautobot "
# We exclude the /migrations/ directory since it is autogenerated code
context.run(
- f"{docker} sh -c \"cd /source && find . -name '*.py' -not -path '*/migrations/*' | xargs pylint\"",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f"{docker} sh -c \"cd /source && find . -name '*.py' -not -path '*/migrations/*' | "
+ 'PYTHONPATH=/source/development DJANGO_SETTINGS_MODULE=nautobot_config xargs pylint"',
+ env=DEFAULT_ENV,
pty=True,
)
@@ -248,33 +263,18 @@ def pylint(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def black(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run black to check that Python files adhere to its style standards.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
- context.run(
- f'{docker} sh -c "cd /source && black --check --diff ."',
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
- pty=True,
- )
-
-
-@task
-def blacken(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
- """Run black to format Python files to adhere to its style standards.
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
- Args:
- context (obj): Used to run specific commands
- nautobot_ver (str): Nautobot version to use to build the container
- python_ver (str): Will use the Python version docker image to build from
- """
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
+ docker = f"{COMPOSE_COMMAND} run --entrypoint='' nautobot "
context.run(
- f'{docker} sh -c "cd /source && black ."',
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f'{docker} sh -c "cd /source && black --check --diff ."',
+ env=DEFAULT_ENV,
pty=True,
)
@@ -282,51 +282,19 @@ def blacken(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def pydocstyle(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
+ docker = f"{COMPOSE_COMMAND} run --entrypoint='' nautobot "
# We exclude the /migrations/ directory since it is autogenerated code
context.run(
f"{docker} sh -c \"cd /source && find . -name '*.py' -not -path '*/migrations/*' | xargs pydocstyle\"",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
- pty=True,
- )
-
-
-@task
-def flake8(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
- """This will run flake8 for the specified name and Python version.
-
- Args:
- context (obj): Used to run specific commands
- nautobot_ver (str): Nautobot version to use to build the container
- python_ver (str): Will use the Python version docker image to build from
- """
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
- context.run(
- f"{docker} sh -c \"cd /source && find . -name '*.py' | xargs flake8\"",
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
- pty=True,
- )
-
-
-@task
-def yamllint(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
- """Run yamllint to validate formatting adheres to NTC defined YAML standards.
-
- Args:
- context (obj): Used to run specific commands
- nautobot_ver (str): Nautobot version to use to build the container
- python_ver (str): Will use the Python version docker image to build from
- """
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
- context.run(
- f'{docker} sh -c "cd /source && yamllint ."',
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ env=DEFAULT_ENV,
pty=True,
)
@@ -334,16 +302,18 @@ def yamllint(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def bandit(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run bandit to validate basic static code security analysis.
-
Args:
context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
- docker = f"docker-compose -f {COMPOSE_FILE} -p {BUILD_NAME} run nautobot"
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
+ docker = f"{COMPOSE_COMMAND} run --entrypoint='' nautobot "
context.run(
- f'{docker} sh -c "cd /source && bandit --configfile .bandit.yml --recursive ./"',
- env={"NAUTOBOT_VER": nautobot_ver, "PYTHON_VER": python_ver},
+ f'{docker} sh -c "cd /source && bandit --recursive ./ --configfile .bandit.yml"',
+ env=DEFAULT_ENV,
pty=True,
)
@@ -351,25 +321,24 @@ def bandit(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
@task
def tests(context, nautobot_ver=NAUTOBOT_VER, python_ver=PYTHON_VER):
"""Run all tests for this plugin.
-
Args:
- context (obj): Used to run specific commands
+ context (obj): Used to run specific commands
nautobot_ver (str): Nautobot version to use to build the container
python_ver (str): Will use the Python version docker image to build from
"""
+ DEFAULT_ENV[NAUTOBOT_VER] = nautobot_ver
+ DEFAULT_ENV[PYTHON_VER] = python_ver
+
# Sorted loosely from fastest to slowest
print("Running black...")
black(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
- print("Running yamllint...")
- yamllint(context, NAME, python_ver)
print("Running bandit...")
bandit(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
- # print("Running pydocstyle...")
- # pydocstyle(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
- print("Running flake8...")
- flake8(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
- # print("Running pylint...")
- # pylint(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
+ print("Running pydocstyle...")
+ pydocstyle(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
+ print("Running pylint...")
+ pylint(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
print("Running unit tests...")
unittest(context, nautobot_ver=nautobot_ver, python_ver=python_ver)
+
print("All tests have passed!")