ApiOpenStudio uses both unit and functional tests. These are run during the pull request and merge phases of the development lifecycle.
Therefore, it is important that you validate that all tests pass before committing and creating a merge request (otherwise the merge request will fail).
From a developers point of view, this means that they can immediately see if the pull request is unstable and the code will not be able to merge until all tests pass.
The tests include:
Tests are run using Codeception and PHP CodeSniffer. You can run these tests using [GitLab Runner][setup_gitlab_runner] or [inside a running instance of ApiOpenStudio][run_tests_outside_gitlab_runner].
The best and most effective way is to run tests using gitlab-runner
, because this will simulate the exact testing that GitLab pipelines will run.