12 # Common parameters for the 'make' during CI tests
13 MAKEFLAGS: "-j5 --no-keep-going"
15 # GitLab-CI environment
17 # more attempts for more robust
18 GET_SOURCES_ATTEMPTS: "10"
19 ARTIFACT_DOWNLOAD_ATTEMPTS: "10"
21 # We use get_sources.sh script to fetch the submodules and/or re-fetch the repo
22 # if it was corrupted (if submodule update fails this can happen)
24 GIT_SUBMODULE_STRATEGY: none
28 IDF_PATH: "$CI_PROJECT_DIR"
31 APPLY_BOT_FILTER_SCRIPT: "$CI_PROJECT_DIR/tools/ci/apply_bot_filter.py"
32 CHECKOUT_REF_SCRIPT: "$CI_PROJECT_DIR/tools/ci/checkout_project_ref.py"
34 # When 'fetch' strategy is used, Gitlab removes untracked files before checking out
35 # new revision. However if the new revision doesn't include some of the submodules
36 # which were present in the old revision, such submodule directories would not be
37 # removed by the checkout. This extra step ensures that these stale submodules
39 .git_clean_stale_submodules: &git_clean_stale_submodules >
40 find . -name '.git' -not -path './.git' -printf '%P\n'
43 grep -q {} .gitmodules
44 || (echo "Removing {}, has .git directory but not in .gitmodules file"
47 # before each job, we need to check if this job is filtered by bot stage/job filter
48 .apply_bot_filter: &apply_bot_filter
49 python $APPLY_BOT_FILTER_SCRIPT || exit 0
52 - *git_clean_stale_submodules
53 # apply bot filter in before script
58 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
59 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
60 - chmod 600 ~/.ssh/id_rsa
61 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
63 # Set IS_PRIVATE or IS_PUBLIC depending on if our branch is public or not
65 # (the same regular expressions are used to set these are used in 'only:' sections below
66 - source tools/ci/configure_ci_environment.sh
68 # fetch the submodules (& if necessary re-fetch repo) from gitlab
69 - time ./tools/ci/get-full-sources.sh
72 before_script: &do_nothing_before
73 - *git_clean_stale_submodules
74 # apply bot filter in before script
76 - echo "Not setting up GitLab key, not fetching submodules"
77 - source tools/ci/configure_ci_environment.sh
79 .add_gitlab_key_before:
80 before_script: &add_gitlab_key_before
81 - *git_clean_stale_submodules
82 # apply bot filter in before script
84 - echo "Not fetching submodules"
85 - source tools/ci/configure_ci_environment.sh
89 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
90 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
91 - chmod 600 ~/.ssh/id_rsa
92 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
96 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
103 - git clone https://github.com/espressif/esp-idf-template.git
104 - cd esp-idf-template
105 # Try to use the same branch name for esp-idf-template that we're
106 # using on esp-idf. If it doesn't exist then just stick to the default
108 - python $CHECKOUT_REF_SCRIPT esp-idf-template
109 # Test debug build (default)
111 # Now test release build
113 - sed -i.bak -e's/CONFIG_OPTIMIZATION_LEVEL_DEBUG\=y/CONFIG_OPTIMIZATION_LEVEL_RELEASE=y/' sdkconfig
115 # Check if there are any stray printf/ets_printf references in WiFi libs
116 - cd ../components/esp32/lib
117 - test $(xtensa-esp32-elf-nm *.a | grep -w printf | wc -l) -eq 0
118 - test $(xtensa-esp32-elf-nm *.a | grep -w ets_printf | wc -l) -eq 0
121 .build_template: &build_template
123 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
130 .build_ssc_template: &build_ssc_template
137 SSC_CONFIG_FOLDER: "$CI_PROJECT_DIR/SSC/configs/ESP32_IDF"
139 - git clone $SSC_REPOSITORY
141 - python $CHECKOUT_REF_SCRIPT SSC
142 - MAKEFLAGS= ./ci_build_ssc.sh "${CI_JOB_NAME}" "${IDF_PATH}/.gitlab-ci.yml"
144 # don't forget to add to dependency to test_template when adding new build_ssc jobs
146 <<: *build_ssc_template
149 <<: *build_ssc_template
152 <<: *build_ssc_template
154 # If you want to add new build ssc jobs, please add it into dependencies of `assign_test` and `.test_template`
160 - tools/unit-test-app/output
161 - components/idf_test/unit_test/TestCaseAll.yml
162 - components/idf_test/unit_test/CIConfigs/*.yml
165 - cd tools/unit-test-app
166 - MAKEFLAGS= make help # make sure kconfig tools are built in single process
167 - make ut-clean-all-configs
168 - export EXTRA_CFLAGS="-Werror -Werror=deprecated-declarations"
169 - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS}
170 - make ut-build-all-configs
171 - python tools/UnitTestParser.py
173 .build_examples_template: &build_examples_template
179 - build_examples/*/*/*/build/*.bin
180 - build_examples/*/*/*/build/*.elf
181 - build_examples/*/*/*/build/*.map
182 - build_examples/*/*/*/build/download.config
183 - build_examples/*/*/*/build/bootloader/*.bin
188 LOG_PATH: "$CI_PROJECT_DIR/log_examples"
190 # it's not possible to build 100% out-of-tree and have the "artifacts"
191 # mechanism work, but this is the next best thing
192 - rm -rf build_examples
193 - mkdir build_examples
195 # build some of examples
196 - mkdir -p ${LOG_PATH}
197 - ${IDF_PATH}/tools/ci/build_examples.sh "${CI_JOB_NAME}"
200 <<: *build_examples_template
203 <<: *build_examples_template
206 <<: *build_examples_template
209 <<: *build_examples_template
212 <<: *build_examples_template
215 <<: *build_examples_template
218 <<: *build_examples_template
221 <<: *build_examples_template
223 # If you want to add new build example jobs, please add it into dependencies of `.example_test_template`
227 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
233 # English version of documentation
234 - docs/en/doxygen-warning-log.txt
235 - docs/en/sphinx-warning-log.txt
236 - docs/en/sphinx-warning-log-sanitized.txt
237 - docs/en/_build/html
238 # Chinese version of documentation
239 - docs/zh_CN/doxygen-warning-log.txt
240 - docs/zh_CN/sphinx-warning-log.txt
241 - docs/zh_CN/sphinx-warning-log-sanitized.txt
242 - docs/zh_CN/_build/html
246 - ./check_lang_folder_sync.sh
250 - ../check_doc_warnings.sh
254 - ../check_doc_warnings.sh
256 .host_test_template: &host_test_template
258 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
264 <<: *host_test_template
266 - cd components/nvs_flash/test_nvs_host
270 <<: *host_test_template
273 - components/nvs_flash/test_nvs_host/coverage_report
276 # This job takes a few hours to finish, so only run it on demand
278 BOT_NEEDS_TRIGGER_BY_NAME: 1
280 - cd components/nvs_flash/test_nvs_host
281 - make coverage_report
283 test_partition_table_on_host:
284 <<: *host_test_template
288 - cd components/partition_table/test_gen_esp32part_host
289 - ./gen_esp32part_tests.py
292 <<: *host_test_template
295 - components/wear_levelling/test_wl_host/coverage_report.zip
297 - cd components/wear_levelling/test_wl_host
301 <<: *host_test_template
303 - cd components/fatfs/test_fatfs_host/
306 test_mdns_fuzzer_on_host:
308 image: $CI_DOCKER_REGISTRY/afl-fuzzer-test
315 - components/mdns/test_afl_fuzz_host/out/crashes
318 # can only be triggered
321 BOT_NEEDS_TRIGGER_BY_NAME: 1
323 - export AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 && export AFL_SKIP_CPUFREQ=1
324 - cd components/mdns/test_afl_fuzz_host/
325 # run AFL fuzzer for one hour
326 - ( make fuzz || pkill sleep ) &
327 - ( sleep 3600 || mkdir -p out/crashes/env_failed ) && pkill afl-fuz
328 # check no crashes found
329 - "[ -z `ls out/crashes/` ] || exit 1"
332 <<: *host_test_template
334 - cd components/spiffs/test_spiffs_host/
337 test_multi_heap_on_host:
338 <<: *host_test_template
340 - cd components/heap/test_multi_heap_host
341 - ./test_all_configs.sh
344 <<: *host_test_template
346 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
347 - rm -rf test_build_system
348 - mkdir test_build_system
349 - cd test_build_system
350 - ${IDF_PATH}/tools/ci/test_build_system.sh
353 <<: *host_test_template
357 - tools/test_idf_monitor/outputs/*
360 - cd ${IDF_PATH}/tools/test_idf_monitor
361 - source /opt/pyenv/activate
362 - pyenv global 2.7.15
363 - ./run_test_idf_monitor.py
365 - ./run_test_idf_monitor.py
366 - pyenv global system
368 test_esp_err_to_name_on_host:
369 <<: *host_test_template
373 - components/esp32/esp_err_to_name.c
377 - source /opt/pyenv/activate
378 - pyenv global 2.7.15
379 - ./gen_esp_err_to_name.py
380 - git diff --exit-code -- ../components/esp32/esp_err_to_name.c || (echo 'Differences found. Please run gen_esp_err_to_name.py and commit the changes.'; exit 1)
382 - ./gen_esp_err_to_name.py
383 - git diff --exit-code -- ../components/esp32/esp_err_to_name.c || (echo 'Differences found between running under Python 2 and 3.'; exit 1)
384 - pyenv global system
388 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
394 - /^v\d+\.\d+(\.\d+)?($|-)/
397 before_script: *do_nothing_before
401 - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64
402 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
403 - chmod 600 ~/.ssh/id_rsa
404 - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
405 - git remote remove github &>/dev/null || true
406 - git remote add github git@github.com:espressif/esp-idf.git
407 # Need separate push commands for tag builds and for branch builds
408 - "[ -n \"${CI_COMMIT_TAG}\" ] && git push github ${CI_COMMIT_TAG}"
409 - "[ -z \"${CI_COMMIT_TAG}\" ] && git push github ${CI_COMMIT_SHA}:refs/heads/${CI_COMMIT_REF_NAME}"
413 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
419 - /^v\d+\.\d+(\.\d+)?($|-)/
423 before_script: *do_nothing_before
427 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
428 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
429 - chmod 600 ~/.ssh/id_rsa
430 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
431 - export GIT_VER=$(git describe --always)
434 - tar czvf $GIT_VER.tar.gz $GIT_VER
435 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
436 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
437 - cd ../../zh_CN/_build/
439 - tar czvf $GIT_VER.tar.gz $GIT_VER
440 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
441 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
442 # add link to preview doc
443 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
444 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
448 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
452 # can only be triggered
456 - docs/_build/linkcheck
459 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
460 - test "$CHECK_LINKS" = "Yes" || exit 0
461 # can only run on master branch (otherwise the commit is not on Github yet)
462 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
468 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
474 - /^v\d+\.\d+(\.\d+)?($|-)/
476 before_script: *do_nothing_before
478 - tools/ci/check-line-endings.sh ${IDF_PATH}
482 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
488 - /^v\d+\.\d+(\.\d+)?($|-)/
490 before_script: *do_nothing_before
493 - git log -n10 --oneline
494 # commit start with "WIP: " need to be squashed before merge
495 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
499 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
505 - /^v\d+\.\d+(\.\d+)?($|-)/
507 before_script: *do_nothing_before
509 - tools/ci/check-executable.sh
511 check_submodule_sync:
513 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
519 - /^v\d+\.\d+(\.\d+)?($|-)/
523 before_script: *do_nothing_before
525 # check if all submodules are correctly synced to public repostory
526 - git submodule update --init --recursive
531 image: $CI_DOCKER_REGISTRY/ubuntu-test-env
533 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
534 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
539 - build_esp_idf_tests
541 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
542 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
545 - components/idf_test/*/CIConfigs
546 - components/idf_test/*/TC.sqlite
547 - $EXAMPLE_CONFIG_OUTPUT_PATH
549 before_script: *add_gitlab_key_before
551 # assign example tests
552 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
553 # assign unit test cases
554 - python $TEST_FW_PATH/CIAssignUnitTest.py $IDF_PATH/components/idf_test/unit_test/TestCaseAll.yml $IDF_PATH/.gitlab-ci.yml $IDF_PATH/components/idf_test/unit_test/CIConfigs
555 # clone test script to assign tests
556 - git clone $TEST_SCRIPT_REPOSITORY
557 - cd auto_test_script
558 - python $CHECKOUT_REF_SCRIPT auto_test_script
559 # assgin integration test cases
560 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin
562 .example_test_template: &example_test_template
563 stage: integration_test
568 - /^v\d+\.\d+(\.\d+)?($|-)/
587 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
588 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
589 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
590 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
591 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
593 # first test if config file exists, if not exist, exit 0
594 - test -e $CONFIG_FILE || exit 0
595 # clone test env configs
596 - git clone $TEST_ENV_CONFIG_REPOSITORY
597 - cd ci-test-runner-configs
598 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
601 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE -e $ENV_FILE
603 .unit_test_template: &unit_test_template
604 <<: *example_test_template
608 - build_esp_idf_tests
610 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
611 TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app"
612 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml"
613 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
614 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
616 .test_template: &test_template
617 stage: integration_test
622 - /^v\d+\.\d+(\.\d+)?($|-)/
636 LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF"
637 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
638 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test"
639 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml"
640 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml"
641 before_script: *add_gitlab_key_before
643 # first test if config file exists, if not exist, exit 0
644 - test -e $CONFIG_FILE || exit 0
645 # clone local test env configs
646 - git clone $TEST_ENV_CONFIG_REPOSITORY
647 - cd ci-test-runner-configs
648 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
650 - git clone $TEST_SCRIPT_REPOSITORY
651 - cd auto_test_script
652 - python $CHECKOUT_REF_SCRIPT auto_test_script
654 - python CIRunner.py -l "$LOG_PATH/$CI_JOB_NAME" -c $CONFIG_FILE -e $LOCAL_ENV_CONFIG_PATH -t $TEST_CASE_FILE_PATH -m $MODULE_UPDATE_FILE
668 # clone local test env configs
669 - git clone $TEST_ENV_CONFIG_REPOSITORY
670 - cd ci-test-runner-configs
671 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
673 - git clone $TEST_SCRIPT_REPOSITORY
674 - cd auto_test_script
675 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..."
677 - ./Tools/prepare_nvs_bin.sh
679 - python CIRunner.py -l "$LOG_PATH/$CI_JOB_NAME" -c $CONFIG_FILE -e $LOCAL_ENV_CONFIG_PATH -t $TEST_CASE_FILE_PATH -m $MODULE_UPDATE_FILE
682 <<: *example_test_template
688 <<: *example_test_template
694 <<: *example_test_template
700 <<: *example_test_template
706 <<: *unit_test_template
712 <<: *unit_test_template
718 <<: *unit_test_template
724 <<: *unit_test_template
730 <<: *unit_test_template
736 <<: *unit_test_template
742 <<: *unit_test_template
748 <<: *unit_test_template
754 <<: *unit_test_template
760 <<: *unit_test_template
766 <<: *unit_test_template
772 <<: *unit_test_template
778 <<: *unit_test_template
784 <<: *unit_test_template
790 <<: *unit_test_template
796 <<: *unit_test_template
802 <<: *unit_test_template
808 <<: *unit_test_template
814 <<: *unit_test_template
820 <<: *unit_test_template
826 <<: *unit_test_template
832 <<: *unit_test_template
838 <<: *unit_test_template
844 <<: *unit_test_template
850 <<: *unit_test_template
856 <<: *unit_test_template
862 <<: *unit_test_template
868 <<: *unit_test_template
874 <<: *unit_test_template
880 <<: *unit_test_template
886 <<: *unit_test_template
892 <<: *unit_test_template
898 <<: *unit_test_template
904 <<: *unit_test_template
910 <<: *unit_test_template
916 <<: *unit_test_template
922 <<: *unit_test_template
928 <<: *unit_test_template
934 <<: *unit_test_template
940 <<: *unit_test_template
946 <<: *unit_test_template
952 <<: *unit_test_template
958 <<: *unit_test_template
965 <<: *unit_test_template
972 <<: *unit_test_template
979 <<: *unit_test_template
986 <<: *unit_test_template
993 <<: *unit_test_template
1000 <<: *unit_test_template
1007 <<: *unit_test_template
1014 <<: *unit_test_template
1021 <<: *unit_test_template
1028 <<: *unit_test_template
1035 <<: *unit_test_template
1042 <<: *unit_test_template
1049 <<: *unit_test_template
1055 <<: *unit_test_template
1061 <<: *unit_test_template
1067 <<: *unit_test_template
1074 <<: *unit_test_template
1080 <<: *unit_test_template
1086 <<: *unit_test_template
1092 <<: *unit_test_template
1099 <<: *unit_test_template
1105 <<: *unit_test_template
1111 <<: *unit_test_template
1117 <<: *unit_test_template
1124 <<: *unit_test_template
1130 <<: *unit_test_template
1136 <<: *unit_test_template
1142 <<: *unit_test_template
1149 <<: *unit_test_template