packagingv3: add tests for new app configuration / regenconf mechanism

Author: alexAubin

.gitlab/ci/test.gitlab-ci.yml

@@ -71,10 +71,15 @@ test-questions:
   script:
     - python3 -m pytest src/tests/test_questions.py
 
-test-app-config:
+test-app-configpanel:
   extends: .test-stage
   script:
-    - python3 -m pytest src/tests/test_app_config.py
+    - python3 -m pytest src/tests/test_app_configpanel.py
+
+test-app-regenconf:
+  extends: .test-stage
+  script:
+    - python3 -m pytest src/tests/test_app_regenconf.py
 
 test-app-resources:
   extends: .test-stage
@@ -147,7 +152,9 @@ coverage:
       artifacts: true
     - job: test-questions
       artifacts: true
-    - job: test-app-config
+    - job: test-app-configpanel
+      artifacts: true
+    - job: test-app-regenconf
       artifacts: true
     - job: test-app-resources
       artifacts: true

src/tests/test_app_config.py renamed to src/tests/test_app_configpanel.py

@@ -0,0 +1,319 @@
+#!/usr/bin/env python3
+#
+# Copyright (c) 2025 YunoHost Contributors
+#
+# This file is part of YunoHost (see https://yunohost.org)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+import glob
+import os
+import pytest
+
+from moulinette.utils.filesystem import read_file, write_to_file
+from yunohost.app import _make_environment_for_app_script, app_setting, _get_app_settings
+from yunohost.utils.error import YunohostError
+from yunohost.utils.configurations import (
+    BaseConfiguration,
+    Configurations,
+    ConfigurationsClassesByType,
+    AppConfigurationsManager,
+    DIR_TO_BACKUP_CONF_MANUALLY_MODIFIED,
+)
+from .conftest import message
+
+
+class DummyAppConfigurations(Configurations):
+    type = "dummy"
+
+    class MainConfiguration(BaseConfiguration):
+        template: str = "dummy.conf"
+        path: str = "/tmp/dummyconfs/__APP__.conf"
+
+    class ExtraConfiguration(BaseConfiguration):
+        template: str = "dummy-__CONF_ID__.conf"
+        path: str = "/tmp/dummyconfs/__APP__-__CONF_ID__.conf"
+
+    def reload():
+        pass
+
+
+ConfigurationsClassesByType["dummy"] = DummyAppConfigurations
+
+
+def setup_function(function):
+    clean()
+
+    os.system("mkdir /etc/yunohost/apps/testapp")
+    os.system("mkdir /etc/yunohost/apps/testapp/conf")
+    os.system("mkdir /tmp/dummyconfs/")
+    os.system("echo 'id: testapp' > /etc/yunohost/apps/testapp/settings.yml")
+    os.system("echo 'foo: bar' >> /etc/yunohost/apps/testapp/settings.yml")
+    dummy_manifest = '\n'.join([
+        'packaging_format = 3',
+        'id = "testapp"',
+        'version = "0.1"',
+        'description.en = "A dummy app to test app resources"'
+    ])
+    write_to_file("/etc/yunohost/apps/testapp/manifest.toml", dummy_manifest)
+    dummy_conf = '\n'.join([
+        '# This is a dummy conf file',
+        'APP = __APP__',
+        'FOO = __FOO__'
+    ])
+    write_to_file("/etc/yunohost/apps/testapp/conf/dummy.conf", dummy_conf)
+
+
+def teardown_function(function):
+    clean()
+
+
+def clean():
+    os.system("rm -rf /etc/yunohost/apps/testapp")
+    os.system("rm -rf /tmp/dummyconfs/")
+    os.system(f"rm -rf {DIR_TO_BACKUP_CONF_MANUALLY_MODIFIED}/testapp/")
+    os.system("userdel testapp 2>/dev/null")
+
+
+def test_conf_dummy_new():
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    settings = _get_app_settings("testapp")
+    assert settings.get("_configurations", {}).get("dummy.main")
+
+
+def test_conf_dummy_remove():
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    current = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    write_to_file(conf, "FOO = bar")
+    assert os.path.exists(conf)
+    AppConfigurationsManager("testapp", current=current, wanted={}, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert not os.path.exists(conf)
+
+
+def test_conf_dummy_dryrun():
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False, dry_run=True
+    )
+    assert not os.path.exists(conf)
+
+
+def test_conf_dummy_different_template():
+
+    write_to_file("/etc/yunohost/apps/testapp/conf/dummy2.conf", "This is another template")
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {"main": {"template": "dummy2.conf"}}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" not in read_file(conf).strip()
+    assert "This is another template" in read_file(conf).strip()
+
+
+def test_conf_dummy_with_extra():
+
+    write_to_file("/etc/yunohost/apps/testapp/conf/dummy-extra.conf", "This is another template")
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {"extra": {}}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    conf2 = "/tmp/dummyconfs/testapp-extra.conf"
+    assert not os.path.exists(conf)
+    assert not os.path.exists(conf2)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+    assert "This is another template" in read_file(conf2).strip()
+
+
+def test_conf_dummy_missingvar():
+    workdir = "/etc/yunohost/apps/testapp/"
+    app_setting("testapp", "foo", delete=True)
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+
+    with pytest.raises(YunohostError):
+        with message("app_uninitialized_variables"):
+            AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+                rollback_and_raise_exception_if_failure=True
+            )
+
+
+def test_conf_dummy_update_after_var_change():
+
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    app_setting("testapp", "foo", "nyah")
+
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    current = wanted
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    AppConfigurationsManager("testapp", current=current, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+
+    assert "FOO = nyah" in read_file(conf).strip()
+
+
+def test_conf_dummy_update_after_path_change():
+
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    current = wanted
+    conf2 = "/tmp/dummyconfs/wat.conf"
+    wanted = {"configurations": {"dummy": {"main": {"path": conf2}}}, "env": env}
+    AppConfigurationsManager("testapp", current=current, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert not os.path.exists(conf)
+    assert "FOO = bar" in read_file(conf2).strip()
+
+
+def test_conf_dummy_update_after_template_change():
+
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    write_to_file("/etc/yunohost/apps/testapp/conf/dummy.conf", "# This is the updated conf template")
+
+    AppConfigurationsManager("testapp", current=wanted, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+
+    assert read_file(conf).strip() == "# This is the updated conf template"
+
+
+def test_conf_dummy_manualchange_mergeable():
+
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    write_to_file(conf, "# Manual comment on top of file\n" + read_file(conf))
+
+    app_setting("testapp", "foo", "nyah")
+
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    current = wanted
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    AppConfigurationsManager("testapp", current=current, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+
+    assert "# Manual comment on top of file" in read_file(conf).strip()
+    assert "FOO = nyah" in read_file(conf).strip()
+
+    backup_conf_glob = f"{DIR_TO_BACKUP_CONF_MANUALLY_MODIFIED}/testapp/{conf}.backup.*"
+    assert len(glob.glob(backup_conf_glob)) == 1
+    backup_content = read_file(list(glob.glob(backup_conf_glob))[0])
+    assert "# Manual comment on top of file" in backup_content
+    assert "FOO = bar" in backup_content
+
+
+def test_conf_dummy_manualchange_nonmergeable():
+
+    workdir = "/etc/yunohost/apps/testapp/"
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    conf = "/tmp/dummyconfs/testapp.conf"
+    assert not os.path.exists(conf)
+    AppConfigurationsManager("testapp", current={}, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+    assert "FOO = bar" in read_file(conf).strip()
+
+    write_to_file(conf, read_file(conf).replace("FOO = bar", "FOO = manual_value"))
+
+    app_setting("testapp", "foo", "nyah")
+
+    env = _make_environment_for_app_script("testapp", workdir=workdir)
+    current = wanted
+    wanted = {"configurations": {"dummy": {}}, "env": env}
+    AppConfigurationsManager("testapp", current=current, wanted=wanted, workdir=workdir).apply(
+        rollback_and_raise_exception_if_failure=False
+    )
+
+    assert "FOO = nyah" in read_file(conf).strip()
+
+    backup_conf_glob = f"{DIR_TO_BACKUP_CONF_MANUALLY_MODIFIED}/testapp/{conf}.backup.*"
+    assert len(glob.glob(backup_conf_glob)) == 1
+    backup_content = read_file(list(glob.glob(backup_conf_glob))[0])
+    assert "FOO = manual_value" in backup_content
+
+
+@pytest.mark.skip
+def test_conf_dummy_unexposed_property():
+    raise NotImplementedError
+
+
+@pytest.mark.skip
+def test_conf_dummy_ifclause():
+    raise NotImplementedError
+
+
+@pytest.mark.skip
+def test_conf_dummy_reload_fails():
+    # TODO: should rollback?
+    raise NotImplementedError