Config: deprecate gerrit_* with gerrit dict

Replace all gerrit_* parameters by the same parameters in gerrit dict
(eg. gerrit_realm is becoming gerrit > realm). All gerrit_* parameters
are marked as deprecated, ie. they are still supported but Rift emits
warning visible by end users to report the new parameter name.

Also add unit tests to cover Gerrit module.

Author: rezib

lib/rift/Config.py

@@ -264,11 +264,31 @@ class Config():
         'vm_build_post_script': {
             'deprecated': 'vm.build_post_script'
         },
-        'gerrit_realm': {},
-        'gerrit_server': {},
-        'gerrit_url': {},
-        'gerrit_username': {},
-        'gerrit_password': {},
+        'gerrit': {
+            'check': 'dict',
+            'syntax': {
+                'realm': {},
+                'server': {},
+                'url': {},
+                'username': {},
+                'password': {},
+            }
+        },
+        'gerrit_realm': {
+            'deprecated': 'gerrit.realm'
+        },
+        'gerrit_server': {
+            'deprecated': 'gerrit.server'
+        },
+        'gerrit_url': {
+            'deprecated': 'gerrit.url'
+        },
+        'gerrit_username': {
+            'deprecated': 'gerrit.username'
+        },
+        'gerrit_password': {
+            'deprecated': 'gerrit.password'
+        },
         'rpm_macros': {
             'check':    'dict',
         },

lib/rift/Gerrit.py

@@ -80,15 +80,20 @@ def invalidate(self):
     def push(self, config, changeid, revid):
         """Send REST request to Gerrit server from config"""
         auth_methods = ('digest', 'basic')
-        realm = config.get('gerrit_realm')
-        server = config.get('gerrit_server')
-        username = config.get('gerrit_username')
-        password = config.get('gerrit_password')
-        auth_method = config.get('gerrit_auth_method', 'basic')
+
+        gerrit_config = config.get('gerrit')
+        if gerrit_config is None:
+            raise RiftError("Gerrit configuration is not defined")
+
+        realm = gerrit_config.get('realm')
+        server = gerrit_config.get('server')
+        username = gerrit_config.get('username')
+        password = gerrit_config.get('password')
+        auth_method = gerrit_config.get('auth_method', 'basic')
 
         if realm is None:
             raise RiftError("Gerrit realm is not defined")
-        if server is None and config.get('gerrit_url') is None:
+        if server is None and gerrit_config.get('url') is None:
             raise RiftError("Gerrit url is not defined")
         if username is None:
             raise RiftError("Gerrit username is not defined")
@@ -98,7 +103,7 @@ def push(self, config, changeid, revid):
             raise RiftError(f"Gerrit auth_method is not correct (supported {auth_methods})")
 
         # Set a default url if only gerrit_server was defined
-        url = config.get('gerrit_url', f"https://{server}")
+        url = gerrit_config.get('url', f"https://{server}")
 
         # FIXME: Don't check certificate
         ctx = ssl.create_default_context()

tests/Config.py

@@ -677,6 +677,27 @@ def test_load_deprecated_vm_parameters(self):
         self.assertEqual(config.get('vm').get('cpus'), 42)
         self.assertEqual(config.get('vm').get('memory'), 1234)
 
+    def test_load_deprecated_gerrit_parameters(self):
+        """load() deprecated gerrit_* parameters."""
+        cfgfile = make_temp_file(
+            textwrap.dedent(
+                """
+                annex: /a/dir
+                vm:
+                  image: /a/image.img
+                gerrit_realm: Rift
+                gerrit_url: https://localhost
+                gerrit_username: rift
+                """
+            )
+        )
+        config = Config()
+        with self.assertWarns(RiftDeprecatedConfWarning):
+            config.load(cfgfile.name)
+        self.assertEqual(config.get('gerrit').get('realm'), 'Rift')
+        self.assertEqual(config.get('gerrit').get('url'), 'https://localhost')
+        self.assertEqual(config.get('gerrit').get('username'), 'rift')
+
 
 class ConfigTestSyntax(RiftTestCase):
     """Test Config with modified syntax."""

tests/Gerrit.py

@@ -0,0 +1,56 @@
+#
+# Copyright (C) 2024 CEA
+#
+from unittest import mock
+
+from TestUtils import RiftTestCase
+from rift.Config import Config
+from rift.Gerrit import Review
+from rift import RiftError
+
+class GerritTest(RiftTestCase):
+    def setUp(self):
+        self.config = Config()
+        self.config.set(
+            'gerrit',
+            {
+                'realm': 'Rift',
+                'server': 'localhost',
+                'username': 'rift',
+                'password': 'SECR3T',
+            }
+        )
+        self.review = Review()
+        self.review.add_comment('/path/to/file', 42, 'E', 'test error message')
+
+    def test_invalidate(self):
+        """ Test Review.invalidate() method"""
+        self.assertEqual(self.review.validated, True)
+        self.review.invalidate()
+        self.assertEqual(self.review.validated, False)
+
+    @mock.patch("rift.Gerrit.urllib.urlopen")
+    def test_push(self, mock_urlopen):
+        """ Test Review push """
+        self.review.push(self.config, 4242, 42)
+        # Check push successfully send HTTP request with urllib.urlopen() and
+        # reads its result.
+        mock_urlopen.assert_called_once()
+        mock_urlopen.return_value.read.assert_called_once()
+
+    def test_push_no_config(self):
+        """ Test Review push w/o gerrit config error """
+        del self.config.options['gerrit']
+        with self.assertRaisesRegex(RiftError, "Gerrit configuration is not defined"):
+            self.review.push(self.config, 4242, 42)
+
+    def test_push_missing_conf_param(self):
+        """ Test Review push with missing parameter error """
+        gerrit_conf = self.config.get('gerrit')
+        for parameter, value in gerrit_conf.copy().items():
+            # temporary remove parameter
+            del gerrit_conf[parameter]
+            with self.assertRaisesRegex(RiftError, "Gerrit .* is not defined"):
+                self.review.push(self.config, 4242, 42)
+            # restore value
+            gerrit_conf[parameter] = value