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 .host_fuzzer_test_template: &host_fuzzer_test_template
308 image: $CI_DOCKER_REGISTRY/afl-fuzzer-test
315 - ${FUZZER_TEST_DIR}/out/crashes
316 - ${FUZZER_TEST_DIR}/fuzz_output.log
319 # can only be triggered
322 - export AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 && export AFL_SKIP_CPUFREQ=1
323 - cd ${FUZZER_TEST_DIR}
324 # run AFL fuzzer for one hour
325 - ( ( make ${FUZZER_PARAMS} fuzz | tee fuzz_output.log | grep -v '\(Fuzzing test case\|Entering queue cycle\)' ) || pkill sleep ) &
326 - ( sleep 3600 || mkdir -p out/crashes/env_failed ) && pkill afl-fuz
327 # check no crashes found
328 - test -z "$(ls out/crashes/)" || exit 1
330 test_mdns_fuzzer_on_host:
331 <<: *host_fuzzer_test_template
333 BOT_NEEDS_TRIGGER_BY_NAME: 1
334 FUZZER_TEST_DIR: components/mdns/test_afl_fuzz_host
336 test_lwip_dns_fuzzer_on_host:
337 <<: *host_fuzzer_test_template
339 BOT_NEEDS_TRIGGER_BY_NAME: 1
340 FUZZER_TEST_DIR: components/lwip/test_afl_host
341 FUZZER_PARAMS: MODE=dns
343 test_lwip_dhcp_fuzzer_on_host:
344 <<: *host_fuzzer_test_template
346 BOT_NEEDS_TRIGGER_BY_NAME: 1
347 FUZZER_TEST_DIR: components/lwip/test_afl_host
348 FUZZER_PARAMS: MODE=dhcp_client
350 test_lwip_dhcps_fuzzer_on_host:
351 <<: *host_fuzzer_test_template
353 BOT_NEEDS_TRIGGER_BY_NAME: 1
354 FUZZER_TEST_DIR: components/lwip/test_afl_host
355 FUZZER_PARAMS: MODE=dhcp_server
358 <<: *host_test_template
360 - cd components/spiffs/test_spiffs_host/
363 test_multi_heap_on_host:
364 <<: *host_test_template
366 - cd components/heap/test_multi_heap_host
367 - ./test_all_configs.sh
370 <<: *host_test_template
372 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
373 - rm -rf test_build_system
374 - mkdir test_build_system
375 - cd test_build_system
376 - ${IDF_PATH}/tools/ci/test_build_system.sh
379 <<: *host_test_template
383 - tools/test_idf_monitor/outputs/*
386 - cd ${IDF_PATH}/tools/test_idf_monitor
387 - source /opt/pyenv/activate
388 - pyenv global 2.7.15
389 - ./run_test_idf_monitor.py
391 - ./run_test_idf_monitor.py
392 - pyenv global system
394 test_esp_err_to_name_on_host:
395 <<: *host_test_template
399 - components/esp32/esp_err_to_name.c
403 - source /opt/pyenv/activate
404 - pyenv global 2.7.15
405 - ./gen_esp_err_to_name.py
406 - 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)
408 - ./gen_esp_err_to_name.py
409 - git diff --exit-code -- ../components/esp32/esp_err_to_name.c || (echo 'Differences found between running under Python 2 and 3.'; exit 1)
410 - pyenv global system
414 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
420 - /^v\d+\.\d+(\.\d+)?($|-)/
423 before_script: *do_nothing_before
427 - echo -n $GH_PUSH_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 github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
431 - git remote remove github &>/dev/null || true
432 - git remote add github git@github.com:espressif/esp-idf.git
433 # Need separate push commands for tag builds and for branch builds
434 - "[ -n \"${CI_COMMIT_TAG}\" ] && git push github ${CI_COMMIT_TAG}"
435 - "[ -z \"${CI_COMMIT_TAG}\" ] && git push github ${CI_COMMIT_SHA}:refs/heads/${CI_COMMIT_REF_NAME}"
439 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
445 - /^v\d+\.\d+(\.\d+)?($|-)/
449 before_script: *do_nothing_before
453 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
454 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
455 - chmod 600 ~/.ssh/id_rsa
456 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
457 - export GIT_VER=$(git describe --always)
460 - tar czvf $GIT_VER.tar.gz $GIT_VER
461 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
462 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
463 - cd ../../zh_CN/_build/
465 - tar czvf $GIT_VER.tar.gz $GIT_VER
466 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
467 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
468 # add link to preview doc
469 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
470 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
474 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
478 # can only be triggered
482 - docs/_build/linkcheck
485 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
486 - test "$CHECK_LINKS" = "Yes" || exit 0
487 # can only run on master branch (otherwise the commit is not on Github yet)
488 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
494 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
500 - /^v\d+\.\d+(\.\d+)?($|-)/
502 before_script: *do_nothing_before
504 - tools/ci/check-line-endings.sh ${IDF_PATH}
508 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
514 - /^v\d+\.\d+(\.\d+)?($|-)/
516 before_script: *do_nothing_before
519 - git log -n10 --oneline
520 # commit start with "WIP: " need to be squashed before merge
521 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
525 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
531 - /^v\d+\.\d+(\.\d+)?($|-)/
533 before_script: *do_nothing_before
535 - tools/ci/check-executable.sh
537 check_submodule_sync:
539 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
545 - /^v\d+\.\d+(\.\d+)?($|-)/
549 before_script: *do_nothing_before
551 # check if all submodules are correctly synced to public repostory
552 - git submodule update --init --recursive
557 image: $CI_DOCKER_REGISTRY/ubuntu-test-env
559 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
560 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
565 - build_esp_idf_tests
567 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
568 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
571 - components/idf_test/*/CIConfigs
572 - components/idf_test/*/TC.sqlite
573 - $EXAMPLE_CONFIG_OUTPUT_PATH
575 before_script: *add_gitlab_key_before
577 # assign example tests
578 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
579 # assign unit test cases
580 - 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
581 # clone test script to assign tests
582 - git clone $TEST_SCRIPT_REPOSITORY
583 - cd auto_test_script
584 - python $CHECKOUT_REF_SCRIPT auto_test_script
585 # assgin integration test cases
586 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin
588 .example_test_template: &example_test_template
589 stage: integration_test
594 - /^v\d+\.\d+(\.\d+)?($|-)/
613 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
614 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
615 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
616 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
617 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
619 # first test if config file exists, if not exist, exit 0
620 - test -e $CONFIG_FILE || exit 0
621 # clone test env configs
622 - git clone $TEST_ENV_CONFIG_REPOSITORY
623 - cd ci-test-runner-configs
624 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
627 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE -e $ENV_FILE
629 .unit_test_template: &unit_test_template
630 <<: *example_test_template
634 - build_esp_idf_tests
636 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
637 TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app"
638 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml"
639 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
640 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
642 .test_template: &test_template
643 stage: integration_test
648 - /^v\d+\.\d+(\.\d+)?($|-)/
662 LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF"
663 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
664 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test"
665 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml"
666 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml"
667 before_script: *add_gitlab_key_before
669 # first test if config file exists, if not exist, exit 0
670 - test -e $CONFIG_FILE || exit 0
671 # clone local test env configs
672 - git clone $TEST_ENV_CONFIG_REPOSITORY
673 - cd ci-test-runner-configs
674 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
676 - git clone $TEST_SCRIPT_REPOSITORY
677 - cd auto_test_script
678 - python $CHECKOUT_REF_SCRIPT auto_test_script
680 - 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
694 # clone local test env configs
695 - git clone $TEST_ENV_CONFIG_REPOSITORY
696 - cd ci-test-runner-configs
697 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
699 - git clone $TEST_SCRIPT_REPOSITORY
700 - cd auto_test_script
701 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..."
703 - ./Tools/prepare_nvs_bin.sh
705 - 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
708 <<: *example_test_template
714 <<: *example_test_template
720 <<: *example_test_template
726 <<: *example_test_template
732 <<: *unit_test_template
738 <<: *unit_test_template
744 <<: *unit_test_template
750 <<: *unit_test_template
756 <<: *unit_test_template
762 <<: *unit_test_template
768 <<: *unit_test_template
774 <<: *unit_test_template
780 <<: *unit_test_template
786 <<: *unit_test_template
792 <<: *unit_test_template
798 <<: *unit_test_template
804 <<: *unit_test_template
810 <<: *unit_test_template
816 <<: *unit_test_template
822 <<: *unit_test_template
828 <<: *unit_test_template
834 <<: *unit_test_template
840 <<: *unit_test_template
846 <<: *unit_test_template
852 <<: *unit_test_template
858 <<: *unit_test_template
864 <<: *unit_test_template
870 <<: *unit_test_template
876 <<: *unit_test_template
882 <<: *unit_test_template
888 <<: *unit_test_template
894 <<: *unit_test_template
900 <<: *unit_test_template
906 <<: *unit_test_template
912 <<: *unit_test_template
918 <<: *unit_test_template
924 <<: *unit_test_template
930 <<: *unit_test_template
936 <<: *unit_test_template
942 <<: *unit_test_template
948 <<: *unit_test_template
954 <<: *unit_test_template
960 <<: *unit_test_template
966 <<: *unit_test_template
972 <<: *unit_test_template
978 <<: *unit_test_template
984 <<: *unit_test_template
991 <<: *unit_test_template
998 <<: *unit_test_template
1005 <<: *unit_test_template
1012 <<: *unit_test_template
1019 <<: *unit_test_template
1026 <<: *unit_test_template
1033 <<: *unit_test_template
1040 <<: *unit_test_template
1047 <<: *unit_test_template
1054 <<: *unit_test_template
1061 <<: *unit_test_template
1068 <<: *unit_test_template
1075 <<: *unit_test_template
1081 <<: *unit_test_template
1087 <<: *unit_test_template
1093 <<: *unit_test_template
1100 <<: *unit_test_template
1106 <<: *unit_test_template
1112 <<: *unit_test_template
1118 <<: *unit_test_template
1125 <<: *unit_test_template
1131 <<: *unit_test_template
1137 <<: *unit_test_template
1143 <<: *unit_test_template
1150 <<: *unit_test_template
1156 <<: *unit_test_template
1162 <<: *unit_test_template
1168 <<: *unit_test_template
1175 <<: *unit_test_template