make_msvc_package.py

#!python

# Copyright (c) 2016 Ryan Prichard
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

#
# Run with native CPython 2.7.
#
# This script looks for MSVC using a version-specific environment variable,
# such as VS140COMNTOOLS for MSVC 2015.
#

import common_ship

import argparse
import os
import shutil
import subprocess
import sys

os.chdir(common_ship.topDir)

MSVC_VERSION_TABLE = {
    "2022" : {
        "package_name" : "msvc2022",
        "gyp_version" : "2022",
        "common_tools_env" : "VS170COMNTOOLS",
        "xp_toolset" : "v170_xp",
    },
    "2015" : {
        "package_name" : "msvc2015",
        "gyp_version" : "2015",
        "common_tools_env" : "VS140COMNTOOLS",
        "xp_toolset" : "v140_xp",
    },
    "2013" : {
        "package_name" : "msvc2013",
        "gyp_version" : "2013",
        "common_tools_env" : "VS120COMNTOOLS",
        "xp_toolset" : "v120_xp",
    },
}

ARCH_TABLE = {
    "x64" : {
        "msvc_platform" : "x64",
    },
    "ia32" : {
        "msvc_platform" : "Win32",
    },
    "arm64" : {
        "msvc_platform" : "arm64",
    },
}

def readArguments():
    parser = argparse.ArgumentParser()
    parser.add_argument("--msvc-version", default="2015")
    ret = parser.parse_args()
    if ret.msvc_version not in MSVC_VERSION_TABLE:
        sys.exit("Error: unrecognized version: " + ret.msvc_version + ". " +
            "Versions: " + " ".join(sorted(MSVC_VERSION_TABLE.keys())))
    return ret

ARGS = readArguments()

def checkoutGyp():
    if os.path.isdir("build-gyp"):
        return
    subprocess.check_call([
        "git.exe",
        "clone",
        "https://chromium.googlesource.com/external/gyp",
        "build-gyp"
    ])

def cleanMsvc():
    common_ship.rmrf("""
        src/Release src/.vs src/gen
        src/*.vcxproj src/*.vcxproj.filters src/*.sln src/*.sdf
    """.split())

def build(arch, packageDir, xp=False):
    archInfo = ARCH_TABLE[arch]
    versionInfo = MSVC_VERSION_TABLE[ARGS.msvc_version]

    devCmdPath = os.path.join(os.environ[versionInfo["common_tools_env"]], "VsDevCmd.bat")
    if not os.path.isfile(devCmdPath):
        sys.exit("Error: MSVC environment script missing: " + devCmdPath)

    toolsetArgument = " --toolset {}".format(versionInfo["xp_toolset"]) if xp else ""
    newEnv = os.environ.copy()
    newEnv["PATH"] = os.path.dirname(sys.executable) + ";" + common_ship.defaultPathEnviron
    commandLine = (
        '"' + devCmdPath + '" && ' +
        " vcbuild.bat" +
        " --gyp-msvs-version " + versionInfo["gyp_version"] +
        " --msvc-platform " + archInfo["msvc_platform"] +
        " --commit-hash " + common_ship.commitHash +
        toolsetArgument
    )

    subprocess.check_call(commandLine, shell=True, env=newEnv)

    archPackageDir = os.path.join(packageDir, arch)
    if xp:
        archPackageDir += "_xp"

    common_ship.mkdir(archPackageDir + "/bin")
    common_ship.mkdir(archPackageDir + "/lib")

    binSrc = os.path.join(common_ship.topDir, "src/Release", archInfo["msvc_platform"])

    shutil.copy(binSrc + "/winpty.dll",                 archPackageDir + "/bin")
    shutil.copy(binSrc + "/winpty-agent.exe",           archPackageDir + "/bin")
    shutil.copy(binSrc + "/winpty-debugserver.exe",     archPackageDir + "/bin")
    shutil.copy(binSrc + "/winpty.lib",                 archPackageDir + "/lib")

def buildPackage():
    versionInfo = MSVC_VERSION_TABLE[ARGS.msvc_version]

    packageName = "winpty-%s-%s" % (
        common_ship.winptyVersion,
        versionInfo["package_name"],
    )

    packageRoot = os.path.join(common_ship.topDir, "ship/packages")
    packageDir = os.path.join(packageRoot, packageName)
    packageFile = packageDir + ".zip"

    common_ship.rmrf([packageDir])
    common_ship.rmrf([packageFile])
    common_ship.mkdir(packageDir)

    checkoutGyp()
    cleanMsvc()
    build("ia32", packageDir, True)
    build("x64", packageDir, True)
    build("arm64", packageDir, True)
    cleanMsvc()
    build("ia32", packageDir)
    build("x64", packageDir)
    build("arm64", packageDir)

    topDir = common_ship.topDir

    common_ship.mkdir(packageDir + "/include")
    shutil.copy(topDir + "/src/include/winpty.h",               packageDir + "/include")
    shutil.copy(topDir + "/src/include/winpty_constants.h",     packageDir + "/include")
    shutil.copy(topDir + "/LICENSE",                            packageDir)
    shutil.copy(topDir + "/README.md",                          packageDir)
    shutil.copy(topDir + "/RELEASES.md",                        packageDir)

    subprocess.check_call([common_ship.ZIP_TOOL, "a", packageFile, "."], cwd=packageDir)

if __name__ == "__main__":
    buildPackage()