update tester

CMakeLists.txt

+cmake_minimum_required(VERSION 3.12)
+
+project(image-transformer LANGUAGES C)
+
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+if(CMAKE_C_COMPILER_ID STREQUAL GNU)
+    set(CMAKE_CONFIGURATION_TYPES Debug Release ASan LSan UBSan)
+elseif(CMAKE_C_COMPILER_ID MATCHES Clang)
+    set(CMAKE_CONFIGURATION_TYPES Debug Release ASan LSan MSan UBSan)
+elseif(MSVC)
+    set(CMAKE_CONFIGURATION_TYPES Debug Release ASan)
+endif()
+
+if(CMAKE_BUILD_TYPE AND NOT CMAKE_BUILD_TYPE IN_LIST CMAKE_CONFIGURATION_TYPES)
+    message(FATAL_ERROR "Unexpected build type ${CMAKE_BUILD_TYPE}, possible values: ${CMAKE_CONFIGURATION_TYPES}")
+endif()
+
+if(CMAKE_C_COMPILER_ID STREQUAL GNU OR CMAKE_C_COMPILER_ID MATCHES Clang)
+    set(CMAKE_C_FLAGS       "-std=c17 -pedantic -Wall -Werror -ggdb")
+    set(CMAKE_C_FLAGS_ASAN  "${CMAKE_C_FLAGS_DEBUG} -fsanitize=address -fno-optimize-sibling-calls -fno-omit-frame-pointer")
+    set(CMAKE_C_FLAGS_LSAN  "${CMAKE_C_FLAGS_DEBUG} -fsanitize=leak")
+    set(CMAKE_C_FLAGS_MSAN  "${CMAKE_C_FLAGS_DEBUG} -fsanitize=memory -fno-optimize-sibling-calls -fno-omit-frame-pointer")
+    set(CMAKE_C_FLAGS_UBSAN "${CMAKE_C_FLAGS_DEBUG} -fsanitize=undefined")
+elseif(MSVC)
+    set(CMAKE_C_FLAGS       "/std:c17 /W4 /WX")
+    set(CMAKE_C_FLAGS_ASAN  "${CMAKE_C_FLAGS_DEBUG} /fsanitize=address")
+    set(CMAKE_EXE_LINKER_FLAGS_ASAN "/debug /INCREMENTAL:NO")
+endif()
+
+if(WIN32)
+    add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
+endif()
+
+find_program(CLANG_TIDY clang-tidy)
+message(STATUS "Clang-tidy: ${CLANG_TIDY}")
+if(CLANG_TIDY)
+    file(STRINGS clang-tidy-checks.txt clang_tidy_checks)
+    list(JOIN clang_tidy_checks "," clang_tidy_checks_str)
+    set(CMAKE_C_CLANG_TIDY
+        ${CLANG_TIDY}
+        -header-filter=${CMAKE_SOURCE_DIR}
+        -checks=${clang_tidy_checks_str}
+        -warnings-as-errors=*
+    )
+endif()
+
+add_subdirectory(solution)
+
+option(BUILD_TESTING "Enable tests" ON)
+if(BUILD_TESTING)
+    enable_testing()
+    add_subdirectory(tester)
+endif()

CMakeSettings.json

+{
+  "configurations": [
+    {
+      "name": "x64-Debug",
+      "generator": "Ninja",
+      "configurationType": "Debug",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    },
+    {
+      "name": "x64-Release",
+      "generator": "Ninja",
+      "configurationType": "Release",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    },
+    {
+      "name": "x64-Asan",
+      "generator": "Ninja",
+      "configurationType": "ASan",
+      "inheritEnvironments": [ "msvc_x64_x64" ],
+      "buildRoot": "${projectDir}\\out\\build\\${name}",
+      "installRoot": "${projectDir}\\out\\install\\${name}",
+      "cmakeCommandArgs": "",
+      "buildCommandArgs": "",
+      "ctestCommandArgs": ""
+    }
+  ]
+}
\ No newline at end of file

README.md

@@ -225,15 +225,59 @@ bmp-заголовка.
 ```
 
 - Архитектура приложения описана в предыдущем разделе. 
-- Мы предоставляем вам `Makefile`, который нужно использовать. Заголовочные файлы ищутся в `include`.
-  Ваша программа будет тестироваться с помощью `clang` и проверяться
-  статическим анализатором `clang-tidy`.  Флаги и формат его запуска можно
-  посмотреть
-  [тут](https://gitlab.se.ifmo.ru/low-level-programming/docker-c-test-machine/-/blob/master/to-docker-image/run-checks.sh).
-  Тесты запускаются в
-  [Docker-контейнере](https://gitlab.se.ifmo.ru/low-level-programming/docker-c-test-machine/),
-  вы можете использовать его для тестирования вашего кода локально.
-  Скрипт `run-tests` запускает тесты.
+- Код размещается в директории `solution/src`, заголовочные файлы ищутся в `solution/include`.
+
+## Система сборки и тестирования
+
+Для сборки кода вам предоставлена система сборки на языке CMake, самим писать систему сборки не требуется.
+
+- В зависимости от платформы и компилятора, система сборки поддерживает несколько конфигураций с динамическими
+  анализаторами (санитайзерами). Санитайзеры могут дать подробную информацию о возможных и реальных ошибках в
+  программе вместо классического сообщения о segmentation fault. Выбрать подходящую конфигурацию вы можете с
+  помощью переменной `CMAKE_BUILD_TYPE`:
+
+  - `ASan` — [AddressSanitizer](https://clang.llvm.org/docs/AddressSanitizer.html),
+    набор проверок на некорректное использование адресов памяти. Примеры:
+    use-after-free, double-free, выход за пределы стека, кучи или статического блока.
+
+  - `LSan` — [LeakSanitizer](https://clang.llvm.org/docs/LeakSanitizer.html),
+    проверки на утечки памяти.
+
+  - `MSan` — [MemorySanitizer](https://clang.llvm.org/docs/MemorySanitizer.html),
+    проверяет, что любая используемая ячейка памяти проинициализирована на момент чтения из нее.
+
+  - `UBSan` — [UndefinedBehaviourSanitizer](https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html),
+    набор базовых проверок на неопределенное поведение. Примеры: переполнение численного типа,
+    null-pointer dereference.
+
+- Если в вашей системе имеется статический анализатор `clang-tidy`, он будет запущен во время компиляции программы.
+  Список проверок описан в файле `clang-tidy-checks.txt`. Вы можете добавить свои проверки в конец этого файла.
+
+- Директория `tester` содержит код и изображения для тестирования вашей программы. Для запуска тестов используется CTest.
+
+- Поддержана интеграция системы сборки со средами разработки CLion, Visual Studio и Visual Studio Code.
+
+Чтобы система сборки работала на вашей системе, вам необходимо:
+
+### Linux и MacOS
+
+- Компилятор (`gcc`/`clang`) и `cmake` (проверьте, что `cmake` версии 3.12 или выше)
+- Если вы хотите использовать санитайзеры с GCC, установите `libasan`, `liblsan` и `libubsan` с помощью пакетного менеджера (названия могут отличаться).
+- Если вы хотите использовать санитайзеры с Clang, на некоторых системах вам может понадобиться пакет `compiler-rt`.
+- Если вы хотите пользоваться `clang-tidy`, установите `clang-tools-extra`.
+
+### Windows
+
+- Какая-либо среда разработки (CLion, Visual Studio, Visual Studio Code)
+- Если вы хотите пользоваться `clang-tidy`, скачайте LLVM: https://github.com/llvm/llvm-project/releases (найдите установщик win64 под одной из версий)
+- Для VS Code требуется отдельно поставить Visual Studio (с сайта Microsoft) и CMake: https://cmake.org/download/
+
+### Инструкции по сборке и тестированию
+
+- [Работа с терминалом](docs/Terminal.md)
+- [CLion](docs/CLion.md)
+- [Visual Studio](docs/Visual%20Studio.md)
+- [Visual Studio Code](docs/VSCode.md)
 
 # Для самопроверки
 

clang-tidy-checks.txt

+clang-analyzer-*
+llvm-include-order
+misc-*
+performance-*
+readability-redundant-*
+readability-simplify-*
+readability-const-*
+readability-implicit-bool-*
+readability-identifier-naming
+readability-inconsistent-declaration-parameter-name
+readability-misleading-indentation
+readability-named-parameter
+bugprone-argument-comment
+bugprone-assert-side-effect
+bugprone-bad-signal-to-kill-thread
+bugprone-bool-pointer-implicit-conversion
+bugprone-branch-clone
+bugprone-copy-constructor-init
+bugprone-dangling-handle
+bugprone-dynamic-static-initializers
+bugprone-exception-escape
+bugprone-fold-init-type
+bugprone-forward-declaration-namespace
+bugprone-forwarding-reference-overload
+bugprone-inaccurate-erase
+bugprone-incorrect-roundings
+bugprone-infinite-loop
+bugprone-integer-division
+bugprone-lambda-function-name
+bugprone-macro-parentheses
+bugprone-macro-repeated-side-effects
+bugprone-misplaced-operator-in-strlen-in-alloc
+bugprone-misplaced-pointer-arithmetic-in-alloc
+bugprone-misplaced-widening-cast
+bugprone-move-forwarding-reference
+bugprone-multiple-statement-macro
+bugprone-narrowing-conversions
+bugprone-no-escape
+bugprone-not-null-terminated-result
+bugprone-parent-virtual-call
+bugprone-posix-return
+bugprone-signed-char-misuse
+bugprone-sizeof-container
+bugprone-sizeof-expression
+bugprone-spuriously-wake-up-functions
+bugprone-string-constructor
+bugprone-string-integer-assignment
+bugprone-string-literal-with-embedded-nul
+bugprone-suspicious-enum-usage
+bugprone-suspicious-include
+bugprone-suspicious-memset-usage
+bugprone-suspicious-missing-comma
+bugprone-suspicious-semicolon
+bugprone-suspicious-string-compare
+bugprone-swapped-arguments
+bugprone-terminating-continue
+bugprone-throw-keyword-missing
+bugprone-too-small-loop-variable
+bugprone-undefined-memory-manipulation
+bugprone-undelegated-constructor
+bugprone-unhandled-self-assignment
+bugprone-unused-raii
+bugprone-unused-return-value
+bugprone-use-after-move
+bugprone-virtual-near-miss

cmake-variants.yaml

+buildType:
+  default: debug
+  description: Build Type
+  choices:
+    debug:
+      short: Debug
+      long: Build with debugging information
+      buildType: Debug
+    release:
+      short: Release
+      long: Optimize the resulting binaries
+      buildType: Release
+    asan:
+      short: ASan
+      long: Instrument with AddressSanitizer
+      buildType: ASan
+    lsan:
+      short: LSan
+      long: Instrument with LeakSanitizer
+      buildType: LSan
+    msan:
+      short: MSan
+      long: Instrument with MemorySanitizer
+      buildType: MSan
+    ubsan:
+      short: UBSan
+      long: Instrument with UndefinedBehaviourSanitizer
+      buildType: UBSan

docs/CLion.md

+# Разработка с CLion
+
+## 1. Выберите и склонируйте ваш форк с GitLab
+
+![Select project from VCS](CLion/01-get-from-vcs.png)
+
+## 2. В окне проекта, выберите `CMakeLists.txt` на панели слева
+
+![Load CMake project](CLion/02-load-cmake-project.png)
+
+Сверху окна с редактором появится подсказка, предлагающая загрузить CMake в проект. Нажмите **`Load CMake project`**.
+
+В окне сборки может появиться ошибка, например: `Unexpected build type MSan, possible values: Debug;Release;ASan;LSan;UBSan`.
+Она означает, что данной конфигурации на вашей ОС или с вашим компилятором не предусмотрено,
+но разработке с другими конфигурациями она не помешает.
+
+## 3. Выберите необходимую конфигурацию в раскрывающемся списке
+
+![Choose Config](CLion/03-choose-configuration.png)
+
+- **`Debug`** быстро компилируется и подходит для разработки.
+- **`ASan, LSan, MSan, UBSan`** подходят для отладки ошибок сегментации и других проблем с памятью. Рекомендуется 
+  запустить ваш код с санитайзерами перед отправкой на проверку!
+- **`Release`** нужен для сборки кода с оптимизациями и проверки скорости выполнения.
+
+В качестве цели для сборки выберите **`All CTest`**. Теперь вы можете собирать проект и
+запускать его через кнопки сверху справа как обычно.
+
+Если при сборке вы получили ошибку вроде `C:\CLion 2022.2.4\bin\mingw\bin/ld.exe: cannot find -lasan`, значит, у вас
+нет нужной библиотеки для запуска данного профиля. Можете просто выбрать другую конфигурацию.

docs/Terminal.md

+# Работа с терминалом
+
+## 1. Конфигурация
+
+```bash
+$ mkdir ./build/
+$ cd ./build/
+$ cmake .. -DCMAKE_BUILD_TYPE=<config>
+```
+
+Вместо `<config>` можно использовать одну из существующих конфигураций:
+
+- **`Debug`** быстро компилируется и подходит для разработки.
+- **`ASan, LSan, MSan, UBSan`** подходят для отладки ошибок сегментации и других проблем с памятью. Рекомендуется 
+  запустить ваш код с санитайзерами перед отправкой на проверку!
+- **`Release`** нужен для сборки кода с оптимизациями и проверки скорости выполнения.
+
+## 2. Сборка
+
+```bash
+$ cmake --build ./build/
+```
+
+Исполняемые файлы `./build/solution/image-transformer` и `./build/tester/image-matcher`
+будут собраны, их можно использовать для ручного тестирования.
+
+## 3. Тестирование
+
+```bash
+$ cmake --build ./build/ --target check
+# ИЛИ
+$ cd ./build/
+$ ctest --output-on-failure
+```
+
+## Бонус: `ssh` + `git`
+
+### Как настроить SSH ключи
+
+```bash
+$ ssh-keygen
+$ cat ~/.ssh/id_rsa.pub
+```
+
+В настройках профиля GitLab нужно открыть категорию `SSH Keys`, добавить новый
+ключ и скопировать содержимое `id_rsa.pub` туда.
+
+### Как склонировать форк
+
+```bash
+$ git clone ssh://git@gitlab.se.ifmo.ru:4815/<my username>/assignment-image-rotation.git
+$ cd ./assignment-image-rotation/
+```
+
+### Как отправить свои изменения обратно в форк
+
+```bash
+$ git add ./solution/
+$ git status
+$ git commit -m "Lab complete"
+$ git push origin master
+```
+
+После того, как вы откроете merge request, каждое новое изменение, добавленное таким образом,
+будет появляться там автомагически.
+
+### Как обновить свою лабораторную, если преподаватель попросил "подтянуть к себе свежие изменения" из основного репозитория
+
+```bash
+$ git remote add upstream ssh://git@gitlab.se.ifmo.ru:4815/programming-languages/assignment-image-rotation.git
+$ git fetch upstream
+$ git checkout master
+$ git merge upstream/master
+$ git remote remove upstream
+```

docs/VSCode.md

+# Разработка с Visual Studio Code
+
+Для разработки требуются расширения:
+
+- **`CMake`** от `twxs` 
+- **`CMakeTools`** от `Microsoft` 
+- **`C/C++`** от `Microsoft` 
+
+Перезагрузите VSCode после установки расширений.
+
+## 1. Выберите и склонируйте ваш форк с GitLab
+
+![Clone repository](VSCode/01-clone.png)
+
+## 2. В окне проекта, выберите компилятор
+
+![Choose Kit](VSCode/02-choose-kit.png)
+
+VSCode предложит выбрать компилятор при открытии проекта. Если он этого не сделал,
+кликните по кнопке с гаечным ключом на нижней панели.
+
+На Windows, вероятнее всего, вам нужен компилятор `Visual Studio` с версией `amd64`.
+
+## 3. Выберите конфигурацию на нижней панели
+
+![Choose Config](VSCode/03-choose-config.png)
+
+- **`Debug`** быстро компилируется и подходит для разработки.
+- **`ASan, LSan, MSan, UBSan`** подходят для отладки ошибок сегментации и других проблем с памятью. Рекомендуется 
+  запустить ваш код с санитайзерами перед отправкой на проверку!
+- **`Release`** нужен для сборки кода с оптимизациями и проверки скорости выполнения.
+
+На той же нижней панели, используйте кнопку **`Build`** для сборки кода и **`Run CTests tests`** для запуска тестов.
+
+Если во время сборки вы видите ошибку вроде `...\Microsoft.CppBuild.targets(457,5): error MSB8013: This project doesn't contain the Configuration and Platform combination of MSan|x64`, это означает что выбранная конфигурация на вашей системе не поддержана - выберите другую.

docs/Visual Studio.md

+# Разработка с Visual Studio
+
+## 1. Выберите и склонируйте ваш форк с GitLab
+
+![Select project from VCS](VS/01-vcs.png)
+
+## 2. В окне решения, выберите `Folder View` на панели слева
+
+![Select Folder View](VS/02-folder-view.png)
+
+Visual Studio запустит конфигурацию проекта с помощью CMake в профиле по умолчанию (**`x64-Debug`**).
+
+## 3. Выберите необходимую конфигурацию в раскрывающемся списке
+
+![Choose Config](VS/03-choose-config.png)
+
+- **`x64-Debug`** быстро компилируется и подходит для разработки.
+- **`x64-Asan`** подходит для отладки ошибок сегментации и других проблем с памятью. Рекомендуется 
+  запустить ваш код в Asan перед отправкой на проверку!
+- **`x64-Release`** нужен для сборки кода с оптимизациями и проверки скорости выполнения.
+
+## 4. Используйте панели сверху для запуска сборки и тестирования
+
+![Run build and tests](VS/04-tests.png)
+
+- Варианты для сборки находятся в меню **`Build`**. Для сборки всего решения нажмите **`F7`**.
+- Для запуска тестов выберите **`Run CTests for ...`** в меню **`Test`**.

run-tests

-echo "--------------------"
-echo "Building tester"
-echo "--------------------"
-
-make -C tester
-
-echo "Compiling and testing with sanitizers"
-
-sanitizers=( '-fsanitize=leak -fsanitize=address'
-             '-fsanitize=memory -fsanitize-memory-track-origins=2' 
-             '-fsanitize=undefined'
-           )
-
-
-COMPARE_TEST_RESULTS=./tester/build/bmp-compare 
-
-for sanitizer in "${sanitizers[@]}"
-do 
-  echo "--------------------"
-  echo "Starting tests with the following sanitizer enabled: $sanitizer"
-  echo "--------------------"
-  make -C solution clean && make -C solution with="$sanitizer"  || { echo "Unable to compile; see log" ; exit 1 ; } 
-
-# Here we launch tests
-
-  for test in `ls tester/tests/* -d` ;
-  do
-    fst="$test/input.bmp" 
-    snd="$test/output.bmp"
-    expected="${snd/.bmp/_expected.bmp}"
-
-    ./solution/build/image-transformer "$fst" "$snd"
-
-    echo -e "\ncomparing: $snd and $expected"
-
-    $COMPARE_TEST_RESULTS "$snd" "$expected" && echo -e "OK\n" || exit 1 ;
-  
-  done 
-# tests end
-
-  
-echo ""
-
-done
-