Make remote_run Windows compatible (#803)

Author: amd-arsuresh

automation/script/remote_run.py

@@ -9,6 +9,7 @@
 import copy
 from datetime import datetime
 from script.script_utils import *
+import platform
 
 
 def remote_run(self_module, i):
@@ -86,6 +87,13 @@ def remote_run(self_module, i):
 
     run_cmds = []
     remote_mlc_python_venv = i.get('remote_python_venv', 'mlcflow')
+
+    # Determine if the local system is Windows to adjust command formatting
+    is_windows = platform.system() == 'Windows'
+
+    # Note: The remote activation command uses Unix syntax because we're SSHing into a (likely) Unix server
+    # Even if we're running from Windows locally, the remote commands execute
+    # on the remote server
     run_cmds.append(f". {remote_mlc_python_venv}/bin/activate")
     if i.get('remote_pull_mlc_repos', False):
         run_cmds.append("mlc pull repo")
@@ -96,10 +104,9 @@ def remote_run(self_module, i):
     for key in env_keys_to_copy:
         if key in env and os.path.exists(env[key]):
             files_to_copy.append(env[key])
-            remote_env[key] = os.path.join(
-                "mlc-remote-artifacts",
-                os.path.basename(
-                    env[key]))
+            # Use forward slashes for remote path (Unix/Linux servers)
+            remote_env[key] = "mlc-remote-artifacts/" + \
+                os.path.basename(env[key])
 
             for k, value in input_mapping.items():
                 if value == key and k in run_input:
@@ -203,9 +210,14 @@ def regenerate_script_cmd(i):
             value = env[key]
 
             # Check if the value is a string containing the specified paths
+            # Use both forward and backward slashes for Windows compatibility
             if isinstance(value, str) and (
                     os.path.join("local", "cache", "") in value or
+                    "local/cache/" in value or
+                    "local\\cache\\" in value or
                     os.path.join("MLC", "repos", "") in value or
+                    "MLC/repos/" in value or
+                    "MLC\\repos\\" in value or
                     "<<<" in value
             ):
                 del env[key]
@@ -217,8 +229,12 @@ def regenerate_script_cmd(i):
                     val for val in value
                     if isinstance(val, str) and (
                         os.path.join("local", "cache", "") in val or
+                        "local/cache/" in val or
+                        "local\\cache\\" in val or
                         os.path.join("MLC", "repos", "") in val or
-                        "<<<" in value
+                        "MLC/repos/" in val or
+                        "MLC\\repos\\" in val or
+                        "<<<" in val
                     )
                 ]
 

script/remote-run-commands/customize.py

@@ -1,6 +1,7 @@
 from mlc import utils
 import os
 import subprocess
+import platform
 
 
 def preprocess(i):
@@ -11,11 +12,17 @@ def preprocess(i):
 
     cmd_string = ''
 
-    # pre_run_cmds = env.get('MLC_SSH_PRE_RUN_CMDS', ['source $HOME/cm/bin/activate'])
+    is_windows = os_info['platform'] == 'windows'
+
+    # pre_run_cmds = env.get('MLC_SSH_PRE_RUN_CMDS', ['source $HOME/mlcflow/bin/activate'])
     pre_run_cmds = env.get('MLC_SSH_PRE_RUN_CMDS', [])
 
     files_to_copy = env.get('MLC_SSH_FILES_TO_COPY', [])
 
+    if "<<<HOME>>>" in env.get('MLC_SSH_KEY_FILE', ''):
+        env['MLC_SSH_KEY_FILE'] = env['MLC_SSH_KEY_FILE'].replace(
+            "<<<HOME>>>", os.path.expanduser("~"))
+
     run_cmds = env.get('MLC_SSH_RUN_COMMANDS', [])
 
     run_cmds = pre_run_cmds + run_cmds
@@ -26,8 +33,12 @@ def preprocess(i):
             cmd = cmd.replace(";;", ",")
             run_cmds[i] = cmd
 
+    # Use semicolon for Unix-like systems, the remote server will handle it
     cmd_string += " ; ".join(run_cmds)
-    user = env.get('MLC_SSH_USER', os.environ.get('USER'))
+
+    # Get username - on Windows, USERNAME is the env var, not USER
+    user = env.get('MLC_SSH_USER', os.environ.get(
+        'USER') or os.environ.get('USERNAME'))
     password = env.get('MLC_SSH_PASSWORD', None)
     host = env.get('MLC_SSH_HOST')
     port = env.get('MLC_SSH_PORT', '22')
@@ -40,29 +51,47 @@ def preprocess(i):
     ssh_cmd = ["ssh", "-p", port]
 
     if env.get("MLC_SSH_SKIP_HOST_VERIFY"):
+        # Use NUL on Windows, /dev/null on Unix
+        null_device = "NUL" if is_windows else "/dev/null"
         ssh_cmd += ["-o", "StrictHostKeyChecking=no",
-                    "-o", "UserKnownHostsFile=/dev/null"]
+                    "-o", f"UserKnownHostsFile={null_device}"]
 
     key_file = env.get("MLC_SSH_KEY_FILE")
     if key_file:
         ssh_cmd += ["-i", key_file]
 
     ssh_cmd_str = " ".join(ssh_cmd)
 
+    # Use double quotes on Windows, single quotes on Unix for better
+    # compatibility
+    quote_char = '"' if is_windows else "'"
     ssh_run_command = ssh_cmd_str + " " + user + "@" + host + \
-        password_string + " '" + cmd_string + "'"
+        password_string + " " + quote_char + cmd_string + quote_char
     env['MLC_SSH_CMD'] = ssh_run_command
 
-    # ---- Use sshpass if password is provided ----
+    # ---- Use sshpass if password is provided (only on Unix-like systems) ----
     rsync_base = ["rsync", "-avz"]
 
-    if password:
+    if password and not is_windows:
         rsync_base = ["sshpass", "-p", password] + rsync_base
 
-    target_directory = env['MLC_SSH_TARGET_COPY_DIRECTORY']
+    target_directory = env.get('MLC_SSH_TARGET_COPY_DIRECTORY', '')
 
     # ---- Execute copy commands ----
     for file in files_to_copy:
+        # Check if rsync is available
+        rsync_available = True
+        try:
+            subprocess.run(["rsync", "--version"],
+                           capture_output=True, check=True)
+        except (subprocess.CalledProcessError, FileNotFoundError):
+            rsync_available = False
+
+        if not rsync_available:
+            print(f"⚠️  rsync not found. Skipping file copy for {file}")
+            print("   On Windows, install rsync via WSL, Cygwin, or use Git Bash")
+            continue
+
         cmd = [
             "rsync",
             "-avz",

script/remote-run-commands/run.bat

@@ -1 +1,4 @@
-rem native script
+@echo off
+set cmd=%MLC_SSH_CMD%
+echo %cmd%
+%cmd%