nautobot 2.0.0a3__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/extras/tests/example_jobs/test_ipaddress_vars.py

@@ -1,52 +0,0 @@
-import json
-
-from nautobot.extras.jobs import Job, IPAddressVar, IPAddressWithMaskVar
-
-
-name = "IP Addresses"
-
-
-class TestIPAddresses(Job):
-    class Meta:
-        description = "Validate IP Addresses"
-
-    ipv4_address = IPAddressVar(
-        description="IPv4 Address",
-    )
-    ipv4_with_mask = IPAddressWithMaskVar(
-        description="IPv4 with mask",
-    )
-    ipv4_network = IPAddressWithMaskVar(
-        description="IPv4 network",
-    )
-    ipv6_address = IPAddressVar(
-        description="IPv6 Address",
-    )
-    ipv6_with_mask = IPAddressWithMaskVar(
-        description="IPv6 with mask",
-    )
-    ipv6_network = IPAddressWithMaskVar(
-        description="IPv6 network",
-    )
-
-    def run(self, data, commit):
-        ipv4_address = data["ipv4_address"]
-        ipv4_with_mask = data["ipv4_with_mask"]
-        ipv4_network = data["ipv4_network"]
-        ipv6_address = data["ipv6_address"]
-        ipv6_with_mask = data["ipv6_with_mask"]
-        ipv6_network = data["ipv6_network"]
-
-        # Log the data as JSON so we can pull it back out for testing.
-        self.log_info(obj=json.dumps({k: str(v) for k, v in data.items()}), message="IP Address Test")
-
-        self.log_warning(f"IPv4: {ipv4_address}")
-        self.log_warning(f"IPv4: {ipv4_with_mask}")
-        self.log_warning(f"IPv4: {ipv4_network}")
-        self.log_warning(f"IPv6: {ipv6_address}")
-        self.log_warning(f"IPv6: {ipv6_with_mask}")
-        self.log_warning(f"IPv6: {ipv6_network}")
-
-        self.log_success(message="Job didn't crash!")
-
-        return "Nice IPs, bro."

nautobot/extras/tests/example_jobs/test_job_button_receiver.py

@@ -1,21 +0,0 @@
-from nautobot.dcim.models import Device, Location
-from nautobot.extras.jobs import JobButtonReceiver
-
-
-class TestJobButtonReceiverSimple(JobButtonReceiver):
-    def receive_job_button(self, obj):
-        self.log_info(f"request.user: {self.request.user.username}")
-        self.log_success(obj.name)
-
-
-class TestJobButtonReceiverComplex(JobButtonReceiver):
-    def receive_job_button(self, obj):
-        self.log_info(f"request.user: {self.request.user.username}")
-        if isinstance(obj, Device):
-            self.log_success(f"Device: {obj}")
-        elif isinstance(obj, Location):
-            self.log_success(f"Location: {obj}")
-
-
-class TestJobButtonReceiverFail(JobButtonReceiver):
-    pass

nautobot/extras/tests/example_jobs/test_job_hook_receiver.py

@@ -1,20 +0,0 @@
-from nautobot.extras.jobs import JobHookReceiver
-from nautobot.dcim.models import Location, LocationType
-
-
-class TestJobHookReceiverLog(JobHookReceiver):
-    def receive_job_hook(self, change, action, changed_object):
-        self.log_info(f"change: {change}")
-        self.log_info(f"action: {action}")
-        self.log_info(f"request.user: {self.request.user.username}")
-        self.log_success(changed_object.name)
-
-
-class TestJobHookReceiverChange(JobHookReceiver):
-    def receive_job_hook(self, change, action, changed_object):
-        location_type = LocationType.objects.create(name="Job Location Type")
-        Location.objects.create(name="test_jhr", location_type=location_type)
-
-
-class TestJobHookReceiverFail(JobHookReceiver):
-    pass

nautobot/extras/tests/example_jobs/test_location_with_custom_field.py

@@ -1,35 +0,0 @@
-from django.contrib.contenttypes.models import ContentType
-
-from nautobot.dcim.models import Location, LocationType
-from nautobot.extras.choices import CustomFieldTypeChoices
-from nautobot.extras.jobs import Job
-from nautobot.extras.models import CustomField
-
-
-class TestCreateLocationWithCustomField(Job):
-    class Meta:
-        name = "Location and Custom Field Creation"
-        description = "Location with a custom field"
-
-    def run(self, data, commit):
-        obj_type = ContentType.objects.get_for_model(Location)
-        cf = CustomField(label="cf1", type=CustomFieldTypeChoices.TYPE_TEXT, default="-")
-        cf.validated_save()
-        cf.content_types.set([obj_type])
-
-        self.log_success(obj=cf, message="CustomField created successfully.")
-
-        location_type = LocationType.objects.create(name="Test Location Type 1")
-        location_1 = Location.objects.create(
-            name="Test Location", slug="test-location-one", location_type=location_type
-        )
-        location_1.cf[cf.key] = "some-value"
-        location_1.save()
-        self.log_success(obj=location_1, message="Created a new location")
-
-        location_2 = Location.objects.create(
-            name="Test Site Two", slug="test-location-two", location_type=location_type
-        )
-        self.log_success(obj=location_2, message="Created another new location")
-
-        return "Job completed."

nautobot/extras/tests/example_jobs/test_log_redaction.py

@@ -1,14 +0,0 @@
-from nautobot.extras.jobs import Job
-
-
-class TestLogRedaction(Job):
-    class Meta:
-        description = "Test redaction of logs"
-
-    def run(self, data, commit):
-        self.log_debug("The secret is supersecret123")
-        self.log_info(message="The secret is supersecret123")
-        self.log_success(message="The secret is supersecret123")
-        self.log_warning(message="The secret is supersecret123")
-        # Disabled as we don't want the job to fail
-        # self.log_failure(message="The secret is supersecret123")

nautobot/extras/tests/example_jobs/test_modify_db.py

@@ -1,18 +0,0 @@
-from nautobot.extras.jobs import Job
-from nautobot.extras.models import Status
-
-
-class TestModifyDB(Job):
-    """
-    Job that modifies the database.
-    """
-
-    def test_modify_db(self):
-        """
-        Job function.
-        """
-        obj = Status(
-            name="Test Status",
-        )
-        obj.save()
-        self.log_success(obj=obj, message="Status created successfully.")

nautobot/extras/tests/example_jobs/test_object_var_optional.py

@@ -1,14 +0,0 @@
-from nautobot.extras.jobs import Job, ObjectVar
-from nautobot.dcim.models import Location
-
-
-class TestOptionalObjectVar(Job):
-    location = ObjectVar(
-        description="Location (optional)",
-        model=Location,
-        required=False,
-    )
-
-    def run(self, data, commit):
-        self.log_info(obj=data["location"], message="The Location if any that the user provided.")
-        return "Nice Location (or not)!"

nautobot/extras/tests/example_jobs/test_object_var_required.py

@@ -1,14 +0,0 @@
-from nautobot.extras.jobs import Job, ObjectVar
-from nautobot.dcim.models import Location
-
-
-class TestRequiredObjectVar(Job):
-    location = ObjectVar(
-        description="Location (required)",
-        model=Location,
-        required=True,
-    )
-
-    def run(self, data, commit):
-        self.log_info(obj=data["location"], message="The Location that the user provided.")
-        return "Nice Location!"

nautobot/extras/tests/example_jobs/test_object_vars.py

@@ -1,29 +0,0 @@
-from nautobot.extras.jobs import Job, ObjectVar, MultiObjectVar
-from nautobot.extras.models import Role
-
-name = "Object Vars"
-
-
-class TestObjectVars(Job):
-    class Meta:
-        description = "Validate Objects"
-
-    role = ObjectVar(model=Role)
-    roles = MultiObjectVar(model=Role)
-
-    def run(self, data, commit):
-        role = data["role"]
-        roles = data["roles"]
-
-        # store the object data for later
-        self.job_result.data["object_vars"] = {
-            "role": str(role.pk),
-            "roles": [str(r) for r in roles.values_list("pk", flat=True)],
-        }
-
-        self.log_info(f"Role: {role}")
-        self.log_warning(f"Roles: {roles}")
-
-        self.log_success(message="Job didn't crash!")
-
-        return "Nice Roles!"

nautobot/extras/tests/example_jobs/test_pass.py

@@ -1,19 +0,0 @@
-from nautobot.extras.jobs import Job
-
-
-class TestPass(Job):
-    """
-    Job with pass result.
-    """
-
-    description = "Validate job import"
-
-    class Meta:
-        has_sensitive_variables = False
-
-    def test_pass(self):
-        """
-        Job function.
-        """
-        self.log_success(obj=None)
-        self.status = "complete"

nautobot/extras/tests/example_jobs/test_read_only_fail.py

@@ -1,24 +0,0 @@
-from nautobot.dcim.models import Location, LocationType
-from nautobot.extras.jobs import Job
-
-
-class TestReadOnlyFail(Job):
-    """
-    Read only Job with fail result.
-    """
-
-    description = "Validate job import"
-
-    class Meta:
-        read_only = True
-
-    def run(self, data, commit):
-        """
-        Job function.
-        """
-
-        location_type = LocationType.objects.create(name="Job Root Type")
-        location = Location.objects.create(name="New Location", location_type=location_type)
-
-        self.log_success(obj=location)
-        raise Exception("Test failure")  # pylint: disable=broad-exception-raised

nautobot/extras/tests/example_jobs/test_read_only_no_commit_field.py

@@ -1,10 +0,0 @@
-from nautobot.extras.jobs import Job, StringVar
-
-
-class TestReadOnlyNoCommitField(Job):
-    """My job demo."""
-
-    var = StringVar(description="Hello")
-
-    class Meta:
-        read_only = True

nautobot/extras/tests/example_jobs/test_read_only_pass.py

@@ -1,22 +0,0 @@
-from nautobot.dcim.models import Location, LocationType
-from nautobot.extras.jobs import Job
-
-
-class TestReadOnlyPass(Job):
-    """
-    Ready only Job with pass result.
-    """
-
-    description = "Validate job import"
-
-    class Meta:
-        read_only = True
-
-    def run(self, data, commit):
-        """
-        Job function.
-        """
-        location_type = LocationType.objects.create(name="Job Root Type")
-        location = Location.objects.create(name="New Location", location_type=location_type)
-
-        self.log_success(obj=location)

nautobot/ipam/api/nested_serializers.py

@@ -1,159 +0,0 @@
-import netaddr
-from rest_framework import serializers
-
-from nautobot.core.api import WritableNestedSerializer
-from nautobot.ipam import models
-
-__all__ = [
-    "IPFieldSerializer",
-    "NestedIPAddressSerializer",
-    "NestedNamespaceSerializer",
-    "NestedPrefixSerializer",
-    "NestedRIRSerializer",
-    "NestedRouteTargetSerializer",
-    "NestedServiceSerializer",
-    "NestedVLANGroupSerializer",
-    "NestedVLANSerializer",
-    "NestedVRFSerializer",
-]
-
-
-class IPFieldSerializer(serializers.CharField):
-    def to_representation(self, value):
-        """Convert internal (IPNetwork) representation to API (string) representation."""
-        return str(value)
-
-    def to_internal_value(self, value):
-        """Convert API (string) representation to internal (IPNetwork) representation."""
-        try:
-            return netaddr.IPNetwork(value)
-        except netaddr.AddrFormatError:
-            raise serializers.ValidationError(f"Invalid IP address format: {value}")
-        except (TypeError, ValueError) as e:
-            raise serializers.ValidationError(e)
-
-
-#
-# Namespaces
-#
-
-
-class NestedNamespaceSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:namespace-detail")
-
-    class Meta:
-        model = models.Namespace
-        fields = ["url", "name", "description", "location"]
-
-
-#
-# VRFs
-#
-
-
-class NestedVRFSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vrf-detail")
-    prefix_count = serializers.IntegerField(read_only=True)
-
-    class Meta:
-        model = models.VRF
-        fields = ["id", "url", "name", "rd", "display", "prefix_count"]
-
-
-#
-# Route targets
-#
-
-
-class NestedRouteTargetSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:routetarget-detail")
-
-    class Meta:
-        model = models.RouteTarget
-        fields = ["id", "url", "name"]
-
-
-#
-# RIRs
-#
-
-
-class NestedRIRSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:rir-detail")
-    assigned_prefix_count = serializers.IntegerField(read_only=True)
-
-    class Meta:
-        model = models.RIR
-        fields = ["id", "url", "name", "assigned_prefix_count"]
-
-
-#
-# VLANs
-#
-
-
-class NestedVLANGroupSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlangroup-detail")
-    vlan_count = serializers.IntegerField(read_only=True)
-
-    class Meta:
-        model = models.VLANGroup
-        fields = ["id", "url", "name", "slug", "vlan_count"]
-
-
-class NestedVLANSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:vlan-detail")
-
-    class Meta:
-        model = models.VLAN
-        fields = [
-            "id",
-            "url",
-            "vid",
-            "name",
-        ]
-
-
-#
-# Prefixes
-#
-
-
-class NestedPrefixSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:prefix-detail")
-    ip_version = serializers.IntegerField(read_only=True)
-    prefix = IPFieldSerializer()
-    namespace = NestedNamespaceSerializer()
-
-    class Meta:
-        model = models.Prefix
-        fields = ["id", "url", "ip_version", "namespace", "prefix"]
-
-
-#
-# IP addresses
-#
-
-
-class NestedIPAddressSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:ipaddress-detail")
-    ip_version = serializers.IntegerField(read_only=True)
-    address = IPFieldSerializer()
-    parent = IPFieldSerializer()
-
-    class Meta:
-        model = models.IPAddress
-        fields = ["id", "url", "ip_version", "address", "parent"]
-
-
-#
-# Services
-#
-
-
-class NestedServiceSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="ipam-api:service-detail")
-
-    class Meta:
-        model = models.Service
-        fields = ["id", "url", "name", "protocol", "ports"]

nautobot/ipam/migrations/0029_ipam__prefix__add_parent.py

@@ -1,31 +0,0 @@
-# Generated by Django 3.2.18 on 2023-03-22 16:10
-
-from django.db import migrations, models
-import django.db.models.deletion
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("ipam", "0028_ipam__namespaces"),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name="prefix",
-            name="parent",
-            field=models.ForeignKey(
-                blank=True,
-                null=True,
-                on_delete=django.db.models.deletion.PROTECT,
-                related_name="children",
-                to="ipam.prefix",
-            ),
-        ),
-        migrations.AlterIndexTogether(
-            name="prefix",
-            index_together={
-                ("network", "broadcast", "prefix_length"),
-                ("namespace", "network", "broadcast", "prefix_length"),
-            },
-        ),
-    ]

nautobot/ipam/migrations/0030_ipam__prefix__data_migration.py

@@ -1,13 +0,0 @@
-# Generated by Django 3.2.18 on 2023-03-23 19:59
-
-# TODO(jathan): Thiis a placeholder for datamigrations for Prefix model changes.
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("ipam", "0029_ipam__prefix__add_parent"),
-    ]
-
-    operations = []

nautobot/ipam/migrations/0031_ipam__ipaddress__add_parent.py

@@ -1,41 +0,0 @@
-# Generated by Django 3.2.18 on 2023-03-24 19:47
-
-from django.db import migrations, models
-import django.db.models.deletion
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("ipam", "0030_ipam__prefix__data_migration"),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name="ipaddress",
-            name="ip_version",
-            field=models.IntegerField(db_index=True, editable=False, null=True),
-        ),
-        migrations.AddField(
-            model_name="ipaddress",
-            name="parent",
-            field=models.ForeignKey(
-                blank=True,
-                null=True,
-                on_delete=django.db.models.deletion.PROTECT,
-                related_name="ip_addresses",
-                to="ipam.prefix",
-            ),
-        ),
-        migrations.AlterModelOptions(
-            name="ipaddress",
-            options={
-                "ordering": ("ip_version", "host", "prefix_length"),
-                "verbose_name": "IP address",
-                "verbose_name_plural": "IP addresses",
-            },
-        ),
-        migrations.AlterUniqueTogether(
-            name="ipaddress",
-            unique_together={("parent", "host")},
-        ),
-    ]

nautobot/ipam/migrations/0032_ipam__ipaddress__data_migration.py

@@ -1,11 +0,0 @@
-# Generated by Django 3.2.18 on 2023-03-30 17:33
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("ipam", "0031_ipam__ipaddress__add_parent"),
-    ]
-
-    operations = []

nautobot/tenancy/api/nested_serializers.py

@@ -1,31 +0,0 @@
-from rest_framework import serializers
-
-from nautobot.core.api import TreeModelSerializerMixin, WritableNestedSerializer
-from nautobot.tenancy.models import Tenant, TenantGroup
-
-__all__ = [
-    "NestedTenantGroupSerializer",
-    "NestedTenantSerializer",
-]
-
-
-#
-# Tenants
-#
-
-
-class NestedTenantGroupSerializer(WritableNestedSerializer, TreeModelSerializerMixin):
-    url = serializers.HyperlinkedIdentityField(view_name="tenancy-api:tenantgroup-detail")
-    tenant_count = serializers.IntegerField(read_only=True)
-
-    class Meta:
-        model = TenantGroup
-        fields = ["id", "url", "name", "tenant_count", "tree_depth"]
-
-
-class NestedTenantSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="tenancy-api:tenant-detail")
-
-    class Meta:
-        model = Tenant
-        fields = ["id", "url", "name"]

nautobot/users/api/nested_serializers.py

@@ -1,67 +0,0 @@
-from django.contrib.auth import get_user_model
-from django.contrib.auth.models import Group
-from django.contrib.contenttypes.models import ContentType
-from drf_spectacular.utils import extend_schema_field
-from rest_framework import serializers
-
-from nautobot.core.api import ContentTypeField, WritableNestedSerializer
-from nautobot.users.models import ObjectPermission, Token
-
-__all__ = [
-    "NestedGroupSerializer",
-    "NestedObjectPermissionSerializer",
-    "NestedTokenSerializer",
-    "NestedUserSerializer",
-]
-
-
-class NestedGroupSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="users-api:group-detail")
-
-    class Meta:
-        model = Group
-        fields = ["id", "url", "name"]
-
-
-class NestedUserSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="users-api:user-detail")
-
-    class Meta:
-        model = get_user_model()
-        fields = ["id", "url", "username"]
-
-
-class NestedTokenSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="users-api:token-detail")
-
-    class Meta:
-        model = Token
-        fields = ["id", "url", "display", "key", "write_enabled"]
-
-
-class NestedObjectPermissionSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name="users-api:objectpermission-detail")
-    object_types = ContentTypeField(queryset=ContentType.objects.all(), many=True)
-    groups = serializers.SerializerMethodField(read_only=True)
-    users = serializers.SerializerMethodField(read_only=True)
-
-    class Meta:
-        model = ObjectPermission
-        fields = [
-            "id",
-            "url",
-            "name",
-            "enabled",
-            "object_types",
-            "groups",
-            "users",
-            "actions",
-        ]
-
-    @extend_schema_field(list)
-    def get_groups(self, obj):
-        return [g.name for g in obj.groups.all()]
-
-    @extend_schema_field(list)
-    def get_users(self, obj):
-        return [u.username for u in obj.users.all()]