1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
import unittest
from io import BytesIO
from unittest import mock
import django
from django.core.files.base import File
from django.core.files.storage import Storage
from django.test import TestCase, override_settings
from health_check.contrib.s3boto3_storage.backends import S3Boto3StorageHealthCheck
from health_check.exceptions import ServiceUnavailable
from health_check.storage.backends import (
DefaultFileStorageHealthCheck,
StorageHealthCheck,
)
class CustomStorage(Storage):
pass
class MockStorage(Storage):
"""
A Mock Storage backend used for testing.
saves - Determines whether save will mock a successful or unsuccessful save
deletes - Determines whether save will mock a successful or unsuccessful deletion.
"""
MOCK_FILE_COUNT = 0
saves = None
deletes = None
def __init__(self, saves=True, deletes=True):
super().__init__()
self.MOCK_FILE_COUNT = 0
self.saves = saves
self.deletes = deletes
def exists(self, file_name):
return self.MOCK_FILE_COUNT != 0
def delete(self, name):
if self.deletes:
self.MOCK_FILE_COUNT -= 1
def save(self, name, content, max_length=None):
if self.saves:
self.MOCK_FILE_COUNT += 1
# Mocking the S3Boto3Storage backend
class MockS3Boto3Storage:
"""S3Boto3Storage backend mock to simulate interactions with AWS S3."""
def __init__(self, saves=True, deletes=True):
self.saves = saves
self.deletes = deletes
self.files = {}
def open(self, name, mode="rb"):
"""
Simulate file opening from the mocked S3 storage.
For simplicity, this doesn't differentiate between read and write modes.
"""
if name in self.files:
# Assuming file content is stored as bytes
file_content = self.files[name]
if isinstance(file_content, bytes):
return File(BytesIO(file_content))
else:
raise ValueError("File content must be bytes.")
else:
raise FileNotFoundError(f"The file {name} does not exist.")
def save(self, name, content):
"""
Ensure content is stored as bytes in a way compatible with open method.
Assumes content is either a ContentFile, bytes, or a string that needs conversion.
"""
if self.saves:
# Check if content is a ContentFile or similar and read bytes
if hasattr(content, "read"):
file_content = content.read()
elif isinstance(content, bytes):
file_content = content
elif isinstance(content, str):
file_content = content.encode() # Convert string to bytes
else:
raise ValueError("Unsupported file content type.")
self.files[name] = file_content
return name
raise Exception("Failed to save file.")
def delete(self, name):
if self.deletes:
self.files.pop(name, None)
else:
raise Exception("Failed to delete file.")
def exists(self, name):
return name in self.files
def get_file_name(*args, **kwargs):
return "mockfile.txt"
def get_file_content(*args, **kwargs):
return b"mockcontent"
@mock.patch("health_check.storage.backends.StorageHealthCheck.get_file_name", get_file_name)
@mock.patch(
"health_check.storage.backends.StorageHealthCheck.get_file_content",
get_file_content,
)
class HealthCheckStorageTests(TestCase):
"""
Tests health check behavior with a mocked storage backend.
Ensures check_status returns/raises the expected result when the storage works or raises exceptions.
"""
def test_get_storage(self):
"""Test get_storage method returns None on the base class, but a Storage instance on default."""
base_storage = StorageHealthCheck()
self.assertIsNone(base_storage.get_storage())
default_storage = DefaultFileStorageHealthCheck()
self.assertIsInstance(default_storage.get_storage(), Storage)
@unittest.skipUnless((4, 2) <= django.VERSION < (5, 0), "Only for Django 4.2 - 5.0")
def test_get_storage_django_between_42_and_50(self):
"""Check that the old DEFAULT_FILE_STORAGE setting keeps being supported."""
# Note: this test doesn't work on Django<4.2 because the setting value is
# evaluated when the class attribute DefaultFileStorageHealthCheck.store is
# read, which is at import time, before we can mock the setting.
with self.settings(DEFAULT_FILE_STORAGE="tests.test_storage.CustomStorage"):
default_storage = DefaultFileStorageHealthCheck()
self.assertIsInstance(default_storage.get_storage(), CustomStorage)
def test_get_storage_django_42_plus(self):
"""Check that the new STORAGES setting is supported."""
with self.settings(STORAGES={"default": {"BACKEND": "tests.test_storage.CustomStorage"}}):
default_storage = DefaultFileStorageHealthCheck()
self.assertIsInstance(default_storage.get_storage(), CustomStorage)
@mock.patch(
"health_check.storage.backends.DefaultFileStorageHealthCheck.storage",
MockStorage(),
)
def test_check_status_working(self):
"""Test check_status returns True when storage is working properly."""
default_storage_health = DefaultFileStorageHealthCheck()
default_storage = default_storage_health.get_storage()
default_storage_open = f"{default_storage.__module__}.{default_storage.__class__.__name__}.open"
with mock.patch(
default_storage_open,
mock.mock_open(read_data=default_storage_health.get_file_content()),
):
self.assertTrue(default_storage_health.check_status())
@mock.patch(
"health_check.storage.backends.storages",
{"default": MockStorage(saves=False)},
)
def test_file_does_not_exist(self):
"""Test check_status raises ServiceUnavailable when file is not saved."""
default_storage_health = DefaultFileStorageHealthCheck()
with self.assertRaises(ServiceUnavailable):
default_storage_health.check_status()
@mock.patch(
"health_check.storage.backends.storages",
{"default": MockStorage(deletes=False)},
)
def test_file_not_deleted(self):
"""Test check_status raises ServiceUnavailable when file is not deleted."""
default_storage_health = DefaultFileStorageHealthCheck()
with self.assertRaises(ServiceUnavailable):
default_storage_health.check_status()
@mock.patch("storages.backends.s3boto3.S3Boto3Storage", new=MockS3Boto3Storage)
@override_settings(
STORAGES={
"default": {"BACKEND": "storages.backends.s3boto3.S3Boto3Storage"},
}
)
class HealthCheckS3Boto3StorageTests(TestCase):
"""Tests health check behavior with a mocked S3Boto3Storage backend."""
def test_check_delete_success(self):
"""Test that check_delete correctly deletes a file when S3Boto3Storage is working."""
health_check = S3Boto3StorageHealthCheck()
mock_storage = health_check.get_storage()
file_name = "testfile.txt"
content = BytesIO(b"Test content")
mock_storage.save(file_name, content)
health_check.check_delete(file_name)
self.assertFalse(mock_storage.exists(file_name))
def test_check_delete_failure(self):
"""Test that check_delete raises ServiceUnavailable when deletion fails."""
with mock.patch.object(
MockS3Boto3Storage,
"delete",
side_effect=Exception("Failed to delete file."),
):
health_check = S3Boto3StorageHealthCheck()
with self.assertRaises(ServiceUnavailable):
health_check.check_delete("testfile.txt")
def test_check_status_working(self):
"""Test check_status returns True when S3Boto3Storage can save and delete files."""
health_check = S3Boto3StorageHealthCheck()
self.assertTrue(health_check.check_status())
def test_check_status_failure_on_save(self):
"""Test check_status raises ServiceUnavailable when file cannot be saved."""
with mock.patch.object(MockS3Boto3Storage, "save", side_effect=Exception("Failed to save file.")):
health_check = S3Boto3StorageHealthCheck()
with self.assertRaises(ServiceUnavailable):
health_check.check_status()
def test_check_status_failure_on_delete(self):
"""Test check_status raises ServiceUnavailable when file cannot be deleted."""
with mock.patch.object(MockS3Boto3Storage, "exists", new_callable=mock.PropertyMock) as mock_exists:
mock_exists.return_value = False
health_check = S3Boto3StorageHealthCheck()
with self.assertRaises(ServiceUnavailable):
health_check.check_status()
|