yzharko / spbspu-labs-2024-aads

Лабораторные работы по дисциплине "Алгоритмы и Структуры Данных" групп ПИ[1 | 5 | 6]

Лабораторные работы

Правила

• Каждый студент размещает свои работы в каталоге со своим именем на английском языке, строчными буквами и разделив фамилию и имя точкой, например, "lastname.firstname".

• Каждая работа должна находиться в каталоге, имя которого представляет собой объединение заглавной латинской буквы, обозначающей читаемый курс ("P" для АиП, "S" для АиСД, "T" для ТП) и номера работы, например, "lastname.firstname/S1" для первой работы по АиСД.

• Все работы должны быть быть написаны в рамках стандарта C++ 14.

• Сроком сдачи работы является дата отправки Pull Request.

• Каждая работа должна быть выполнена в отдельном Pull Request. Соответственно, не допускаются следующие ситуации:

  • более одной работы внутри Pull Request, но, если работа требует исправления уже сданных работ, такие изменения должны быть выполнены в том же Pull Request, так как поддерживают корректность проекта;

  • несколько Pull Request для одной и той же работы, за исключением предыдущего пункта, так как каждый Pull Request обеспечивает отслеживание истории изменений и приема работы.

• Изменения в Pull Request должны быть выполнены относительно самого свежего коммита в ветке "master" основного проекта. Достигается это операциями "merge" и "rebase" (см. документацию по Git).

• Каждый коммит должен:

  • содержать логически единое изменение;

  • обладать комментарием, из которого понятно что (в первой строке) и зачем (описание после пустой строки) было сделано;

  • успешно компилироваться и компоноваться;

  • проходить unit-тесты, если они есть;

  • крайне желательно проходить приемочные тесты.

  Категорически не допускается "брать штурмом" систему, создавая множество коммитов путем подбора символов в исходных программах, которые смогут, наконец, скомпилироваться.

• На проекте используется Continuous Integration (CI), соответственно, сборка и тестирование выполняются автоматически. Коммиты, не прошедшие CI (с ошибкой или пропустившие CI) не принимаются. Результаты тестирования доступны в виде архива артефактов сборки и могут быть получены по ссылке "Download acceptance artifacts" Web UI, указанной либо в коммите, либо в CI pipeline.

Сборка работ

Для сборки и запуска работ присутствует Makefile для GNU Make. Все работы автоматически обнаруживаются и могут быть построены с использованием нескольких целей.

Идентификатором каждой работы является строка lastname.firstname/labnumber, на которую в дальнейшем ссылаются при помощи labid.

Все исходные тексты в каждой работе идентифицируются по расширению "cpp". Обнаруженные исходные тексты делятся на группы:

• Исходные тексты работы: все файлы, имена которых не начинаются с "test-".

• Исходные тексты тестов: все файлы, исключая файл "main.cpp".

Как видно, файл "main.cpp" стоит особняком: его назначение - функция main() выполненной работы.

Makefile автоматически строит программу для каждой работы. Так как имя программы в общем случае неизвестно, специальная цель выполняет запуск построенной программы с передачей параметров.

Общие файлы для нескольких работ должны размещаться в подкаталоге "common" своего каталога. Они будут автоматически добавлены при сборке работы. Внутри каталога "common" допустимо создавать подкаталоги для организации файлов.

Поддерживаемые цели:

• build-labid: построение лабораторной работы, например

    $ make build-ivanov.ivan/S2
  

• run-labid: запуск построенной программы, например

    $ make run-ivanov.ivan/S2
  

  Для передачи дополнительных параметров используется переменная ARGS (при помощи GNU Make):

    $ make run-ivanov.ivan/S1 ARGS="1 ascending"
  

  или (c использованием Bourne Shell):

    $ ARGS="1 ascending" make run-ivanov.ivan/S1
  

  или (Bourne Shell, с сохранением в окружении процесса):

    $ export ARGS="1 ascending"
    $ make run-ivanov.ivan/S1
  

• test-labid: сборка и запуск тестов работы:

    $ make test-ivanov.ivan/S3
  

  Переменная TEST_ARGS используется для передачи параметров тестам аналогично ARGS.

• labs: список всех лабораторных в проекте.

Дополнительной возможностью является запуск динамического анализатора Valgrind для запускаемых программ. Для этого необходимо указать в переменной VALGRIND параметры анализатора так, как это делается для ARGS/TEST_ARGS.

Boost

Библиотека Boost может находиться в нестандартном месте. Для того, чтобы указать его, в корне проекта необходимо разместить файл .boost_location, состоящий из одной строки с путем к корню библиотеки.

Путь не должен содержать пробельные символы.