Unclear Exception Message about diffsync

[dgarros]

Please can you provide your DiffSyncModel for port

[jdrew82]

Here ya go:

class Port(DiffSyncModel):
    """Port model."""

    _modelname = "port"
    _identifiers = ("device", "name")
    _shortname = ("name",)
    _attributes = ("enabled", "mtu", "description", "mac_addr", "type", "tags")
    _children = {}
    name: str
    device: str
    enabled: Optional[bool]
    mtu: Optional[int]
    description: Optional[str]
    mac_addr: Optional[str]
    type: Optional[str]
    ipaddrs: Optional[List["IPAddress"]]
    tags: Optional[List[str]]

    @classmethod
    def create(cls, diffsync, ids, attrs):  # pylint: disable=inconsistent-return-statements
        """Create Interface object in Nautobot."""
        diffsync.job.log_debug(f"Creating Interface {ids['name']} for {ids['device']}.")
        try:
            if ids.get("device"):
                new_intf = NautobotInterface(
                    name=ids["name"],
                    device=NautobotDevice.objects.get(name=ids["device"]),
                    enabled=is_truthy(attrs["enabled"]),
                    mtu=attrs["mtu"] if attrs.get("mtu") in range(1, 65537) else None,
                    description=attrs["description"],
                    type=attrs["type"],
                    mac_address=attrs["mac_addr"][:12] if attrs.get("mac_addr") else None,
                )
                if attrs.get("tags"):
                    for _tag in nbutils.get_tags(attrs["tags"]):
                        new_intf.tags.add(_tag)
                new_intf.validated_save()
                return super().create(ids=ids, diffsync=diffsync, attrs=attrs)
        except NautobotDevice.DoesNotExist as err:
            print(f"{ids['name']} doesn't exist. {err}")

    def update(self, attrs):
        """Update Interface object in Nautobot."""
        return super().update(attrs)

    def delete(self):
        """Delete Interface object from Nautobot.

        Because Interface has a direct relationship with Cables and IP Addresses it can't be deleted before they are.
        The self.diffsync._objects_to_delete dictionary stores all objects for deletion and removes them from Nautobot
        in the correct order. This is used in the Nautobot adapter sync_complete function.
        """
        print(f"Interface {self.name} for {self.device} will be deleted.")
        super().delete()
        _dev = NautobotInterface.objects.get(
            name=self.get_identifiers()["name"], device__name=self.get_identifiers()["device"]
        )
        self.diffsync._objects_to_delete["port"].append(_dev)  # pylint: disable=protected-access
        return self

The Port class is a child of Device so should be unique to that Device.

[dgarros]

@jdrew82 as a workaround, if you remove the line _shortname = ("name",) from your model it will report the full name of the object that is generating the exception.

Not 100% sure if this something that should be fixed or if this is the expected behavior ...

[jdrew82]

@jdrew82 as a workaround, if you remove the line _shortname = ("name",) from your model it will report the full name of the object that is generating the exception.

Not 100% sure if this something that should be fixed or if this is the expected behavior ...

I was able to address this by not having the model be a top-level. I only created this issue as @glennmatthews requested that I do so to improve the logging information returned. If possible it'd be great if you could provide the parent context the object is in relation to. The error message as I provided isn't helpful as I have no idea which interface it's talking about.