[analyzer] SATest: Add initial docker infrastructure

[vsavchenko]

Summary

Static analysis is very sensitive to environment.
OS and libraries installed can affect the results. This fact makes
it extremely hard to have a regression testing system that will
produce stable results.

For this very reason, this commit introduces a new dockerized testing
environment, so that every analyzer developer can check their changes
against previous analysis results.

[NoQ]

clang/utils/analyzer/Dockerfile

10

Ouch. I'm pretty bad with docker but is it possible to simply take a newer ubuntu?

15

Maybe put apt-get update on a separate line?

Also i think you mentioned offline that you want to freeze package versions here, can you add a FIXME?

clang/utils/analyzer/entrypoint.py

31

-DLLVM_ENABLE_ASSERTIONS=ON???

35

I think this one's on by default but i guess it wouldn't hurt^^

[NoQ]

clang/utils/analyzer/Dockerfile

15

can you add a FIXME?

Wait, you already did that in D81600, nvm.

[vsavchenko]

clang/utils/analyzer/Dockerfile

10

This is the latest LTS version of Ubuntu. And actually that was one of the reasons I migrated to Fedora in my later pre-macOS years, Ubuntu is pretty bad with maintaining newer versions of packages.

15

It is actually one of the good practices for writing Docker files and related to the Docker's build cache.

It is even recommended to do every apt-related stuff on the same line. I went with one decision in between:
https://forums.docker.com/t/dockerfile-run-apt-get-install-all-packages-at-once-or-one-by-one/17191

clang/utils/analyzer/entrypoint.py

31

I was thinking about adding a separate list of options specifically for building. Assertions can significantly affect performance and I don't know if that should be a default.

[NoQ]

Ok then!

clang/utils/analyzer/entrypoint.py

31

I still think assertions should be on by default; it's much worse when somebody accidentally tests a logic-related patch without assertions than when somebody tests a performance-related patch with assertions.

clang/utils/analyzer/Dockerfile

+FROM ubuntu:bionic
+
+RUN apt-get update && apt-get install -y \
+    apt-transport-https \
+    ca-certificates \
+    gnupg \
+    software-properties-common \
+    wget
+
+# newer CMake is required by LLVM
+RUN wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null
+RUN apt-add-repository -y 'deb https://apt.kitware.com/ubuntu/ bionic main'
+
+# test system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    gettext \
+    python3 \
+    python3-pip \
+    cmake \
+    ninja-build
+
+# box2d dependencies
+RUN apt-get install -y \
+    libx11-dev \
+    libxrandr-dev \
+    libxinerama-dev \
+    libxcursor-dev \
+    libxi-dev
+
+# symengine dependencies
+RUN apt-get install -y \
+    libgmp10 \
+    libgmp-dev
+
+RUN update-alternatives --install /usr/bin/python python /usr/bin/python3 1
+
+VOLUME /analyzer
+VOLUME /projects
+VOLUME /llvm-project
+VOLUME /build
+VOLUME /scripts
+
+ENV PATH="/analyzer/bin:${PATH}"
+
+ADD entrypoint.py /entrypoint.py
+
+# Uncomment in case of requirements
+# ADD requirements.txt /requirements.txt
+# RUN pip3 install -r /requirements.txt
+
+ENTRYPOINT ["python", "/entrypoint.py"]

clang/utils/analyzer/entrypoint.py

+import argparse
+import os
+
+from typing import List, Tuple
+
+from subprocess import check_call
+
+
+def main():
+    settings, rest = parse_arguments()
+    if settings.build_llvm or settings.build_llvm_only:
+        build_llvm()
+    if settings.build_llvm_only:
+        return
+    test(rest)
+
+
+def parse_arguments() -> Tuple[argparse.Namespace, List[str]]:
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--build-llvm', action='store_true')
+    parser.add_argument('--build-llvm-only', action='store_true')
+    return parser.parse_known_args()
+
+
+def build_llvm() -> None:
+    os.chdir('/build')
+    cmake()
+    ninja()
+
+
+CMAKE_COMMAND = "cmake -G Ninja -DCMAKE_BUILD_TYPE=Release " \
+    "-DCMAKE_INSTALL_PREFIX=/analyzer -DLLVM_TARGETS_TO_BUILD=X86 " \
+    "-DLLVM_ENABLE_PROJECTS=clang -DLLVM_BUILD_RUNTIME=OFF " \
+    "-DLLVM_ENABLE_TERMINFO=OFF -DCLANG_ENABLE_ARCMT=OFF " \
+    "-DCLANG_ENABLE_STATIC_ANALYZER=ON"
+
+
+def cmake():
+    check_call(CMAKE_COMMAND + ' /llvm-project/llvm', shell=True)
+
+
+def ninja():
+    check_call("ninja install", shell=True)
+
+
+def test(args: List[str]):
+    os.chdir("/projects")
+    check_call("/scripts/SATest.py " + " ".join(args), shell=True)
+
+
+if __name__ == '__main__':
+    main()