Skip to content

Latest commit

 

History

History
339 lines (211 loc) · 16.9 KB

jobs.md

File metadata and controls

339 lines (211 loc) · 16.9 KB

CI pipeline

(Generated automatically by tools/generate_ci_docs.py. Do not edit by hand.)

It consists of multiple stages below, each having one or more jobs Latest CI pipeline of master branch can be seen at https://gitlab.com/satoshilabs/trezor/trezor-firmware/-/pipelines/master/latest

ENVIRONMENT stage - environment.yml

Connected with creating the testing image for CI.

Consists of 3 jobs below:

Environment job builds the ci/Dockerfile and pushes the built docker image into our GitLab registry. Since modifications of this Dockerfile are very rare this is a manual job which needs to be triggered on GitLab. Almost all CI jobs run inside this docker image.


PREBUILD stage - prebuild.yml

Static checks on the code.

Consists of 6 jobs below:

Check the code for style correctness and perform some static code analysis. Biggest part is the python one - using flake8, isort, black, pylint and pyright, also checking Rust files by rustfmt and C files by clang-format. Changelogs formats are checked.

Check validity of coin definitions and protobuf files.

Check validity of auto-generated files.

Checking format of .editorconfig files.

Checking the format of release commit messages.

Verifying that all commits changing some functionality have a changelog entry or contain [no changelog] in the commit message.


BUILD stage - build.yml

All builds are published as artifacts so they can be downloaded and used.

Consists of 33 jobs below:

Build of Core into firmware. Regular version. Are you looking for Trezor T firmware build? This is most likely it.

Build of Core into firmware with enabled debug mode. In debug mode you can upload mnemonic seed, use debug link etc. which enables device tests. Storage on the device gets wiped on every start in this firmware.

Build of Core into firmware. Bitcoin-only version.

Non-frozen emulator build. This means you still need Python files present which get interpreted.

Non-frozen emulator build for model R.

Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly.

Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly. See Emulator for more info. Debug mode enabled, Bitcoin-only version.

Build of Core into UNIX emulator. Something you can run on your laptop. Frozen version. That means you do not need any other files to run it, it is just a single binary file that you can execute directly. Are you looking for a Trezor T emulator? This is most likely it.

Build of our cryptographic library, which is then incorporated into the other builds.

Regular version (not only Bitcoin) of above. Are you looking for a Trezor One emulator? This is most likely it.

Build of Legacy into UNIX emulator. Use keyboard arrows to emulate button presses. Bitcoin-only version.


TEST stage - test.yml

All the tests run test cases on the freshly built emulators from the previous BUILD stage.

Consists of 39 jobs below:

Python unit tests, checking core functionality.

Python unit tests, checking core functionality. For model R.

Rust unit tests.

Device tests for Core. Running device tests and also comparing screens with the expected UI result. See artifacts for a comprehensive report of UI. See docs/tests/ui-tests for more info.

Device tests excluding altcoins, only for BTC.

Monero tests.

Tests for U2F and HID.

FIDO2 device tests.

Click tests - UI. See docs/tests/click-tests for more info.

Click tests. See docs/tests/click-tests for more info.

Upgrade tests. See docs/tests/upgrade-tests for more info.

Persistence tests - UI.

Legacy device test - UI.

Finds out how much flash space we have left in the firmware build Fails if the free space is less than certain threshold

Compares the current flash space with the situation in the current master Fails if the new binary is significantly larger than the master one (the threshold is defined in the script, currently 5kb). Allowing fir failure, not to prevent the merge. Also generates a report with the current situation


TEST-NONENGLISH stage - test-nonenglish.yml

Tests for non-english languages, that run only nightly

  • apart from that, they run also for every branch containing "translations" in its name

Consists of 16 jobs below:

START_DEVICE_TESTS

START_CLICK_TESTS


POSTTEST stage - posttest.yml

Consists of 2 jobs below:


DEPLOY stage - deploy.yml

Consists of 13 jobs below: