Start Docker-izing sanitizer-windows

[rnk]

Summary

This defines a new docker image for sanitizer-windows based on the
existing docker image. I chose to dockerize sanitizer-windows first,
because it cycles quickly and doesn't do a two-stage build.

My plan is to have both the existing sanitizer-windows bot and the new
one run concurrently, but the new one will connect to the silent,
staging buildmaster (lab.llvm.org:9994). Once we are ready to cut over,
I will turn off the old sanitizer-windows VM and update this port in the
docker image and redeploy.

I am chosing to stick with the buildbot annotation script approach,
because it allows for much faster iteration: I can adjust paths for the
VS installation for example simply by committing to zorg. However, both
the live and staging bot will use the same script, so the same script
must work for both sanitizer-windows bots at the same time!

[kuhnel]

LGTM.

I'm not using the current deployment of the "windows10_vs2019" any more. So feel free to just modify that image and re-use the worker-config. That way you don't have to configure another deployment.

If you don't want to use that, I'll just delete to save resources.

buildbot/google/docker/buildbot-sanitizer-windows/Dockerfile

3

This base image still contains GnuWin, Python2 and an ancient version of the buildbot-worker.
So when starting with a new worker I guess we should clean that up (remove python2 and GnuWin, and upgrade to the latest builbot-worker)

buildbot/google/docker/buildbot-sanitizer-windows/Dockerfile

+# escape=`
+FROM gcr.io/sanitizer-bots/windows-base-vscode2019:8
+
+ENV WORKER_NAME=sanitizer-windows
+
+# copy script to start the agent
+COPY run.ps1 .
+COPY fix_buildbot_tac_paths.py .
+
+# Set location for sccache cache
+ENV SCCACHE_DIR="C:\volumes\sccache"
+
+# Set the maximum sccache local cache size
+ENV SCCACHE_CACHE_SIZE="10G"
+
+# Move buildbot work dir to a volume to avoid of disc issues
+VOLUME C:\volumes\buildbot
+
+# Configure 32bit tools ("x86") instead of 64bit ("amd64")
+CMD ["powershell.exe", "-NoLogo", "-ExecutionPolicy", "Bypass", `
+     "c:\\buildbot\\run.ps1"]

buildbot/google/docker/buildbot-sanitizer-windows/VERSION

+1

buildbot/google/docker/buildbot-sanitizer-windows/admin

+Reid Kleckner <[e-mail]>

buildbot/google/docker/buildbot-sanitizer-windows/fix_buildbot_tac_paths.py

+#!/usr/bin/env python3
+# Replace backward slashes in the paths in a "buildbot.tac" file
+
+import argparse
+import re
+import shutil
+
+
+def fix_slashes(buildbot_tac_path : str):
+    shutil.copy(buildbot_tac_path, buildbot_tac_path + ".bak")
+    result = []
+    with open(buildbot_tac_path) as buildbot_tac_file:
+        buildbot_tac = buildbot_tac_file.readlines()
+        for line in buildbot_tac:
+            if line.lstrip().startswith('basedir'):
+                line = line.replace(r'\\','/')
+            result.append(line)
+    with open(buildbot_tac_path, 'w') as buildbot_tac_file:
+        buildbot_tac_file.writelines(result)
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument('buildbot_tac_path', help="path of 'buildbot.tac' file")
+    args = parser.parse_args()
+    fix_slashes(args.buildbot_tac_path)

buildbot/google/docker/buildbot-sanitizer-windows/run.ps1

+# Stop the script on the first error
+$ErrorActionPreference = "Stop"
+
+# Read password from file
+$WORKER_PASSWORD=Get-Content "C:\volumes\secrets\token"
+
+#Create short drive alias "Q:" for worker dir, to keep path lengths <260 
+SUBST Q: C:\volumes\buildbot
+Get-PSDrive
+
+# chdir to the volume storing the temporary data
+# This is a mounted volume
+Set-Location Q:\
+
+# Write host and admin information
+# delete old folder if it exists
+# configure powershell output to use UTF-8, otherwiese buildbot can't read the file
+if ( Test-Path -Path 'info\' -PathType Container ) { 
+  Remove-Item -Recurse -Force info 
+}
+mkdir "info\"
+$HOST_FILE="info\host"
+$PSDefaultParameterValues['Out-File:Encoding'] = 'utf8'
+Write-Output "Windows version: $(cmd /c ver)" > $HOST_FILE
+Write-Output "VCTools version: $(ls C:\BuildTools\VC\Tools\MSVC | Select -ExpandProperty Name)" >> $HOST_FILE
+Write-Output "Cores          : $((Get-CimInstance Win32_ComputerSystem).NumberOfLogicalProcessors)" >> $HOST_FILE
+Write-Output "RAM            : $([int][Math]::Round((Get-CimInstance Win32_ComputerSystem).TotalPhysicalMemory / 1073741824)) GB" >> $HOST_FILE
+Write-Output "Reid Kleckner <[e-mail]>" > "info\admin"
+
+# create the worker
+Write-Output "creating worker..."
+buildslave create-slave --keepalive=200 Q: `
+  "lab.llvm.org:9994" "$env:WORKER_NAME" "$WORKER_PASSWORD"
+# Note: Powershell does NOT exit on non-zero return codes, so we need to check manually.
+if ($LASTEXITCODE -ne 0) { throw "Exit code of 'buildslave create' is $LASTEXITCODE" }
+
+# Replace backward slashes with forward slashes on buildbot.tac
+# Otherwise Cmake will go into infinite re-configuration loops
+python C:\buildbot\fix_buildbot_tac_paths.py buildbot.tac
+if ($LASTEXITCODE -ne 0) { throw "Exit code of 'fix_buildbot_tac_paths' is $LASTEXITCODE" }
+
+# start the daemon, as this does not print and logs to std out, run it in the background
+Write-Output "starting worker..."
+cmd /c Start /B buildslave start Q:
+
+# Wait a bit until the logfile exists
+Start-Sleep -s 5
+
+# To keep the container running and produce log outputs: dump the worker
+# log to stdout, this is the windows equivalent of `tail -f`
+Get-Content -Path "Q:\twistd.log" -Wait

zorg/buildbot/builders/annotated/annotated_builder.py

 from __future__ import print_function
 
 import util
 
 import argparse
 import errno
 import os
 import re
 import shutil
 import subprocess
 import sys
 
 from os.path import join as pjoin
 
 VSWHERE_PATH = "C:/Program Files (x86)/Microsoft Visual Studio/Installer/vswhere.exe"
+BUILDTOOLS_VSDEVCMD = "C:/BuildTools/Common7/Tools/VsDevCmd.bat"
 
 def get_argument_parser(*args, **kwargs):
     ap = argparse.ArgumentParser(*args, **kwargs)
     ap.add_argument('--jobs', help='Number of concurrent jobs to run')
     return ap
 
 
 class AnnotatedBuilder:
def run_steps(
         except Exception as e:
             self.report_step_exception(e)
             return 1
 
         return 0
 
 
 def get_vcvars(vs_tools, arch):
-    """Get the VC tools environment using vswhere.exe from VS 2017
+    """Get the VC tools environment using vswhere.exe or buildtools docker
 
-    This code is following the guidelines from strategy 1 in this blog post:
+    This is intended to work either when VS is in its standard installation
+    location, or when the docker instructions have been followed, and we can
+    find Visual C++ in C:/BuildTools.
+
+    Visual Studio provides a docker image with instructions here:
+    https://docs.microsoft.com/en-us/visualstudio/install/build-tools-container?view=vs-2019
+
+    This vswhere code is following the guidelines from strategy 1 in this blog
+    post:
         https://blogs.msdn.microsoft.com/vcblog/2017/03/06/finding-the-visual-c-compiler-tools-in-visual-studio-2017/
 
     It doesn't work when VS is not installed at the default location.
     """
     if not arch:
         # First check the wow64 processor architecture, since python is probably
         # 32-bit, then fall back to PROCESSOR_ARCHITECTURE.
         arch = os.environ.get('PROCESSOR_ARCHITEW6432', '').lower()
         if not arch:
             arch = os.environ.get('PROCESSOR_ARCHITECTURE', '').lower()
     else:
         arch = arch.lower()
 
     # Use vswhere.exe if it exists.
     if os.path.exists(VSWHERE_PATH):
         cmd = [VSWHERE_PATH, "-latest", "-property", "installationPath"]
         vs_path = subprocess.check_output(cmd).strip()
         util.report("Running vswhere to find VS: " + repr(cmd))
         util.report("vswhere output: " + vs_path)
         if not os.path.isdir(vs_path):
             raise ValueError("VS install path does not exist: " + vs_path)
         vcvars_path = pjoin(vs_path, 'VC', 'Auxiliary', 'Build',
                             'vcvarsall.bat')
+    elif os.path.exists(BUILDTOOLS_VSDEVCMD):
+        vcvars_path = BUILDTOOLS_VSDEVCMD
     elif vs_tools is None:
         vs_tools = os.path.expandvars('%VS140COMNTOOLS%')
         vcvars_path = pjoin(vs_tools, '..', '..', 'VC', 'vcvarsall.bat')
 
     # Newer vcvarsall.bat scripts aren't quiet, so direct them to NUL, aka
     # Windows /dev/null.
     cmd = util.shquote_cmd([vcvars_path, arch]) + ' > NUL && set'
     util.report("Running vcvars: " + cmd)