11 KiB

Czysty Wina Historia

IDF CI

IDF CI

General Workflow

Push to a remote branch
Create an MR, choose related labels (not required)
A detached pipeline will be created.
if you push a new commit, a new pipeline will be created automatically.

What if Expected Jobs ARE NOT Created?

check the file patterns

If you found a job that is not running as expected with some file changes, a git commit to improve the pattern will be appreciated.
please add MR labels to run additional tests, currently we have to do this only for target-test jobs, please use it as few as possible. Our final goal is to remove all the labels and let the file changes decide everything!

MR labels for additional jobs

Supported MR Labels

build
build_docs
component_ut[_esp32/esp32s2/...]
custom_test[_esp32/esp32s2/...]
docker
docs
docs_fast, triggers a fast docs build, not a full build which is the CI default. This skips PDF build as well as doxygen APIs, reducing the build time by 90+%.
example_test[_esp32/esp32s2/...]
fuzzer_test
host_test
integration_test
iperf_stress_test
macos
macos_test
nvs_coverage
submodule
unit_test[_esp32/esp32s2/...]
weekend_test
windows

There are two general labels (not recommended since these two labels will trigger a lot of jobs)

target_test: includes all target for example_test, custom_test, component_ut, unit_test, integration_test
all_test: includes all test labels

How to trigger a `detached` pipeline without pushing new commits?

Go to MR web page -> Pipelines tab -> click Run pipeline button.

In very rare case, this tab will not show up because no merge_request pipeline is created before. Please use web API then.

curl -X POST --header "PRIVATE-TOKEN: [YOUR PERSONAL ACCESS TOKEN]" [GITLAB_SERVER]/api/v4/projects/103/merge_requests/[MERGE_REQUEST_IID]/pipelines

How to Develop With `rules.yml`?

General Concepts

pattern: Defined in an array. A GitLab job will be created if the changed files in this MR matched one of the patterns. For example:
```
.patterns-python-files: &patterns-python-files
  - "**/*.py"
```
label: Defined in an if clause, similar as the previous bot command. A GitLab job will be created if the pipeline variables contains variables in BOT_LABEL_xxx format (DEPRECATED) or included in the MR labels. For example:
```
.if-label-build_docs: &if-label-build_docs
  if: '$BOT_LABEL_BUILD_DOCS || $CI_MERGE_REQUEST_LABELS =~ /^(?:[^,\n\r]+,)*build_docs(?:,[^,\n\r]+)*$/i'
```

rule: A combination of various patterns, and labels. It will be used by GitLab YAML extends keyword to tell GitLab in what conditions will this job be created. For example:

.rules:build:docs:
  rules:
    - <<: *if-protected
    - <<: *if-label-build_docs
    - <<: *if-label-docs
    - <<: *if-dev-push
      changes: *patterns-docs

An example for GitLab job on how to use extends:

check_docs_lang_sync:
  extends:
    - .pre_check_template
    - .rules:build:docs
  script:
    - cd docs
    - ./check_lang_folder_sync.sh

How to Add a New `Job`?

check if there's a suitable .rules:<rules-you-need> template

if there is, put this in the job extends. All done, now you can close this window. (extends could be array or string)
if there isn't
1. check How to Add a New Rules Template?, create a suitable one
2. follow step 1

How to Add a New `Rules` Template?

check if this rule is related to labels, patterns

if it is, please refer to dependencies/README.md and add new rules by auto-generating
if it isn't, please continue reading

check if there's a suitable .if-<if-anchor-you-need> anchor

if there is, create a rule following rules Template Naming Rules.For detail information, please refer to GitLab Documentation rules-if. Here's an example.
```
.rules:dev:
  rules:
    - <<: *if-trigger
    - <<: *if-dev-push
```
if there isn't
1. check How to Add a New if Anchor?, create a suitable one
2. follow step 1

How to Add a New `if` Anchor?

Create an if anchor following if Anchors Naming Rules. For detailed information about how to write the condition clause, please refer to GitLab Documentation `only/except (advanced). Here's an example.

.if-schedule: &if-schedule:
  if: '$CI_PIPELINE_SOURCE == "schedule"'

Naming Rules

Common Naming Rules

if a phrase has multi words, use _ to concatenate them.

e.g. regular_test

if a name has multi phrases, use - to concatenate them.

e.g. regular_test-example_test

`if` Anchors Naming Rules

if it's a label: .if-label-<label_name>
if it's a ref: .if-ref-<ref_name>
if it's a branch: .if-branch-<branch_name>
if it's a tag: .if-tag-<tag_name>
if it's multi-type combination: .if-ref-<release_name>-branch-<branch_name>

Common Phrases/Abbreviations
- no_label
  
  $BOT_TRIGGER_WITH_LABEL == null
- protected
  
  ($CI_COMMIT_REF_NAME == "master" || $CI_COMMIT_BRANCH =~ /^release\/v/ || $CI_COMMIT_TAG =~ /^v\d+\.\d+(\.\d+)?($|-)/)
- target_test
  
  a combination of example_test, custom_test, unit_test, component_ut, integration_test and all targets

`rules` Template Naming Rules

if it's tag related: .rules:tag:<tag_1>-<tag_2>
if it's label related: .rules:labels:<label_1>-<label_2>
if it's test related: .rules:test:<test_type>
if it's build related: .rules:build:<build_type>
if it's pattern related: .rules:patterns:<patterns>

Reusable Shell Script `tools/ci/utils.sh`

It is used to put all the reusable shell scripts as small functions. If you want to set before_script: [] for you job, now you can set extends: .before_script_slim instead. it will only run source tools/ci/utils.sh

If you're developing CI shell scripts, you can use these functions without source them. They're already included in all before_script

To run these commands in shell script locally, place source tools/ci/utils.sh at the very beginning.

Functions

add_gitlab_ssh_keys
add_github_ssh_keys
add_doc_server_ssh_keys
fetch_submodules
get_all_submodules

error: log in red color
warning: log in orange color
info: log in green color
run_cmd: run the command with duration seconds info
retry_failed: run the command with duration seconds info, retry when failed

Manifest File to Control the Build/Test apps

.build-test-rules.yml file is a manifest file to control if the CI is running the build and test job or not. The Supported Targets table in README.md for apps would be auto-generated by pre-commit from the app's .build-test-rules.yml.

Grammar

Operands

Variables start with SOC_. The value would be parsed from components/soc/[TARGET]/include/soc/*_caps.h
IDF_TARGET
INCLUDE_DEFAULT (The default value of officially supported targets is 1, otherwise is 0)
String, must be double-quoted. e.g. "esp32", "12345"
Integer, support decimal and hex. e.g. 1, 0xAB
List with String and Integer inside, the type could be mixed. e.g. ["esp32", 1]

Operators

==, !=, >, >=, <, <=
and, or
in, not in with list
parentheses

Limitation:

all operators are binary operator. For more than two operands, you may use nested parentheses trick. For example,
- A == 1 or (B == 2 and C in [1,2,3])
- (A == 1 and B == 2) or (C not in ["3", "4", 5])

How does it work?

By default, we enable build and test jobs for supported targets. In other words, if an app supports all supported targets, it does not need to be added in a manifest file. The manifest files are files that set the violation rules for apps.

three rules (disable rules are calculated after the enable rule):

enable: run CI build/test jobs for targets that match any of the specified conditions only
disable: will not run CI build/test jobs for targets that match any of the specified conditions
disable_test: will not run CI test jobs for targets that match any of the specified conditions

Each key is a test folder. Will apply to all folders inside.

If one sub folder is in a special case, you can overwrite the rules for this folder by adding another entry for this folder itself. Each folder's rules are standalone, and will not inherit its parent's rules. (YAML inheritance is too complicated for reading)

For example in the following codeblock, only disable rule exists in examples/foo/bar. It's unaware of its parent's enable rule.

examples/foo:
  enable:
    - if: IDF_TARGET == "esp32"

examples/foo/bar:
  disable:
    - if: IDF_TARGET == "esp32s2"

Example

examples/foo:
  enable:
    - if IDF_TARGET in ["esp32", 1, 2, 3]
    - if IDF_TARGET not in ["4", "5", 6]
  # should be run under all targets!

examples/bluetooth:
  disable:  # disable both build and tests jobs
    - if: SOC_BT_SUPPORTED != 1
    # reason is optional if there's no `temporary: true`
  disable_test:
    - if: IDF_TARGET == "esp32"
      temporary: true
      reason: lack of ci runners  # required when `temporary: true`

examples/bluetooth/test_foo:
  # each folder's settings are standalone
  disable:
    - if: IDF_TARGET == "esp32s2"
      temporary: true
      reason: no idea
  # unlike examples/bluetooth, the apps under this folder would not be build nor test for "no idea" under target esp32s2

examples/get-started/hello_world:
  enable:
    - if: IDF_TARGET == "linux"
      reason: this one only supports linux!

examples/get-started/blink:
  enable:
    - if: INCLUDE_DEFAULT == 1 or IDF_TARGET == "linux"
      reason: This one supports all supported targets and linux

11 KiB Czysty Wina Historia