ACCU 2022 Demo

Introduction

This project contains examples from my ACCU 2022 presentation, Contractual Disappointment in C++.

Continuous Integration

The project's CI pipeline demonstrates how to maintain high-quality C++ by running automated tests against tools such as:

• AddressSanitizer,
• CppCheck static analyser,
• Clang and GCC compilers,
• Clang Static Analyzer,
• Clang-Tidy C++ linter and static analyser,
• Conan Python-based C++ package manager,
• Include what you use tool to analyze #includes,
• pre-commit linting framework with formatting and correctness checks for:
  • Bash
  • C++
  • CMake
  • JSON
  • Markdown
  • Python
  • YAML
• UndefinedBehaviorSanitizer.
• Valgrind,
• vcpkg CMake-based C++ package manager.

Developers are invited to suggest or add their favourite tools, or to use this project as the starting point for their own C or C++ projects.

Instructions

The project is built and tested on Linux and Windows. It is designed to be easy to build and to run with:

• Conan package manager,
• CMake build system generator,
• A C++20-compatible compiler such as Clang, GCC or MSVC.

Build and Test (Conan)

To build all tests and libraries using Conan on Linux,

1. create an empty build directory,

   mkdir -p build
   cd build/

2. install package dependencies,

   conan install --build=missing <path-to-project>

3. then configure, build, test, and install the programs:

   conan build <path-to-project>

Build and Test (vcpkg)

To build all three utilities using vcpkg on Linux,

1. create an empty build directory,

   mkdir -p build
   cd build/

2. install vcpkg using these instructions,

   git clone https://github.com/Microsoft/vcpkg.git
   ./vcpkg/bootstrap-vcpkg.sh

3. then configure, build, and test the programs:

   cmake -DCMAKE_TOOLCHAIN_FILE=vcpkg/scripts/buildsystems/vcpkg.cmake <path-to-project>
   cmake --build .
   ctest