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 # before each job, we need to check if this job is filtered by bot stage/job filter
35 .apply_bot_filter: &apply_bot_filter
36 python $APPLY_BOT_FILTER_SCRIPT || exit 0
39 # apply bot filter in before script
44 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
45 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
46 - chmod 600 ~/.ssh/id_rsa
47 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
49 # Set IS_PRIVATE or IS_PUBLIC depending on if our branch is public or not
51 # (the same regular expressions are used to set these are used in 'only:' sections below
52 - source tools/ci/configure_ci_environment.sh
54 # fetch the submodules (& if necessary re-fetch repo) from gitlab
55 - time ./tools/ci/get-full-sources.sh
58 before_script: &do_nothing_before
59 # apply bot filter in before script
61 - echo "Not setting up GitLab key, not fetching submodules"
62 - source tools/ci/configure_ci_environment.sh
64 .add_gitlab_key_before:
65 before_script: &add_gitlab_key_before
66 # apply bot filter in before script
68 - echo "Not fetching submodules"
69 - source tools/ci/configure_ci_environment.sh
73 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
74 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
75 - chmod 600 ~/.ssh/id_rsa
76 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
80 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
87 - git clone https://github.com/espressif/esp-idf-template.git
89 # Try to use the same branch name for esp-idf-template that we're
90 # using on esp-idf. If it doesn't exist then just stick to the default
92 - python $CHECKOUT_REF_SCRIPT esp-idf-template
93 # Test debug build (default)
95 # Now test release build
97 - sed -i.bak -e's/CONFIG_OPTIMIZATION_LEVEL_DEBUG\=y/CONFIG_OPTIMIZATION_LEVEL_RELEASE=y/' sdkconfig
99 # Check if there are any stray printf/ets_printf references in WiFi libs
100 - cd ../components/esp32/lib
101 - test $(xtensa-esp32-elf-nm *.a | grep -w printf | wc -l) -eq 0
102 - test $(xtensa-esp32-elf-nm *.a | grep -w ets_printf | wc -l) -eq 0
105 .build_template: &build_template
107 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
114 .build_ssc_template: &build_ssc_template
121 SSC_CONFIG_FOLDER: "$CI_PROJECT_DIR/SSC/configs/ESP32_IDF"
123 - git clone $SSC_REPOSITORY
125 - python $CHECKOUT_REF_SCRIPT SSC
126 - MAKEFLAGS= ./ci_build_ssc.sh "${CI_JOB_NAME}" "${IDF_PATH}/.gitlab-ci.yml"
128 # don't forget to add to dependency to test_template when adding new build_ssc jobs
130 <<: *build_ssc_template
133 <<: *build_ssc_template
136 <<: *build_ssc_template
142 - tools/unit-test-app/output
143 - components/idf_test/unit_test/TestCaseAll.yml
144 - components/idf_test/unit_test/CIConfigs/*.yml
147 - cd tools/unit-test-app
148 - make help # make sure kconfig tools are built in single process
149 - make ut-clean-all-configs
150 - export EXTRA_CFLAGS="-Werror -Werror=deprecated-declarations"
151 - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS}
152 - make ut-build-all-configs TESTS_ALL=1
153 - python tools/UnitTestParser.py
155 .build_examples_template: &build_examples_template
161 - build_examples/*/*/*/build/*.bin
162 - build_examples/*/*/*/build/*.elf
163 - build_examples/*/*/*/build/*.map
164 - build_examples/*/*/*/build/download.config
165 - build_examples/*/*/*/build/bootloader/*.bin
170 LOG_PATH: "$CI_PROJECT_DIR/log_examples"
172 # it's not possible to build 100% out-of-tree and have the "artifacts"
173 # mechanism work, but this is the next best thing
174 - rm -rf build_examples
175 - mkdir build_examples
177 # build some of examples
178 - mkdir -p ${LOG_PATH}
179 - ${IDF_PATH}/tools/ci/build_examples.sh "${CI_JOB_NAME}"
182 <<: *build_examples_template
185 <<: *build_examples_template
188 <<: *build_examples_template
191 <<: *build_examples_template
194 <<: *build_examples_template
197 <<: *build_examples_template
200 <<: *build_examples_template
203 <<: *build_examples_template
208 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
214 # English version of documentation
215 - docs/en/doxygen-warning-log.txt
216 - docs/en/sphinx-warning-log.txt
217 - docs/en/sphinx-warning-log-sanitized.txt
218 - docs/en/_build/html
219 # Chinese version of documentation
220 - docs/zh_CN/doxygen-warning-log.txt
221 - docs/zh_CN/sphinx-warning-log.txt
222 - docs/zh_CN/sphinx-warning-log-sanitized.txt
223 - docs/zh_CN/_build/html
227 - ./check_lang_folder_sync.sh
231 - ../check_doc_warnings.sh
235 - ../check_doc_warnings.sh
239 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
244 - cd components/nvs_flash/test_nvs_host
249 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
255 - components/nvs_flash/test_nvs_host/coverage_report
258 # This job takes a few hours to finish, so only run it on demand
260 BOT_NEEDS_TRIGGER_BY_NAME: 1
262 - cd components/nvs_flash/test_nvs_host
263 - make coverage_report
265 test_partition_table_on_host:
267 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
272 - cd components/partition_table/test_gen_esp32part_host
273 - ./gen_esp32part_tests.py
277 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
282 - components/wear_levelling/test_wl_host/coverage_report.zip
285 - cd components/wear_levelling/test_wl_host
288 test_multi_heap_on_host:
290 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
294 - cd components/heap/test_multi_heap_host
295 - ./test_all_configs.sh
299 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
304 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
305 - rm -rf test_build_system
306 - mkdir test_build_system
307 - cd test_build_system
308 - ${IDF_PATH}/tools/ci/test_build_system.sh
312 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
320 - /^v\d+\.\d+(\.\d+)?($|-)/
322 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
323 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test"
324 REPORT_PATH: "$CI_PROJECT_DIR/CI_Test_Report"
325 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/tools/unit-test-app/tools/ModuleDefinition.yml"
327 #We need all UT* and IT* artifacts except for only a few other
336 - VER_NUM=`git rev-list HEAD | wc -l | awk '{print $1}'`
337 - SHA_ID=`echo $CI_COMMIT_SHA | cut -c 1-7`
338 - REVISION="${VER_NUM}_${SHA_ID}"
339 # replace / to _ in branch name
340 - ESCAPED_BRANCH_NAME=`echo $CI_COMMIT_REF_NAME | sed 's/\//___/g'`
341 # result path and artifacts path
342 - RESULT_PATH="$CI_PROJECT_NAME/$ESCAPED_BRANCH_NAME/$REVISION"
343 - ARTIFACTS_PATH="$GITLAB_HTTP_SERVER/idf/esp-idf/builds/$CI_JOB_ID/artifacts/browse/$CI_COMMIT_SHA"
345 - git clone $GITLAB_SSH_SERVER/yinling/auto_test_script.git
346 - cd auto_test_script
347 - python $CHECKOUT_REF_SCRIPT auto_test_script
350 - python CITestReport.py -l $LOG_PATH -t $TEST_CASE_FILE_PATH -p $REPORT_PATH -r $RESULT_PATH -a $ARTIFACTS_PATH -m $MODULE_UPDATE_FILE || TEST_RESULT=Fail
351 # commit to CI-test-result project
352 - git clone $GITLAB_SSH_SERVER/qa/CI-test-result.git
353 - rm -rf "CI-test-result/RawData/$RESULT_PATH"
354 - cp -R $CI_PROJECT_NAME CI-test-result/RawData
357 - git config --global user.email "ci-test-result@espressif.com"
358 - git config --global user.name "ci-test-result"
361 - git commit . -m "update test result for $CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/$CI_COMMIT_SHA, pipeline ID $CI_PIPELINE_ID" || exit 0
362 - git push origin master
363 - test "${TEST_RESULT}" = "Pass" || exit 1
365 test_esp_err_to_name_on_host:
367 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
373 - ./gen_esp_err_to_name.py
374 - 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)
376 push_master_to_github:
378 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
384 - /^v\d+\.\d+(\.\d+)?($|-)/
388 GITHUB_PUSH_REFS: refs/remotes/origin/release refs/remotes/origin/master
389 before_script: *do_nothing_before
393 - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64
394 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
395 - chmod 600 ~/.ssh/id_rsa
396 - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
397 - git remote remove github &>/dev/null || true
398 - git remote add github git@github.com:espressif/esp-idf.git
399 # What the next line of script does: goes through the list of refs for all branches we push to github,
400 # generates a snippet of shell which is evaluated. The snippet checks CI_COMMIT_SHA against the SHA
401 # (aka objectname) at tip of each branch, and if any SHAs match then it checks out the local branch
402 # and then pushes that ref to a corresponding github branch
403 - 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)
408 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
414 - /^v\d+\.\d+(\.\d+)?($|-)/
418 before_script: *do_nothing_before
422 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
423 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
424 - chmod 600 ~/.ssh/id_rsa
425 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
426 - export GIT_VER=$(git describe --always)
429 - tar czvf $GIT_VER.tar.gz $GIT_VER
430 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
431 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
432 - cd ../../zh_CN/_build/
434 - tar czvf $GIT_VER.tar.gz $GIT_VER
435 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
436 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
437 # add link to preview doc
438 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
439 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
443 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
447 # can only be triggered
451 - docs/_build/linkcheck
454 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
455 - test "$CHECK_LINKS" = "Yes" || exit 0
456 # can only run on master branch (otherwise the commit is not on Github yet)
457 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
463 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
469 - /^v\d+\.\d+(\.\d+)?($|-)/
471 before_script: *do_nothing_before
474 - git log -n10 --oneline
475 # commit start with "WIP: " need to be squashed before merge
476 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
478 check_submodule_sync:
480 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
486 - /^v\d+\.\d+(\.\d+)?($|-)/
490 before_script: *do_nothing_before
492 # check if all submodules are correctly synced to public repostory
493 - git submodule update --init --recursive
498 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
499 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
501 UT_BIN_PATH: "tools/unit-test-app/output"
502 OUTPUT_BIN_PATH: "test_bins/ESP32_IDF"
503 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
504 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
508 - components/idf_test/*/CIConfigs
509 - components/idf_test/*/TC.sqlite
510 - $EXAMPLE_CONFIG_OUTPUT_PATH
511 - tools/unit-test-app/output
513 before_script: *add_gitlab_key_before
515 # first move test bins together: test_bins/CHIP_SDK/TestApp/bin_files
516 - mkdir -p $OUTPUT_BIN_PATH
517 - cp -r SSC/ssc_bin/* $OUTPUT_BIN_PATH
518 # assign example tests
519 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
520 # assign unit test cases
521 - 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
522 # clone test script to assign tests
523 - git clone $TEST_SCRIPT_REPOSITORY
524 - cd auto_test_script
525 - python $CHECKOUT_REF_SCRIPT auto_test_script
526 # assgin integration test cases
527 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin
529 .example_test_template: &example_test_template
535 - /^v\d+\.\d+(\.\d+)?($|-)/
538 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
539 # we have a lot build example jobs and the binaries them exceed the limitation of artifacts.
540 # we can't artifact them in one job. For example test jobs, download all artifacts from previous stages.
547 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
548 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
549 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
550 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
552 # first test if config file exists, if not exist, exit 0
553 - test -e $CONFIG_FILE || exit 0
556 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE
558 .unit_test_template: &unit_test_template
559 <<: *example_test_template
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"
569 .test_template: &test_template
575 - /^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 <<: *unit_test_template
649 <<: *unit_test_template
656 <<: *unit_test_template
663 <<: *unit_test_template
670 <<: *unit_test_template
677 <<: *unit_test_template
684 <<: *unit_test_template
691 <<: *unit_test_template
698 <<: *unit_test_template
705 <<: *unit_test_template
712 <<: *unit_test_template
719 <<: *unit_test_template
726 <<: *unit_test_template
733 <<: *unit_test_template
740 <<: *unit_test_template
747 <<: *unit_test_template
754 <<: *unit_test_template
761 <<: *unit_test_template
768 <<: *unit_test_template
775 <<: *unit_test_template
782 <<: *unit_test_template
789 <<: *unit_test_template
796 <<: *unit_test_template
803 <<: *unit_test_template
810 <<: *unit_test_template
817 <<: *unit_test_template
824 <<: *unit_test_template
831 <<: *unit_test_template
838 <<: *unit_test_template
845 <<: *unit_test_template
852 <<: *unit_test_template
859 <<: *unit_test_template
866 <<: *unit_test_template
873 <<: *unit_test_template
880 <<: *unit_test_template
887 <<: *unit_test_template