special handling for windows file renaming error.

During vcpkg installation, we sometimes see a permissions not granted
for renaming a downloaded file. This fix tries to circumvent those issues
by copying over the directory to the right name.

Author: vimanyu

scripts/gha/build_desktop.py

@@ -65,7 +65,8 @@ def install_x86_support_libraries():
     utils.run_command(['apt', 'install', 'libsecret-1-dev:i386'], as_root=True)
 
 
-def install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library):
+def install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library,
+                                        attempt_auto_fix=False):
   """Install packages with vcpkg.
 
   This does the following,
@@ -75,6 +76,13 @@ def install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library):
   Args:
     arch (str): Architecture (eg: 'x86', 'x64').
     msvc_runtime_library (str): Runtime library for MSVC (eg: 'static', 'dynamic').
+    attempt_auto_fix (bool): In case of errors, try to auto fix.
+  Returns:
+    (bool): True if installation was successful.
+            False if installation wasn't successful but auto fix was attempted
+                  and we should retry the installation.
+  Raises:
+    (ValueError): If installation wasn't successful and auto fix wasn't attempted.
   """
 
   # Install vcpkg executable if its not installed already
@@ -101,11 +109,14 @@ def install_cpp_dependencies_with_vcpkg(arch, msvc_runtime_library):
 
   # Some errors in vcpkg installation are not bubbled up. Verify existence
   # of certain important directories before proceeding.
-  utils.verify_vcpkg_build(vcpkg_triplet)
+  success = utils.verify_vcpkg_build(vcpkg_triplet, attempt_auto_fix)
+  if not success:
+    return False
 
   # Clear temporary directories and files created by vcpkg buildtrees
   # could be several GBs and cause github runners to run out of space
   utils.clean_vcpkg_temp_data()
+  return True
 
 
 def cmake_configure(build_dir, arch, msvc_runtime_library='static',
@@ -180,7 +191,16 @@ def main():
     install_x86_support_libraries()
 
   # Install platform dependent cpp dependencies with vcpkg
-  install_cpp_dependencies_with_vcpkg(args.arch, args.msvc_runtime_library)
+  # Try once with auto-fixing any errors (if any)
+  success = install_cpp_dependencies_with_vcpkg(args.arch,
+                                                args.msvc_runtime_library,
+                                                attempt_auto_fix=True)
+  if not success:
+    # If auto-fix was attempted, give it one more try.
+    # If it fails again, a ValueError will be raised and script will exit.
+    install_cpp_dependencies_with_vcpkg(args.arch,
+                                        args.msvc_runtime_library,
+                                        attempt_auto_fix=False)
 
   # CMake configure
   cmake_configure(args.build_dir, args.arch, args.msvc_runtime_library,

scripts/gha/utils.py

@@ -169,15 +169,41 @@ def get_vcpkg_installation_script_path():
   return script_absolute_path
 
 
-def verify_vcpkg_build(vcpkg_triplet):
-  """Check if vcpkg installation finished successfully."""
+def verify_vcpkg_build(vcpkg_triplet, attempt_auto_fix=False):
+  """Check if vcpkg installation finished successfully.
+
+  Args:
+    vcpkg_triplet (str): Triplet name for vcpkg. Eg: 'x64-linux'
+    attempt_auto_fix (bool): If installation failed, try fixing some errors.
+
+  Returns:
+    (bool) True if everything looks good
+           False if installation failed but auto fix was attempted.
+                 Caller should retry installation in this case.
+  Raises:
+    (ValueError) Installation failed and auto fix was not attempted
+  """
   # At the very least, we should have an "installed" directory under vcpkg triplet.
   vcpkg_root_dir_path = get_vcpkg_root_path()
   installed_triplets_dir_path = os.path.join(vcpkg_root_dir_path, 'installed', vcpkg_triplet)
   if not os.path.exists(installed_triplets_dir_path):
+    if is_windows_os() and attempt_auto_fix:
+      # On some Windows machines with NFS drives, we have seen errors
+      # installing vcpkg due to permission issues while renaming temp directories.
+      # Manually renaming and re-running script makes it go through.
+      tools_dir_path = os.path.join(vcpkg_root_dir_path, 'downloads', 'tools')
+      for name in os.listdir(tools_dir_path):
+        if '.partial.' in name and os.path.isdir(os.path.join(tools_dir_path, name)):
+          # Since we can't rename, lets copy the directory to one without partial in the name
+          expected_name = name.split('.partial.')[0]
+          shutil.copytree(os.path.join(tools_dir_path, name),
+                          os.path.join(tools_dir_path, expected_name))
+      return False
+
     raise ValueError("Could not find directory containing installed packages by vcpkg: {0}\n"
                      "Please check if there were errors during "
                      "vcpkg installation.".format(installed_triplets_dir_path))
+  return True
 
 
 def clean_vcpkg_temp_data():