enchancement for status field for contracts

changes/337.added

@@ -0,0 +1 @@
+Added a Status Field to ContractLCM for lifecycle purposes.

nautobot_device_lifecycle_mgmt/filters.py

@@ -593,7 +593,7 @@ def _sw_missing_only(self, queryset, name, value):  # pylint: disable=unused-arg
         return queryset
 
 
-class ContractLCMFilterSet(NautobotFilterSet):
+class ContractLCMFilterSet(NautobotFilterSet, StatusModelFilterSetMixin):
     """Filter for ContractLCMFilter."""
 
     q = django_filters.CharFilter(method="search", label="Search")

nautobot_device_lifecycle_mgmt/forms.py

@@ -17,8 +17,20 @@
     add_blank_choice,
 )
 from nautobot.core.forms.constants import BOOLEAN_WITH_BLANK_CHOICES
-from nautobot.dcim.models import Device, DeviceType, InventoryItem, Location, Manufacturer, Platform
-from nautobot.extras.forms import CustomFieldModelBulkEditFormMixin, NautobotFilterForm
+from nautobot.dcim.models import (
+    Device,
+    DeviceType,
+    InventoryItem,
+    Location,
+    Manufacturer,
+    Platform,
+)
+from nautobot.extras.forms import (
+    CustomFieldModelBulkEditFormMixin,
+    NautobotFilterForm,
+    StatusModelBulkEditFormMixin,
+    StatusModelFilterFormMixin,
+)
 from nautobot.extras.models import Role, Status, Tag
 
 from nautobot_device_lifecycle_mgmt.choices import (
@@ -75,7 +87,10 @@ class HardwareLCMForm(NautobotModelForm):
     device_type = DynamicModelChoiceField(queryset=DeviceType.objects.all(), required=False)
     inventory_item = HardwareLCMDynamicModelChoiceField(
         queryset=InventoryItem.objects.without_tree_fields().order_by().distinct("part_id"),
-        query_params={"part_id__nre": "^$", "nautobot_device_lifecycle_mgmt_distinct_part_id": "true"},
+        query_params={
+            "part_id__nre": "^$",
+            "nautobot_device_lifecycle_mgmt_distinct_part_id": "true",
+        },
         label="Inventory Part ID",
         display_field="part_id",
         to_field_name="part_id",
@@ -354,7 +369,9 @@ class ValidatedSoftwareLCMForm(NautobotModelForm):
     devices = DynamicModelMultipleChoiceField(queryset=Device.objects.all(), required=False)
     device_types = DynamicModelMultipleChoiceField(queryset=DeviceType.objects.all(), required=False)
     device_roles = DynamicModelMultipleChoiceField(
-        queryset=Role.objects.all(), query_params={"content_types": "dcim.device"}, required=False
+        queryset=Role.objects.all(),
+        query_params={"content_types": "dcim.device"},
+        required=False,
     )
 
     inventory_items = DynamicModelMultipleChoiceField(queryset=InventoryItem.objects.all(), required=False)
@@ -383,7 +400,19 @@ def clean(self):
         inventory_items = self.cleaned_data.get("inventory_items")
         object_tags = self.cleaned_data.get("object_tags")
 
-        if sum(obj.count() for obj in (devices, device_types, device_roles, inventory_items, object_tags)) == 0:
+        if (
+            sum(
+                obj.count()
+                for obj in (
+                    devices,
+                    device_types,
+                    device_roles,
+                    inventory_items,
+                    object_tags,
+                )
+            )
+            == 0
+        ):
             msg = "You need to assign to at least one object."
             self.add_error(None, msg)
 
@@ -482,7 +511,10 @@ class DeviceSoftwareValidationResultFilterForm(NautobotFilterForm):
         required=False,
     )
     device_role = DynamicModelMultipleChoiceField(
-        queryset=Role.objects.all(), query_params={"content_types": "dcim.device"}, to_field_name="name", required=False
+        queryset=Role.objects.all(),
+        query_params={"content_types": "dcim.device"},
+        to_field_name="name",
+        required=False,
     )
     exclude_sw_missing = forms.BooleanField(
         required=False,
@@ -561,7 +593,10 @@ class InventoryItemSoftwareValidationResultFilterForm(NautobotFilterForm):
         required=False,
     )
     device_role = DynamicModelMultipleChoiceField(
-        queryset=Role.objects.all(), query_params={"content_types": "dcim.device"}, to_field_name="name", required=False
+        queryset=Role.objects.all(),
+        query_params={"content_types": "dcim.device"},
+        to_field_name="name",
+        required=False,
     )
     exclude_sw_missing = forms.BooleanField(
         required=False,
@@ -624,9 +659,10 @@ def get_form_kwargs(self):
         return {"provider": self.request.GET.get("provider")}  # pylint: disable=E1101
 
 
-class ContractLCMBulkEditForm(NautobotBulkEditForm):
+class ContractLCMBulkEditForm(NautobotBulkEditForm, StatusModelBulkEditFormMixin):
     """Device Lifecycle Contrcts bulk edit form."""
 
+    model = ContractLCM
     pk = forms.ModelMultipleChoiceField(queryset=ContractLCM.objects.all(), widget=forms.MultipleHiddenInput)
     provider = forms.ModelChoiceField(queryset=ProviderLCM.objects.all(), required=False)
     start = forms.DateField(widget=DatePicker(), required=False)
@@ -646,10 +682,11 @@ class Meta:
             "currency",
             "support_level",
             "contract_type",
+            "status",
         ]
 
 
-class ContractLCMFilterForm(NautobotFilterForm):
+class ContractLCMFilterForm(NautobotFilterForm, StatusModelFilterFormMixin):
     """Filter form to filter searches."""
 
     model = ContractLCM
@@ -659,7 +696,9 @@ class ContractLCMFilterForm(NautobotFilterForm):
         required=False, choices=CurrencyChoices.CHOICES, widget=StaticSelect2Multiple()
     )
     contract_type = forms.ChoiceField(
-        required=False, widget=StaticSelect2, choices=add_blank_choice(ContractTypeChoices.CHOICES)
+        required=False,
+        widget=StaticSelect2,
+        choices=add_blank_choice(ContractTypeChoices.CHOICES),
     )
     name = forms.CharField(required=False)
     tags = TagFilterField(model)
@@ -672,6 +711,7 @@ class Meta:
         fields = [
             "q",
             "provider",
+            "status",
             "name",
             "start",
             "end",
@@ -789,7 +829,14 @@ class ContactLCMBulkEditForm(NautobotBulkEditForm):
     class Meta:
         """Meta attributes for the ContactLCMBulkEditForm class."""
 
-        nullable_fields = ["address", "phone", "email", "comments", "priority", "contract"]
+        nullable_fields = [
+            "address",
+            "phone",
+            "email",
+            "comments",
+            "priority",
+            "contract",
+        ]
 
 
 class ContactLCMFilterForm(NautobotFilterForm):
@@ -846,7 +893,9 @@ class CVELCMBulkEditForm(NautobotBulkEditForm, CustomFieldModelBulkEditFormMixin
     comments = forms.CharField(required=False)
     tags = DynamicModelMultipleChoiceField(queryset=Tag.objects.all(), required=False)
     status = DynamicModelChoiceField(
-        queryset=Status.objects.all(), required=False, query_params={"content_types": model._meta.label_lower}
+        queryset=Status.objects.all(),
+        required=False,
+        query_params={"content_types": model._meta.label_lower},
     )
 
     class Meta:

nautobot_device_lifecycle_mgmt/migrations/0023_contractlcm_status.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.25 on 2024-11-19 18:33
+
+import django.db.models.deletion
+import nautobot.extras.models.statuses
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("extras", "0098_rename_data_jobresult_result"),
+        ("nautobot_device_lifecycle_mgmt", "0022_alter_softwareimagelcm_inventory_items_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="contractlcm",
+            name="status",
+            field=nautobot.extras.models.statuses.StatusField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="contracts",
+                to="extras.status",
+            ),
+        ),
+    ]

nautobot_device_lifecycle_mgmt/models.py

@@ -417,6 +417,7 @@ def __str__(self):
     "graphql",
     "relationships",
     "webhooks",
+    "statuses",
 )
 class ContractLCM(PrimaryModel):
     """ContractLCM model for app."""
@@ -442,6 +443,12 @@ class ContractLCM(PrimaryModel):
         verbose_name="Contract Type", max_length=CHARFIELD_MAX_LENGTH, blank=True, default=""
     )
     devices = models.ManyToManyField(to="dcim.Device", related_name="device_contracts", blank=True)
+    status = StatusField(
+        null=True,
+        blank=True,
+        on_delete=models.PROTECT,
+        to="extras.status",
+    )
     comments = models.TextField(blank=True, default="")
 
     class Meta:

nautobot_device_lifecycle_mgmt/tables.py

@@ -427,7 +427,7 @@ class Meta(BaseTable.Meta):
         ]
 
 
-class ContractLCMTable(BaseTable):
+class ContractLCMTable(StatusTableMixin, BaseTable):
     """Table for list view."""
 
     pk = ToggleColumn()
@@ -452,6 +452,7 @@ class Meta(BaseTable.Meta):
         fields = (
             "pk",
             "name",
+            "status",
             "start",
             "end",
             "cost",

nautobot_device_lifecycle_mgmt/tests/conftest.py

@@ -6,7 +6,14 @@
 from nautobot.dcim.models import Device, DeviceType, InventoryItem, Location, LocationType, Manufacturer, Platform
 from nautobot.extras.models import Role, Status
 
-from nautobot_device_lifecycle_mgmt.models import CVELCM, HardwareLCM, SoftwareLCM, ValidatedSoftwareLCM
+from nautobot_device_lifecycle_mgmt.models import (
+    CVELCM,
+    ContractLCM,
+    HardwareLCM,
+    ProviderLCM,
+    SoftwareLCM,
+    ValidatedSoftwareLCM,
+)
 
 
 def create_devices():
@@ -201,3 +208,75 @@ def create_inventory_item_hardware_notices():
             documentation_url="https://test.com",
         ),
     )
+
+
+def create_contracts():
+    """Create DeviceLifecycle Contracts for tests."""
+    contract_ct = ContentType.objects.get_for_model(ContractLCM)
+    not_supported = Status.objects.create(
+        name="End of Support", color="f44336", description="Contract no longer supported."
+    )
+    not_supported.content_types.set([contract_ct])
+    supported = Status.objects.create(name="Active Support", color="4caf50", description="Active Contract.")
+    supported.content_types.set([contract_ct])
+    hero_provider = ProviderLCM.objects.create(
+        name="Skyrim Merchant",
+        description="Whiteruns Merchant",
+        country="USA",
+    )
+    villain_provider = ProviderLCM.objects.create(
+        name="Skyrim Villain Merchant",
+        description="Whiteruns Villain Merchant",
+        country="USA",
+    )
+
+    return (
+        ContractLCM.objects.create(
+            provider=hero_provider,
+            name="Hero Discounts 1",
+            number="1234567890",
+            start="2022-01-01",
+            end="2022-12-31",
+            cost=5000.00,
+            support_level="Silver",
+            currency="USD",
+            contract_type="Hardware",
+            status=not_supported,
+        ),
+        ContractLCM.objects.create(
+            provider=hero_provider,
+            name="Hero Discounts 2",
+            number="1234567890",
+            start="2022-01-01",
+            end="2022-12-31",
+            cost=10000.00,
+            support_level="Gold",
+            currency="USD",
+            contract_type="Hardware",
+            status=not_supported,
+        ),
+        ContractLCM.objects.create(
+            provider=villain_provider,
+            name="Villain Discounts 1",
+            number="1234567890",
+            start="2021-01-01",
+            end="2060-12-31",
+            cost=5000.00,
+            support_level="Silver",
+            currency="USD",
+            contract_type="Hardware",
+            status=supported,
+        ),
+        ContractLCM.objects.create(
+            provider=villain_provider,
+            name="Villain Discounts 2",
+            number="1234567890",
+            start="2021-01-01",
+            end="2060-12-31",
+            cost=10000.00,
+            support_level="Gold",
+            currency="USD",
+            contract_type="Hardware",
+            status=supported,
+        ),
+    )