Merge pull request #116 from shane-ns1/deprecate-isKeyWriteLocked

Deprecate "writeLocked" keys, which do not actually do anything

Author: shane-ns1

CHANGELOG.md

@@ -1,5 +1,6 @@
 * Drop support for EOL Python 2.7 and 3.7. Add support for Python 3.11
   and 3.12.
+* Deprecate "writeLocked" keys, which did not actually do anything.
 
 ## 0.18.0 (August 23, 2022)
 * Add usage stats pagination support

doc/api/config.rst

@@ -15,12 +15,10 @@ Sample:
             "account1": {
                 "key": "<<CLEARTEXT API KEY>>",
                 "desc": "account number 1",
-                "writeLock": true
             },
             "account2": {
                 "key": "<<ANOTHER CLEARTEXT API KEY>>",
                 "desc": "account number 2",
-                "writeLock": false
             }
        },
        "cli": {

doc/configuration.rst

@@ -39,12 +39,10 @@ This example shows two different API keys. Which to use can be selected at runti
             "account1": {
                 "key": "<<CLEARTEXT API KEY>>",
                 "desc": "account number 1",
-                "writeLock": true
             },
             "account2": {
                 "key": "<<ANOTHER CLEARTEXT API KEY>>",
                 "desc": "account number 2",
-                "writeLock": false
             },
        },
        "cli": {

ns1/config.py

@@ -6,6 +6,19 @@
 import json
 import os
 
+try:
+    from warnings import deprecated
+except ImportError:
+    import warnings
+
+    def deprecated(reason="deprecated"):
+        def decorator(func):
+            def wrapper_func():
+                warnings.warn(reason, DeprecationWarning)
+                func()
+            return wrapper_func
+        return deprecated
+
 from ns1.rest.rate_limiting import default_rate_limit_func
 from ns1.rest.rate_limiting import rate_limit_strategy_concurrent
 from ns1.rest.rate_limiting import rate_limit_strategy_solo
@@ -181,6 +194,7 @@ def getKeyConfig(self, keyID=None):
 
         return self._data["keys"][k]
 
+    @deprecated("write locked keys are not implemented")
     def isKeyWriteLocked(self, keyID=None):
         """
         Determine if a key config is write locked.

tests/unit/test_acl.py

@@ -18,7 +18,6 @@ def acl_config(config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }

tests/unit/test_address.py

@@ -18,7 +18,6 @@ def address_config(config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }

tests/unit/test_apikey.py

@@ -18,7 +18,6 @@ def apikey_config(config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }

tests/unit/test_client_classes.py

@@ -18,7 +18,6 @@ def client_class_config(config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }

tests/unit/test_config.py

@@ -29,7 +29,6 @@ def test_writeread(tmpdir, config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }
@@ -44,7 +43,6 @@ def test_writeread(tmpdir, config):
     assert cfg_read is not config
     assert cfg_read.getEndpoint() == config.getEndpoint()
     assert cfg_read.getCurrentKeyID() == config.getCurrentKeyID()
-    assert cfg_read.isKeyWriteLocked() == config.isKeyWriteLocked()
 
 
 def test_str_repr(config):
@@ -61,37 +59,11 @@ def test_dodefaults(config):
     assert config._data == defaults
 
 
-def test_apikey_writelock(config):
-    key_cfg = {
-        "default_key": "readonly",
-        "keys": {
-            "readonly": {
-                "key": "key-1",
-                "desc": "test key number 1",
-                "writeLock": True,
-            },
-            "readwrite": {
-                "key": "key-2",
-                "desc": "test key number 2",
-                "writeLock": False,
-            },
-        },
-    }
-
-    config.loadFromString(json.dumps(key_cfg))
-    assert config.getCurrentKeyID() == "readonly"
-    assert config.isKeyWriteLocked()
-
-    config.useKeyID("readwrite")
-    assert not config.isKeyWriteLocked()
-
-
 def test_create_from_apikey(config):
     apikey = "apikey"
     config.createFromAPIKey(apikey)
     assert config.getAPIKey() == apikey
     assert config.getCurrentKeyID() == "default"
-    assert not config.isKeyWriteLocked()
 
 
 def test_load_from_str(config):
@@ -101,7 +73,6 @@ def test_load_from_str(config):
             "test1": {
                 "key": "key-1",
                 "desc": "test key number 1",
-                "writeLock": True,
             }
         },
     }

tests/unit/test_data.py

@@ -18,7 +18,6 @@ def source_config(config):
                 "test1": {
                     "key": "key-1",
                     "desc": "test key number 1",
-                    "writeLock": True,
                 }
             },
         }