Add runtime configuration validation (#8905)

* Sync config models

* re-sync

Author: ofek

disk/datadog_checks/disk/config_models/__init__.py

@@ -0,0 +1,18 @@
+# (C) Datadog, Inc. 2021-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from .instance import InstanceConfig
+from .shared import SharedConfig
+
+
+class ConfigMixin:
+    _config_model_instance: InstanceConfig
+    _config_model_shared: SharedConfig
+
+    @property
+    def config(self) -> InstanceConfig:
+        return self._config_model_instance
+
+    @property
+    def shared_config(self) -> SharedConfig:
+        return self._config_model_shared

disk/datadog_checks/disk/config_models/defaults.py

@@ -0,0 +1,108 @@
+# (C) Datadog, Inc. 2021-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from datadog_checks.base.utils.models.fields import get_default_field_value
+
+
+def shared_device_global_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def shared_file_system_global_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def shared_mount_point_global_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def shared_service(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_all_partitions(field, value):
+    return False
+
+
+def instance_blkid_cache_file(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_create_mounts(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_device_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_device_include(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_device_tag_re(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_disable_generic_tags(field, value):
+    return False
+
+
+def instance_empty_default_hostname(field, value):
+    return False
+
+
+def instance_file_system_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_file_system_include(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_include_all_devices(field, value):
+    return True
+
+
+def instance_min_collection_interval(field, value):
+    return 15
+
+
+def instance_min_disk_size(field, value):
+    return 0
+
+
+def instance_mount_point_exclude(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_mount_point_include(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_service(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_service_check_rw(field, value):
+    return False
+
+
+def instance_tag_by_filesystem(field, value):
+    return False
+
+
+def instance_tag_by_label(field, value):
+    return True
+
+
+def instance_tags(field, value):
+    return get_default_field_value(field, value)
+
+
+def instance_timeout(field, value):
+    return 5
+
+
+def instance_use_lsblk(field, value):
+    return False

disk/datadog_checks/disk/config_models/instance.py

@@ -0,0 +1,76 @@
+# (C) Datadog, Inc. 2021-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
+from typing import Any, Mapping, Optional, Sequence
+
+from pydantic import BaseModel, root_validator, validator
+
+from datadog_checks.base.utils.functions import identity
+from datadog_checks.base.utils.models import validation
+
+from . import defaults, validators
+
+
+class CreateMount(BaseModel):
+    class Config:
+        allow_mutation = False
+
+    host: Optional[str]
+    mountpoint: Optional[str]
+    password: Optional[str]
+    share: Optional[str]
+    type: Optional[str]
+    user: Optional[str]
+
+
+class InstanceConfig(BaseModel):
+    class Config:
+        allow_mutation = False
+
+    all_partitions: Optional[bool]
+    blkid_cache_file: Optional[str]
+    create_mounts: Optional[Sequence[CreateMount]]
+    device_exclude: Optional[Sequence[str]]
+    device_include: Optional[Sequence[str]]
+    device_tag_re: Optional[Mapping[str, Any]]
+    disable_generic_tags: Optional[bool]
+    empty_default_hostname: Optional[bool]
+    file_system_exclude: Optional[Sequence[str]]
+    file_system_include: Optional[Sequence[str]]
+    include_all_devices: Optional[bool]
+    min_collection_interval: Optional[float]
+    min_disk_size: Optional[float]
+    mount_point_exclude: Optional[Sequence[str]]
+    mount_point_include: Optional[Sequence[str]]
+    service: Optional[str]
+    service_check_rw: Optional[bool]
+    tag_by_filesystem: Optional[bool]
+    tag_by_label: Optional[bool]
+    tags: Optional[Sequence[str]]
+    timeout: Optional[int]
+    use_lsblk: Optional[bool]
+    use_mount: bool
+
+    @root_validator(pre=True)
+    def _initial_validation(cls, values):
+        return validation.core.initialize_config(getattr(validators, 'initialize_instance', identity)(values))
+
+    @validator('*', pre=True, always=True)
+    def _ensure_defaults(cls, v, field):
+        if v is not None or field.required:
+            return v
+
+        return getattr(defaults, f'instance_{field.name}')(field, v)
+
+    @validator('*')
+    def _run_validations(cls, v, field):
+        if not v:
+            return v
+
+        return getattr(validators, f'instance_{field.name}', identity)(v, field=field)
+
+    @root_validator(pre=False)
+    def _final_validation(cls, values):
+        return validation.core.finalize_config(getattr(validators, 'finalize_instance', identity)(values))

disk/datadog_checks/disk/config_models/shared.py

@@ -0,0 +1,45 @@
+# (C) Datadog, Inc. 2021-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)
+from __future__ import annotations
+
+from typing import Optional, Sequence
+
+from pydantic import BaseModel, root_validator, validator
+
+from datadog_checks.base.utils.functions import identity
+from datadog_checks.base.utils.models import validation
+
+from . import defaults, validators
+
+
+class SharedConfig(BaseModel):
+    class Config:
+        allow_mutation = False
+
+    device_global_exclude: Optional[Sequence[str]]
+    file_system_global_exclude: Optional[Sequence[str]]
+    mount_point_global_exclude: Optional[Sequence[str]]
+    service: Optional[str]
+
+    @root_validator(pre=True)
+    def _initial_validation(cls, values):
+        return validation.core.initialize_config(getattr(validators, 'initialize_shared', identity)(values))
+
+    @validator('*', pre=True, always=True)
+    def _ensure_defaults(cls, v, field):
+        if v is not None or field.required:
+            return v
+
+        return getattr(defaults, f'shared_{field.name}')(field, v)
+
+    @validator('*')
+    def _run_validations(cls, v, field):
+        if not v:
+            return v
+
+        return getattr(validators, f'shared_{field.name}', identity)(v, field=field)
+
+    @root_validator(pre=False)
+    def _final_validation(cls, values):
+        return validation.core.finalize_config(getattr(validators, 'finalize_shared', identity)(values))

disk/datadog_checks/disk/config_models/validators.py

@@ -0,0 +1,3 @@
+# (C) Datadog, Inc. 2021-present
+# All rights reserved
+# Licensed under a 3-clause BSD style license (see LICENSE)