Add config tables for all configurable commands

Author: pederhan

CHANGELOG

@@ -7,7 +7,44 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- released start -->
 
-<!-- ## [Unreleased] -->
+## [Unreleased]
+
+### Added
+
+- Configuration file tables for the following commands:
+  - `create_host`: `[app.commands.create_host]`
+  - `create_user`: `[app.commands.create_user]`
+  - `create_notification_user`: `[app.commands.create_notification_user]`
+  - `export_configuration`: `[app.commands.export]`
+  - `import_configuration`: `[app.commands.export]`
+  - **NOTE:** `export_configuration` and `import_configuration` share the same configuration table.
+- New option `create_user --default-usergroups/--no-default-usergroups`
+- New option `create_notification_user --default-usergroups/--no-default-usergroups`
+
+### Changed
+
+- Moved the following config options to the new `[app.commands]` table:
+  - `app.default_hostgroups` → `app.commands.create_host.hostgroups`
+  - `app.default_admin_usergroups` → `app.commands.create_hostgroup.rw_groups`
+  - `app.default_create_user_usergroups` → `app.commands.create_user.usergroups` & `app.commands.create_hostgroup.ro_groups`
+  - `app.default_notification_users_usergroups` → `app.commands.create_notification_user.usergroups`
+  - `app.export_directory` → `app.commands.export.directory`
+  - `app.export_format` → `app.commands.export.format`
+  - `app.export_timestamps` → `app.commands.export.timestamps`
+- Removed default value in config for notification user groups (`All-notification-users`).
+- `create_notification_user` no longer uses the same default user groups as `create_user`.
+  - The default user groups is now set by `app.commands.create_notification_user.usergroups` in the config file.
+
+### Deprecated
+
+- Deprecated the following config options (moved to the new `[app.commands]` table):
+  - `app.default_hostgroups`
+  - `app.default_admin_usergroups`
+  - `app.default_create_user_usergroups`
+  - `app.default_notification_users_usergroups`
+  - `app.export_directory`
+  - `app.export_format`
+  - `app.export_timestamps`
 
 ## [3.5.2](https://github.com/unioslo/zabbix-cli/releases/tag/3.5.2) - 2025-04-24
 

docs/scripts/gen_config_data.py

@@ -181,16 +181,20 @@ def validate_type(cls, value: Any) -> str:
         def type_to_str(t: type[Any]) -> str:
             if lenient_issubclass(value, str):
                 return "str"
+
             if lenient_issubclass(value, Enum):
                 # Get the name of the first enum member type
-                # Will fail if enum has no members
+                # NOTE: Will fail if enum has no members
                 return str(list(value)[0])  # pyright: ignore[reportUnknownArgumentType]
+
             # Types that are represented as strings in config (paths, secrets, etc.)
             if typ := TYPE_MAP.get(t):
                 return typ
+
             # Primitives and built-in generics (str, int, list[str], dict[str, int], etc.)
             if origin in TYPE_CAN_STR:
                 return str(value)
+
             # Fall back on the string representation of the type
             return getattr(value, "__name__", str(value))
 
@@ -303,6 +307,8 @@ def get_config_options(
             continue
         if field.default is None:
             continue
+        if field.deprecated:
+            continue
 
         if lenient_issubclass(field.annotation, RootModel):
             logging.debug("Skipping %s. It is a root model.", field_name)

tests/data/zabbix-cli-old-v3.toml

@@ -0,0 +1,35 @@
+[api]
+url = "https:/zabbix.example.com"
+username = "Admin"
+password = ""
+auth_token = ""
+verify_ssl = true
+
+[app]
+default_hostgroups = ["All-hosts"]
+default_admin_usergroups = ["All-admin-users"]
+default_create_user_usergroups = ["All-users"]
+default_notification_users_usergroups = ["All-notification-users"]
+export_directory = "/path/to/data_dir/exports"
+export_format = "json"
+export_timestamps = false
+use_session_file = true
+session_file = "/path/to/data_dir/.zabbix-cli_session.json"
+auth_token_file = "/path/to/data_dir/.zabbix-cli_auth_token"
+auth_file = "/path/to/data_dir/.zabbix-cli_auth"
+allow_insecure_auth_file = true
+history = true
+history_file = "/path/to/data_dir/history"
+bulk_mode = "strict"
+legacy_json_format = false
+use_color = true
+use_paging = false
+output_format = "table"
+
+
+[logging]
+enabled = true
+log_level = "INFO"
+log_file = "/path/to/logs_dir/zabbix-cli.log"
+
+[plugins]

tests/data/zabbix-cli.toml

@@ -23,6 +23,22 @@ legacy_json_format = false
 
 [app.commands.create_host]
 create_interface = true
+hostgroups = []
+
+[app.commands.create_hostgroup]
+ro_groups = []
+rw_groups = []
+
+[app.commands.create_notification_user]
+usergroups = []
+
+[app.commands.create_user]
+usergroups = []
+
+[app.commands.export]
+directory = "/path/to/exports"
+format = "json"
+timestamps = false
 
 [app.output]
 format = "table"

tests/test_config.py

@@ -305,22 +305,22 @@ def test_deprecated_field_warnings(caplog: pytest.LogCaptureFixture) -> None:
             (
                 "zabbix_cli",
                 30,
-                "Config option [configopt]output_format[/] is deprecated. Use [configopt]app.output.format[/] instead.",
+                "Config option [configopt]output_format[/] is deprecated. Replaced by: [configopt]app.output.format[/].",
             ),
             (
                 "zabbix_cli",
                 30,
-                "Config option [configopt]system_id[/] is deprecated. Use [configopt]api.username[/] instead.",
+                "Config option [configopt]system_id[/] is deprecated. Replaced by: [configopt]api.username[/].",
             ),
             (
                 "zabbix_cli",
                 30,
-                "Config option [configopt]use_colors[/] is deprecated. Use [configopt]app.output.color[/] instead.",
+                "Config option [configopt]use_colors[/] is deprecated. Replaced by: [configopt]app.output.color[/].",
             ),
             (
                 "zabbix_cli",
                 30,
-                "Config option [configopt]use_paging[/] is deprecated. Use [configopt]app.output.paging[/] instead.",
+                "Config option [configopt]use_paging[/] is deprecated. Replaced by: [configopt]app.output.paging[/].",
             ),
             (
                 "zabbix_cli",
@@ -351,18 +351,22 @@ def test_get_deprecated_fields_set() -> None:
             DeprecatedField(
                 field_name="app.output_format",
                 value=OutputFormat.JSON,
-                replacement="app.output.format",
+                replacement=["app.output.format"],
             ),
             DeprecatedField(
                 field_name="app.system_id",
                 value="System-User",
-                replacement="api.username",
+                replacement=["api.username"],
             ),
             DeprecatedField(
-                field_name="app.use_colors", value=True, replacement="app.output.color"
+                field_name="app.use_colors",
+                value=True,
+                replacement=["app.output.color"],
             ),
             DeprecatedField(
-                field_name="app.use_paging", value=True, replacement="app.output.paging"
+                field_name="app.use_paging",
+                value=True,
+                replacement=["app.output.paging"],
             ),
         ]
     )
@@ -404,7 +408,7 @@ def _set_deprecated_fields_in_new_location(self) -> Self:
             DeprecatedField(
                 field_name="bar.qux_deprecated",
                 value="test123",
-                replacement="bar.baz.qux",
+                replacement=["bar.baz.qux"],
             )
         ]
     )
@@ -466,6 +470,13 @@ def test_get_deprecated_fields() -> None:
             "app.use_colors",
             "app.use_paging",
             "app.system_id",
+            "app.default_hostgroups",
+            "app.default_admin_usergroups",
+            "app.default_create_user_usergroups",
+            "app.default_notification_users_usergroups",
+            "app.export_directory",
+            "app.export_format",
+            "app.export_timestamps",
         ]
     )
 
@@ -484,13 +495,6 @@ def test_load_deprecated_config(tmp_path: Path) -> None:
 verify_ssl = true
 
 [app]
-default_hostgroups = ["All-hosts"]
-default_admin_usergroups = []
-default_create_user_usergroups = []
-default_notification_users_usergroups = ["All-notification-users"]
-export_directory = "{tmp_path}/exports"
-export_format = "json"
-export_timestamps = false
 use_session_file = true
 auth_token_file = "{tmp_path}/.zabbix-cli_auth_token"
 auth_file = "{tmp_path}/.zabbix-cli_auth"
@@ -499,6 +503,13 @@ def test_load_deprecated_config(tmp_path: Path) -> None:
 bulk_mode = "strict"
 
 # Deprecated options (moved)
+default_hostgroups = ["All-hosts"]
+default_admin_usergroups = ["All-admin-users"]
+default_create_user_usergroups = ["All-users"]
+default_notification_users_usergroups = ["All-notification-users"]
+export_directory = "{tmp_path}/exports"
+export_format = "json"
+export_timestamps = false
 use_colors = false
 use_paging = true
 output_format = "json"
@@ -522,10 +533,21 @@ def test_load_deprecated_config(tmp_path: Path) -> None:
     config = Config.from_file(conf)
 
     # Check that the deprecated fields are assigned to the new fields
+    assert config.app.commands.create_host.hostgroups == ["All-hosts"]
+    assert config.app.commands.create_hostgroup.rw_groups == ["All-admin-users"]
+    assert config.app.commands.create_hostgroup.ro_groups == ["All-users"]
+    assert config.app.commands.create_notification_user.usergroups == [
+        "All-notification-users"
+    ]
+    assert config.app.commands.create_user.usergroups == ["All-users"]
+    assert config.app.commands.export.directory == tmp_path / "exports"
+    assert config.app.commands.export.format == OutputFormat.JSON
+    assert config.app.commands.export.timestamps is False
+
     assert config.app.output.color is False
     assert config.app.output.paging is True
     assert config.app.output.format == OutputFormat.JSON
-    assert config.api.username == "System-User"
+    assert config.api.username == "System-User"  # assigned from app.system_id
 
 
 def test_load_deprecated_config_with_new_and_old_options(tmp_path: Path) -> None:
@@ -536,16 +558,45 @@ def test_load_deprecated_config_with_new_and_old_options(tmp_path: Path) -> None
     """
     conf = tmp_path / "zabbix-cli.toml"
     conf.write_text(
-        """
-[api]
-username = "Admin"
+        f"""
+##### Deprecated options (should be ignored) #####
 
 [app]
+default_hostgroups = ["All-hosts-deprecated"]
+default_admin_usergroups = ["All-admin-users-deprecated"]
+default_create_user_usergroups = ["All-users-deprecated"]
+default_notification_users_usergroups = ["All-notification-users-deprecated"]
+export_directory = "{tmp_path}/exports_deprecated"
+export_format = "yaml"
+export_timestamps = true
 use_colors = false
 use_paging = true
 output_format = "json"
 system_id = "System-User"
 
+##### New options (should be used) #####
+
+[api]
+username = "Admin"
+
+[app.commands.create_user]
+usergroups = ["All-users"]
+
+[app.commands.create_notification_user]
+usergroups = ["All-notification-users"]
+
+[app.commands.create_host]
+hostgroups = ["All-hosts"]
+
+[app.commands.create_hostgroup]
+ro_groups = ["All-users"]
+rw_groups = ["All-admin-users"]
+
+[app.commands.export]
+directory = "{tmp_path}/exports"
+format = "json"
+timestamps = false
+
 [app.output]
 color = true
 format = "table"
@@ -555,6 +606,18 @@ def test_load_deprecated_config_with_new_and_old_options(tmp_path: Path) -> None
     config = Config.from_file(conf)
 
     # New fields should NOT be overwritten by deprecated fields
+    assert config.app.commands.create_host.hostgroups == ["All-hosts"]
+    assert config.app.commands.create_hostgroup.rw_groups == ["All-admin-users"]
+    assert config.app.commands.create_hostgroup.ro_groups == ["All-users"]
+    assert config.app.commands.create_user.usergroups == ["All-users"]
+    assert config.app.commands.create_notification_user.usergroups == [
+        "All-notification-users"
+    ]
+    assert config.app.commands.create_hostgroup.ro_groups == ["All-users"]
+    assert config.app.commands.create_hostgroup.rw_groups == ["All-admin-users"]
+    assert config.app.commands.export.directory == tmp_path / "exports"
+    assert config.app.commands.export.format == OutputFormat.JSON
+    assert config.app.commands.export.timestamps is False
     assert config.api.username == "Admin"
     assert config.app.output.color is True
     assert config.app.output.paging is False

zabbix_cli/commands/cli.py

@@ -376,6 +376,8 @@ def update_config(
         if not bool_prompt("Update config file?", default=False):
             exit_err("Update cancelled.")
 
+    # When we dump the config, we automatically exclude the deprecated fields
+    # while taking advantage of the validators that update the new fields.
     config = app.state.config
     config.dump_to_file(config_file, secrets=secrets)
     success(f"Config saved to {path_link(config_file)}")