Merge !1657: datamodel: management: default unix-socket based on rundir

Author: vcunat

NEWS

@@ -12,6 +12,7 @@ Improvements
 ------------
 - manager: allow multiple instances with different rundirs (!1656)
 - tests: disable problematic config.http test (#925, !1662)
+- /management/unix-socket: allow path relative to rundir (!1657)
 
 
 Knot Resolver 6.0.10 (2025-01-20)

doc/_static/config.schema.json

@@ -54,7 +54,7 @@
             "default": 256
         },
         "management": {
-            "description": "Configuration of management HTTP API.",
+            "description": "Configuration of management HTTP API. By default, unix-socket is located in 'rundir'.",
             "type": "object",
             "properties": {
                 "unix-socket": {
@@ -75,7 +75,7 @@
                 }
             },
             "default": {
-                "unix_socket": "/run/knot-resolver/kres-api.sock",
+                "unix_socket": "kres-api.sock",
                 "interface": null
             }
         },

python/knot_resolver/client/command.py

@@ -4,7 +4,7 @@
 from typing import Dict, List, Optional, Set, Tuple, Type, TypeVar
 from urllib.parse import quote
 
-from knot_resolver.constants import API_SOCK_FILE, CONFIG_FILE
+from knot_resolver.constants import API_SOCK_FILE, API_SOCK_NAME, CONFIG_FILE, RUN_DIR
 from knot_resolver.datamodel.types import IPAddressPort
 from knot_resolver.utils.modeling import parsing
 from knot_resolver.utils.modeling.exceptions import DataValidationError
@@ -154,21 +154,38 @@ def get_socket_from_config(config: Path, optional_file: bool) -> Optional[Socket
     try:
         with open(config, "r", encoding="utf8") as f:
             data = parsing.try_to_parse(f.read())
+
+        rkey = "rundir"
+        rundir = Path(data[rkey]) if rkey in data else RUN_DIR
+
         mkey = "management"
         if mkey in data:
             management = data[mkey]
-            if "unix-socket" in management:
-                return SocketDesc(
-                    f'http+unix://{quote(management["unix-socket"], safe="")}/',
-                    f'Key "/management/unix-socket" in "{config}" file',
-                )
-            if "interface" in management:
-                ip = IPAddressPort(management["interface"], object_path=f"/{mkey}/interface")
+
+            ikey = "interface"
+            if ikey in data[mkey]:
+                ip = IPAddressPort(data[mkey][ikey], object_path=f"/{mkey}/{ikey}")
                 return SocketDesc(
                     f"http://{ip.addr}:{ip.port}",
                     f'Key "/management/interface" in "{config}" file',
                 )
-        return None
+
+            skey = "unix-socket"
+            if skey in management:
+                socket = Path(management[skey])
+                if not socket.is_absolute():
+                    socket = rundir / socket
+                return SocketDesc(
+                    f'http+unix://{quote(str(socket), safe="")}/',
+                    f'Key "/management/unix-socket" in "{config}" file',
+                )
+
+        socket = rundir / API_SOCK_NAME
+        return SocketDesc(
+            f'http+unix://{quote(str(socket), safe="")}/',
+            f'Key "/rundir" in "{config}" file',
+        )
+
     except ValueError as e:
         raise DataValidationError(*e.args) from e  # pylint: disable=no-value-for-parameter
     except OSError as e:

python/knot_resolver/constants.py

@@ -5,15 +5,18 @@
 USER = "knot-resolver"
 GROUP = "knot-resolver"
 
-# dirs paths
+# default files names
+API_SOCK_NAME = "kres-api.sock"
+
+# default dirs paths
 RUN_DIR = Path("/run/knot-resolver")
 ETC_DIR = Path("/etc/knot-resolver")
 SBIN_DIR = Path("/usr/sbin")
 CACHE_DIR = Path("/var/cache/knot-resolver")
 
-# files paths
+# default files paths
 CONFIG_FILE = ETC_DIR / "config.yaml"
-API_SOCK_FILE = RUN_DIR / "kres-api.sock"
+API_SOCK_FILE = RUN_DIR / API_SOCK_NAME
 
 # executables paths
 KRESD_EXECUTABLE = SBIN_DIR / "kresd"

python/knot_resolver/constants.py.in

@@ -5,15 +5,18 @@ VERSION = "@version@"
 USER = "@user@"
 GROUP = "@group@"
 
-# dirs paths
+# default files names
+API_SOCK_NAME = "kres-api.sock"
+
+# default dirs paths
 RUN_DIR = Path("@run_dir@")
 ETC_DIR = Path("@etc_dir@")
 SBIN_DIR = Path("@sbin_dir@")
 CACHE_DIR = Path("@cache_dir@")
 
-# files paths
+# default files paths
 CONFIG_FILE = ETC_DIR / "config.yaml"
-API_SOCK_FILE = RUN_DIR / "kres-api.sock"
+API_SOCK_FILE = RUN_DIR / API_SOCK_NAME
 
 # executables paths
 KRESD_EXECUTABLE = SBIN_DIR / "kresd"

python/knot_resolver/datamodel/config_schema.py

@@ -1,9 +1,10 @@
 import logging
 import os
 import socket
+from pathlib import Path
 from typing import Any, Dict, List, Literal, Optional, Tuple, Union
 
-from knot_resolver.constants import API_SOCK_FILE, RUN_DIR, VERSION
+from knot_resolver.constants import API_SOCK_NAME, RUN_DIR, VERSION
 from knot_resolver.datamodel.cache_schema import CacheSchema
 from knot_resolver.datamodel.defer_schema import DeferSchema
 from knot_resolver.datamodel.dns64_schema import Dns64Schema
@@ -95,7 +96,7 @@ class Raw(ConfigSchema):
         rundir: Directory where the resolver can create files and which will be it's cwd.
         workers: The number of running kresd (Knot Resolver daemon) workers. If set to 'auto', it is equal to number of CPUs available.
         max_workers: The maximum number of workers allowed. Cannot be changed in runtime.
-        management: Configuration of management HTTP API.
+        management: Configuration of management HTTP API. By default, unix-socket is located in 'rundir'.
         webmgmt: Configuration of legacy web management endpoint.
         options: Fine-tuning global parameters of DNS resolver operation.
         network: Network connections and protocols configuration.
@@ -118,7 +119,7 @@ class Raw(ConfigSchema):
         rundir: WritableDir = lazy_default(WritableDir, str(RUN_DIR))
         workers: Union[Literal["auto"], IntPositive] = IntPositive(1)
         max_workers: IntPositive = IntPositive(WORKERS_MAX)
-        management: ManagementSchema = lazy_default(ManagementSchema, {"unix-socket": str(API_SOCK_FILE)})
+        management: ManagementSchema = lazy_default(ManagementSchema, {"unix-socket": str(API_SOCK_NAME)})
         webmgmt: Optional[WebmgmtSchema] = None
         options: OptionsSchema = OptionsSchema()
         network: NetworkSchema = NetworkSchema()
@@ -173,6 +174,14 @@ def _workers(self, obj: Raw) -> Any:
             )
         return obj.workers
 
+    def _management(self, obj: Raw) -> Any:
+        if obj.management.unix_socket:
+            soc = Path(obj.management.unix_socket.serialize())
+            if soc.is_absolute():
+                return obj.management
+            return ManagementSchema({"unix-socket": str(obj.rundir.to_path() / soc)})
+        return obj.management
+
     def _dnssec(self, obj: Raw) -> Any:
         if obj.dnssec is True:
             return DnssecSchema()
@@ -259,7 +268,7 @@ def kres_config_json_schema() -> Dict[str, Any]:
     """
 
     context = get_global_validation_context()
-    set_global_validation_context(Context(None, False))
+    set_global_validation_context(Context(RUN_DIR, False))
 
     schema = KresConfig.json_schema(
         schema_id=f"https://www.knot-resolver.cz/documentation/v{VERSION}/_static/config.schema.json",

tests/manager/datamodel/test_config_schema.py

@@ -1,7 +1,9 @@
 import inspect
 import json
+import os
 from typing import Any, Dict, Type, cast
 
+from knot_resolver.constants import API_SOCK_FILE, API_SOCK_NAME, RUN_DIR
 from knot_resolver.datamodel import KresConfig
 from knot_resolver.datamodel.lua_schema import LuaSchema
 from knot_resolver.utils.modeling import BaseSchema
@@ -49,10 +51,31 @@ def _check_str_type(cls: Type[Any], object_path: str = ""):
 def test_config_defaults():
     config = KresConfig()
 
+    # Management API default
+    assert config.management.unix_socket.to_path() == API_SOCK_FILE
+
     # DNS64 default
     assert config.dns64 == False
 
 
+def test_management_unix_socket():
+    cwd = os.getcwd()
+    config = KresConfig({"rundir": cwd})
+    assert str(config.management.unix_socket) == f"{cwd}/{API_SOCK_NAME}"
+
+    my_soc = "my-new.soc"
+    config = KresConfig({"management": {"unix-socket": my_soc}})
+    assert str(config.management.unix_socket) == f"{RUN_DIR}/{my_soc}"
+
+
+def test_management_interface():
+    cwd = os.getcwd()
+    config = KresConfig({"rundir": cwd, "management": {"interface": "127.0.0.1@5000"}})
+
+    assert config.management.unix_socket == None
+    assert str(config.management.interface) == "127.0.0.1@5000"
+
+
 def test_dnssec_false():
     config = KresConfig({"dnssec": False})