Lab06.Report

Laboratory work VI

Данная лабораторная работа посвещена изучению фреймворков для тестирования на примере Catch

$ open https://github.com/philsquared/Catch

Tasks

1. Создать публичный репозиторий с названием lab06 на сервисе GitHub
2. Выполнить инструкцию учебного материала
3. Ознакомиться со ссылками учебного материала
4. Составить отчет и отправить ссылку личным сообщением в Slack

Tutorial

Устанавливаем переменную окружения

$ export GITHUB_USERNAME=<имя_пользователя>
$ alias gsed=sed # for *-nix system

Используем ранее созданный скрипт (Lab02)

$ cd ${GITHUB_USERNAME}/workspace
$ pushd .
$ source scripts/activate

Клонируем существующий репозиторий и переключаемся на ветку lab06

$ git clone https://github.com/${GITHUB_USERNAME}/lab05 projects/lab06
$ cd projects/lab06
$ git checkout lab06

Скачиваем заголовочный файл фреймворка для тестирования Catch

$ mkdir tests
$ wget https://github.com/philsquared/Catch/releases/download/v2.2.1/catch.hpp -O tests/catch.hpp
$ cat > tests/main.cpp <<EOF
#define CATCH_CONFIG_MAIN
#include "catch.hpp"
EOF

Производим изменения в CMakeLists.txt

# редактируем каждую строку в соответствии с правилами
$ gsed -i '/option(BUILD_EXAMPLES "Build examples" OFF)/a\
option(BUILD_TESTS "Build tests" OFF)
' CMakeLists.txt
$ cat >> CMakeLists.txt <<EOF

if(BUILD_TESTS)
	enable_testing()
	file(GLOB \${PROJECT_NAME}_TEST_SOURCES tests/*.cpp)
	add_executable(check \${\${PROJECT_NAME}_TEST_SOURCES})
	target_link_libraries(check \${PROJECT_NAME} \${DEPENDS_LIBRARIES})
	add_test(NAME check COMMAND check "-s" "-r" "compact" "--use-colour" "yes") 
endif()
EOF

Создаем файл тестового сценария

$ cat >> tests/test1.cpp <<EOF
#include "catch.hpp"
#include "print.hpp"

TEST_CASE("output values should match input values", "[file]") {
  std::string text = "hello";
  std::ofstream out("file.txt");
  
  print(text, out);
  out.close();
  
  std::string result;
  std::ifstream in("file.txt");
  in >> result;
  
  REQUIRE(result == text);
}
EOF

Собираем проект и производим тестирование

$ cmake -H. -B_build -DBUILD_TESTS=ON
$ cmake --build _build
$ cmake --build _build --target test # получаем результат теста
$ Running tests...
$ Test project /lab06/_build
$     Start 1: check
$ 1/1 Test #1: check ............................   Passed    0.00 sec
$
$ 100% tests passed, 0 tests failed out of 1
$
$ Total Test time (real) =   0.00 sec

Тестируем, выводя краткий и подробный отчет

$ _build/check -s -r compact # компактный вывод теста
$ /lab06/tests/test1.cpp:15: passed: result == text for: "hello" == "hello"
$ Passed 1 test case with 1 assertion.
$ cmake --build _build --target test -- ARGS=--verbose # подробный отчет тестирования

Добавляем в .travis.yml дополнительную команду для сборки и тестирования проекта

$ sed -i 's/lab05/lab06/g' README.md
$ sed -i 's/\(DCMAKE_INSTALL_PREFIX=_install\)/\1 -DBUILD_TESTS=ON/' .travis.yml
$ sed -i '/cmake --build _build --target install/a\
- cmake --build _build --target test -- ARGS=--verbose
' .travis.yml

Проверяем .travis.yml на наличие ошибок

$ travis lint

Отправляем все изменения в репозиторий

$ git add .
$ git commit -m"added tests"
$ git push origin master

Запускаем сервис travis для сборки данного проекта

$ travis login --auto
$ travis enable

Создаем скриншот и сохраняем его в директории artifacts

$ mkdir artifacts
$ sleep 20s && gnome-screenshot --file artifacts/screenshot.png
# for macOS: $ screencapture -T 20 artifacts/screenshot.png
# open https://github.com/${GITHUB_USERNAME}/lab06

Links

Copyright (c) 2017 Братья Вершинины

blockspacer/REPORT.md

Select an option