User defined query missing `napalm_driver` causes `add_ansible_platform` to fail.

[qduk]

ISSUE TYPE

• Bug Report

SOFTWARE VERSIONS

pynautobot

3.0.0

Ansible:

2.18.11

Nautobot:

2.0.0

Collection:

networktocode.nautobot v6.0.0

SUMMARY

If a user defines a custom graphql query for devices -> platform but does not include "napalm_driver" as a value, the add_ansible_platform method fails to add the napalm driver as it checks for the existence of the napalm_driver key in the platform dictionary.

STEPS TO REPRODUCE

In your inventory file, create a graphql option like so:

query:
  devices:
    filters:
      has_primary_ip: true
    platform:
      name:
    primary_ip4:
      host:

Then, run your inventory sync. You'll notice that the ansible_network_os variable does not get assigned to the hosts.

EXPECTED RESULTS

I'd expect for the code to merge the needed napalm_driver into the query as it is part of the base query

ACTUAL RESULTS

My definition of platform overrides the base_query entirely resulting in the loss of the napalm_driver key

[cmsirbu]

I'd be in favour of adding in the platform automatically if it's not part of the query, since we state this in the plugin docs:

# This module will automatically add the ansible_host key and set it equal to primary_ip4.host
# as well as the ansible_network_os key and set it to platform.napalm_driver via netutils mapping
# if the primary_ip4.host and platform.napalm_driver are present on the device in Nautobot.

Do we need the same fix for primary_ip4.host?

[qduk]

Yes. Someone could overwrite the primary_ip4 key without host and it wouldn't get injected back in. I can update that.

Also, this doesn't take into consideration if someone is using a saved_query. Do we want to take the same approach? Inject platform[napalm_driver] and primary_ip4[host] if they aren't in the saved_query as well?

I did notice there is some logging if primary_ip4 is missing here

I think, per the documentation like you said, we should just inject it wherever needed so it is always there.