#!/usr/bin/env python3

#

# Copyright (c) 2024 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 os

from yunohost.domain import domain_add, domain_list, domain_remove

from yunohost.regenconf import (

_force_clear_hashes,

_get_conf_hashes,

manually_modified_files,

regen_conf,

)

from .conftest import message

TEST_DOMAIN = "secondarydomain.test"

TEST_DOMAIN_NGINX_CONFIG = "/etc/nginx/conf.d/%s.conf" % TEST_DOMAIN

TEST_DOMAIN_DNSMASQ_CONFIG = "/etc/dnsmasq.d/%s" % TEST_DOMAIN

SSHD_CONFIG = "/etc/ssh/sshd_config"

def setup_function(function):

_force_clear_hashes([TEST_DOMAIN_NGINX_CONFIG])

clean()

def teardown_function(function):

clean()

_force_clear_hashes([TEST_DOMAIN_NGINX_CONFIG])

def clean():

regen_conf(["ssh"], force=True)

def test_add_domain():

assert TEST_DOMAIN_NGINX_CONFIG not in manually_modified_files()

def test_add_and_edit_domain_conf():

assert TEST_DOMAIN_NGINX_CONFIG in manually_modified_files()

def test_add_domain_conf_already_exists():

assert TEST_DOMAIN_NGINX_CONFIG not in manually_modified_files()

def test_ssh_conf_unmanaged():

assert SSHD_CONFIG in _get_conf_hashes("ssh")

def test_ssh_conf_unmanaged_and_manually_modified():

assert SSHD_CONFIG not in manually_modified_files()

def test_stale_hashes_get_removed_if_empty():

assert TEST_DOMAIN_DNSMASQ_CONFIG not in _get_conf_hashes("dnsmasq")

def test_stale_hashes_if_file_manually_deleted():

assert TEST_DOMAIN_DNSMASQ_CONFIG not in _get_conf_hashes("dnsmasq")

# This test only works if you comment the part at the end of the regen-conf in

# dnsmasq that auto-flag /etc/dnsmasq.d/foo.bar as "to be removed" (using touch)

# ... But we want to keep it because they also possibly flag files that were

# never known by the regen-conf (e.g. if somebody adds a

# /etc/dnsmasq.d/my.custom.extension)

# Ideally we could use a system that's able to properly state 'no file in this

# folder should exist except the ones excplicitly defined by regen-conf' but

# that's too much work for the scope of this commit.

#

# ... Anyway, the proper way to write these tests would be to use a dummy

# regen-conf hook just for tests but meh I'm lazy

#

# def test_stale_hashes_if_file_manually_modified():

# """

# Same as other test, but manually delete the file in between and check

# behavior

# """

#

# domain_add(TEST_DOMAIN)

#

# assert os.path.exists(TEST_DOMAIN_DNSMASQ_CONFIG)

# assert TEST_DOMAIN_DNSMASQ_CONFIG in _get_conf_hashes("dnsmasq")

#

# os.system("echo '#pwet' > %s" % TEST_DOMAIN_DNSMASQ_CONFIG)

#

# assert os.path.exists(TEST_DOMAIN_DNSMASQ_CONFIG)

# assert open(TEST_DOMAIN_DNSMASQ_CONFIG).read().strip() == "#pwet"

#

# regen_conf(names=["dnsmasq"])

#

# assert os.path.exists(TEST_DOMAIN_DNSMASQ_CONFIG)

# assert open(TEST_DOMAIN_DNSMASQ_CONFIG).read().strip() == "#pwet"

# assert TEST_DOMAIN_DNSMASQ_CONFIG in _get_conf_hashes("dnsmasq")

#

# domain_remove(TEST_DOMAIN)

#

# assert os.path.exists(TEST_DOMAIN_DNSMASQ_CONFIG)

# assert open(TEST_DOMAIN_DNSMASQ_CONFIG).read().strip() == "#pwet"

# assert TEST_DOMAIN_DNSMASQ_CONFIG in _get_conf_hashes("dnsmasq")

#

# regen_conf(names=["dnsmasq"], force=True)

#

# assert not os.path.exists(TEST_DOMAIN_DNSMASQ_CONFIG)

# assert TEST_DOMAIN_DNSMASQ_CONFIG not in _get_conf_hashes("dnsmasq")