Merge pull request 'feat: a missing license can say what the device withholds without it (4.15.0)' (#44) from feat/license-withholds into main

napalm_device_types/licenses.py

@@ -22,6 +22,11 @@ class LicenseMixin:
             Example::
 
                 [{"name": "pve-subscription", "status": "none"},
-                 {"name": "vSphere", "status": "active", "edition": "Free"}]
+                 {"name": "vSphere", "status": "active", "edition": "Free"},
+                 {"name": "DCMS", "status": "missing",
+                  "withholds": ["drives", "firmware inventory"]}]
+
+            ``withholds`` names what a device keeps back for want of a license while
+            the rest of it answers; a missing license without it may keep back all.
             """
             ...

napalm_device_types/models.py

@@ -1008,6 +1008,11 @@ class LicenseDict(TypedDict):
     edition: NotRequired[str]  # the edition or level, e.g. "Free", "Enterprise Plus"
     expires: NotRequired[Optional[str]]  # ISO date, None for no expiry
     detail: NotRequired[str]  # the device's own words, e.g. why a feature is refused
+    # What the device withholds without it while the rest works, e.g. ["drives",
+    # "firmware inventory"] on a BMC that answers but wants a further license.
+    # Absent: the device says nothing of the kind, or withholds everything it
+    # would offer with it.
+    withholds: NotRequired[List[str]]
 
 
 class HypervisorHostDict(TypedDict):

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "napalm-device-types"
-version = "4.14.0"
+version = "4.15.0"
 description = "Abstract device-type base classes for NAPALM drivers"
 readme = "README.md"
 requires-python = ">=3.10"

tests/test_fact_getters.py

@@ -23,7 +23,16 @@ def test_a_license_says_what_it_is_and_whether_it_holds():
     hints = get_type_hints(LicenseDict)
     assert {"name", "status"} <= set(hints)
     assert LicenseDict.__required_keys__ == frozenset({"name", "status"})
-    assert set(hints) == {"name", "status", "edition", "expires", "detail"}
+    assert set(hints) == {"name", "status", "edition", "expires", "detail", "withholds"}
+
+
+def test_a_missing_license_may_say_what_the_device_withholds_without_it():
+    # A Supermicro X10 with only SFT-OOB-LIC answers Redfish but keeps its drives and
+    # firmware inventory until DCMS is activated: partly licensed, not unlicensed.
+    hints = get_type_hints(LicenseDict)
+    # Python 3.10 keeps NotRequired[...] around the type; later versions strip it.
+    assert "List[str]" in str(hints["withholds"])
+    assert "withholds" not in LicenseDict.__required_keys__
 
 
 def test_a_hypervisor_host_says_how_it_stands():