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
305 - cd components/fatfs/test_fatfs_host/
308 test_mdns_fuzzer_on_host:
310 image: $CI_DOCKER_REGISTRY/afl-fuzzer-test$BOT_DOCKER_IMAGE_TAG
317 - components/mdns/test_afl_fuzz_host/out/crashes
320 # can only be triggered
323 BOT_NEEDS_TRIGGER_BY_NAME: 1
325 - export AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 && export AFL_SKIP_CPUFREQ=1
326 - cd components/mdns/test_afl_fuzz_host/
327 # run AFL fuzzer for one hour
328 - ( make fuzz || pkill sleep ) &
329 - ( sleep 3600 || mkdir -p out/crashes/env_failed ) && pkill afl-fuz
330 # check no crashes found
331 - "[ -z `ls out/crashes/` ] || exit 1"
334 <<: *host_test_template
338 - cd components/spiffs/test_spiffs_host/
341 test_multi_heap_on_host:
342 <<: *host_test_template
344 - cd components/heap/test_multi_heap_host
345 - ./test_all_configs.sh
348 <<: *host_test_template
350 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
351 - rm -rf test_build_system
352 - mkdir test_build_system
353 - cd test_build_system
354 - ${IDF_PATH}/tools/ci/test_build_system.sh
357 <<: *host_test_template
361 - tools/test_idf_monitor/outputs/*
364 - cd ${IDF_PATH}/tools/test_idf_monitor
365 - ./run_test_idf_monitor.py
367 test_esp_err_to_name_on_host:
368 <<: *host_test_template
371 - ./gen_esp_err_to_name.py
372 - 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)
374 push_master_to_github:
376 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
382 - /^v\d+\.\d+(\.\d+)?($|-)/
386 GITHUB_PUSH_REFS: refs/remotes/origin/release refs/remotes/origin/master
387 before_script: *do_nothing_before
391 - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64
392 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
393 - chmod 600 ~/.ssh/id_rsa
394 - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
395 - git remote remove github &>/dev/null || true
396 - git remote add github git@github.com:espressif/esp-idf.git
397 # What the next line of script does: goes through the list of refs for all branches we push to github,
398 # generates a snippet of shell which is evaluated. The snippet checks CI_COMMIT_SHA against the SHA
399 # (aka objectname) at tip of each branch, and if any SHAs match then it checks out the local branch
400 # and then pushes that ref to a corresponding github branch
401 - eval $(git for-each-ref --shell bash --format 'if [ $CI_COMMIT_SHA == %(objectname) ]; then git checkout -B %(refname:strip=3); git push --follow-tags github %(refname:strip=3); fi;' $GITHUB_PUSH_REFS)
406 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
412 - /^v\d+\.\d+(\.\d+)?($|-)/
416 before_script: *do_nothing_before
420 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
421 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
422 - chmod 600 ~/.ssh/id_rsa
423 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
424 - export GIT_VER=$(git describe --always)
427 - tar czvf $GIT_VER.tar.gz $GIT_VER
428 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
429 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
430 - cd ../../zh_CN/_build/
432 - tar czvf $GIT_VER.tar.gz $GIT_VER
433 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
434 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
435 # add link to preview doc
436 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
437 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
441 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
445 # can only be triggered
449 - docs/_build/linkcheck
452 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
453 - test "$CHECK_LINKS" = "Yes" || exit 0
454 # can only run on master branch (otherwise the commit is not on Github yet)
455 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
461 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
467 - /^v\d+\.\d+(\.\d+)?($|-)/
469 before_script: *do_nothing_before
471 - tools/ci/check-line-endings.sh ${IDF_PATH}
475 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
481 - /^v\d+\.\d+(\.\d+)?($|-)/
483 before_script: *do_nothing_before
486 - git log -n10 --oneline
487 # commit start with "WIP: " need to be squashed before merge
488 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
492 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
498 - /^v\d+\.\d+(\.\d+)?($|-)/
500 before_script: *do_nothing_before
502 - tools/ci/check-executable.sh
504 check_submodule_sync:
506 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
512 - /^v\d+\.\d+(\.\d+)?($|-)/
516 before_script: *do_nothing_before
518 # check if all submodules are correctly synced to public repostory
519 - git submodule update --init --recursive
524 image: $CI_DOCKER_REGISTRY/ubuntu-test-env$BOT_DOCKER_IMAGE_TAG
526 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
527 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
532 - build_esp_idf_tests
534 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
535 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
538 - components/idf_test/*/CIConfigs
539 - components/idf_test/*/TC.sqlite
540 - $EXAMPLE_CONFIG_OUTPUT_PATH
542 before_script: *add_gitlab_key_before
544 # assign example tests
545 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
546 # assign unit test cases
547 - 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
548 # clone test script to assign tests
549 - git clone $TEST_SCRIPT_REPOSITORY
550 - cd auto_test_script
551 - python $CHECKOUT_REF_SCRIPT auto_test_script
552 # assgin integration test cases
553 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin
555 .example_test_template: &example_test_template
556 stage: integration_test
561 - /^v\d+\.\d+(\.\d+)?($|-)/
580 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
581 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
582 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
583 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
584 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
586 # first test if config file exists, if not exist, exit 0
587 - test -e $CONFIG_FILE || exit 0
588 # clone test env configs
589 - git clone $TEST_ENV_CONFIG_REPOSITORY
590 - cd ci-test-runner-configs
591 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
594 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE -e $ENV_FILE
596 .unit_test_template: &unit_test_template
597 <<: *example_test_template
601 - build_esp_idf_tests
603 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
604 TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app"
605 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml"
606 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
607 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
609 .test_template: &test_template
610 stage: integration_test
615 - /^v\d+\.\d+(\.\d+)?($|-)/
629 LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF"
630 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
631 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test"
632 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml"
633 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml"
634 before_script: *add_gitlab_key_before
636 # first test if config file exists, if not exist, exit 0
637 - test -e $CONFIG_FILE || exit 0
638 # clone local test env configs
639 - git clone $TEST_ENV_CONFIG_REPOSITORY
640 - cd ci-test-runner-configs
641 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
643 - git clone $TEST_SCRIPT_REPOSITORY
644 - cd auto_test_script
645 - python $CHECKOUT_REF_SCRIPT auto_test_script
647 - 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
661 # clone local test env configs
662 - git clone $TEST_ENV_CONFIG_REPOSITORY
663 - cd ci-test-runner-configs
664 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
666 - git clone $TEST_SCRIPT_REPOSITORY
667 - cd auto_test_script
668 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..."
670 - ./Tools/prepare_nvs_bin.sh
672 - 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
675 <<: *example_test_template
681 <<: *example_test_template
687 <<: *example_test_template
693 <<: *example_test_template
699 <<: *unit_test_template
705 <<: *unit_test_template
711 <<: *unit_test_template
717 <<: *unit_test_template
723 <<: *unit_test_template
729 <<: *unit_test_template
735 <<: *unit_test_template
741 <<: *unit_test_template
747 <<: *unit_test_template
753 <<: *unit_test_template
759 <<: *unit_test_template
765 <<: *unit_test_template
771 <<: *unit_test_template
777 <<: *unit_test_template
783 <<: *unit_test_template
789 <<: *unit_test_template
795 <<: *unit_test_template
801 <<: *unit_test_template
807 <<: *unit_test_template
813 <<: *unit_test_template
819 <<: *unit_test_template
825 <<: *unit_test_template
831 <<: *unit_test_template
837 <<: *unit_test_template
843 <<: *unit_test_template
849 <<: *unit_test_template
855 <<: *unit_test_template
861 <<: *unit_test_template
867 <<: *unit_test_template
873 <<: *unit_test_template
879 <<: *unit_test_template
885 <<: *unit_test_template
891 <<: *unit_test_template
897 <<: *unit_test_template
903 <<: *unit_test_template
909 <<: *unit_test_template
915 <<: *unit_test_template
921 <<: *unit_test_template
927 <<: *unit_test_template
933 <<: *unit_test_template
939 <<: *unit_test_template
946 <<: *unit_test_template
953 <<: *unit_test_template
960 <<: *unit_test_template
967 <<: *unit_test_template
974 <<: *unit_test_template
981 <<: *unit_test_template
988 <<: *unit_test_template
995 <<: *unit_test_template
1002 <<: *unit_test_template
1009 <<: *unit_test_template
1016 <<: *unit_test_template
1023 <<: *unit_test_template
1030 <<: *unit_test_template
1036 <<: *unit_test_template
1042 <<: *unit_test_template
1048 <<: *unit_test_template
1055 <<: *unit_test_template
1061 <<: *unit_test_template
1067 <<: *unit_test_template
1073 <<: *unit_test_template
1080 <<: *unit_test_template
1086 <<: *unit_test_template
1092 <<: *unit_test_template
1098 <<: *unit_test_template
1105 <<: *unit_test_template
1111 <<: *unit_test_template
1117 <<: *unit_test_template
1123 <<: *unit_test_template