ClangBuilder: Use list of checks instead of boolean. NFCI

[rovka]

Summary

Modify getClangCMakeBuildFactory and getClangCMakeGCSBuildFactory
to take as input a list of checks instead of a boolean. This makes it possible
to run subsets of the tests and is similar to the pattern used by the
UnifiedTreeBuilder.

[gkistanova]

Thanks, Diana!

List of checks is a good idea.

zorg/buildbot/builders/ClangBuilder.py

75

Please do not use mutable objects as defaults. Instead make it None and handle that in the body as the trigger to set a default value.

https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments

136

Ditto.

186

Ditto.

_getClangCMakeBuildFactory seems the right place to implement that “default check-all” logic.

297

Just for a better UX you may want each check to be a separate build step, if multiple specified. Not a stopper for this patch.

[rovka]

Thanks, I updated it to use None as a default.
Separate steps for each set of checks sounds like a good idea. Maybe we can add that when we actually have a buildbot that runs at least 2 sets of checks (hopefully this one, in the near future).

[gkistanova]

Thanks, Diana!
LGTM.

buildbot/osuosl/master/config/builders.py

# Clang builders.
 
     {'name': "clang-arm64-windows-msvc",
     'tags' : ["clang"],
     'workernames' : ["linaro-armv8-windows-msvc-01", "linaro-armv8-windows-msvc-02"],
     'builddir': "clang-arm64-windows-msvc",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     vs="manual",
                     checkout_flang=True,
-                    test=False, # Disable testing until MCJIT failures are fixed
+                    checks=[], # Disable testing until MCJIT failures are fixed
                     extra_cmake_args=[
                         "-DCMAKE_TRY_COMPILE_CONFIGURATION=Release",
                         "-DLLVM_DEFAULT_TARGET_TRIPLE=aarch64-pc-windows-msvc",
                         "-DLLVM_HOST_TRIPLE=aarch64-pc-windows-msvc",
                         "-DLLVM_TARGET_ARCH=AArch64",
                         # The BUILTINS environment variable is expected to already exist
                         # on the worker when it is launched.
                         "-DCMAKE_EXE_LINKER_FLAGS=%BUILTINS%",
# Clang builders.
     {'name' : "clang-native-arm-lnt-perf",
     'tags'  : ["clang"],
     'workernames':["linaro-tk1-02"],
     'builddir':"clang-native-arm-lnt-perf",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     clean=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=False,
+                    checks=[],
                     runTestSuite=True,
                     testsuite_flags=[
                         '--cppflags', '-O3 -mcpu=cortex-a15 -mthumb',
                         '--threads=1', '--build-threads=4',
                         '--use-perf=all',
                         '--benchmarking-only', '--exec-multisample=3',
                         '--exclude-stat-from-submission=compile'],
                     extra_cmake_args=[
                         "-DLLVM_TARGETS_TO_BUILD='ARM'",
                         "-DLLVM_PARALLEL_LINK_JOBS=2"],
                     submitURL='http://lnt.llvm.org/submitRun',
                     testerName='LNT-Thumb2v7-A15-O3')},
 
     # ARMv7 LNT test-suite in test-only mode
     {'name' : "clang-armv7-lnt",
     'tags'  : ["clang"],
     'workernames' : ["linaro-clang-armv7-lnt"],
     'builddir': "clang-armv7-lnt",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     clean=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=False,
+                    checks=[],
                     runTestSuite=True,
                     testsuite_flags=[
                         '--cppflags', '-mcpu=cortex-a15 -marm',
                         '--threads=32', '--build-threads=32'])},
 
     ## ARMv7 check-all 2-stage
     {'name' : "clang-armv7-2stage",
     'tags'  : ["clang"],
'factory' : ClangBuilder.getClangCMakeBuildFactory(
                         "-DLLVM_LIT_ARGS='-v -j12'"])},
 
     {'name' : "clang-arm64-windows-msvc-2stage",
     'tags'  : ["clang"],
     'workernames' : ["linaro-armv8-windows-msvc-01", "linaro-armv8-windows-msvc-02"],
     'builddir': "clang-arm64-windows-msvc-2stage",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     vs="manual",
-                    test=False, # Disable testing until MCJIT failures are fixed
+                    checks=[], # Disable testing until MCJIT failures are fixed
                     useTwoStage=True,
                     testStage1=False,
                     extra_cmake_args=[
                         "-DCMAKE_TRY_COMPILE_CONFIGURATION=Release",
                         "-DLLVM_DEFAULT_TARGET_TRIPLE=aarch64-pc-windows-msvc",
                         "-DLLVM_HOST_TRIPLE=aarch64-pc-windows-msvc",
                         "-DLLVM_TARGET_ARCH=AArch64",
                         # FIXME: compiler-rt\lib\sanitizer_common\sanitizer_unwind_win.cpp assumes WIN64 is x86_64,
# Clang builders.
     'tags'  : ["clang"],
     'workernames' : ["avx2-intel64"],
     'builddir': "clang-cmake-x86_64-avx2-linux",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     clean=False,
                     checkout_clang_tools_extra=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=True,
                     useTwoStage=False,
                     runTestSuite=True,
                     nt_flags=['--cflag', '-march=broadwell', '--threads=80', '--build-threads=80'],
                     env={'PATH':'/usr/bin/ccache:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'},
                     extra_cmake_args=[
                         "-DLLVM_ENABLE_ASSERTIONS=ON",
                         "-DCMAKE_C_FLAGS='-march=broadwell'",
                         "-DCMAKE_CXX_FLAGS='-march=broadwell'",
                         "-DLLVM_TARGETS_TO_BUILD='X86'"])},
 
     ## X86_64 AVX2 LNT test-suite in Benchmark mode
     {'name' : "clang-cmake-x86_64-avx2-linux-perf",
     'tags'  : ["clang"],
     'workernames' : ["avx2-intel64"],
     'builddir': "clang-cmake-x86_64-avx2-linux-perf",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     clean=False,
                     checkout_clang_tools_extra=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=False,
+                    checks=[],
                     useTwoStage=False,
                     runTestSuite=True,
                     nt_flags=['--cflag', '-march=broadwell', '--threads=1', '--build-threads=80', '--use-perf',
                             '--benchmarking-only', '--multisample=4', '--exclude-stat-from-submission=compile'],
                     env={'PATH':'/usr/bin/ccache:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'},
                     extra_cmake_args=[
                         "-DCMAKE_C_FLAGS='-march=broadwell'",
                         "-DCMAKE_CXX_FLAGS='-march=broadwell'",
                         "-DLLVM_TARGETS_TO_BUILD='X86'"],
                     submitURL='http://lnt.llvm.org/submitRun',
                     testerName='LNT-Broadwell-AVX2-O3')},
 
     ## X86_64 Clang+LLVM Run test-suite targeting AVX512 on SDE (Emulator)
     {'name' : "clang-cmake-x86_64-sde-avx512-linux",
     'tags'  : ["clang"],
     'workernames' : ["sde-avx512-intel64"],
     'builddir': "clang-cmake-x86_64-sde-avx512-linux",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     clean=False,
                     checkout_clang_tools_extra=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=True,
                     useTwoStage=False,
                     runTestSuite=True,
                     nt_flags=['--cflag', '-march=skylake-avx512', '--threads=80',
                         '--build-threads=80', '--make-param', "RUNUNDER=sde64 -skx --", '--make-param', 'USER_MODE_EMULATION=1',
                         '--make-param', 'RUNTIMELIMIT=1200'],
                     env={'PATH':'/home/ssglocal/tools/sde/latest:/usr/bin/ccache:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'},
                     extra_cmake_args=[
                         "-DLLVM_ENABLE_ASSERTIONS=ON",
# Clang builders.
     'tags'  : ["clang"],
     'workernames' : ["xcore-ubuntu20-x64"],
     'builddir': "clang-xcore-ubuntu-20-x64",
     'factory' : ClangBuilder.getClangCMakeBuildFactory(
                     jobs=4,
                     checkout_clang_tools_extra=False,
                     checkout_compiler_rt=False,
                     checkout_lld=False,
-                    test=True,
                     testStage1=True,
                     useTwoStage=False,
                     stage1_config='Release',
                     extra_cmake_args=[
                         "-DLLVM_TARGETS_TO_BUILD:STRING=XCore",
                         "-DLLVM_DEFAULT_TARGET_TRIPLE:STRING=xcore-unknown-unknown-elf",
                         "-DLLVM_ENABLE_THREADS:BOOL=OFF"])},
 

zorg/buildbot/builders/ClangBuilder.py

f.addStep(ShellCommand(
                   command=['gsutil', 'cp', '../install.tar.xz', gcs_url],
                   description=('uploading ' + package_name +
                                'to storage bucket ...'),
                   workdir=install_prefix,
                   env=env))
 
 def getClangCMakeGCSBuildFactory(
             clean=True,
-            test=True,
+            checks=None,
             cmake='cmake',
             jobs=None,
 
             # VS tools environment variable if using MSVC. For example,
             # %VS120COMNTOOLS% selects the 2013 toolchain.
             vs=None,
             vs_target_arch='x86',
 
def getClangCMakeGCSBuildFactory(
             # Use a lower compression level to generate the build-cache package faster.
             # defuault is 6 according to xz documentation
             xz_compression_factor=6,
             use_pixz_compression=False,
 
             # Triggers
             trigger_after_stage1=None):
     return _getClangCMakeBuildFactory(
-               clean=clean, test=test, cmake=cmake, jobs=jobs, vs=vs,
+               clean=clean, checks=checks, cmake=cmake, jobs=jobs, vs=vs,
                vs_target_arch=vs_target_arch, useTwoStage=useTwoStage,
                testStage1=testStage1, stage1_config=stage1_config,
                stage2_config=stage2_config, runTestSuite=runTestSuite,
                nt_flags=nt_flags, testsuite_flags=testsuite_flags,
                submitURL=submitURL, testerName=testerName,
                env=env, extra_cmake_args=extra_cmake_args,
                checkout_clang_tools_extra=checkout_clang_tools_extra,
                checkout_compiler_rt=checkout_compiler_rt,
                checkout_lld=checkout_lld,
                checkout_libcxx=checkout_libcxx,
                stage1_upload_directory=stage1_upload_directory,
                xz_compression_factor=xz_compression_factor,
                use_pixz_compression=use_pixz_compression,
                trigger_after_stage1=trigger_after_stage1)
 
 def getClangCMakeBuildFactory(
             clean=True,
-            test=True,
+            checks=None,
             cmake='cmake',
             jobs=None,
 
             # VS tools environment variable if using MSVC. For example,
             # %VS120COMNTOOLS% selects the 2013 toolchain.
             vs=None,
             vs_target_arch='x86',
 
def getClangCMakeBuildFactory(
             # Extra repositories
             checkout_clang_tools_extra=True,
             checkout_compiler_rt=True,
             checkout_lld=True,
             checkout_libcxx=False,
             checkout_flang=False,
             checkout_test_suite=False):
     return _getClangCMakeBuildFactory(
-               clean=clean, test=test, cmake=cmake, jobs=jobs, vs=vs,
+               clean=clean, checks=checks, cmake=cmake, jobs=jobs, vs=vs,
                vs_target_arch=vs_target_arch, useTwoStage=useTwoStage,
                testStage1=testStage1, stage1_config=stage1_config,
                stage2_config=stage2_config, runTestSuite=runTestSuite,
                nt_flags=nt_flags, testsuite_flags=testsuite_flags,
                submitURL=submitURL, testerName=testerName,
                env=env, extra_cmake_args=extra_cmake_args,
                checkout_clang_tools_extra=checkout_clang_tools_extra,
                checkout_lld=checkout_lld,
                checkout_compiler_rt=checkout_compiler_rt,
                checkout_libcxx=checkout_libcxx,
                checkout_flang=checkout_flang,
                checkout_test_suite=checkout_test_suite)
 
 def _getClangCMakeBuildFactory(
             clean=True,
-            test=True,
+            checks=None,
             cmake='cmake',
             jobs=None,
 
             # VS tools environment variable if using MSVC. For example,
             # %VS120COMNTOOLS% selects the 2013 toolchain.
             vs=None,
             vs_target_arch='x86',
 
def _getClangCMakeBuildFactory(
             # default is 6 according to documentation
             xz_compression_factor=6,
             use_pixz_compression=False,
 
             # Triggers
             trigger_after_stage1=None):
 
     ############# PREPARING
+    if checks is None:
+        checks = ['check-all']
     if nt_flags is None:
         nt_flags = []
     if testsuite_flags is None:
         testsuite_flags = []
     if env is None:
         env = {}
     if extra_cmake_args is None:
         extra_cmake_args = []
def _getClangCMakeBuildFactory(
     lit_args = "'-v"
     if jobs is not None:
         jobs_cmd = ["-j"+str(jobs)]
         lit_args += " -j"+str(jobs)+"'"
     else:
         lit_args += "'"
     ninja_cmd = ['ninja'] + jobs_cmd
     ninja_install_cmd = ['ninja', 'install'] + jobs_cmd
-    ninja_check_cmd = ['ninja', 'check-all'] + jobs_cmd
+    ninja_check_cmd = ['ninja'] + checks + jobs_cmd
 
     # Global configurations
     stage1_build = 'stage1'
     stage1_install = 'stage1.install'
     stage2_build = 'stage2'
     stage2_install = 'stage2.install'
 
     # Set up VS environment, if appropriate.
def _getClangCMakeBuildFactory(
 
     f.addStep(WarningCountingShellCommand(name='build stage 1',
                                           command=ninja_cmd,
                                           haltOnFailure=True,
                                           description='ninja all',
                                           workdir=stage1_build,
                                           env=env))
 
-    if test and testStage1:
+    if checks and testStage1:
         haltOnStage1Check = not useTwoStage and not runTestSuite
         f.addStep(LitTestCommand(name='ninja check 1',
                                  command=ninja_check_cmd,
                                  haltOnFailure=haltOnStage1Check,
                                  description=["checking stage 1"],
                                  descriptionDone=["stage 1 checked"],
                                  workdir=stage1_build,
                                  env=env))
if useTwoStage:
 
         f.addStep(WarningCountingShellCommand(name='build stage 2',
                                               command=ninja_cmd,
                                               haltOnFailure=True,
                                               description='ninja all',
                                               workdir=stage2_build,
                                               env=env))
 
-        if test:
+        if checks:
             f.addStep(LitTestCommand(name='ninja check 2',
                                      command=ninja_check_cmd,
                                      haltOnFailure=not runTestSuite,
                                      description=["checking stage 2"],
                                      descriptionDone=["stage 2 checked"],
                                      workdir=stage2_build,
                                      env=env))