ipfabric_netbox 3.1.2__py3-none-any.whl

ipfabric_netbox/jobs.py

@@ -0,0 +1,95 @@
+import logging
+from datetime import timedelta
+
+from core.choices import DataSourceStatusChoices
+from core.choices import JobStatusChoices
+from core.exceptions import SyncError
+from core.models import Job
+from netbox.context_managers import event_tracking
+from rq.timeouts import JobTimeoutException
+from utilities.datetime import local_now
+from utilities.request import NetBoxFakeRequest
+
+from .models import IPFabricBranch
+from .models import IPFabricSource
+from .models import IPFabricSync
+
+logger = logging.getLogger(__name__)
+
+
+def sync_ipfabricsource(job, *args, **kwargs):
+    ipfsource = IPFabricSource.objects.get(pk=job.object_id)
+
+    try:
+        job.start()
+        ipfsource.sync(job=job)
+        job.terminate()
+    except Exception as e:
+        job.terminate(status=JobStatusChoices.STATUS_ERRORED)
+        IPFabricSource.objects.filter(pk=ipfsource.pk).update(
+            status=DataSourceStatusChoices.FAILED
+        )
+        if type(e) in (SyncError, JobTimeoutException):
+            logging.error(e)
+        else:
+            raise e
+
+
+def sync_ipfabric(job, *args, **kwargs):
+    obj = IPFabricSync.objects.get(pk=job.object_id)
+
+    try:
+        job.start()
+        obj.sync(job=job)
+        job.terminate()
+    except Exception as e:
+        job.terminate(status=JobStatusChoices.STATUS_ERRORED)
+        IPFabricSync.objects.filter(pk=obj.pk).update(
+            status=DataSourceStatusChoices.FAILED
+        )
+        if type(e) in (SyncError, JobTimeoutException):
+            logging.error(e)
+        else:
+            raise e
+    finally:
+        if obj.interval and not kwargs.get("adhoc"):
+            new_scheduled_time = local_now() + timedelta(minutes=obj.interval)
+            job = Job.enqueue(
+                sync_ipfabric,
+                name=f"{obj.name} - (scheduled)",
+                instance=obj,
+                user=obj.user,
+                schedule_at=new_scheduled_time,
+                interval=obj.interval,
+            )
+
+
+def merge_ipfabric_branch(job, *args, **kwargs):
+    branch = IPFabricBranch.objects.get(pk=job.object_id)
+    try:
+        request = NetBoxFakeRequest(
+            {
+                "META": {},
+                "POST": branch.sync.parameters,
+                "GET": {},
+                "FILES": {},
+                "user": branch.user,
+                "path": "",
+                "id": job.job_id,
+            }
+        )
+
+        job.start()
+        with event_tracking(request):
+            branch.sync_merge()
+        job.terminate()
+    except Exception as e:
+        print(e)
+        job.terminate(status=JobStatusChoices.STATUS_ERRORED)
+        IPFabricSync.objects.filter(pk=branch.sync.pk).update(
+            status=DataSourceStatusChoices.FAILED
+        )
+        if type(e) in (SyncError, JobTimeoutException):
+            logging.error(e)
+        else:
+            raise e

ipfabric_netbox/migrations/0001_initial.py

@@ -0,0 +1,342 @@
+# Generated by Django 4.1.8 on 2023-09-28 13:22
+import django.core.validators
+import django.db.models.deletion
+import taggit.managers
+import utilities.json
+from django.conf import settings
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("core", "0005_job_created_auto_now"),
+        ("extras", "0092_delete_jobresult"),
+        ("contenttypes", "0002_remove_content_type_name"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="IPFabricSnapshot",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                ("last_updated", models.DateTimeField(editable=False)),
+                ("name", models.CharField(max_length=200)),
+                ("snapshot_id", models.CharField(max_length=100, unique=True)),
+                ("data", models.JSONField(blank=True, null=True)),
+                ("date", models.DateTimeField(blank=True, editable=False, null=True)),
+            ],
+            options={
+                "verbose_name": "IP Fabric Snapshot",
+                "verbose_name_plural": "IP Fabric Snapshots",
+                "ordering": ("source", "-date"),
+            },
+        ),
+        migrations.CreateModel(
+            name="IPFabricTransformMap",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("name", models.CharField(max_length=100, unique=True)),
+                ("source_model", models.CharField(max_length=50)),
+                ("status", models.CharField(max_length=50)),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "target_model",
+                    models.ForeignKey(
+                        limit_choices_to=models.Q(
+                            models.Q(
+                                models.Q(("app_label", "dcim"), ("model", "site")),
+                                models.Q(
+                                    ("app_label", "dcim"), ("model", "manufacturer")
+                                ),
+                                models.Q(("app_label", "dcim"), ("model", "platform")),
+                                models.Q(
+                                    ("app_label", "dcim"), ("model", "devicerole")
+                                ),
+                                models.Q(
+                                    ("app_label", "dcim"), ("model", "devicetype")
+                                ),
+                                models.Q(("app_label", "dcim"), ("model", "device")),
+                                models.Q(
+                                    ("app_label", "dcim"), ("model", "virtualchassis")
+                                ),
+                                models.Q(("app_label", "dcim"), ("model", "interface")),
+                                models.Q(("app_label", "ipam"), ("model", "vlan")),
+                                models.Q(("app_label", "ipam"), ("model", "vrf")),
+                                models.Q(("app_label", "ipam"), ("model", "prefix")),
+                                models.Q(("app_label", "ipam"), ("model", "ipaddress")),
+                                models.Q(
+                                    ("app_label", "contenttypes"),
+                                    ("model", "contenttype"),
+                                ),
+                                _connector="OR",
+                            )
+                        ),
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="+",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Transform Map",
+                "verbose_name_plural": "IP Fabric Transform Maps",
+            },
+        ),
+        migrations.CreateModel(
+            name="IPFabricTransformField",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("source_field", models.CharField(max_length=100)),
+                ("target_field", models.CharField(max_length=100)),
+                ("coalesce", models.BooleanField(default=False)),
+                ("template", models.TextField(blank=True, null=True)),
+                (
+                    "transform_map",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="field_maps",
+                        to="ipfabric_netbox.ipfabrictransformmap",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Transform Field",
+                "verbose_name_plural": "IP Fabric Transform Fields",
+                "ordering": ("transform_map",),
+            },
+        ),
+        migrations.CreateModel(
+            name="IPFabricSync",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                ("name", models.CharField(max_length=100, unique=True)),
+                ("type", models.CharField(default="dcim", max_length=50)),
+                (
+                    "status",
+                    models.CharField(default="new", editable=False, max_length=50),
+                ),
+                ("parameters", models.JSONField(blank=True, null=True)),
+                (
+                    "last_synced",
+                    models.DateTimeField(blank=True, editable=False, null=True),
+                ),
+                ("scheduled", models.DateTimeField(blank=True, null=True)),
+                (
+                    "interval",
+                    models.PositiveIntegerField(
+                        blank=True,
+                        null=True,
+                        validators=[django.core.validators.MinValueValidator(1)],
+                    ),
+                ),
+                (
+                    "snapshot_data",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="snapshots",
+                        to="ipfabric_netbox.ipfabricsnapshot",
+                    ),
+                ),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Sync",
+                "ordering": ["pk"],
+            },
+        ),
+        migrations.CreateModel(
+            name="IPFabricSource",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("description", models.CharField(blank=True, max_length=200)),
+                ("comments", models.TextField(blank=True)),
+                ("name", models.CharField(max_length=100, unique=True)),
+                ("url", models.CharField(max_length=200)),
+                (
+                    "status",
+                    models.CharField(default="new", editable=False, max_length=50),
+                ),
+                ("parameters", models.JSONField(blank=True, null=True)),
+                (
+                    "last_synced",
+                    models.DateTimeField(blank=True, editable=False, null=True),
+                ),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Source",
+                "verbose_name_plural": "IP Fabric Sources",
+                "ordering": ("name",),
+            },
+        ),
+        migrations.AddField(
+            model_name="ipfabricsnapshot",
+            name="source",
+            field=models.ForeignKey(
+                editable=False,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="snapshots",
+                to="ipfabric_netbox.ipfabricsource",
+            ),
+        ),
+        migrations.CreateModel(
+            name="IPFabricRelationshipField",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("target_field", models.CharField(max_length=100)),
+                ("coalesce", models.BooleanField(default=False)),
+                ("template", models.TextField(blank=True, null=True)),
+                (
+                    "source_model",
+                    models.ForeignKey(
+                        limit_choices_to=models.Q(
+                            models.Q(
+                                ("app_label", "dcim"),
+                                ("app_label", "ipam"),
+                                models.Q(
+                                    ("app_label", "contenttypes"),
+                                    ("model", "contenttype"),
+                                ),
+                                _connector="OR",
+                            )
+                        ),
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="ipfabric_transform_fields",
+                        to="contenttypes.contenttype",
+                    ),
+                ),
+                (
+                    "transform_map",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="relationship_maps",
+                        to="ipfabric_netbox.ipfabrictransformmap",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Relationship Field",
+                "verbose_name_plural": "IP Fabric Relationship Fields",
+                "ordering": ("transform_map",),
+            },
+        ),
+        migrations.CreateModel(
+            name="IPFabricBranch",
+            fields=[
+                (
+                    "branch_ptr",
+                    models.OneToOneField(
+                        auto_created=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        parent_link=True,
+                        primary_key=True,
+                        serialize=False,
+                        to="extras.branch",
+                    ),
+                ),
+                (
+                    "job",
+                    models.ForeignKey(
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        to="core.job",
+                    ),
+                ),
+                (
+                    "sync",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="ipfabric_netbox.ipfabricsync",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "IP Fabric Branch",
+                "verbose_name_plural": "IP Fabric Branches",
+                "ordering": ("name",),
+            },
+            bases=("extras.branch",),
+        ),
+    ]

ipfabric_netbox/migrations/0002_ipfabricsnapshot_status.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.1.10 on 2023-10-10 15:47
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipfabric_netbox", "0001_initial"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="ipfabricsnapshot",
+            name="status",
+            field=models.CharField(default="unloaded", max_length=50),
+        ),
+    ]

ipfabric_netbox/migrations/0003_ipfabricsource_type_and_more.py

@@ -0,0 +1,49 @@
+# Generated by Django 4.1.10 on 2024-01-05 16:59
+import django.db.models.deletion
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipfabric_netbox", "0002_ipfabricsnapshot_status"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="ipfabricsource",
+            name="type",
+            field=models.CharField(default="local", max_length=50),
+        ),
+        migrations.AlterField(
+            model_name="ipfabricsnapshot",
+            name="snapshot_id",
+            field=models.CharField(max_length=100),
+        ),
+        migrations.AlterField(
+            model_name="ipfabricsource",
+            name="last_synced",
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.CreateModel(
+            name="IPFabricData",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("data", models.JSONField(blank=True, null=True)),
+                ("type", models.CharField(max_length=50)),
+                (
+                    "snapshot_data",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="ipf_data",
+                        to="ipfabric_netbox.ipfabricsnapshot",
+                    ),
+                ),
+            ],
+        ),
+    ]

ipfabric_netbox/migrations/0004_ipfabricsync_auto_merge.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.1.10 on 2024-01-09 16:01
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipfabric_netbox", "0003_ipfabricsource_type_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="ipfabricsync",
+            name="auto_merge",
+            field=models.BooleanField(default=False),
+        ),
+    ]

ipfabric_netbox/migrations/0005_alter_ipfabricrelationshipfield_source_model_and_more.py

@@ -0,0 +1,64 @@
+# Generated by Django 5.0.5 on 2024-05-16 15:23
+import django.db.models.deletion
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        ("ipfabric_netbox", "0004_ipfabricsync_auto_merge"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="ipfabricrelationshipfield",
+            name="source_model",
+            field=models.ForeignKey(
+                limit_choices_to=models.Q(
+                    models.Q(
+                        ("app_label", "dcim"),
+                        ("app_label", "ipam"),
+                        ("app_label", "tenancy"),
+                        models.Q(
+                            ("app_label", "contenttypes"), ("model", "contenttype")
+                        ),
+                        _connector="OR",
+                    )
+                ),
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="ipfabric_transform_fields",
+                to="contenttypes.contenttype",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="ipfabrictransformmap",
+            name="target_model",
+            field=models.ForeignKey(
+                limit_choices_to=models.Q(
+                    models.Q(
+                        models.Q(("app_label", "dcim"), ("model", "site")),
+                        models.Q(("app_label", "dcim"), ("model", "manufacturer")),
+                        models.Q(("app_label", "dcim"), ("model", "platform")),
+                        models.Q(("app_label", "dcim"), ("model", "devicerole")),
+                        models.Q(("app_label", "dcim"), ("model", "devicetype")),
+                        models.Q(("app_label", "dcim"), ("model", "device")),
+                        models.Q(("app_label", "dcim"), ("model", "virtualchassis")),
+                        models.Q(("app_label", "dcim"), ("model", "interface")),
+                        models.Q(("app_label", "ipam"), ("model", "vlan")),
+                        models.Q(("app_label", "ipam"), ("model", "vrf")),
+                        models.Q(("app_label", "ipam"), ("model", "prefix")),
+                        models.Q(("app_label", "ipam"), ("model", "ipaddress")),
+                        models.Q(
+                            ("app_label", "contenttypes"), ("model", "contenttype")
+                        ),
+                        models.Q(("app_label", "tenancy"), ("model", "tenant")),
+                        _connector="OR",
+                    )
+                ),
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="+",
+                to="contenttypes.contenttype",
+            ),
+        ),
+    ]

ipfabric_netbox/migrations/0006_alter_ipfabrictransformmap_target_model.py

@@ -0,0 +1,48 @@
+# Generated by Django 5.0.9 on 2024-12-18 10:51
+import django.db.models.deletion
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("contenttypes", "0002_remove_content_type_name"),
+        (
+            "ipfabric_netbox",
+            "0005_alter_ipfabricrelationshipfield_source_model_and_more",
+        ),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="ipfabrictransformmap",
+            name="target_model",
+            field=models.ForeignKey(
+                limit_choices_to=models.Q(
+                    models.Q(
+                        models.Q(("app_label", "dcim"), ("model", "site")),
+                        models.Q(("app_label", "dcim"), ("model", "manufacturer")),
+                        models.Q(("app_label", "dcim"), ("model", "platform")),
+                        models.Q(("app_label", "dcim"), ("model", "devicerole")),
+                        models.Q(("app_label", "dcim"), ("model", "devicetype")),
+                        models.Q(("app_label", "dcim"), ("model", "device")),
+                        models.Q(("app_label", "dcim"), ("model", "virtualchassis")),
+                        models.Q(("app_label", "dcim"), ("model", "interface")),
+                        models.Q(("app_label", "ipam"), ("model", "vlan")),
+                        models.Q(("app_label", "ipam"), ("model", "vrf")),
+                        models.Q(("app_label", "ipam"), ("model", "prefix")),
+                        models.Q(("app_label", "ipam"), ("model", "ipaddress")),
+                        models.Q(
+                            ("app_label", "contenttypes"), ("model", "contenttype")
+                        ),
+                        models.Q(("app_label", "tenancy"), ("model", "tenant")),
+                        models.Q(("app_label", "dcim"), ("model", "inventoryitem")),
+                        _connector="OR",
+                    )
+                ),
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="+",
+                to="contenttypes.contenttype",
+            ),
+        ),
+    ]