import os from pathlib import Path from unittest import mock from celery import states from django.contrib.auth.models import User from django.test import override_settings from rest_framework import status from rest_framework.test import APITestCase from documents.models import PaperlessTask from paperless import version class TestSystemStatus(APITestCase): ENDPOINT = "/api/status/" def setUp(self): self.user = User.objects.create_superuser( username="temp_admin", ) def test_system_status(self): """ GIVEN: - A user is logged in WHEN: - The user requests the system status THEN: - The response contains relevant system status information """ self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["pngx_version"], version.__full_version_str__) self.assertIsNotNone(response.data["server_os"]) self.assertEqual(response.data["install_type"], "bare-metal") self.assertIsNotNone(response.data["storage"]["total"]) self.assertIsNotNone(response.data["storage"]["available"]) self.assertEqual(response.data["database"]["type"], "sqlite") self.assertIsNotNone(response.data["database"]["url"]) self.assertEqual(response.data["database"]["status"], "OK") self.assertIsNone(response.data["database"]["error"]) self.assertIsNotNone(response.data["database"]["migration_status"]) self.assertEqual(response.data["tasks"]["redis_url"], "redis://localhost:6379") self.assertEqual(response.data["tasks"]["redis_status"], "ERROR") self.assertIsNotNone(response.data["tasks"]["redis_error"]) def test_system_status_insufficient_permissions(self): """ GIVEN: - A user is not logged in or does not have permissions WHEN: - The user requests the system status THEN: - The response contains a 401 status code or a 403 status code """ response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) normal_user = User.objects.create_user(username="normal_user") self.client.force_login(normal_user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) def test_system_status_container_detection(self): """ GIVEN: - The application is running in a containerized environment WHEN: - The user requests the system status THEN: - The response contains the correct install type """ self.client.force_login(self.user) os.environ["PNGX_CONTAINERIZED"] = "1" response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["install_type"], "docker") os.environ["KUBERNETES_SERVICE_HOST"] = "http://localhost" response = self.client.get(self.ENDPOINT) self.assertEqual(response.data["install_type"], "kubernetes") @mock.patch("redis.Redis.execute_command") def test_system_status_redis_ping(self, mock_ping): """ GIVEN: - Redies ping returns True WHEN: - The user requests the system status THEN: - The response contains the correct redis status """ mock_ping.return_value = True self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["redis_status"], "OK") def test_system_status_redis_no_credentials(self): """ GIVEN: - Redis URL with credentials WHEN: - The user requests the system status THEN: - The response contains the redis URL but no credentials """ with override_settings( _CHANNELS_REDIS_URL="redis://username:password@localhost:6379", ): self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["redis_url"], "redis://localhost:6379", ) def test_system_status_redis_socket(self): """ GIVEN: - Redis URL is socket WHEN: - The user requests the system status THEN: - The response contains the redis URL """ with override_settings(_CHANNELS_REDIS_URL="unix:///path/to/redis.sock"): self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["redis_url"], "unix:///path/to/redis.sock", ) @mock.patch("celery.app.control.Inspect.ping") def test_system_status_celery_ping(self, mock_ping): """ GIVEN: - Celery ping returns pong WHEN: - The user requests the system status THEN: - The response contains the correct celery status """ mock_ping.return_value = {"hostname": {"ok": "pong"}} self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["celery_status"], "OK") @override_settings(INDEX_DIR=Path("/tmp/index")) @mock.patch("whoosh.index.FileIndex.last_modified") def test_system_status_index_ok(self, mock_last_modified): """ GIVEN: - The index last modified time is set WHEN: - The user requests the system status THEN: - The response contains the correct index status """ mock_last_modified.return_value = 1707839087 self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["index_status"], "OK") self.assertIsNotNone(response.data["tasks"]["index_last_modified"]) @override_settings(INDEX_DIR=Path("/tmp/index/")) @mock.patch("documents.index.open_index", autospec=True) def test_system_status_index_error(self, mock_open_index): """ GIVEN: - The index is not found WHEN: - The user requests the system status THEN: - The response contains the correct index status """ mock_open_index.return_value = None mock_open_index.side_effect = Exception("Index error") self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) mock_open_index.assert_called_once() self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["index_status"], "ERROR") self.assertIsNotNone(response.data["tasks"]["index_error"]) def test_system_status_classifier_ok(self): """ GIVEN: - The classifier is found WHEN: - The user requests the system status THEN: - The response contains an OK classifier status """ PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.SUCCESS, task_name=PaperlessTask.TaskName.TRAIN_CLASSIFIER, ) self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["classifier_status"], "OK") self.assertIsNone(response.data["tasks"]["classifier_error"]) def test_system_status_classifier_warning(self): """ GIVEN: - No classifier task is found WHEN: - The user requests the system status THEN: - The response contains a WARNING classifier status """ self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["classifier_status"], "WARNING", ) def test_system_status_classifier_error(self): """ GIVEN: - An error occurred while loading the classifier WHEN: - The user requests the system status THEN: - The response contains an ERROR classifier status """ PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.FAILURE, task_name=PaperlessTask.TaskName.TRAIN_CLASSIFIER, result="Classifier training failed", ) self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["classifier_status"], "ERROR", ) self.assertIsNotNone(response.data["tasks"]["classifier_error"]) def test_system_status_sanity_check_ok(self): """ GIVEN: - The sanity check is successful WHEN: - The user requests the system status THEN: - The response contains an OK sanity check status """ PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.SUCCESS, task_name=PaperlessTask.TaskName.CHECK_SANITY, ) self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["sanity_check_status"], "OK") self.assertIsNone(response.data["tasks"]["sanity_check_error"]) def test_system_status_sanity_check_warning(self): """ GIVEN: - No sanity check task is found WHEN: - The user requests the system status THEN: - The response contains a WARNING sanity check status """ self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["sanity_check_status"], "WARNING", ) def test_system_status_sanity_check_error(self): """ GIVEN: - The sanity check failed WHEN: - The user requests the system status THEN: - The response contains an ERROR sanity check status """ PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.FAILURE, task_name=PaperlessTask.TaskName.CHECK_SANITY, result="5 issues found.", ) self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual( response.data["tasks"]["sanity_check_status"], "ERROR", ) self.assertIsNotNone(response.data["tasks"]["sanity_check_error"]) def test_system_status_ai_disabled(self): """ GIVEN: - The AI feature is disabled WHEN: - The user requests the system status THEN: - The response contains the correct AI status """ with override_settings(AI_ENABLED=False): self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["llmindex_status"], "DISABLED") self.assertIsNone(response.data["tasks"]["llmindex_error"]) def test_system_status_ai_enabled(self): """ GIVEN: - The AI index feature is enabled, but no tasks are found - The AI index feature is enabled and a task is found WHEN: - The user requests the system status THEN: - The response contains the correct AI status """ with override_settings(AI_ENABLED=True, LLM_EMBEDDING_BACKEND="openai"): self.client.force_login(self.user) # No tasks found response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["llmindex_status"], "WARNING") PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.SUCCESS, task_name=PaperlessTask.TaskName.LLMINDEX_UPDATE, ) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["llmindex_status"], "OK") self.assertIsNone(response.data["tasks"]["llmindex_error"]) def test_system_status_ai_error(self): """ GIVEN: - The AI index feature is enabled and a task is found with an error WHEN: - The user requests the system status THEN: - The response contains the correct AI status """ with override_settings(AI_ENABLED=True, LLM_EMBEDDING_BACKEND="openai"): PaperlessTask.objects.create( type=PaperlessTask.TaskType.SCHEDULED_TASK, status=states.FAILURE, task_name=PaperlessTask.TaskName.LLMINDEX_UPDATE, result="AI index update failed", ) self.client.force_login(self.user) response = self.client.get(self.ENDPOINT) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["tasks"]["llmindex_status"], "ERROR") self.assertIsNotNone(response.data["tasks"]["llmindex_error"])