netbox-plugin-dns 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

netbox_dns/forms/zone.py

@@ -1,7 +1,8 @@
 from django import forms
+from django.db import transaction
 from django.conf import settings
 from django.core.validators import MinValueValidator, MaxValueValidator
-from django.urls import reverse_lazy
+from django.core.exceptions import ValidationError
 
 from netbox.forms import (
     NetBoxModelBulkEditForm,
@@ -9,6 +10,7 @@ from netbox.forms import (
     NetBoxModelImportForm,
     NetBoxModelForm,
 )
+from netbox.context import events_queue
 from utilities.forms.fields import (
     DynamicModelMultipleChoiceField,
     TagFilterField,
@@ -17,26 +19,107 @@ from utilities.forms.fields import (
     CSVModelMultipleChoiceField,
     DynamicModelChoiceField,
 )
-from utilities.forms.widgets import BulkEditNullBooleanSelect, APISelect
+from utilities.forms.widgets import BulkEditNullBooleanSelect
 from utilities.forms.rendering import FieldSet
-from utilities.forms import add_blank_choice
+from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, add_blank_choice
 from tenancy.models import Tenant
 from tenancy.forms import TenancyForm, TenancyFilterForm
 
 from netbox_dns.models import (
     View,
     Zone,
-    ZoneStatusChoices,
     NameServer,
     Registrar,
     Contact,
+    ZoneTemplate,
 )
+from netbox_dns.choices import ZoneStatusChoices
 from netbox_dns.utilities import name_to_unicode
 from netbox_dns.fields import RFC2317NetworkFormField
 from netbox_dns.validators import validate_ipv4, validate_prefix, validate_rfc2317
 
 
-class ZoneForm(TenancyForm, NetBoxModelForm):
+__ALL__ = (
+    "ZoneForm",
+    "ZoneFilterForm",
+    "ZoneImportForm",
+    "ZoneBulkEditForm",
+)
+
+
+class RollbackTransaction(Exception):
+    pass
+
+
+class ZoneTemplateUpdateMixin:
+    def clean(self, *args, **kwargs):
+        super().clean(*args, **kwargs)
+
+        if (template := self.cleaned_data.get("template")) is None:
+            return
+
+        if not self.cleaned_data.get("nameservers") and template.nameservers.all():
+            self.cleaned_data["nameservers"] = template.nameservers.all()
+
+        if not self.cleaned_data.get("tags") and template.tags.all():
+            self.cleaned_data["tags"] = template.tags.all()
+
+        for field in template.template_fields:
+            if (
+                self.cleaned_data.get(field) is None
+                and getattr(template, field) is not None
+            ):
+                self.cleaned_data[field] = getattr(template, field)
+
+        template_error = None
+        saved_events_queue = events_queue.get()
+
+        try:
+            with transaction.atomic():
+                if self.instance.id is not None:
+                    zone = super().save(*args, **kwargs)
+                else:
+                    zone_data = self.cleaned_data.copy()
+
+                    zone_data.pop("template", None)
+                    zone_data.pop("tenant_group", None)
+                    zone_data.pop("_init_time", None)
+
+                    nameservers = zone_data.pop("nameservers")
+                    tags = zone_data.pop("tags")
+
+                    zone = Zone.objects.create(**zone_data)
+
+                    zone.nameservers.set(nameservers)
+                    zone.tags.set(tags)
+
+                template.create_records(zone)
+                raise RollbackTransaction
+
+        except ValidationError as exc:
+            if isinstance(exc, dict):
+                template_error = item.value()
+            else:
+                template_error = [exc]
+        except RollbackTransaction:
+            pass
+
+        events_queue.set(saved_events_queue)
+        if template_error is not None:
+            raise ValidationError({"template": template_error})
+
+        return self.cleaned_data
+
+    def save(self, *args, **kwargs):
+        zone = super().save(*args, **kwargs)
+
+        if (template := self.cleaned_data.get("template")) is not None:
+            template.create_records(zone)
+
+        return zone
+
+
+class ZoneForm(ZoneTemplateUpdateMixin, TenancyForm, NetBoxModelForm):
     nameservers = DynamicModelMultipleChoiceField(
         queryset=NameServer.objects.all(),
         required=False,
@@ -104,11 +187,17 @@ class ZoneForm(TenancyForm, NetBoxModelForm):
         help_text="IPv4 reverse zone for deletgating the RFC2317 PTR records is managed in NetBox DNS",
         required=False,
     )
+    template = DynamicModelChoiceField(
+        queryset=ZoneTemplate.objects.all(),
+        required=False,
+        label="Template",
+    )
 
     fieldsets = (
         FieldSet(
             "view",
             "name",
+            "template",
             "status",
             "nameservers",
             "default_ttl",
@@ -206,6 +295,7 @@ class ZoneForm(TenancyForm, NetBoxModelForm):
             "name",
             "view",
             "status",
+            "template",
             "nameservers",
             "default_ttl",
             "description",
@@ -297,6 +387,7 @@ class ZoneFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     soa_serial_auto = forms.NullBooleanField(
         required=False,
         label="Generate Serial",
+        widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES),
     )
     rfc2317_prefix = RFC2317NetworkFormField(
         required=False,
@@ -305,6 +396,7 @@ class ZoneFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     rfc2317_parent_managed = forms.NullBooleanField(
         required=False,
         label="Parent Managed",
+        widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES),
     )
     rfc2317_parent_zone_id = DynamicModelMultipleChoiceField(
         queryset=Zone.objects.all(),
@@ -343,7 +435,7 @@ class ZoneFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     tag = TagFilterField(Zone)
 
 
-class ZoneImportForm(NetBoxModelImportForm):
+class ZoneImportForm(ZoneTemplateUpdateMixin, NetBoxModelImportForm):
     view = CSVModelChoiceField(
         queryset=View.objects.all(),
         required=False,
@@ -385,7 +477,7 @@ class ZoneImportForm(NetBoxModelImportForm):
         required=False,
         help_text="Mailbox of the zone's administrator",
     )
-    soa_serial_auto = forms.NullBooleanField(
+    soa_serial_auto = forms.BooleanField(
         required=False,
         help_text="Generate the SOA serial",
     )
@@ -473,6 +565,12 @@ class ZoneImportForm(NetBoxModelImportForm):
         to_field_name="name",
         help_text="Assigned tenant",
     )
+    template = CSVModelChoiceField(
+        queryset=ZoneTemplate.objects.all(),
+        required=False,
+        to_field_name="name",
+        label="Template",
+    )
 
     class Meta:
         model = Zone
@@ -481,6 +579,7 @@ class ZoneImportForm(NetBoxModelImportForm):
             "view",
             "name",
             "status",
+            "template",
             "nameservers",
             "default_ttl",
             "description",
@@ -532,9 +631,6 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
         queryset=View.objects.all(),
         required=False,
         label="View",
-        widget=APISelect(
-            attrs={"data-url": reverse_lazy("plugins-api:netbox_dns-api:view-list")}
-        ),
     )
     status = forms.ChoiceField(
         choices=add_blank_choice(ZoneStatusChoices),
@@ -559,11 +655,6 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
         queryset=NameServer.objects.all(),
         required=False,
         label="SOA Primary Nameserver",
-        widget=APISelect(
-            attrs={
-                "data-url": reverse_lazy("plugins-api:netbox_dns-api:nameserver-list")
-            }
-        ),
     )
     soa_rname = forms.CharField(
         required=False,
@@ -614,11 +705,6 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
     registrar = DynamicModelChoiceField(
         queryset=Registrar.objects.all(),
         required=False,
-        widget=APISelect(
-            attrs={
-                "data-url": reverse_lazy("plugins-api:netbox_dns-api:registrar-list")
-            }
-        ),
     )
     registry_domain_id = forms.CharField(
         required=False,
@@ -627,41 +713,26 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
     registrant = DynamicModelChoiceField(
         queryset=Contact.objects.all(),
         required=False,
-        widget=APISelect(
-            attrs={"data-url": reverse_lazy("plugins-api:netbox_dns-api:contact-list")}
-        ),
     )
     admin_c = DynamicModelChoiceField(
         queryset=Contact.objects.all(),
         required=False,
         label="Administrative Contact",
-        widget=APISelect(
-            attrs={"data-url": reverse_lazy("plugins-api:netbox_dns-api:contact-list")}
-        ),
     )
     tech_c = DynamicModelChoiceField(
         queryset=Contact.objects.all(),
         required=False,
         label="Technical Contact",
-        widget=APISelect(
-            attrs={"data-url": reverse_lazy("plugins-api:netbox_dns-api:contact-list")}
-        ),
     )
     billing_c = DynamicModelChoiceField(
         queryset=Contact.objects.all(),
         required=False,
         label="Billing Contact",
-        widget=APISelect(
-            attrs={"data-url": reverse_lazy("plugins-api:netbox_dns-api:contact-list")}
-        ),
     )
-    tenant = CSVModelChoiceField(
+    tenant = DynamicModelChoiceField(
         queryset=Tenant.objects.all(),
         required=False,
-        to_field_name="name",
-        help_text="Assigned tenant",
     )
-    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
 
     model = Zone
 
@@ -705,6 +776,7 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
 
     nullable_fields = (
         "description",
+        "nameservers",
         "rfc2317_prefix",
         "registrar",
         "registry_domain_id",
@@ -712,4 +784,5 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
         "admin_c",
         "tech_c",
         "billing_c",
+        "tenant",
     )

netbox_dns/forms/zone_template.py

@@ -0,0 +1,298 @@
+from django import forms
+
+from netbox.forms import (
+    NetBoxModelBulkEditForm,
+    NetBoxModelFilterSetForm,
+    NetBoxModelImportForm,
+    NetBoxModelForm,
+)
+from utilities.forms.fields import (
+    DynamicModelMultipleChoiceField,
+    TagFilterField,
+    CSVModelChoiceField,
+    CSVModelMultipleChoiceField,
+    DynamicModelChoiceField,
+)
+from utilities.forms.rendering import FieldSet
+from tenancy.models import Tenant
+from tenancy.forms import TenancyForm, TenancyFilterForm
+
+from netbox_dns.models import (
+    ZoneTemplate,
+    RecordTemplate,
+    NameServer,
+    Registrar,
+    Contact,
+)
+
+
+__ALL__ = (
+    "ZoneTemplateForm",
+    "ZoneTemplateFilterForm",
+    "ZoneTemplateImportForm",
+    "ZoneTemplateBulkEditForm",
+)
+
+
+class ZoneTemplateForm(TenancyForm, NetBoxModelForm):
+    nameservers = DynamicModelMultipleChoiceField(
+        queryset=NameServer.objects.all(),
+        required=False,
+    )
+    record_templates = DynamicModelMultipleChoiceField(
+        queryset=RecordTemplate.objects.all(),
+        required=False,
+    )
+
+    fieldsets = (
+        FieldSet("name", "description", "nameservers", name="Zone Template"),
+        FieldSet("record_templates", name="Record Templates"),
+        FieldSet(
+            "registrar",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            name="Domain Registration",
+        ),
+        FieldSet("tags", name="Tags"),
+        FieldSet("tenant_group", "tenant", name="Tenancy"),
+    )
+
+    class Meta:
+        model = ZoneTemplate
+
+        fields = (
+            "name",
+            "nameservers",
+            "record_templates",
+            "description",
+            "tags",
+            "registrar",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            "tenant",
+        )
+
+
+class ZoneTemplateFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
+    model = ZoneTemplate
+    fieldsets = (
+        FieldSet("q", "filter_id", "tag"),
+        FieldSet("name", "nameserver_id", "description", name="Attributes"),
+        FieldSet("record_template_id", name="Record Templates"),
+        FieldSet(
+            "registrar_id",
+            "registrant_id",
+            "admin_c_id",
+            "tech_c_id",
+            "billing_c_id",
+            name="Registration",
+        ),
+        FieldSet("tenant_group_id", "tenant_id", name="Tenancy"),
+    )
+
+    name = forms.CharField(
+        required=False,
+        label="Template name",
+    )
+    nameserver_id = DynamicModelMultipleChoiceField(
+        queryset=NameServer.objects.all(),
+        required=False,
+        label="Nameservers",
+    )
+    record_template_id = DynamicModelMultipleChoiceField(
+        queryset=RecordTemplate.objects.all(),
+        required=False,
+        label="Record templates",
+    )
+    description = forms.CharField(
+        required=False,
+    )
+    registrar_id = DynamicModelMultipleChoiceField(
+        queryset=Registrar.objects.all(),
+        required=False,
+        label="Registrar",
+    )
+    registrant_id = DynamicModelMultipleChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Registrant",
+    )
+    admin_c_id = DynamicModelMultipleChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Admin-C",
+    )
+    tech_c_id = DynamicModelMultipleChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Tech-C",
+    )
+    billing_c_id = DynamicModelMultipleChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Billing-C",
+    )
+    tag = TagFilterField(ZoneTemplate)
+
+
+class ZoneTemplateImportForm(NetBoxModelImportForm):
+    nameservers = CSVModelMultipleChoiceField(
+        queryset=NameServer.objects.all(),
+        to_field_name="name",
+        required=False,
+        help_text="Name servers for the zone template",
+    )
+    record_templates = CSVModelMultipleChoiceField(
+        queryset=RecordTemplate.objects.all(),
+        to_field_name="name",
+        required=False,
+        help_text="Record templates used by this zone template",
+    )
+    registrar = CSVModelChoiceField(
+        queryset=Registrar.objects.all(),
+        required=False,
+        to_field_name="name",
+        help_text="Registrar the domain is registered with",
+        error_messages={
+            "invalid_choice": "Registrar not found.",
+        },
+    )
+    registrant = CSVModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        to_field_name="contact_id",
+        help_text="Owner of the domain",
+        error_messages={
+            "invalid_choice": "Registrant contact ID not found",
+        },
+    )
+    admin_c = CSVModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        to_field_name="contact_id",
+        help_text="Administrative contact for the domain",
+        error_messages={
+            "invalid_choice": "Administrative contact ID not found",
+        },
+    )
+    tech_c = CSVModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        to_field_name="contact_id",
+        help_text="Technical contact for the domain",
+        error_messages={
+            "invalid_choice": "Technical contact ID not found",
+        },
+    )
+    billing_c = CSVModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        to_field_name="contact_id",
+        help_text="Billing contact for the domain",
+        error_messages={
+            "invalid_choice": "Billing contact ID not found",
+        },
+    )
+    tenant = CSVModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+        to_field_name="name",
+        help_text="Assigned tenant",
+    )
+
+    class Meta:
+        model = ZoneTemplate
+
+        fields = (
+            "name",
+            "nameservers",
+            "record_templates",
+            "description",
+            "registrar",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            "tenant",
+            "tags",
+        )
+
+
+class ZoneTemplateBulkEditForm(NetBoxModelBulkEditForm):
+    nameservers = DynamicModelMultipleChoiceField(
+        queryset=NameServer.objects.all(),
+        required=False,
+    )
+    record_templates = DynamicModelMultipleChoiceField(
+        queryset=RecordTemplate.objects.all(),
+        required=False,
+    )
+    description = forms.CharField(max_length=200, required=False)
+    registrar = DynamicModelChoiceField(
+        queryset=Registrar.objects.all(),
+        required=False,
+    )
+    registrant = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+    )
+    admin_c = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Administrative Contact",
+    )
+    tech_c = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Technical Contact",
+    )
+    billing_c = DynamicModelChoiceField(
+        queryset=Contact.objects.all(),
+        required=False,
+        label="Billing Contact",
+    )
+    tenant = CSVModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+        to_field_name="name",
+        help_text="Assigned tenant",
+    )
+    tenant = DynamicModelChoiceField(queryset=Tenant.objects.all(), required=False)
+
+    model = ZoneTemplate
+
+    fieldsets = (
+        FieldSet(
+            "nameservers",
+            "description",
+            name="Attributes",
+        ),
+        FieldSet(
+            "record_templates",
+            name="Record Templates",
+        ),
+        FieldSet(
+            "registrar",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            name="Domain Registration",
+        ),
+        FieldSet("tenant_group", "tenant", name="Tenancy"),
+    )
+
+    nullable_fields = (
+        "description",
+        "nameservers",
+        "record_templates",
+        "registrar",
+        "registrant",
+        "admin_c",
+        "tech_c",
+        "billing_c",
+    )

netbox_dns/graphql/__init__.py

@@ -5,6 +5,8 @@ from .schema import (
     NetBoxDNSRegistrarQuery,
     NetBoxDNSZoneQuery,
     NetBoxDNSRecordQuery,
+    NetBoxDNSZoneTemplateQuery,
+    NetBoxDNSRecordTemplateQuery,
 )
 
 schema = [
@@ -14,4 +16,6 @@ schema = [
     NetBoxDNSRecordQuery,
     NetBoxDNSContactQuery,
     NetBoxDNSRegistrarQuery,
+    NetBoxDNSZoneTemplateQuery,
+    NetBoxDNSRecordTemplateQuery,
 ]

netbox_dns/graphql/filters.py

@@ -2,7 +2,16 @@ import strawberry_django
 
 from netbox.graphql.filter_mixins import autotype_decorator, BaseFilterMixin
 
-from netbox_dns.models import NameServer, View, Zone, Record, Contact, Registrar
+from netbox_dns.models import (
+    NameServer,
+    View,
+    Zone,
+    Record,
+    Contact,
+    Registrar,
+    ZoneTemplate,
+    RecordTemplate,
+)
 from netbox_dns.filtersets import (
     NameServerFilterSet,
     ViewFilterSet,
@@ -10,6 +19,8 @@ from netbox_dns.filtersets import (
     RecordFilterSet,
     ContactFilterSet,
     RegistrarFilterSet,
+    ZoneTemplateFilterSet,
+    RecordTemplateFilterSet,
 )
 
 
@@ -37,6 +48,18 @@ class NetBoxDNSRecordFilter(BaseFilterMixin):
     ip_address: str | None
 
 
+@strawberry_django.filter(ZoneTemplate, lookups=True)
+@autotype_decorator(ZoneTemplateFilterSet)
+class NetBoxDNSZoneTemplateFilter(BaseFilterMixin):
+    pass
+
+
+@strawberry_django.filter(RecordTemplate, lookups=True)
+@autotype_decorator(RecordTemplateFilterSet)
+class NetBoxDNSRecordTemplateFilter(BaseFilterMixin):
+    pass
+
+
 @strawberry_django.filter(Contact, lookups=True)
 @autotype_decorator(ContactFilterSet)
 class NetBoxDNSContactFilter(BaseFilterMixin):

netbox_dns/graphql/schema.py

@@ -3,7 +3,16 @@ from typing import List
 import strawberry
 import strawberry_django
 
-from netbox_dns.models import NameServer, View, Zone, Record, Contact, Registrar
+from netbox_dns.models import (
+    NameServer,
+    View,
+    Zone,
+    Record,
+    Contact,
+    Registrar,
+    ZoneTemplate,
+    RecordTemplate,
+)
 from .types import (
     NetBoxDNSNameServerType,
     NetBoxDNSViewType,
@@ -11,6 +20,8 @@ from .types import (
     NetBoxDNSRecordType,
     NetBoxDNSContactType,
     NetBoxDNSRegistrarType,
+    NetBoxDNSZoneTemplateType,
+    NetBoxDNSRecordTemplateType,
 )
 
 
@@ -68,3 +79,25 @@ class NetBoxDNSRegistrarQuery:
         return Registrar.objects.get(pk=id)
 
     netbox_dns_registrar_list: List[NetBoxDNSRegistrarType] = strawberry_django.field()
+
+
+@strawberry.type
+class NetBoxDNSZoneTemplateQuery:
+    @strawberry.field
+    def netbox_dns_zone_template(self, id: int) -> NetBoxDNSZoneTemplateType:
+        return ZoneTemplate.objects.get(pk=id)
+
+    netbox_dns_zone_template_list: List[NetBoxDNSZoneTemplateType] = (
+        strawberry_django.field()
+    )
+
+
+@strawberry.type
+class NetBoxDNSRecordTemplateQuery:
+    @strawberry.field
+    def netbox_dns_record_template(self, id: int) -> NetBoxDNSRecordTemplateType:
+        return RecordTemplate.objects.get(pk=id)
+
+    netbox_dns_record_template_list: List[NetBoxDNSRecordTemplateType] = (
+        strawberry_django.field()
+    )