{vm-repair} Adding longoptions prefix to Run script Parameters (#8309)

Author: Sandido

src/vm-repair/HISTORY.rst

@@ -2,6 +2,10 @@
 Release History
 ===============
 
+2.0.3
+++++++
+Added new long parameter functionality in `vm repair run` cmd `parameters` parameter. When using the prefix `++`, the entire key=value string will be sent to the running script, not just the value.
+
 2.0.2
 ++++++
 Updated parameter descriptions and examples for `az vm repair create`.

src/vm-repair/azext_vm_repair/_help.py

@@ -64,6 +64,9 @@
         - name: Run a script with parameters on the VM.
           text: >
             az vm repair run -g MyResourceGroup -n MySourceWinVM --run-id win-hello-world --parameters hello=hi world=earth --verbose
+        - name: Run a verified script with some parameters. In the first parameter named 'key', only the value 'test' is sent to the script. The second parameter named \'initiator\', uses the prefix '++' to send the entire following string 'initiator=selfhelp' to the script. 
+          text: >
+            az vm repair run -g MyResourceGroup -n MySourceWinVM --run-id linux-alar2 --parameters key=test ++initiator=selfhelp --verbose --debug
         - name: Run a local custom script on the VM.
           text: >
             az vm repair run -g MyResourceGroup -n MySourceWinVM --custom-script-file ./file.ps1 --verbose

src/vm-repair/azext_vm_repair/_params.py

@@ -45,7 +45,7 @@ def load_arguments(self, _):
         c.argument('repair_vm_id', help='Repair VM resource id.')
         c.argument('run_id', help='Unique run id for run scripts.')
         c.argument('custom_script_file', help='Custom script file to run on VM. Script should be PowerShell for windows, Bash for Linux.')
-        c.argument('parameters', nargs='+', help="Space-separated parameters in the format of '[name=]value'. Positional for bash scripts.")
+        c.argument('parameters', nargs='+', help="Space-separated parameters in the format of '[name=]value'. Positional for bash scripts. To avoid splitting on =, use the prefix \'++\' to send the entire string.")
         c.argument('run_on_repair', help="Script will be run on the linked repair VM.")
         c.argument('preview', help="URL of forked repair script library's map.json https://github.com/{user}/repair-script-library/blob/master/map.json")
 
@@ -71,4 +71,4 @@ def load_arguments(self, _):
         c.argument('copy_disk_name', help='Name of OS disk copy.')
         c.argument('repair_vm_name', help='Name of repair VM.')
         c.argument('copy_disk_name', help='Name of OS disk copy.')
-        c.argument('repair_group_name', help='Name for new or existing resource group that will contain repair VM.')
+        c.argument('repair_group_name', help='Name for new or existing resource group that will contain repair VM.')

src/vm-repair/azext_vm_repair/repair_utils.py

@@ -660,9 +660,15 @@ def _process_bash_parameters(parameters):
     Example: [param1=1, param2=2] => 1 2
     """
     param_string = ''
+
     for param in parameters:
-        if '=' in param:
+        if param.startswith("++"):
+            # Retain the entire string after the `++` prefix
+            param = param[2:]
+        elif '=' in param:
+            # Split and keep only the value after `=`
             param = param.split('=', 1)[1]
+        # Ensure safe output for bash scripts
         param_string += '{p} '.format(p=param)
 
     return param_string.strip(' ')

src/vm-repair/azext_vm_repair/tests/latest/test_repair_commands.py

@@ -1128,6 +1128,7 @@ def test_vmrepair_DefaultGen1Image(self, resource_group):
         # Call Restore
         self.cmd('vm repair restore -g {rg} -n {vm} --yes')
 
+        
 @pytest.mark.RefactorSanityTest
 class WindowsResourceIdParseAfterRefactor(LiveScenarioTest):
 
@@ -1179,3 +1180,67 @@ def test_vmrepair_WinRunRepairVMIdafterRefactor(self, resource_group):
 
         # Call Restore
         self.cmd('vm repair restore -g {rg} -n {vm} --yes')
+        
+
+@pytest.mark.linuxLongParams
+class LinuxLongParametersParsing(LiveScenarioTest):
+
+    @ResourceGroupPreparer(location='westus2')
+    def test_vmrepair_LongoptionsParams(self, resource_group):
+        import uuid
+        import secrets
+        import string
+        base_password = "Passw0rd2024"
+        guid_suffix = str(uuid.uuid4())
+        secure_password = base_password + guid_suffix
+        # Username generation for linux
+        username_length = 8
+        allowed_characters = string.ascii_lowercase + string.digits  # Only lowercase letters and digits
+        secure_username = ''.join(secrets.choice(allowed_characters) for _ in range(username_length))
+
+        # Ensure username doesn't start with "-" or "$"
+        while secure_username[0] in "-$":
+            secure_username = ''.join(secrets.choice(allowed_characters) for _ in range(username_length))
+        
+        self.kwargs.update({
+            'vm': 'vm1',
+            'admin_password': secure_password,
+            'admin_username': secure_username
+        })
+        
+        # Create test VM
+        self.cmd('vm create -g {rg} -n {vm} --admin-username {admin_username} --admin-password {admin_password} --image Canonical:0001-com-ubuntu-server-jammy:22_04-lts-gen2:latest')
+        vms = self.cmd('vm list -g {rg} -o json').get_output_in_json()
+        # Something wrong with vm create command if it fails here
+        assert len(vms) == 1
+
+        # Create Repair VM
+        repair_vm = self.cmd('vm repair create -g {rg} -n {vm} --repair-username {admin_username} --repair-password {admin_password}  --yes -o json').get_output_in_json()
+        assert repair_vm['status'] == STATUS_SUCCESS, repair_vm['error_message']
+        # Check repair VM
+        self.kwargs.update({
+            'vm': 'vm1',
+            'admin_password': secure_password,
+            'admin_username': secure_username,
+            'repair_resource_group': repair_vm['repair_resource_group']
+        })
+        repair_vms = self.cmd('vm list -g {repair_resource_group} -o json').get_output_in_json()
+        assert len(repair_vms) == 1
+        repair_vm = repair_vms[0]
+        # Verify the image sku is the expected sku from source vm.
+        image_info = repair_vm['storageProfile']['imageReference']  
+        assert image_info['sku'] == "22_04-lts-gen2"
+        
+        self.kwargs.update({
+            'vm': 'vm1',
+            'admin_password': secure_password,
+            'admin_username': secure_username
+        })
+        # Run a script using long parameter parsing
+        result_run = self.cmd('vm repair run -g {rg} -n {vm} --run-on-repair --run-id linux-alar2 --parameters test ++initiator=SELFHELP -o json').get_output_in_json()
+        assert result_run['status'] == STATUS_SUCCESS, result_run['error_message']
+        log_contains_initiator_selfhelp = "initiator=selfhelp" in result_run['logs'].lower()  
+        assert log_contains_initiator_selfhelp, "The logs do not contain 'initiator=selfhelp'"  
+
+        # Call Restore
+        self.cmd('vm repair restore -g {rg} -n {vm} --yes')

src/vm-repair/setup.py

@@ -8,7 +8,7 @@
 from codecs import open
 from setuptools import setup, find_packages
 
-VERSION = "2.0.2"
+VERSION = "2.0.3"
 
 CLASSIFIERS = [
     'Development Status :: 4 - Beta',