cpp-middle-project-sprint-1

• Начало работы
• Сборка проекта и запуск тестов
  • Команды для сборки проекта
  • Команды для запуска приложения
  • Команда для запуска тестов
  • Команда для запуска clang-format - Обязательное требование перед сдачей работы на ревью
  • Команды для запуска отладчика
• Дополнительно

Шаблон репозитория для практического задания 1-го спринта «Мидл разработчик С++»

Начало работы

1. Нажмите зелёную кнопку Use this template, затем Create a new repository.
2. Назовите свой репозиторий.
3. Склонируйте созданный репозиторий командой git clone your-repository-name.
4. Создайте новую ветку командой git switch -c development.
5. Откройте проект в Visual Studio Code.
6. Нажмите F1 и откройте проект в dev-контейнере командой Dev Containers: Reopen in Container.

Сборка проекта и запуск тестов

Данный репозиторий использует три инструмента:

• Conan — свободный менеджер пакетов для C и C++ с открытым исходным кодом (MIT). Позволяет настраивать процесс сборки программ, скачивать и устанавливать сторонние зависимости и необходимые инструменты. Подробнее о Conan:

  • https://habr.com/ru/articles/884464
  • https://docs.conan.io/2.0/tutorial/consuming_packages/build_simple_cmake_project.html
  • https://docs.conan.io/2.0/tutorial/consuming_packages/the_flexibility_of_conanfile_py.html

• cmake — генератор систем сборки для C и C++. Позволяет создавать проекты, которые могут компилироваться на различных платформах и с различными компиляторами. Подробнее о cmake:

  • https://dzen.ru/a/ZzZGUm-4o0u-IQlb
  • https://neerc.ifmo.ru/wiki/index.php?title=CMake_Tutorial
  • https://cmake.org/cmake/help/book/mastering-cmake/cmake/Help/guide/tutorial/index.html

• VS Code Dev Docker container - Docker контейнер, который содержит полностью настроенное окружение для выполнение задания. Подробнее об этой функциональности:

  • https://habr.com/ru/articles/822707/ - "Почти все, что вы хотели бы знать про Docker"
  • https://code.visualstudio.com/docs/devcontainers/containers - официальная документация VS Code
  • https://www.youtube.com/watch?v=p9L7YFqHGk4 - "Docker container for VS Code"
  • https://www.youtube.com/watch?v=pg19Z8LL06w&t=174s&pp=ygUPRG9ja2VyY29udGFpbmVy - "Docker in 1 hour"

Команды для сборки проекта

Используйте F5 для выполнения следующих шагов:

• Создание папки build
• Вызов conan команд для установки требуемых библиотек и запуска процесса сборки
• Запуска lldb отладчика

Команды для запуска приложения

cd build
echo "Hello OpenSSL crypto world!" > input.txt

./CryptoGuard -i input.txt     -o encrypted.txt -p 1234 --command encrypt
./CryptoGuard -i encrypted.txt -o decrypted.txt -p 1234 --command decrypt

./CryptoGuard -i input.txt     --command checksum
./CryptoGuard -i decrypted.txt --command checksum

Команда для запуска тестов

cd build
./CryptoGuard_tests

Команда для запуска clang-format - Обязательное требование перед сдачей работы на ревью

./run_clang_format.sh

Команды для запуска отладчика

В Visual Studio Code настройки параметров для запуска отладчика находятся в .vscode/launch.json файле. Поскольку в этом файле уже есть одна конфигурация Launch CryptoGuard для запуска приложения, которое вычисляет контрольную сумму файла, то для запуска отладчика достаточно нажать F5 или открыть окно Run and Debug комбинацией клавиш Ctrl+Shift+D.

Дополнительно

• Автодополнение Ctrl + Space. Для настройки автодополнения вам необходимо нажать F1 и выполнить команду clangd: Download language server. VS Code сам предложит установить подходящую версию clangd (всплывашка в правом нижнем углу). После завершения установки потребуется перезагрузить окно (кнопка перезапуска будет находиться также справа снизу или нажать F1 и выполнить команду Developer: Reload Window)

Если всё сделано правильно - после успешной сборки проекта вы сможете использовать автодополнение