Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 3.37 KB

continuous-integration.md

File metadata and controls

81 lines (57 loc) · 3.37 KB
Raw

Continuous Integration

Github Actions is used for continuous integration of CosmoScout VR. The file build.yml describes which jobs are run whenever a commit is pushed or a pull request is opened.

Clang-Format Check

We enforce specific code formatting rules described in the file .clang-format. For each and every push event, a job is executed which checks whether the code base obeys these rules.

Commits passing this check will be marked with a ✔️, when the style does not match the rules, the commit will receive a ❌.

Comment Percentage Check

For pull requests only, a job is run which analyses the amount of comments in the source tree. Therefore the percentage of source lines of code containing comments is calculated with the script cloc.sh and compared with the amount of comments in the base branch.

This test will pass if the amount of comments did not decrease.

Builds of CosmoScout VR

Github Actions is also used to compile the code of CosmoScout VR and all of its dependencies. As this job takes quite some time, it is only executed for the events below:

  • For each push to main if the commit message does not contain [no-ci].
  • For each push to any branch if commit message contains [run-ci].
  • For pull requests.

The code is compiled on Ubuntu (with GCC and Clang) and on Windows (with MSVC). Tests are executed on all platforms and the results are uploaded to coveralls.io.

Both, the externals and CosmoScout's code itself is built with ccache and clcache in order to speed up build times by a factor of five. Between job runs, the object file cache is stored with the cache action.

Unit Tests

In CosmoScout VR, unit testing is done with doctest. Tests are executed for every build, so the same behavior of [no-ci] and [run-ci] as above applies here. There are two types of test cases, regular tests and graphical tests.

Regular Tests

Regular tests require no OpenGL and no window. You can run them with the following scripts.

Linux:

./install/linux-Release/bin/run_tests.sh

Windows:

install\windows-Release\bin\run_tests.bat

Graphical Tests

These tests require an OpenGL context and will open a window. Oftentimes they capture a screenshot and compare the result to a reference image.

In order to make them possible even if there is no graphics card or display attached, they require Xvfb and imagemagick to be installed on your system. Graphical tests can only be executed on Linux for now:

./install/linux-Release/bin/run_graphical_tests.sh

‹ Release Management ⌂ Help Index