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
|
#!/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 getpass import getuser
from psutil import process_iter
from vyos.configsession import ConfigSession, ConfigSessionError
from vyos.util import read_file
DDCLIENT_CONF = '/run/ddclient/ddclient.conf'
base_path = ['service', 'dns', 'dynamic']
def get_config_value(key):
tmp = read_file(DDCLIENT_CONF)
tmp = re.findall(r'\n?{}=+(.*)'.format(key), tmp)
tmp = tmp[0].rstrip(',')
return tmp
def check_process():
"""
Check for running process, process name changes dynamically e.g.
"ddclient - sleeping for 270 seconds", thus we need a different approach
"""
running = False
for p in process_iter():
if "ddclient" in p.name():
running = True
return running
class TestServiceDDNS(unittest.TestCase):
def setUp(self):
self.session = ConfigSession(os.getpid())
def tearDown(self):
# Delete DDNS configuration
self.session.delete(base_path)
self.session.commit()
del self.session
def test_service(self):
""" Check individual DDNS service providers """
ddns = ['interface', 'eth0', 'service']
services = ['cloudflare', 'afraid', 'dyndns', 'zoneedit']
for service in services:
user = 'vyos_user'
password = 'vyos_pass'
zone = 'vyos.io'
self.session.delete(base_path)
self.session.set(base_path + ddns + [service, 'host-name', 'test.ddns.vyos.io'])
self.session.set(base_path + ddns + [service, 'login', user])
self.session.set(base_path + ddns + [service, 'password', password])
self.session.set(base_path + ddns + [service, 'zone', zone])
# commit changes
if service == 'cloudflare':
self.session.commit()
else:
# zone option only works on cloudflare, an exception is raised
# for all others
with self.assertRaises(ConfigSessionError):
self.session.commit()
self.session.delete(base_path + ddns + [service, 'zone', 'vyos.io'])
# commit changes again - now it should work
self.session.commit()
# we can only read the configuration file when we operate as 'root'
if getuser() == '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(check_process())
def test_rfc2136(self):
""" Check if DDNS service can be configured and runs """
ddns = ['interface', 'eth0', 'rfc2136', 'vyos']
ddns_key_file = '/config/auth/my.key'
self.session.set(base_path + ddns + ['key', ddns_key_file])
self.session.set(base_path + ddns + ['record', 'test.ddns.vyos.io'])
self.session.set(base_path + ddns + ['server', 'ns1.vyos.io'])
self.session.set(base_path + ddns + ['ttl', '300'])
self.session.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.session.commit()
with open(ddns_key_file, 'w') as f:
f.write('S3cretKey')
# commit changes
self.session.commit()
# TODO: inspect generated configuration file
# Check for running process
self.assertTrue(check_process())
if __name__ == '__main__':
unittest.main()
|
