Merge pull request #2720 from vyos/mergify/bp/sagitta/pr-2718

system: T5877: Shorten system domain-search config path (backport #2718)

6 files changed, 170 insertions, 80 deletions

diff --git a/interface-definitions/dns-domain-name.xml.in b/interface-definitions/dns-domain-name.xml.in
index ef34ecbf5..b5b3692b1 100644
--- a/interface-definitions/dns-domain-name.xml.in
+++ b/interface-definitions/dns-domain-name.xml.in
@@ -45,24 +45,17 @@
           </constraint>
         </properties>
       </leafNode>
-      <node name="domain-search" owner="${vyos_conf_scripts_dir}/host_name.py">
+      <leafNode name="domain-search" owner="${vyos_conf_scripts_dir}/host_name.py">
         <properties>
           <help>Domain Name Server (DNS) domain completion order</help>
           <priority>400</priority>
+          <constraint>
+            <validator name="fqdn"/>
+          </constraint>
+          <constraintErrorMessage>Invalid domain name (RFC 1123 section 2).\nMay only contain letters, numbers and period.</constraintErrorMessage>
+          <multi/>
         </properties>
-        <children>
-          <leafNode name="domain">
-            <properties>
-              <help>DNS domain completion order</help>
-              <constraint>
-                <regex>[-a-zA-Z0-9.]+</regex>
-              </constraint>
-              <constraintErrorMessage>Invalid domain name</constraintErrorMessage>
-              <multi/>
-            </properties>
-          </leafNode>
-        </children>
-      </node>
+      </leafNode>
       <node name="static-host-mapping" owner="${vyos_conf_scripts_dir}/host_name.py">
         <properties>
           <help>Map host names to addresses</help>
diff --git a/interface-definitions/include/version/system-version.xml.i b/interface-definitions/include/version/system-version.xml.i
index 73df8bd8e..fcb24abe2 100644
--- a/interface-definitions/include/version/system-version.xml.i
+++ b/interface-definitions/include/version/system-version.xml.i
@@ -1,3 +1,3 @@
 <!-- include start from include/version/system-version.xml.i -->
-<syntaxVersion component='system' version='26'></syntaxVersion>
+<syntaxVersion component='system' version='27'></syntaxVersion>
 <!-- include end -->
diff --git a/smoketest/scripts/cli/test_system_nameserver.py b/smoketest/scripts/cli/test_system_nameserver.py
deleted file mode 100755
index 4979a7c72..000000000
--- a/smoketest/scripts/cli/test_system_nameserver.py
+++ /dev/null
@@ -1,63 +0,0 @@
-#!/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 unittest
-
-from base_vyostest_shim import VyOSUnitTestSHIM
-
-from vyos.configsession import ConfigSessionError
-
-from vyos.utils.file import read_file
-
-RESOLV_CONF = '/etc/resolv.conf'
-
-test_servers = ['192.0.2.10', '2001:db8:1::100']
-base_path = ['system', 'name-server']
-
-def get_name_servers():
-    resolv_conf = read_file(RESOLV_CONF)
-    return re.findall(r'\n?nameserver\s+(.*)', resolv_conf)
-
-class TestSystemNameServer(VyOSUnitTestSHIM.TestCase):
-    def tearDown(self):
-        # Delete existing name servers
-        self.cli_delete(base_path)
-        self.cli_commit()
-
-    def test_nameserver_add(self):
-        # Check if server is added to resolv.conf
-        for s in test_servers:
-            self.cli_set(base_path + [s])
-        self.cli_commit()
-
-        servers = get_name_servers()
-        for s in servers:
-            self.assertTrue(s in servers)
-
-    def test_nameserver_delete(self):
-        # Test if a deleted server disappears from resolv.conf
-        for s in test_servers:
-          self.cli_delete(base_path + [s])
-        self.cli_commit()
-
-        servers = get_name_servers()
-        for s in servers:
-            self.assertTrue(test_server_1 not in servers)
-
-if __name__ == '__main__':
-    unittest.main(verbosity=2)
-
diff --git a/smoketest/scripts/cli/test_system_resolvconf.py b/smoketest/scripts/cli/test_system_resolvconf.py
new file mode 100755
index 000000000..d8726a301
--- /dev/null
+++ b/smoketest/scripts/cli/test_system_resolvconf.py
@@ -0,0 +1,112 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2019-2023 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 unittest
+
+from base_vyostest_shim import VyOSUnitTestSHIM
+
+from vyos.utils.file import read_file
+
+RESOLV_CONF = '/etc/resolv.conf'
+
+name_servers = ['192.0.2.10', '2001:db8:1::100']
+domain_name = 'vyos.net'
+domain_search = ['vyos.net', 'vyos.io']
+
+base_path_nameserver = ['system', 'name-server']
+base_path_domainname = ['system', 'domain-name']
+base_path_domainsearch = ['system', 'domain-search']
+
+def get_name_servers():
+    resolv_conf = read_file(RESOLV_CONF)
+    return re.findall(r'\n?nameserver\s+(.*)', resolv_conf)
+
+def get_domain_name():
+    resolv_conf = read_file(RESOLV_CONF)
+    res = re.findall(r'\n?domain\s+(.*)', resolv_conf)
+    return res[0] if res else None
+
+def get_domain_searches():
+    resolv_conf = read_file(RESOLV_CONF)
+    res = re.findall(r'\n?search\s+(.*)', resolv_conf)
+    return res[0].split() if res else []
+
+class TestSystemResolvConf(VyOSUnitTestSHIM.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        super(TestSystemResolvConf, cls).setUpClass()
+       # Clear out current configuration to allow running this test on a live system
+        cls.cli_delete(cls, base_path_nameserver)
+        cls.cli_delete(cls, base_path_domainname)
+        cls.cli_delete(cls, base_path_domainsearch)
+
+    def tearDown(self):
+        # Delete test entries servers
+        self.cli_delete(base_path_nameserver)
+        self.cli_delete(base_path_domainname)
+        self.cli_delete(base_path_domainsearch)
+        self.cli_commit()
+
+    def test_nameserver(self):
+        # Check if server is added to resolv.conf
+        for s in name_servers:
+            self.cli_set(base_path_nameserver + [s])
+        self.cli_commit()
+
+        for s in get_name_servers():
+            self.assertTrue(s in name_servers)
+
+        # Test if a deleted server disappears from resolv.conf
+        for s in name_servers:
+          self.cli_delete(base_path_nameserver + [s])
+        self.cli_commit()
+
+        for s in get_name_servers():
+            self.assertTrue(s not in name_servers)
+
+    def test_domainname(self):
+        # Check if domain-name is added to resolv.conf
+        self.cli_set(base_path_domainname + [domain_name])
+        self.cli_commit()
+
+        self.assertEqual(get_domain_name(), domain_name)
+
+        # Test if domain-name disappears from resolv.conf
+        self.cli_delete(base_path_domainname + [domain_name])
+        self.cli_commit()
+
+        self.assertTrue(get_domain_name() is None)
+
+    def test_domainsearch(self):
+        # Check if domain-search is added to resolv.conf
+        for s in domain_search:
+            self.cli_set(base_path_domainsearch + [s])
+        self.cli_commit()
+
+        for s in get_domain_searches():
+            self.assertTrue(s in domain_search)
+
+        # Test if domain-search disappears from resolv.conf
+        for s in domain_search:
+            self.cli_delete(base_path_domainsearch + [s])
+        self.cli_commit()
+
+        for s in get_domain_searches():
+            self.assertTrue(s not in domain_search)
+
+if __name__ == '__main__':
+    unittest.main(verbosity=2)
diff --git a/src/conf_mode/host_name.py b/src/conf_mode/host_name.py
index 36d1f6493..6204cf247 100755
--- a/src/conf_mode/host_name.py
+++ b/src/conf_mode/host_name.py
@@ -61,8 +61,9 @@ def get_config(config=None):
         hosts['domain_name'] = conf.return_value(['system', 'domain-name'])
         hosts['domain_search'].append(hosts['domain_name'])
 
-    for search in conf.return_values(['system', 'domain-search', 'domain']):
-        hosts['domain_search'].append(search)
+    if conf.exists(['system', 'domain-search']):
+        for search in conf.return_values(['system', 'domain-search']):
+            hosts['domain_search'].append(search)
 
     if conf.exists(['system', 'name-server']):
         for ns in conf.return_values(['system', 'name-server']):
diff --git a/src/migration-scripts/system/26-to-27 b/src/migration-scripts/system/26-to-27
new file mode 100755
index 000000000..80bb82cbd
--- /dev/null
+++ b/src/migration-scripts/system/26-to-27
@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2023 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/>.
+#
+# T5877: migrate 'system domain-search domain' to 'system domain-search'
+
+from sys import exit, argv
+from vyos.configtree import ConfigTree
+
+if len(argv) < 2:
+    print("Must specify file name!")
+    exit(1)
+
+file_name = argv[1]
+with open(file_name, 'r') as f:
+    config_file = f.read()
+
+base = ['system', 'domain-search']
+config = ConfigTree(config_file)
+
+if not config.exists(base):
+    exit(0)
+
+if config.exists(base + ['domain']):
+    entries = config.return_values(base + ['domain'])
+    config.delete(base + ['domain'])
+    for entry in entries:
+        config.set(base, value=entry, replace=False)
+
+try:
+    with open(file_name, 'w') as f:
+        f.write(config.to_string())
+except OSError as e:
+    print(f'Failed to save the modified config: {e}')
+    exit(1)