✨ [#900] Implement health check

Author: SilviaAmAm

backend/src/openarchiefbeheer/external_registers/contrib/openklant/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.26 on 2025-11-25 16:37
+# Generated by Django 4.2.26 on 2025-11-27 16:47
 
 from django.db import migrations, models
 
@@ -24,12 +24,19 @@ class Migration(migrations.Migration):
                         verbose_name="ID",
                     ),
                 ),
+                (
+                    "enabled",
+                    models.BooleanField(
+                        default=True,
+                        help_text="Specifies whether the Open Klant plugin is enabled.",
+                        verbose_name="enabled",
+                    ),
+                ),
                 (
                     "services",
                     models.ManyToManyField(
                         blank=True,
                         help_text="Services to talk to Open Klant instances.",
-                        null=True,
                         to="zgw_consumers.service",
                         verbose_name="Open Klant API services",
                     ),

backend/src/openarchiefbeheer/external_registers/contrib/openklant/models.py

@@ -5,6 +5,11 @@
 
 
 class OpenKlantConfig(SingletonModel):
+    enabled = models.BooleanField(
+        verbose_name=_("enabled"),
+        default=True,
+        help_text=_("Specifies whether the Open Klant plugin is enabled."),
+    )
     services = models.ManyToManyField(
         to="zgw_consumers.Service",
         verbose_name=_("Open Klant API services"),

backend/src/openarchiefbeheer/external_registers/contrib/openklant/plugin.py

@@ -1,5 +1,7 @@
 from typing import Iterable, Mapping, NoReturn
 
+from django.utils.translation import gettext as _
+
 from maykin_health_checks.types import HealthCheckResult
 
 from openarchiefbeheer.external_registers.plugin import (
@@ -8,6 +10,7 @@
     ServiceSlug,
 )
 from openarchiefbeheer.external_registers.registry import register
+from openarchiefbeheer.utils.health_checks import CheckResult, ExtraInfo
 
 from .models import OpenKlantConfig
 from .setup_configuration.models import OpenKlantConfigurationModel
@@ -22,7 +25,32 @@ class OpenKlantPlugin(AbstractBasePlugin):
     setup_configuration_step = OpenKlantConfigurationStep
 
     def check_config(self) -> HealthCheckResult:
-        raise NotImplementedError()
+        config = OpenKlantConfig.get_solo()
+        if not config.enabled:
+            return CheckResult(
+                identifier=self.identifier,
+                success=True,
+                message=_("The Open Klant plugin is disabled."),
+            )
+
+        if not config.services.count() > 0:
+            return CheckResult(
+                identifier=self.identifier,
+                success=False,
+                message=_("No Open Klant API services configured."),
+                extra=[
+                    ExtraInfo(
+                        code="missing_service",
+                        model="openarchiefbeheer.config.APIConfig",
+                        field="selectielijst_api_service",
+                    )
+                ],
+            )
+        return CheckResult(
+            identifier=self.identifier,
+            success=True,
+            message=_("The Open Klant settings are properly configured."),
+        )
 
     def get_admin_url(self, resource_url: str) -> str:
         """From the URL of the resource in the API, return the URL to the resource in the admin of the register."""