Auto merge of #24149 - jdm:opt-in-msbuild, r=paulrouget

Add explicit packaging step for UWP apps

<!-- Reviewable:start -->
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/24149)
<!-- Reviewable:end -->

3 files changed, 97 insertions, 77 deletions

diff --git a/python/servo/build_commands.py b/python/servo/build_commands.py
index e07a7666e0e..3846cd86877 100644
--- a/python/servo/build_commands.py
+++ b/python/servo/build_commands.py
@@ -249,15 +249,7 @@ class MachCommands(CommandBase):
             env["CXXFLAGS"] += "-mmacosx-version-min=10.10"
 
         if 'windows' in host:
-            vsinstalldir = os.environ.get('VSINSTALLDIR')
-            vcinstalldir = None
-            vs_version = os.environ.get('VisualStudioVersion')
-            if vsinstalldir and vs_version:
-                msbuild_version = get_msbuild_version(vs_version)
-            else:
-                (vsinstalldir, vs_version, msbuild_version) = find_highest_msvc_version()
-            msbuildinstalldir = os.path.join(vsinstalldir, "MSBuild",
-                                             msbuild_version, "Bin")
+            vs_dirs = self.vs_dirs()
 
         if host != target_triple and 'windows' in target_triple:
             if os.environ.get('VisualStudioVersion'):
@@ -265,9 +257,9 @@ class MachCommands(CommandBase):
                       "Please run `python mach build [arguments]` to bypass automatic "
                       "Visual Studio shell.")
                 sys.exit(1)
-            vcinstalldir = os.environ.get("VCINSTALLDIR", "") or os.path.join(vsinstalldir, "VC")
+            vcinstalldir = vs_dirs['vcdir']
             if not os.path.exists(vcinstalldir):
-                print("Can't find Visual C++ %s installation at %s." % (vs_version, vcinstalldir))
+                print("Can't find Visual C++ %s installation at %s." % (vs_dirs['vs_version'], vcinstalldir))
                 sys.exit(1)
 
             env['PKG_CONFIG_ALLOW_CROSS'] = "1"
@@ -695,13 +687,9 @@ class MachCommands(CommandBase):
 
                 # UWP app packaging already bundles all required DLLs for us.
                 print("Packaging MSVC DLLs")
-                if not package_msvc_dlls(servo_exe_dir, target_triple, vcinstalldir, vs_version):
+                if not package_msvc_dlls(servo_exe_dir, target_triple, vs_dirs['vcdir'], vs_dirs['vs_version']):
                     status = 1
 
-                # UWP build hololens
-                if uwp and status == 0:
-                    build_uwp_hololens(target_triple, dev, msbuildinstalldir)
-
             elif sys.platform == "darwin":
                 # On the Mac, set a lovely icon. This makes it easier to pick out the Servo binary in tools
                 # like Instruments.app.
@@ -907,33 +895,6 @@ def package_gstreamer_dlls(env, servo_exe_dir, target, uwp):
     return not missing
 
 
-def build_uwp_hololens(target, dev, msbuild_dir):
-    # determine Visual studio Build Configuration (Debug/Release) and
-    # Build Platform (x64 vs arm64)
-    vs_platforms = {
-        "x86_64": "x64",
-        "i686": "x86",
-        "aarch64": "arm64",
-    }
-    target_arch = target.split('-')[0]
-    vs_platform = vs_platforms[target_arch]
-
-    if dev:
-        Configuration = "Debug"
-    else:
-        Configuration = "Release"
-
-    # execute msbuild
-    # Note: /m implies to use as many CPU cores as possible while building.
-    # msbuild /m /p:project=ServoApp .\support\hololens\servoapp.sln /p:SolutionDir=.\support\hololens
-    # /p:Configuration="Debug" /p:Platform="x64" /property:AppxBundle=Always;AppxBundlePlatforms="x64"
-    check_call([msbuild_dir + "\msbuild.exe", "/m", "/p:project=ServoApp", ".\support\hololens\ServoApp.sln",
-                "/p:SolutionDir=.\support\hololens",
-                "/p:Configuration=" + Configuration,
-                "/p:Platform=" + vs_platform,
-                "/p:AppxBundle=Always;AppxBundlePlatforms=" + vs_platform])
-
-
 def package_msvc_dlls(servo_exe_dir, target, vcinstalldir, vs_version):
     # copy some MSVC DLLs to servo.exe dir
     msvc_redist_dir = None
@@ -1002,34 +963,3 @@ def package_msvc_dlls(servo_exe_dir, target, vcinstalldir, vs_version):
     for msvc_dll in missing:
         print("DLL file `{}` not found!".format(msvc_dll))
     return not missing
-
-
-def get_msbuild_version(vs_version):
-    if vs_version in ("15.0", "14.0"):
-        msbuild_version = vs_version
-    else:
-        msbuild_version = "Current"
-    return msbuild_version
-
-
-def find_highest_msvc_version():
-    editions = ["Enterprise", "Professional", "Community", "BuildTools"]
-    prog_files = os.environ.get("ProgramFiles(x86)")
-    base_vs_path = os.path.join(prog_files, "Microsoft Visual Studio")
-
-    vs_versions = ["2019", "2017"]
-    versions = {
-        ("2019", "vs"): "16.0",
-        ("2017", "vs"): "15.0",
-    }
-
-    for version in vs_versions:
-        for edition in editions:
-            vs_version = versions[version, "vs"]
-            msbuild_version = get_msbuild_version(vs_version)
-
-            vsinstalldir = os.path.join(base_vs_path, version, edition)
-            if os.path.exists(vsinstalldir):
-                return (vsinstalldir, vs_version, msbuild_version)
-    print("Can't find MSBuild.exe installation under %s." % base_vs_path)
-    sys.exit(1)
diff --git a/python/servo/command_base.py b/python/servo/command_base.py
index 2a370d757da..ee12594ee83 100644
--- a/python/servo/command_base.py
+++ b/python/servo/command_base.py
@@ -597,6 +597,23 @@ install them, let us know by filing a bug!")
     def msvc_package_dir(self, package):
         return path.join(self.context.sharedir, "msvc-dependencies", package, msvc_deps[package])
 
+    def vs_dirs(self):
+        assert 'windows' in host_triple()
+        vsinstalldir = os.environ.get('VSINSTALLDIR')
+        vs_version = os.environ.get('VisualStudioVersion')
+        if vsinstalldir and vs_version:
+            msbuild_version = get_msbuild_version(vs_version)
+        else:
+            (vsinstalldir, vs_version, msbuild_version) = find_highest_msvc_version()
+        msbuildinstalldir = os.path.join(vsinstalldir, "MSBuild", msbuild_version, "Bin")
+        vcinstalldir = os.environ.get("VCINSTALLDIR", "") or os.path.join(vsinstalldir, "VC")
+        return {
+            'msbuild': msbuildinstalldir,
+            'vsdir': vsinstalldir,
+            'vs_version': vs_version,
+            'vcdir': vcinstalldir,
+        }
+
     def build_env(self, hosts_file_path=None, target=None, is_build=False, test_unit=False):
         """Return an extended environment dictionary."""
         env = os.environ.copy()
@@ -978,3 +995,34 @@ install them, let us know by filing a bug!")
                     sys.exit(error)
             else:
                 print("Clobber not needed.")
+
+
+def find_highest_msvc_version():
+    editions = ["Enterprise", "Professional", "Community", "BuildTools"]
+    prog_files = os.environ.get("ProgramFiles(x86)")
+    base_vs_path = os.path.join(prog_files, "Microsoft Visual Studio")
+
+    vs_versions = ["2019", "2017"]
+    versions = {
+        ("2019", "vs"): "16.0",
+        ("2017", "vs"): "15.0",
+    }
+
+    for version in vs_versions:
+        for edition in editions:
+            vs_version = versions[version, "vs"]
+            msbuild_version = get_msbuild_version(vs_version)
+
+            vsinstalldir = os.path.join(base_vs_path, version, edition)
+            if os.path.exists(vsinstalldir):
+                return (vsinstalldir, vs_version, msbuild_version)
+    print("Can't find MSBuild.exe installation under %s." % base_vs_path)
+    sys.exit(1)
+
+
+def get_msbuild_version(vs_version):
+    if vs_version in ("15.0", "14.0"):
+        msbuild_version = vs_version
+    else:
+        msbuild_version = "Current"
+    return msbuild_version
diff --git a/python/servo/package_commands.py b/python/servo/package_commands.py
index 3e14876e29a..d8dbc49b117 100644
--- a/python/servo/package_commands.py
+++ b/python/servo/package_commands.py
@@ -67,6 +67,9 @@ PACKAGES = {
         r'target\release\msi\Servo.exe',
         r'target\release\msi\Servo.zip',
     ],
+    'uwp': [
+        r'support\hololens\AppPackages\ServoApp\ServoApp_1.0.0.0_Test\ServoApp_1.0.0.0_x64_arm64.appxbundle',
+    ],
 }
 
 
@@ -202,8 +205,12 @@ class PackageCommands(CommandBase):
                      default=None,
                      action='store_true',
                      help='Create a local Maven repository')
+    @CommandArgument('--uwp',
+                     default=None,
+                     action='append',
+                     help='Create an APPX package')
     def package(self, release=False, dev=False, android=None, magicleap=None, debug=False,
-                debugger=None, target=None, flavor=None, maven=False):
+                debugger=None, target=None, flavor=None, maven=False, uwp=None):
         if android is None:
             android = self.config["build"]["android"]
         if target and android:
@@ -219,10 +226,16 @@ class PackageCommands(CommandBase):
         if magicleap:
             target = "aarch64-linux-android"
         env = self.build_env(target=target)
-        binary_path = self.get_binary_path(release, dev, target=target, android=android, magicleap=magicleap)
+        binary_path = self.get_binary_path(
+            release, dev, target=target, android=android, magicleap=magicleap,
+            simpleservo=uwp is not None
+        )
         dir_to_root = self.get_top_dir()
         target_dir = path.dirname(binary_path)
-        if magicleap:
+        if uwp:
+            vs_info = self.vs_dirs()
+            build_uwp(uwp, dev, vs_info['msbuild'])
+        elif magicleap:
             if platform.system() not in ["Darwin"]:
                 raise Exception("Magic Leap builds are only supported on macOS.")
             if not env.get("MAGICLEAP_SDK"):
@@ -724,3 +737,32 @@ class PackageCommands(CommandBase):
             update_brew(packages[0], timestamp)
 
         return 0
+
+
+def build_uwp(platforms, dev, msbuild_dir):
+    if any(map(lambda p: p not in ['x64', 'x86', 'arm64'], platforms)):
+        raise Exception("Unsupported appx platforms: " + str(platforms))
+    if dev and len(platforms) > 1:
+        raise Exception("Debug package with multiple architectures is unsupported")
+
+    if dev:
+        Configuration = "Debug"
+    else:
+        Configuration = "Release"
+
+    msbuild = path.join(msbuild_dir, "msbuild.exe")
+    build_file_template = path.join('support', 'hololens', 'package.msbuild')
+    with open(build_file_template) as f:
+        template_contents = f.read()
+        build_file = tempfile.NamedTemporaryFile(delete=False)
+        build_file.write(
+            template_contents
+            .replace("%%BUILD_PLATFORMS%%", ';'.join(platforms))
+            .replace("%%PACKAGE_PLATFORMS%%", '|'.join(platforms))
+            .replace("%%CONFIGURATION%%", Configuration)
+            .replace("%%SOLUTION%%", path.join(os.getcwd(), 'support', 'hololens', 'ServoApp.sln'))
+        )
+        build_file.close()
+        # Generate an appxbundle.
+        subprocess.check_call([msbuild, "/m", build_file.name])
+        os.unlink(build_file.name)