diff options
author | Tom Hughes <tomhughes@chromium.org> | 2022-09-21 14:10:01 -0700 |
---|---|---|
committer | Tom Hughes <tomhughes@chromium.org> | 2022-09-22 12:49:33 -0700 |
commit | 2bcf863b492fe7ed8105c853814dba6ed32ba719 (patch) | |
tree | fcf6ce5810f9ff9e3c8cce434812dd75492269ed /docs/gitlab.md | |
parent | e5fb0b9ba488614b5684e640530f00821ab7b943 (diff) | |
parent | 28712dae9d7ed1e694f7622cc083afa71090d4d5 (diff) | |
download | chrome-ec-2bcf863b492fe7ed8105c853814dba6ed32ba719.tar.gz |
Merge remote-tracking branch cros/main into firmware-fpmcu-bloonchipper-releasefirmware-fpmcu-bloonchipper-release
Generated by: ./util/update_release_branch.py --board bloonchipper
--relevant_paths_file ./util/fingerprint-relevant-paths.txt firmware-
fpmcu-bloonchipper-release
Relevant changes:
git log --oneline e5fb0b9ba4..28712dae9d -- board/hatch_fp
board/bloonchipper common/fpsensor docs/fingerprint driver/fingerprint
util/getversion.sh
ded9307b79 util/getversion.sh: Fix version when not in a git repo
956055e692 board: change Google USB vendor info
71b2ef709d Update license boilerplate text in source code files
33e11afda0 Revert "fpsensor: Build fpsensor source file with C++"
c8d0360723 fpsensor: Build fpsensor source file with C++
bc113abd53 fpsensor: Fix g++ compiler error
150a58a0dc fpsensor: Fix fp_set_sensor_mode return type
b33b5ce85b fpsensor: Remove nested designators for C++ compatibility
2e864b2539 tree-wide: const-ify argv for console commands
56d8b360f9 test: Add test for get ikm failure when seed not set
3a3d6c3690 test: Add test for fpsensor trivial key failure
233e6bbd08 fpsensor_crypto: Abstract calls to hmac_SHA256
0a041b285b docs/fingerprint: Typo correction
c03fab67e2 docs/fingerprint: Fix the path of fputils.py
0b5d4baf5a util/getversion.sh: Fix empty file list handling
6e128fe760 FPMCU dev board environment with Satlab
3eb29b6aa5 builtin: Move ssize_t to sys/types.h
345d62ebd1 docs/fingerprint: Update power numbers for latest dartmonkey release
c25ffdb316 common: Conditionally support printf %l and %i modifiers
9a3c514b45 test: Add a test to check if the debugger is connected
54e603413f Move standard library tests to their own file
43fa6b4bf8 docs/fingerprint: Update power numbers for latest bloonchipper release
25536f9a84 driver/fingerprint/fpc/bep/fpc_sensor_spi.c: Format with clang-format
4face99efd driver/fingerprint/fpc/libfp/fpc_sensor_pal.h: Format with clang-format
738de2b575 trng: Rename rand to trng_rand
14b8270edd docs/fingerprint: Update dragonclaw power numbers
0b268f93d1 driver/fingerprint/fpc/libfp/fpc_private.c: Format with clang-format
f80da163f2 driver/fingerprint/fpc/libfp/fpc_private.h: Format with clang-format
5e9c85c9b1 driver/fingerprint/fpc/libfp/fpc_sensor_pal.c: Format with clang-format
c1f9dd3cf8 driver/fingerprint/fpc/libfp/fpc_bio_algorithm.h: Format with clang-format
eb1e1bed8d driver/fingerprint/fpc/libfp/fpc1145_private.h: Format with clang-format
6e7b611821 driver/fingerprint/fpc/bep/fpc_bio_algorithm.h: Format with clang-format
e0589cd5e2 driver/fingerprint/fpc/bep/fpc1035_private.h: Format with clang-format
7905e556a0 common/fpsensor/fpsensor_crypto.c: Format with clang-format
21289d170c driver/fingerprint/fpc/bep/fpc1025_private.h: Format with clang-format
98a20f937e common/fpsensor/fpsensor_state.c: Format with clang-format
a2d255d8af common/fpsensor/fpsensor.c: Format with clang-format
73055eeb3f driver/fingerprint/fpc/bep/fpc_private.c: Format with clang-format
0f7b5cb509 common/fpsensor/fpsensor_private.h: Format with clang-format
1ceade6e65 driver/fingerprint/fpc/bep/fpc_private.h: Format with clang-format
dc3e9008b8 board/hatch_fp/board.h: Format with clang-format
dca9d74321 Revert "trng: Rename rand to trng_rand"
a6b0b3554f trng: Rename rand to trng_rand
28d0b75b70 third_party/boringssl: Remove unused header
BRANCH=None
BUG=b:246424843 b:234181908 b:244781166 b:234181908 b:244387210
BUG=b:242720240 chromium:1098010 b:180945056 b:236025198 b:234181908
BUG=b:234181908 b:237344361 b:131913998 b:236386294 b:234143158
BUG=b:234781655 b:215613183 b:242720910
TEST=`make -j buildall`
TEST=./test/run_device_tests.py --board bloonchipper
Test "aes": PASSED
Test "cec": PASSED
Test "cortexm_fpu": PASSED
Test "crc": PASSED
Test "flash_physical": PASSED
Test "flash_write_protect": PASSED
Test "fpsensor_hw": PASSED
Test "fpsensor_spi_ro": PASSED
Test "fpsensor_spi_rw": PASSED
Test "fpsensor_uart_ro": PASSED
Test "fpsensor_uart_rw": PASSED
Test "mpu_ro": PASSED
Test "mpu_rw": PASSED
Test "mutex": PASSED
Test "pingpong": PASSED
Test "printf": PASSED
Test "queue": PASSED
Test "rollback_region0": PASSED
Test "rollback_region1": PASSED
Test "rollback_entropy": PASSED
Test "rtc": PASSED
Test "sha256": PASSED
Test "sha256_unrolled": PASSED
Test "static_if": PASSED
Test "stdlib": PASSED
Test "system_is_locked_wp_on": PASSED
Test "system_is_locked_wp_off": PASSED
Test "timer_dos": PASSED
Test "utils": PASSED
Test "utils_str": PASSED
Test "stm32f_rtc": PASSED
Test "panic_data_bloonchipper_v2.0.4277": PASSED
Test "panic_data_bloonchipper_v2.0.5938": PASSED
Force-Relevant-Builds: all
Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Change-Id: I264ad0ffe7afcd507a1e483c6e934a9c4fea47c3
Diffstat (limited to 'docs/gitlab.md')
-rw-r--r-- | docs/gitlab.md | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/gitlab.md b/docs/gitlab.md new file mode 100644 index 0000000000..9f8d07ceec --- /dev/null +++ b/docs/gitlab.md @@ -0,0 +1,84 @@ +# Gitlab CI + +The Zephyr EC Test Team uses external Gitlab CI jobs to generate code coverage +reports. These CI jobs are defined in the `.gitlab-ci.yml` file in +`platform/ec`. + +[TOC] + +## Running CI jobs locally + +For development purposes, it is possible to run the CI jobs on a local machine +using Docker and `gitlab-runner`. + +Note: not all features of Gitlab CI are available when running builds locally. +For example, the local runner cannot build dependencies specified in the +`needs:` sections. (But you can run jobs individually). More details can be +found in the [`gitlab-runner` docs] +(https://docs.gitlab.com/runner/commands/#limitations-of-gitlab-runner-exec). + +### Installation + +First, you must [install Docker](https://docs.docker.com/get-docker/) on your +system. This is out of the scope of this guide, but there are many resources +on the Internet describing how to do this. Docker allows the CI jobs to run in a +controlled environment using containers, ensuring that the jobs run consistently +and without needing to pollute your own system with the many dependencies. + +Next, install the Gitlab Runner. This application is able interpret the +`.gitlab-ci.yml` file, spawn Docker containers to run jobs, and report back +results and artifacts. Usually, runners are deployed in fleets and configured to +register with a Gitlab server, which can push CI jobs to individual runners to +execute. However, it is also possible to use the runner in a purely local mode +using `gitlab-runner exec`. + +Full instructions are available on the +[Gitlab website](https://docs.gitlab.com/runner/install/), but the fastest way +to get it for Debian-based systems is to download and install the package +directly: + +``` +wget https://gitlab-runner-downloads.s3.amazonaws.com/latest/deb/gitlab-runner_amd64.deb +sudo dpkg -i gitlab-runner_amd64.deb +``` + +### Running a Job + +Once Docker and the Gitlab Runner are installed, invoke it as follows. This +takes place outside of the + +``` +(outside) +mkdir ~/gitlab-runner-output # Do once + +cd ~/chromiumos/src/platform/ec +sudo gitlab-runner exec docker \ + --docker-volumes "$HOME/chromiumos/:$HOME/chromiumos/" \ + --docker-volumes "$HOME/gitlab-runner-output:/builds" \ + <name of job> +``` + +Please note: + * `$HOME/chromiumos` should be adjusted to wherever your tree is checked out + to. The reason it is necessary to mount the entire source tree to the + Docker container (as opposed to just `platform/ec`, which is done + automatically) is because the runner needs access to the Git database in + order to clone the source code. Because the `platform/ec` repository is + governed by the `repo` tool, the Git database is actually located at + `$HOME/chromiumos/.repo/projects/src/platform/ec.git`. (The `.git` directory + in `platform/ec` is merely a symlink) + * The second mount causes the runner's work directory to be backed by a + directory on your own system so that you can examine the artifacts after the + job finishes and the container is stopped. + * `<name of job>` is one of the jobs defined in `.gitlab-ci.yml`, such as + `twister_coverage`. + * You may see error messages like `ERROR: Could not create cache adapter`. + These appear to be benign, although getting the cache to work might improve + subsequent build times. This may be investigated at a later date. + +### Accessing Artifacts + +If you used the command as shown above, all of the build artifacts and source, +as checked out by the Gitlab runner, should be under `~/gitlab-runner-output`. +This will persist after the container exits but also get overwritten again on +the next run. |