#!/usr/bin/env python3
#
# Copyright (C) 2019-2020 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import re
import os
import unittest

from base_vyostest_shim import VyOSUnitTestSHIM

from vyos.configsession import ConfigSessionError
from vyos.util import cmd
from vyos.util import process_running
from vyos.util import read_file

DDCLIENT_CONF = '/run/ddclient/ddclient.conf'
DDCLIENT_PID = '/run/ddclient/ddclient.pid'

base_path = ['service', 'dns', 'dynamic']
hostname = 'test.ddns.vyos.io'
interface = 'eth0'

def get_config_value(key):
    tmp = cmd(f'sudo cat {DDCLIENT_CONF}')
    tmp = re.findall(r'\n?{}=+(.*)'.format(key), tmp)
    tmp = tmp[0].rstrip(',')
    return tmp

class TestServiceDDNS(VyOSUnitTestSHIM.TestCase):
    def tearDown(self):
        # Check for running process
        self.assertTrue(process_running(DDCLIENT_PID))

        # Delete DDNS configuration
        self.cli_delete(base_path)
        self.cli_commit()

        # PID file must no londer exist after process exited
        self.assertFalse(os.path.exists(DDCLIENT_PID))

    def test_dyndns_service(self):
        from itertools import product
        ddns = ['interface', interface, 'service']
        users = [None, 'vyos_user']
        services = ['cloudflare', 'afraid', 'dyndns', 'zoneedit']

        for user, service in product(users, services):
            password = 'vyos_pass'
            zone = 'vyos.io'
            self.cli_delete(base_path)
            self.cli_set(base_path + ddns + [service, 'host-name', hostname])
            if user is not None:
                self.cli_set(base_path + ddns + [service, 'login', user])
            self.cli_set(base_path + ddns + [service, 'password', password])
            self.cli_set(base_path + ddns + [service, 'zone', zone])

            # commit changes
            if service == 'cloudflare':
                self.cli_commit()
            elif user is None:
                # not set user is only allowed for cloudflare
                with self.assertRaises(ConfigSessionError):
                    # remove zone to test not set user
                    self.cli_delete(base_path + ddns + [service, 'zone', 'vyos.io'])
                    self.cli_commit()
                # this case is fininshed, user not set is not allowed when service isn't cloudflare
                continue
            else:
                # zone option only works on cloudflare, an exception is raised
                # for all others
                with self.assertRaises(ConfigSessionError):
                    self.cli_commit()
                self.cli_delete(base_path + ddns + [service, 'zone', 'vyos.io'])
                # commit changes again - now it should work
                self.cli_commit()

            # we can only read the configuration file when we operate as 'root'
            protocol = get_config_value('protocol')
            login = None if user is None else get_config_value('login')
            pwd = get_config_value('password')

            # some services need special treatment
            protoname = service
            if service == 'cloudflare':
                tmp = get_config_value('zone')
                self.assertTrue(tmp == zone)
            elif service == 'afraid':
                protoname = 'freedns'
            elif service == 'dyndns':
                protoname = 'dyndns2'
            elif service == 'zoneedit':
                protoname = 'zoneedit1'

            self.assertTrue(protocol == protoname)
            self.assertTrue(login == user)
            self.assertTrue(pwd == "'" + password + "'")

    def test_dyndns_rfc2136(self):
        # Check if DDNS service can be configured and runs
        ddns = ['interface', interface, 'rfc2136', 'vyos']
        ddns_key_file = '/config/auth/my.key'

        self.cli_set(base_path + ddns + ['key', ddns_key_file])
        self.cli_set(base_path + ddns + ['record', 'test.ddns.vyos.io'])
        self.cli_set(base_path + ddns + ['server', 'ns1.vyos.io'])
        self.cli_set(base_path + ddns + ['ttl', '300'])
        self.cli_set(base_path + ddns + ['zone', 'vyos.io'])

        # ensure an exception will be raised as no key is present
        if os.path.exists(ddns_key_file):
            os.unlink(ddns_key_file)

        # check validate() - the key file does not exist yet
        with self.assertRaises(ConfigSessionError):
            self.cli_commit()

        with open(ddns_key_file, 'w') as f:
            f.write('S3cretKey')

        # commit changes
        self.cli_commit()

        # TODO: inspect generated configuration file

    def test_dyndns_ipv6(self):
        ddns = ['interface', interface, 'service', 'dynv6']
        proto = 'dyndns2'
        user = 'none'
        password = 'paSS_4ord'
        srv = 'ddns.vyos.io'

        self.cli_set(base_path + ['interface', interface, 'ipv6-enable'])
        self.cli_set(base_path + ddns + ['host-name', hostname])
        self.cli_set(base_path + ddns + ['login', user])
        self.cli_set(base_path + ddns + ['password', password])
        self.cli_set(base_path + ddns + ['protocol', proto])
        self.cli_set(base_path + ddns + ['server', srv])

        # commit changes
        self.cli_commit()

        protocol = get_config_value('protocol')
        login = get_config_value('login')
        pwd = get_config_value('password')
        server = get_config_value('server')
        usev6 = get_config_value('usev6')

        # Check some generating config parameters
        self.assertEqual(protocol, proto)
        self.assertEqual(login, user)
        self.assertEqual(pwd, f"'{password}'")
        self.assertEqual(server, srv)
        self.assertEqual(usev6, f"ifv6, if={interface}")

if __name__ == '__main__':
    unittest.main(verbosity=2)