Cache openapi dump locally (#617)

Cache the OpenAPI schema for a faster nb_inventory.

Author: kr3ator

plugins/inventory/nb_inventory.py

@@ -258,6 +258,7 @@
 import json
 import uuid
 import math
+import os
 from copy import deepcopy
 from functools import partial
 from sys import version as python_version
@@ -268,6 +269,7 @@
 from ipaddress import ip_interface
 from packaging import specifiers, version
 
+from ansible.constants import DEFAULT_LOCAL_TMP
 from ansible.plugins.inventory import BaseInventoryPlugin, Constructable, Cacheable
 from ansible.module_utils.ansible_release import __version__ as ansible_version
 from ansible.errors import AnsibleError
@@ -1194,9 +1196,30 @@ def wrapper():
             thread_exceptions = None
 
     def fetch_api_docs(self):
-        openapi = self._fetch_information(
-            self.api_endpoint + "/api/docs/?format=openapi"
-        )
+        try:
+            status = self._fetch_information(self.api_endpoint + "/api/status")
+            netbox_api_version = ".".join(status["netbox-version"].split(".")[:2])
+        except:
+            netbox_api_version = 0
+
+        tmp_dir = os.path.split(DEFAULT_LOCAL_TMP)[0]
+        tmp_file = os.path.join(tmp_dir, "netbox_api_dump.json")
+
+        try:
+            with open(tmp_file) as file:
+                openapi = json.load(file)
+        except:
+            openapi = {}
+
+        cached_api_version = openapi.get("info", {}).get("version")
+
+        if netbox_api_version != cached_api_version:
+            openapi = self._fetch_information(
+                self.api_endpoint + "/api/docs/?format=openapi"
+            )
+
+            with open(tmp_file, "w") as file:
+                json.dump(openapi, file)
 
         self.api_version = version.parse(openapi["info"]["version"])
         self.allowed_device_query_parameters = [

tests/unit/inventory/test_nb_inventory.py

@@ -9,7 +9,7 @@
 import pytest
 import os
 from functools import partial
-from unittest.mock import patch, MagicMock, Mock, call
+from unittest.mock import patch, MagicMock, Mock, call, mock_open
 from packaging import version
 
 try:
@@ -190,3 +190,33 @@ def test_get_resource_list_chunked(
     mock_get_resource_list.assert_has_calls(map(call, expected))
     assert mock_get_resource_list.call_count == len(expected)
     assert resources == mock_get_resource_list.return_value * len(expected)
+
+
+@patch(
+    "ansible_collections.netbox.netbox.plugins.inventory.nb_inventory.DEFAULT_LOCAL_TMP",
+    "/fake/path/asdasd3456",
+)
+@pytest.mark.parametrize("netbox_ver", ["2.0.2", "3.0.0"])
+def test_fetch_api_docs(inventory_fixture, netbox_ver):
+    mock_fetch_information = Mock()
+    mock_fetch_information.side_effect = [
+        {"netbox-version": netbox_ver},
+        {"info": {"version": "3.0"}},
+    ]
+
+    inventory_fixture._fetch_information = mock_fetch_information
+
+    with pytest.raises(KeyError, match="paths"):
+        with patch("builtins.open", mock_open()) as filemock:
+            with patch(
+                "ansible_collections.netbox.netbox.plugins.inventory.nb_inventory.json"
+            ) as json_mock:
+                json_mock.load.return_value = {"info": {"version": "2.0"}}
+                inventory_fixture.fetch_api_docs()
+
+    ref_args_list = [call("/fake/path/netbox_api_dump.json")]
+    if netbox_ver == "3.0.0":
+        ref_args_list.append(call("/fake/path/netbox_api_dump.json", "w"))
+
+    assert filemock.call_args_list == ref_args_list
+    assert str(inventory_fixture.api_version) == netbox_ver[:-2]