diff options
Diffstat (limited to 'doc/dev_ref/continuous_integration.rst')
| -rw-r--r-- | doc/dev_ref/continuous_integration.rst | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/dev_ref/continuous_integration.rst b/doc/dev_ref/continuous_integration.rst new file mode 100644 index 000000000..504435c75 --- /dev/null +++ b/doc/dev_ref/continuous_integration.rst @@ -0,0 +1,85 @@ +Continuous Integration and Automated Testing +=============================================== + +CI Build Script +---------------- + +The Travis and AppVeyor builds are orchestrated using a script +``src/scripts/ci_build.py``. This allows one to easily reproduce the +build steps of CI on a local machine. + +A seperate repo https://github.com/randombit/botan-ci-tools holds +binaries which are used by the CI. + +Travis CI +----------- + +https://travis-ci.org/randombit/botan + +This is the primary CI, and tests the Linux, macOS, and iOS builds. Among other +things it runs tests using valgrind, cross compilation to different +architectures (currently ARM, PowerPC and MIPS), MinGW build, and the a build +that produces the coverage report. + +The Travis configurations is in ``src/scripts/ci/travis.yml``, which executes a +setup script ``src/scripts/ci/setup_travis.sh`` to install needed packages. +Then ``src/scripts/ci_build.py`` is invoked. + +AppVeyor +---------- + +https://ci.appveyor.com/project/randombit/botan + +Runs a build/test cycle using MSVC on Windows. Like Travis it uses +``src/scripts/ci_build.py``. The AppVeyor setup script is in +``src/scripts/ci/setup_appveyor.bat`` + +The AppVeyor build uses ``sccache`` as a compiler cache. Since that is not +available in the AppVeyor images it takes a precompiled copy checked into the +``botan-ci-tools`` repo. + +Kullo CI +---------- + +This was the initial CI system and tests Linux, macOS, Windows, and Android +builds. Notably this is currently the only CI system Botan uses which has an +Android build enabled. It does not use ``ci_build.py``. This system is +maintained by @webmaster128 + +LGTM +--------- + +https://lgtm.com/projects/g/randombit/botan/ + +An automated linter that is integrated with Github. It automatically checks each +incoming PR. It also supports custom queries/alerts, which likely would be useful. + +Coverity +--------- + +https://scan.coverity.com/projects/624 + +An automated source code scanner. Use of Coverity scanner is rate-limited, +sometimes it is very slow to produce a new report, and occasionally the service +goes offline for days or weeks at a time. New reports are kicked off manually by +rebasing branch ``coverity_scan`` against the most recent master and force +pushing it. + +Sonar +------- + +https://sonarcloud.io/dashboard?id=botan + +Sonar scanner is another software quality scanner. Unfortunately a recent update +of their scanner caused it to take over an hour to produce a report which caused +Travis CI timeouts, so it has been disabled. It should be re-enabled to run on +demand in the same way Coverity is. + +OSS-Fuzz +---------- + +https://github.com/google/oss-fuzz/ + +OSS-Fuzz is a distributed fuzzer run by Google. Every night, each library fuzzer +in ``src/fuzzer`` is built and run on many machines with any findings reported +by email. |