Fixed pagination when retrieving locations from DNA Center (#1161)

Author: joewesch

changes/1160.fixed

@@ -0,0 +1 @@
+Fixed a bug in the DNA Center integration where the get_locations method was not correctly paginating the results.

nautobot_ssot/integrations/dna_center/utils/dna_center.py

@@ -45,9 +45,11 @@ def get_locations(self):
         try:
             total_num_sites = self.conn.sites.get_site_count()["response"]
             offset = 1
+            # Default page size is 50, max is 500, so we'll use a comfortable middle ground.
+            limit = 200
             while len(loc_data) < total_num_sites:
-                loc_data.extend(self.conn.sites.get_site(offset=offset)["response"])
-                offset = len(loc_data)
+                loc_data.extend(self.conn.sites.get_site(offset=offset, limit=limit)["response"])
+                offset += limit
             for _, item in enumerate(loc_data):
                 if item["siteNameHierarchy"] not in loc_names:
                     loc_names.append(item["siteNameHierarchy"])

nautobot_ssot/tests/dna_center/test_utils_dna_center.py

@@ -33,7 +33,7 @@ def setUp(self):
         self.verify = False
         self.dnac = DnaCenterClient(self.url, self.username, self.password, verify=self.verify)
         self.dnac.conn = MagicMock()
-        self.dnac.conn.sites.get_site_count.return_value = {"response": 4}
+        self.dnac.conn.sites.get_site_count.return_value = {"response": 31}
         self.dnac.conn.devices.get_device_count.return_value = {"response": 3}
 
         self.mock_response = create_autospec(Response)
@@ -70,6 +70,26 @@ def test_get_locations(self):
         actual = self.dnac.get_locations()
         self.assertEqual(actual, LOCATION_FIXTURE)
 
+    def test_get_locations_pagination(self):
+        """Test the get_locations method correctly paginates without skipping items.
+
+        Simulates a 1-based offset API returning a fixed page size. With N total items
+        and page_size P, an off-by-one in offset causes one duplicate per page. When the
+        accumulated duplicates inflate loc_data to >= total before all unique items are
+        fetched, the loop exits early and items are silently skipped.
+        """
+        all_locations = RECV_LOCATION_FIXTURE["response"][:30]
+
+        def fake_get_site(offset=1, limit=10, **kwargs):
+            """Simulate 1-based offset API returning up to limit items."""
+            start = offset - 1
+            return {"response": all_locations[start : start + limit]}
+
+        self.dnac.conn.sites.get_site.side_effect = fake_get_site
+        self.dnac.conn.sites.get_site_count.return_value = {"response": len(all_locations)}
+        actual = self.dnac.get_locations()
+        self.assertEqual(len(actual), len(all_locations))
+
     def test_get_locations_catches_api_error(self):
         """Test the get_locations method in DnaCenterClient catches dnacentersdkException."""
         self.dnac.conn.sites.get_site.side_effect = dnacentersdkException(self.mock_response)