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/
309 <<: *host_test_template
313 - cd components/spiffs/test_spiffs_host/
316 test_multi_heap_on_host:
317 <<: *host_test_template
319 - cd components/heap/test_multi_heap_host
320 - ./test_all_configs.sh
323 <<: *host_test_template
325 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
326 - rm -rf test_build_system
327 - mkdir test_build_system
328 - cd test_build_system
329 - ${IDF_PATH}/tools/ci/test_build_system.sh
332 <<: *host_test_template
336 - tools/test_idf_monitor/outputs/*
339 - cd ${IDF_PATH}/tools/test_idf_monitor
340 - ./run_test_idf_monitor.py
342 test_esp_err_to_name_on_host:
343 <<: *host_test_template
346 - ./gen_esp_err_to_name.py
347 - 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)
349 push_master_to_github:
351 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
357 - /^v\d+\.\d+(\.\d+)?($|-)/
361 GITHUB_PUSH_REFS: refs/remotes/origin/release refs/remotes/origin/master
362 before_script: *do_nothing_before
366 - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64
367 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
368 - chmod 600 ~/.ssh/id_rsa
369 - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
370 - git remote remove github &>/dev/null || true
371 - git remote add github git@github.com:espressif/esp-idf.git
372 # What the next line of script does: goes through the list of refs for all branches we push to github,
373 # generates a snippet of shell which is evaluated. The snippet checks CI_COMMIT_SHA against the SHA
374 # (aka objectname) at tip of each branch, and if any SHAs match then it checks out the local branch
375 # and then pushes that ref to a corresponding github branch
376 - 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)
381 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
387 - /^v\d+\.\d+(\.\d+)?($|-)/
391 before_script: *do_nothing_before
395 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
396 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
397 - chmod 600 ~/.ssh/id_rsa
398 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
399 - export GIT_VER=$(git describe --always)
402 - tar czvf $GIT_VER.tar.gz $GIT_VER
403 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
404 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
405 - cd ../../zh_CN/_build/
407 - tar czvf $GIT_VER.tar.gz $GIT_VER
408 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
409 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
410 # add link to preview doc
411 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
412 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
416 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
420 # can only be triggered
424 - docs/_build/linkcheck
427 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
428 - test "$CHECK_LINKS" = "Yes" || exit 0
429 # can only run on master branch (otherwise the commit is not on Github yet)
430 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
436 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
442 - /^v\d+\.\d+(\.\d+)?($|-)/
444 before_script: *do_nothing_before
447 - git log -n10 --oneline
448 # commit start with "WIP: " need to be squashed before merge
449 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
453 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
459 - /^v\d+\.\d+(\.\d+)?($|-)/
461 before_script: *do_nothing_before
463 - tools/ci/check-executable.sh
465 check_submodule_sync:
467 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
473 - /^v\d+\.\d+(\.\d+)?($|-)/
477 before_script: *do_nothing_before
479 # check if all submodules are correctly synced to public repostory
480 - git submodule update --init --recursive
485 image: $CI_DOCKER_REGISTRY/ubuntu-test-env$BOT_DOCKER_IMAGE_TAG
487 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
488 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
493 - build_esp_idf_tests
495 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
496 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
499 - components/idf_test/*/CIConfigs
500 - components/idf_test/*/TC.sqlite
501 - $EXAMPLE_CONFIG_OUTPUT_PATH
503 before_script: *add_gitlab_key_before
505 # assign example tests
506 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
507 # assign unit test cases
508 - 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
509 # clone test script to assign tests
510 - git clone $TEST_SCRIPT_REPOSITORY
511 - cd auto_test_script
512 - python $CHECKOUT_REF_SCRIPT auto_test_script
513 # assgin integration test cases
514 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin
516 .example_test_template: &example_test_template
517 stage: integration_test
522 - /^v\d+\.\d+(\.\d+)?($|-)/
541 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
542 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
543 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
544 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
545 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
547 # first test if config file exists, if not exist, exit 0
548 - test -e $CONFIG_FILE || exit 0
549 # clone test env configs
550 - git clone $TEST_ENV_CONFIG_REPOSITORY
551 - cd ci-test-runner-configs
552 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
555 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE -e $ENV_FILE
557 .unit_test_template: &unit_test_template
558 <<: *example_test_template
562 - build_esp_idf_tests
564 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
565 TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app"
566 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml"
567 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
568 ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml"
570 .test_template: &test_template
571 stage: integration_test
576 - /^v\d+\.\d+(\.\d+)?($|-)/
590 LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF"
591 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
592 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test"
593 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml"
594 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml"
595 before_script: *add_gitlab_key_before
597 # first test if config file exists, if not exist, exit 0
598 - test -e $CONFIG_FILE || exit 0
599 # clone local test env configs
600 - git clone $TEST_ENV_CONFIG_REPOSITORY
601 - cd ci-test-runner-configs
602 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
604 - git clone $TEST_SCRIPT_REPOSITORY
605 - cd auto_test_script
606 - python $CHECKOUT_REF_SCRIPT auto_test_script
608 - 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
622 # clone local test env configs
623 - git clone $TEST_ENV_CONFIG_REPOSITORY
624 - cd ci-test-runner-configs
625 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
627 - git clone $TEST_SCRIPT_REPOSITORY
628 - cd auto_test_script
629 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..."
631 - ./Tools/prepare_nvs_bin.sh
633 - 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
636 <<: *example_test_template
642 <<: *example_test_template
648 <<: *example_test_template
654 <<: *example_test_template
660 <<: *unit_test_template
666 <<: *unit_test_template
672 <<: *unit_test_template
678 <<: *unit_test_template
684 <<: *unit_test_template
690 <<: *unit_test_template
696 <<: *unit_test_template
702 <<: *unit_test_template
708 <<: *unit_test_template
714 <<: *unit_test_template
720 <<: *unit_test_template
726 <<: *unit_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
907 <<: *unit_test_template
914 <<: *unit_test_template
921 <<: *unit_test_template
928 <<: *unit_test_template
935 <<: *unit_test_template
942 <<: *unit_test_template
949 <<: *unit_test_template
956 <<: *unit_test_template
963 <<: *unit_test_template
970 <<: *unit_test_template
977 <<: *unit_test_template
984 <<: *unit_test_template
991 <<: *unit_test_template
997 <<: *unit_test_template
1003 <<: *unit_test_template
1009 <<: *unit_test_template
1016 <<: *unit_test_template
1022 <<: *unit_test_template
1028 <<: *unit_test_template
1034 <<: *unit_test_template
1041 <<: *unit_test_template
1047 <<: *unit_test_template
1053 <<: *unit_test_template
1059 <<: *unit_test_template
1066 <<: *unit_test_template
1072 <<: *unit_test_template
1078 <<: *unit_test_template
1084 <<: *unit_test_template