def test_get_bucket_id_when_bucket_name_set():
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
bucket = mock.MagicMock()
bucket.id_ = "some-id"
bucket.name = "some-name"
cacheAccountInfo.save_bucket(bucket)
bucket_id_or_none = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("some-name")
assert bucket_id_or_none == "some-id"
def test_helpful_error_on_misconfiguration():
with pytest.raises(ImproperlyConfigured) as error:
DjangoCacheAccountInfo("some-invalid-cache-name")
assert str(error.value) == (
"Expected to find a cache with name 'some-invalid-cache-name' as per options."
" The default 'accountInfo' option of this library is with a django cache by the name of 'django-backblaze-b2'"
)
def test_can_perform_operation_after_cache_cleared():
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
bucket = mock.MagicMock()
bucket.id_ = "some-id"
bucket.name = "some-name"
for operation in [
lambda: cacheAccountInfo.refresh_entire_bucket_name_cache([]),
lambda: cacheAccountInfo.save_bucket(bucket),
lambda: cacheAccountInfo.remove_bucket_name("non-extant"),
]:
cacheAccountInfo.clear()
failure = None
try:
operation()
except Exception as e:
failure = e
assert failure is None
def _createAccountInfoCallable(self, opts: BackblazeB2StorageOptions) -> Callable[[], AbstractAccountInfo]:
if (
not isinstance(opts["accountInfo"], dict)
or "type" not in opts["accountInfo"]
or opts["accountInfo"]["type"] not in ["memory", "sqlite", "django-cache"]
):
raise ImproperlyConfigured(
(f"accountInfo property must be a dict with type found in options.py, was {opts['accountInfo']}")
)
if opts["accountInfo"]["type"] == "django-cache":
logger.debug(f"{self.__class__.__name__} will use {DjangoCacheAccountInfo.__name__}")
return lambda: DjangoCacheAccountInfo(
cacheName=cast(DjangoCacheAccountInfoConfig, opts["accountInfo"]).get("cache", "django-backblaze-b2")
)
elif opts["accountInfo"]["type"] == "memory":
logger.debug(f"{self.__class__.__name__} will use {InMemoryAccountInfo.__name__}")
return lambda: InMemoryAccountInfo()
elif opts["accountInfo"]["type"] == "sqlite":
logger.debug(f"{self.__class__.__name__} will use {SqliteAccountInfo.__name__}")
return lambda: SqliteAccountInfo(
file_name=cast(SqliteAccountInfoConfig, opts["accountInfo"])["databasePath"]
)
raise ImproperlyConfigured()
def test_cachedAccountInfo(settings):
cacheName = "test-cache"
bucket = mock.MagicMock()
bucket.name = "django"
bucket.id_ = "django-bucket-id"
cacheAccountInfo = DjangoCacheAccountInfo(cacheName)
cacheAccountInfo.set_auth_data(
"account-id",
"auth-token",
"api-url",
"download-url",
"recommended-part-size",
"absolute-minimum-part-size",
"application-key",
"realm",
"http://s3.api.url",
dict(
bucketId=None,
bucketName=None,
capabilities=["readFiles"],
namePrefix=None,
),
"application-key-id",
)
cacheAccountInfo.save_bucket(bucket)
with mock.patch.object(settings, "BACKBLAZE_CONFIG",
_settingsDict({})), mock.patch.object(
B2Api, "authorize_account"), mock.patch.object(
B2Api, "list_buckets"):
BackblazeB2Storage(
opts={"accountInfo": {
"type": "django-cache",
"cache": cacheName
}})
B2Api.list_buckets.assert_not_called()
def test_can_store_and_retrieve_values(allowed: Dict):
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
cacheAccountInfo.set_auth_data(
"account-id",
"auth-token",
"api-url",
"download-url",
"recommended-part-size",
"absolute-minimum-part-size",
"application-key",
"realm",
"http://s3-api-url/",
allowed,
"application-key-id",
)
assert cacheAccountInfo.get_account_id() == "account-id"
assert cacheAccountInfo.get_account_auth_token() == "auth-token"
assert cacheAccountInfo.get_api_url() == "api-url"
assert cacheAccountInfo.get_download_url() == "download-url"
assert cacheAccountInfo.get_absolute_minimum_part_size() == "absolute-minimum-part-size"
assert cacheAccountInfo.get_recommended_part_size() == "recommended-part-size"
assert cacheAccountInfo.get_application_key() == "application-key"
assert cacheAccountInfo.get_application_key_id() == "application-key-id"
assert cacheAccountInfo.get_s3_api_url() == "http://s3-api-url/"
assert cacheAccountInfo.get_realm() == "realm"
assert cacheAccountInfo.get_allowed() == allowed
def test_raises_if_attributes_are_none():
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
_ExpectedException = MissingAccountData
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_account_id()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'account_id'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_application_key()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'application_key'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_application_key_id()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'application_key_id'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_account_auth_token()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'auth_token'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_api_url()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'api_url'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_download_url()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'download_url'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_absolute_minimum_part_size()
assert str(error.value) == _auth_token_msg(
"Token refresh required to determine value of 'absolute_minimum_part_size'"
)
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_recommended_part_size()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'recommended_part_size'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_realm()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'realm'")
with pytest.raises(_ExpectedException) as error:
cacheAccountInfo.get_allowed()
assert str(error.value) == _auth_token_msg("Token refresh required to determine value of 'allowed'")
# notably, no error in default sqlite implementation
assert cacheAccountInfo.get_s3_api_url() == ""
def test_can_clear_cache(allowed: Dict):
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
cacheAccountInfo.set_auth_data(
"account-id",
"auth-token",
"api-url",
"download-url",
"recommended-part-size",
"absolute-minimum-part-size",
"application-key",
"realm",
"http://s3-api-url/",
allowed,
"application-key-id",
)
bucket = mock.MagicMock()
bucket.id_ = "some-id"
bucket.name = "some-name"
cacheAccountInfo.save_bucket(bucket)
cacheAccountInfo.clear()
bucket_id_or_none = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("some-name")
with pytest.raises(MissingAccountData) as error:
cacheAccountInfo.get_allowed()
assert bucket_id_or_none is None
assert error.value is not None
def test_can_refresh_entire_bucket_name_cache():
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
bucket = mock.MagicMock()
bucket.id_ = "some-id"
bucket.name = "some-name"
bucket2 = mock.MagicMock()
bucket2.id_ = "other-id"
bucket2.name = "other-name"
cacheAccountInfo.save_bucket(bucket)
cacheAccountInfo.save_bucket(bucket2)
cacheAccountInfo.refresh_entire_bucket_name_cache([("some-name", "new-id"), ("something-random", "some-random-id")])
bucket_id_or_none = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("some-name")
bucket_id_or_none2 = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("other-name")
random_id_or_none = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("something-random")
assert bucket_id_or_none == "new-id"
assert bucket_id_or_none2 is None
assert random_id_or_none == "some-random-id"
def test_get_bucket_id_when_bucket_name_not_set():
cacheAccountInfo = DjangoCacheAccountInfo("test-cache")
bucket_id_or_none = cacheAccountInfo.get_bucket_id_or_none_from_bucket_name("some-name")
assert bucket_id_or_none is None