summaryrefslogtreecommitdiff
path: root/smoketest/scripts/cli/test_service_dns_dynamic.py
blob: 57705e26f310d84dc16d6122c79fd21fdbb83d92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
#!/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_named_running
from vyos.util import read_file

PROCESS_NAME = 'ddclient'
DDCLIENT_CONF = '/run/ddclient/ddclient.conf'

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):
        # Delete DDNS configuration
        self.cli_delete(base_path)
        self.cli_commit()

    def test_dyndns_service(self):
        ddns = ['interface', interface, 'service']
        services = ['cloudflare', 'afraid', 'dyndns', 'zoneedit']

        for service in services:
            user = 'vyos_user'
            password = 'vyos_pass'
            zone = 'vyos.io'
            self.cli_delete(base_path)
            self.cli_set(base_path + ddns + [service, 'host-name', hostname])
            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()
            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 = 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 + "'")

            # Check for running process
            self.assertTrue(process_named_running(PROCESS_NAME))

    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

        # Check for running process
        self.assertTrue(process_named_running(PROCESS_NAME))

    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()

        # Check for running process
        self.assertTrue(process_named_running(PROCESS_NAME))

        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)