clang-tidy docker image for Mesos

This directory contains tooling to build a docker image to run clang-tidy checks over a Mesos repository. It uses a customized version of clang-tidy which is augmented with Mesos-specific checks.

IMPORTANT: This directory is intended for maintainers of mesos-tidy checks. Users should reach for support/mesos-tidy.sh.

Building the docker image

Building the image involves compiling a Mesos-flavored version of clang-tidy, installing Mesos dependencies, and installation of tools to drive check invocations.

The image can be built with:

$ docker build -t mesos-tidy .

On an M1 Mac, you may need to pass --platform to avoid an error with qemu-x86_64: Could not open '/lib64/ld-linux-x86-64.so.2': No such file or directory:

$ docker build -t mesos-tidy --platform linux/amd64 .

A pre-built image is available via Docker Hub as mesos/mesos-tidy.

Running checks

To run checks over a Mesos checkout invoke

$ docker run \
      --platform linux/amd64 \
      --rm \
      -v <MESOS_CHECKOUT>:/SRC \
      [-e CHECKS=<CHECKS>] \
      [-e CMAKE_ARGS=<CMAKE_ARGS>] \
      mesos-tidy

If running on macOS, it will run out of memory by default and you need to constrain the JOB count, for example:

docker run --rm -v <MESOS_CHECKOUT>:/SRC --platform linux/amd64 --env JOBS=4 --memory 32GB mesos-tidy

Here MESOS_CHECKOUT points to a git checkout of the Mesos source tree.

Additional configure parameters can be passed to the cmake invocation of Mesos via CMAKE_ARGS. By default, cmake will be invoked with -DCMAKE_BUILD_TYPE=Release and -DCMAKE_EXPORT_COMPILE_COMMANDS=ON.

Optionally, the set of checks to perform can be specified in a clang-tidy check regex via CHECKS.

Results from 3rdparty external dependencies are filtered from the result set.