[analyzer] SATest: Ensure Docker image can be built

[mantognini]

Summary

Solve build issues occurring when running docker build.

Fix the version of cmake-data to solve the following issue:

The following packages have unmet dependencies:
 cmake : Depends: cmake-data (= 3.20.5-0kitware1) but 3.23.1-0kitware1ubuntu18.04.1 is to be installed

Install libjpeg to solve this issue when installing Python
requirements:

The headers or library files could not be found for jpeg,
a required dependency when compiling Pillow from source.

[mantognini]

This patch relates to my previous comment: https://reviews.llvm.org/D124621#3485799

[steakhal]

LGTM;
So you have used this tool. Could you add some notes somewhere on how to get this to work?
What is the workflow?
Is it documented anywhere?

I know that's an unrelated topic, but I might consider using/integrating this stuff into our workflow.

[mantognini]

In D126196#3533678, @steakhal wrote:

LGTM;
So you have used this tool. Could you add some notes somewhere on how to get this to work?
What is the workflow?
Is it documented anywhere?

I know that's an unrelated topic, but I might consider using/integrating this stuff into our workflow.

Thanks for the review.

It's kind of underdocumented at the moment. Happy to share here the commands I've run. I'm not planning to update a README file at this point as I believe --help messages from various scripts should be clarified too to avoid conflicting/confusing information. Unfortunately, I don't have the bandwidth at the moment to do that properly.

Essentially, I've run this to 1) build the docker image, 2) create some docker volume for persistent storage, and 3) open a shell in a docker container.

python3 ./clang/utils/analyzer/SATest.py docker --build-image
docker volume create --name satest-build
docker volume create --name satest-install
python3 ./clang/utils/analyzer/SATest.py docker \
  --build-dir satest-build --clang-dir satest-install --llvm-project-dir $(pwd) \
  --shell

Then, in that container, I've run essentially this to generate the reference data (mind the final -r):

python /entrypoint.py --build-llvm-only
cd /projects
python /scripts/SATest.py build [--projects cxxopts,...] [-j 10] -v -r

Then, to test some changes, I check out the relevant patch and re-run the above without -r to build and compare the results.

(I guess it should be possible to do all this without manually running commands in the container shell, but I haven't figured out how.)

I hope this helps.

clang/utils/analyzer/Dockerfile

 
 # test system dependencies
 RUN apt-get update && apt-get install -y \
     git=1:2.17.1* \
     gettext=0.19.8.1* \
     python3=3.6.7-1~18.04 \
     python3-pip=9.0.1-2.3* \
     cmake=3.20.5* \
+    cmake-data=3.20.5* \
     ninja-build=1.8.2-1
 
 # box2d dependencies
 RUN apt-get install -y \
     libx11-dev=2:1.6.4-3* \
     libxrandr-dev=2:1.5.1-1 \
     libxinerama-dev=2:1.1.3-1 \
     libxcursor-dev=1:1.1.15-1 \
RUN apt-get install -y \
     autotools-dev=20180224.1 \
     automake=1:1.15.1-3* \
     libncurses5-dev=6.1-1* \
     libevent-dev=2.1.8* \
     pkg-config=0.29.1-0* \
     flex=2.6.4-6 \
     bison=2:3.0.4.*
 
+RUN apt-get install -y \
+    libjpeg-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
 
 ADD requirements.txt /requirements.txt
 RUN pip3 install -r /requirements.txt
 
 ENTRYPOINT ["python", "/entrypoint.py"]