Merge pull request #348 from reef-technologies/fix-api-get-key

Fix `B2Api.get_key()` returning wrong key if `key_id` is incorrect

Author: ppolewicz

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 * Replace `ReplicationScanResult.source_has_sse_c_enabled` with `source_encryption_mode`
+* Fix `B2Api.get_key()` and `RawSimulator.delete_key()`
 
 ### Infrastructure
 * Fix nox's deprecated `session.install()` calls

b2sdk/api.py

@@ -9,6 +9,7 @@
 ######################################################################
 
 from typing import Optional, Tuple, List, Generator
+from contextlib import suppress
 
 from .account_info.abstract import AbstractAccountInfo
 from .api_config import B2HttpApiConfig, DEFAULT_HTTP_API_CONFIG
@@ -539,10 +540,13 @@ def get_key(self, key_id: str) -> Optional[ApplicationKey]:
 
         Raises an exception if profile is not permitted to list keys.
         """
-        return next(
-            self.list_keys(start_application_key_id=key_id),
-            None,
-        )
+        with suppress(StopIteration):
+            key = next(self.list_keys(start_application_key_id=key_id))
+
+            # list_keys() may return some other key if `key_id` does not exist;
+            # thus manually check that we retrieved the right key
+            if key.id_ == key_id:
+                return key
 
     # other
     def get_file_info(self, file_id: str) -> FileVersion:

b2sdk/raw_simulator.py

@@ -1400,6 +1400,9 @@ def delete_key(self, api_url, account_auth_token, application_key_id):
                 'application key does not exist: %s' % (application_key_id,),
                 'bad_request',
             )
+        self.all_application_keys = [
+            key for key in self.all_application_keys if key.application_key_id != application_key_id
+        ]
         return key_sim.as_key()
 
     def finish_large_file(self, api_url, account_auth_token, file_id, part_sha1_array):

b2sdk/v1/api.py

@@ -204,3 +204,7 @@ def create_key(
 
     def delete_key(self, application_key_id):
         return super().delete_key_by_id(application_key_id).as_dict()
+
+    def get_key(self, key_id: str) -> Optional[dict]:
+        keys = self.list_keys(start_application_key_id=key_id)['keys']
+        return next((key for key in keys if key['applicationKeyId'] == key_id), None)

test/unit/api/test_api.py

@@ -480,3 +480,22 @@ def test_list_keys_v2(self):
             'appKeyId9',
         ]
         assert isinstance(keys[0], ApplicationKey)
+
+    def test_get_key(self):
+        self._authorize_account()
+        key = self.api.create_key(['readFiles'], 'testkey')
+
+        if apiver_deps.V <= 1:
+            key_id = key['applicationKeyId']
+        else:
+            key_id = key.id_
+
+        assert self.api.get_key(key_id) is not None
+
+        if apiver_deps.V <= 1:
+            self.api.delete_key(key_id)
+        else:
+            self.api.delete_key(key)
+
+        assert self.api.get_key(key_id) is None
+        assert self.api.get_key('non-existent') is None