Add possibility to delete a specific system (#1595)

Author: maximenoel8

jenkins_pipelines/scripts/test_environment_cleaner/test_environment_cleaner_program/TestEnvironmentCleaner.py

@@ -11,7 +11,7 @@
 # Define the available modes
 MODES = [
     'delete_users', 'delete_activation_keys', 'delete_config_projects',
-    'delete_software_channels', 'delete_systems', 'delete_repositories',
+    'delete_software_channels', 'delete_systems', 'delete_specific_system', 'delete_repositories',
     'full_cleanup', 'delete_salt_keys', 'delete_known_hosts',
     'update_custom_repositories', 'delete_distributions', 'delete_system_groups',
     'delete_images', 'delete_image_profiles', 'update_terminal_mac_addresses'
@@ -26,6 +26,7 @@ def main():
                         default=[], help='List of default modules to force deletion')
     parser.add_argument("--controller_url",required=False, help="The controller URL.")
     parser.add_argument("--hypervisor_url",required=False, help="The terminal hypervisor URL.")
+    parser.add_argument("--system-to-delete",required=False, help="System name to delete")
 
     args = parser.parse_args()
     manager_url = args.url
@@ -40,14 +41,15 @@ def main():
     if args.mode in ["delete_users", "delete_activation_keys", "delete_config_projects",
                      "delete_software_channels", "delete_systems", "delete_repositories",
                      "full_cleanup", "delete_salt_keys", "delete_system_groups", "delete_images",
-                     "delete_image_profiles"]:
+                     "delete_image_profiles", "delete_specific_system"]:
         resource_manager.get_session_key()
         mode_actions = {
             "delete_users": resource_manager.delete_users,
             "delete_activation_keys": resource_manager.delete_activation_keys,
             "delete_config_projects": resource_manager.delete_config_projects,
             "delete_software_channels": resource_manager.delete_software_channels,
             "delete_systems": resource_manager.delete_systems,
+            "delete_specific_system": lambda: resource_manager.delete_system(args.system_to_delete),
             "delete_repositories": resource_manager.delete_channel_repos,
             "delete_salt_keys": resource_manager.delete_salt_keys,
             "delete_system_groups": resource_manager.delete_system_groups,
@@ -65,7 +67,7 @@ def main():
             resource_manager.logout_session()
 
     # Server commands part
-    if args.mode in ["update_terminal_mac_addresses"]:
+    elif args.mode in ["update_terminal_mac_addresses"]:
         ssh_controller_session = SSHClientManager(url=args.controller_url, password= "linux")
         ssh_hypervisor_session = SSHClientManager(url=args.hypervisor_url,ssh_key_path="/home/jenkins/.ssh/id_rsa")
         virsh_output = ssh_hypervisor_session.run_command(f"virsh list | grep terminal | grep {''.join(product_version.split('.')[:2])} | awk '{{print $2}}'")

jenkins_pipelines/scripts/test_environment_cleaner/test_environment_cleaner_program/test_environment_cleaner_api.py

@@ -82,6 +82,13 @@ def delete_systems(self):
                 logger.info(f"Delete system : {system['name']} | id : {system['id']}")
                 self.client.system.deleteSystem(self.session_key, system['id'])
 
+    def delete_system(self, system_name):
+        systems = self.client.system.listSystems(self.session_key)
+        for system in systems:
+            if system['name'] == system_name :
+                logger.info(f"Delete system : {system['name']} | id : {system['id']}")
+                self.client.system.deleteSystem(self.session_key, system['id'])
+
     def delete_system_groups(self):
         groups = self.client.systemgroup.listAllGroups(self.session_key)
         for group in groups:

jenkins_pipelines/scripts/test_environment_cleaner/tests/test_main_program.py

@@ -43,29 +43,6 @@ def test_delete_known_hosts_mode(self, MockSSHClientManager, MockResourceManager
             MockSSHClientManager.assert_called_once_with(url="http://test-url.com", password='linux', product_version="5.0")
             mock_ssh_manager.delete_known_hosts.assert_called_once()
 
-    @patch("test_environment_cleaner_program.TestEnvironmentCleaner.ResourceManager")
-    @patch("test_environment_cleaner_program.TestEnvironmentCleaner.SSHClientManager")
-    def test_invalid_mode(self, MockSSHClientManager, MockResourceManager):
-        test_args = ["test_environment_cleaner_program.TestEnvironmentCleaner", "--url", "http://test-url.com", "--mode", "invalid"]
-        with patch.object(sys, 'argv', test_args):
-            with patch("sys.stderr", new=StringIO()) as fake_err:
-                with self.assertRaises(SystemExit):
-                    main()
-
-                # Assert the error message is in the captured stderr
-                expected_error_message = (
-                    "usage: test_environment_cleaner_program.TestEnvironmentCleaner [-h] --url URL --mode "
-                    "{delete_users,delete_activation_keys,delete_config_projects,delete_software_channels,"
-                    "delete_systems,delete_repositories,full_cleanup,delete_salt_keys,delete_known_hosts,update_custom_repositories,delete_distributions,delete_system_groups,delete_images,delete_image_profiles,update_terminal_mac_addresses}"
-                    " [--default-resources-to-delete [{proxy,monitoring-server,build,terminal} ...]] [--controller_url CONTROLLER_URL] [--hypervisor_url HYPERVISOR_URL] "
-                    "test_environment_cleaner_program.TestEnvironmentCleaner: error: argument --mode: invalid choice: 'invalid' (choose from 'delete_users',"
-                    " 'delete_activation_keys', 'delete_config_projects', 'delete_software_channels', 'delete_systems',"
-                    " 'delete_repositories', 'full_cleanup', 'delete_salt_keys', 'delete_known_hosts', 'update_custom_repositories',"
-                    " 'delete_distributions', 'delete_system_groups', 'delete_images', 'delete_image_profiles', 'update_terminal_mac_addresses')"
-                )
-                cleaned_error = " ".join(fake_err.getvalue().split())
-                self.assertIn(expected_error_message, cleaned_error)
-
     @patch("test_environment_cleaner_program.TestEnvironmentCleaner.ResourceManager")
     @patch("test_environment_cleaner_program.TestEnvironmentCleaner.SSHClientManager")
     def test_update_custom_repositories_mode(self, MockSSHClientManager, MockResourceManager):