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"
29 APPLY_BOT_FILTER_SCRIPT: "$CI_PROJECT_DIR/tools/ci/apply_bot_filter.py"
30 CHECKOUT_REF_SCRIPT: "$CI_PROJECT_DIR/tools/ci/checkout_project_ref.py"
32 # before each job, we need to check if this job is filtered by bot stage/job filter
33 .apply_bot_filter: &apply_bot_filter
34 python $APPLY_BOT_FILTER_SCRIPT || exit 0
37 # apply bot filter in before script
42 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
43 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
44 - chmod 600 ~/.ssh/id_rsa
45 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
47 # Set IS_PRIVATE or IS_PUBLIC depending on if our branch is public or not
49 # (the same regular expressions are used to set these are used in 'only:' sections below
50 - source tools/ci/configure_ci_environment.sh
52 # fetch the submodules (& if necessary re-fetch repo) from gitlab
53 - time ./tools/ci/get-full-sources.sh
56 before_script: &do_nothing_before
57 # apply bot filter in before script
59 - echo "Not setting up GitLab key, not fetching submodules"
60 - source tools/ci/configure_ci_environment.sh
62 .add_gitlab_key_before:
63 before_script: &add_gitlab_key_before
64 # apply bot filter in before script
66 - echo "Not fetching submodules"
67 - source tools/ci/configure_ci_environment.sh
71 - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64
72 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
73 - chmod 600 ~/.ssh/id_rsa
74 - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
78 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
85 - git clone https://github.com/espressif/esp-idf-template.git
87 # Try to use the same branch name for esp-idf-template that we're
88 # using on esp-idf. If it doesn't exist then just stick to the default
90 - python $CHECKOUT_REF_SCRIPT esp-idf-template
91 # Test debug build (default)
93 # Now test release build
95 - sed -i.bak -e's/CONFIG_OPTIMIZATION_LEVEL_DEBUG\=y/CONFIG_OPTIMIZATION_LEVEL_RELEASE=y/' sdkconfig
97 # Check if there are any stray printf/ets_printf references in WiFi libs
98 - cd ../components/esp32/lib
99 - test $(xtensa-esp32-elf-nm *.a | grep -w printf | wc -l) -eq 0
100 - test $(xtensa-esp32-elf-nm *.a | grep -w ets_printf | wc -l) -eq 0
103 .build_template: &build_template
105 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
119 - git clone $SSC_REPOSITORY
121 - python $CHECKOUT_REF_SCRIPT SSC
122 - MAKEFLAGS= ./gen_misc_ng.sh
128 - tools/unit-test-app/output
129 - components/idf_test/unit_test/TestCaseAll.yml
130 - components/idf_test/unit_test/CIConfigs/*.yml
133 - cd tools/unit-test-app
134 - make help # make sure kconfig tools are built in single process
135 - make ut-clean-all-configs
136 - export EXTRA_CFLAGS="-Werror -Werror=deprecated-declarations"
137 - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS}
138 - make ut-build-all-configs TESTS_ALL=1
139 - python tools/UnitTestParser.py
141 .build_examples_template: &build_examples_template
146 - build_examples/*/*/*/build/*.bin
147 - build_examples/*/*/*/build/*.elf
148 - build_examples/*/*/*/build/*.map
149 - build_examples/*/*/*/build/download.config
150 - build_examples/*/*/*/build/bootloader/*.bin
155 LOG_PATH: "$CI_PROJECT_DIR/log_examples"
157 # it's not possible to build 100% out-of-tree and have the "artifacts"
158 # mechanism work, but this is the next best thing
159 - rm -rf build_examples
160 - mkdir build_examples
162 # build some of examples
163 - mkdir -p ${LOG_PATH}
164 - ${IDF_PATH}/tools/ci/build_examples.sh "${CI_JOB_NAME}"
167 <<: *build_examples_template
170 <<: *build_examples_template
173 <<: *build_examples_template
176 <<: *build_examples_template
179 <<: *build_examples_template
182 <<: *build_examples_template
185 <<: *build_examples_template
188 <<: *build_examples_template
193 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
199 # English version of documentation
200 - docs/en/doxygen-warning-log.txt
201 - docs/en/sphinx-warning-log.txt
202 - docs/en/sphinx-warning-log-sanitized.txt
203 - docs/en/_build/html
204 # Chinese version of documentation
205 - docs/zh_CN/doxygen-warning-log.txt
206 - docs/zh_CN/sphinx-warning-log.txt
207 - docs/zh_CN/sphinx-warning-log-sanitized.txt
208 - docs/zh_CN/_build/html
214 - ../check_doc_warnings.sh
218 - ../check_doc_warnings.sh
222 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
227 - cd components/nvs_flash/test_nvs_host
230 test_partition_table_on_host:
232 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
237 - cd components/partition_table/test_gen_esp32part_host
238 - ./gen_esp32part_tests.py
242 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
247 - components/wear_levelling/test_wl_host/coverage_report.zip
250 - cd components/wear_levelling/test_wl_host
253 test_multi_heap_on_host:
255 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
259 - cd components/heap/test_multi_heap_host
264 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
269 - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh
270 - rm -rf test_build_system
271 - mkdir test_build_system
272 - cd test_build_system
273 - ${IDF_PATH}/tools/ci/test_build_system.sh
277 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
284 - /^v\d+\.\d+(\.\d+)?($|-)/
286 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
287 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test"
288 REPORT_PATH: "$CI_PROJECT_DIR/CI_Test_Report"
289 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/tools/unit-test-app/tools/ModuleDefinition.yml"
291 #We need all UT* and IT* artifacts except for only a few other
300 - VER_NUM=`git rev-list HEAD | wc -l | awk '{print $1}'`
301 - SHA_ID=`echo $CI_COMMIT_SHA | cut -c 1-7`
302 - REVISION="${VER_NUM}_${SHA_ID}"
303 # replace / to _ in branch name
304 - ESCAPED_BRANCH_NAME=`echo $CI_COMMIT_REF_NAME | sed 's/\//___/g'`
305 # result path and artifacts path
306 - RESULT_PATH="$CI_PROJECT_NAME/$ESCAPED_BRANCH_NAME/$REVISION"
307 - ARTIFACTS_PATH="$GITLAB_HTTP_SERVER/idf/esp-idf/builds/$CI_JOB_ID/artifacts/browse/$CI_COMMIT_SHA"
309 - git clone $GITLAB_SSH_SERVER/yinling/auto_test_script.git
310 - cd auto_test_script
311 - python $CHECKOUT_REF_SCRIPT auto_test_script
314 - 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
315 # commit to CI-test-result project
316 - git clone $GITLAB_SSH_SERVER/qa/CI-test-result.git
317 - rm -rf "CI-test-result/RawData/$RESULT_PATH"
318 - cp -R $CI_PROJECT_NAME CI-test-result/RawData
321 - git config --global user.email "ci-test-result@espressif.com"
322 - git config --global user.name "ci-test-result"
325 - git commit . -m "update test result for $CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/$CI_COMMIT_SHA, pipeline ID $CI_PIPELINE_ID" || exit 0
326 - git push origin master
327 - test "${TEST_RESULT}" = "Pass" || exit 1
329 test_esp_err_to_name_on_host:
331 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
337 - ./gen_esp_err_to_name.py
338 - 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)
340 push_master_to_github:
342 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
348 - /^v\d+\.\d+(\.\d+)?($|-)/
352 GITHUB_PUSH_REFS: refs/remotes/origin/release refs/remotes/origin/master
353 before_script: *do_nothing_before
357 - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64
358 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
359 - chmod 600 ~/.ssh/id_rsa
360 - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config
361 - git remote remove github &>/dev/null || true
362 - git remote add github git@github.com:espressif/esp-idf.git
363 # What the next line of script does: goes through the list of refs for all branches we push to github,
364 # generates a snippet of shell which is evaluated. The snippet checks CI_COMMIT_SHA against the SHA
365 # (aka objectname) at tip of each branch, and if any SHAs match then it checks out the local branch
366 # and then pushes that ref to a corresponding github branch
367 - 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)
372 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
378 - /^v\d+\.\d+(\.\d+)?($|-)/
382 before_script: *do_nothing_before
386 - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64
387 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa
388 - chmod 600 ~/.ssh/id_rsa
389 - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config
390 - export GIT_VER=$(git describe --always)
393 - tar czvf $GIT_VER.tar.gz $GIT_VER
394 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/en
395 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/en && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
396 - cd ../../zh_CN/_build/
398 - tar czvf $GIT_VER.tar.gz $GIT_VER
399 - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH/zh_CN
400 - ssh $DOCS_SERVER -x "cd $DOCS_PATH/zh_CN && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest"
401 # add link to preview doc
402 - echo "[document preview][en] $CI_DOCKER_REGISTRY/docs/esp-idf/en/${GIT_VER}/index.html"
403 - echo "[document preview][zh_CN] $CI_DOCKER_REGISTRY/docs/esp-idf/zh_CN/${GIT_VER}/index.html"
407 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
411 # can only be triggered
415 - docs/_build/linkcheck
418 # must be triggered with CHECK_LINKS=Yes, otherwise exit without test
419 - test "$CHECK_LINKS" = "Yes" || exit 0
420 # can only run on master branch (otherwise the commit is not on Github yet)
421 - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0
427 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
433 - /^v\d+\.\d+(\.\d+)?($|-)/
435 before_script: *do_nothing_before
438 - git log -n10 --oneline
439 # commit start with "WIP: " need to be squashed before merge
440 - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0'
442 check_submodule_sync:
444 image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG
450 - /^v\d+\.\d+(\.\d+)?($|-)/
454 before_script: *do_nothing_before
456 # check if all submodules are correctly synced to public repostory
457 - git submodule update --init --recursive
462 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
463 # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage.
465 UT_BIN_PATH: "tools/unit-test-app/output"
466 OUTPUT_BIN_PATH: "test_bins/ESP32_IDF"
467 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
468 EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs"
472 - components/idf_test/*/CIConfigs
473 - components/idf_test/*/TC.sqlite
474 - $EXAMPLE_CONFIG_OUTPUT_PATH
475 - tools/unit-test-app/output
477 before_script: *add_gitlab_key_before
479 # first move test bins together: test_bins/CHIP_SDK/TestApp/bin_files
480 - mkdir -p $OUTPUT_BIN_PATH
481 - cp -r SSC/ssc_bin/* $OUTPUT_BIN_PATH
482 # assign example tests
483 - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH
484 # assign unit test cases
485 - 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
486 # clone test script to assign tests
487 - git clone $TEST_SCRIPT_REPOSITORY
488 - cd auto_test_script
489 - python $CHECKOUT_REF_SCRIPT auto_test_script
490 # assgin integration test cases
491 - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/test_bins
493 .example_test_template: &example_test_template
499 - /^v\d+\.\d+(\.\d+)?($|-)/
501 # gitlab ci do not support match job with RegEx or wildcard now in dependencies.
502 # we have a lot build example jobs and the binaries them exceed the limitation of artifacts.
503 # we can't artifact them in one job. For example test jobs, download all artifacts from previous stages.
510 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
511 TEST_CASE_PATH: "$CI_PROJECT_DIR/examples"
512 CONFIG_FILE: "$CI_PROJECT_DIR/examples/test_configs/$CI_JOB_NAME.yml"
513 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
515 # first test if config file exists, if not exist, exit 0
516 - test -e $CONFIG_FILE || exit 0
519 - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE
521 .unit_test_template: &unit_test_template
522 <<: *example_test_template
527 TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw"
528 TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app"
529 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml"
530 LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS"
532 .test_template: &test_template
538 - /^v\d+\.\d+(\.\d+)?($|-)/
549 LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF"
550 LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA"
551 TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test"
552 MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml"
553 CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml"
554 before_script: *add_gitlab_key_before
556 # first test if config file exists, if not exist, exit 0
557 - test -e $CONFIG_FILE || exit 0
558 # clone local test env configs
559 - git clone $TEST_ENV_CONFIG_REPOSITORY
560 - cd ci-test-runner-configs
561 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
563 - git clone $TEST_SCRIPT_REPOSITORY
564 - cd auto_test_script
565 - python $CHECKOUT_REF_SCRIPT auto_test_script
567 - 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
581 # clone local test env configs
582 - git clone $TEST_ENV_CONFIG_REPOSITORY
583 - cd ci-test-runner-configs
584 - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs
586 - git clone $TEST_SCRIPT_REPOSITORY
587 - cd auto_test_script
588 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..."
590 - ./Tools/prepare_nvs_bin.sh
592 - 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
595 <<: *example_test_template
601 <<: *unit_test_template
608 <<: *unit_test_template
615 <<: *unit_test_template
622 <<: *unit_test_template
629 <<: *unit_test_template
636 <<: *unit_test_template
643 <<: *unit_test_template
650 <<: *unit_test_template
657 <<: *unit_test_template
664 <<: *unit_test_template
671 <<: *unit_test_template
678 <<: *unit_test_template
685 <<: *unit_test_template
692 <<: *unit_test_template
699 <<: *unit_test_template
706 <<: *unit_test_template
713 <<: *unit_test_template
720 <<: *unit_test_template
727 <<: *unit_test_template
734 <<: *unit_test_template
741 <<: *unit_test_template
748 <<: *unit_test_template
755 <<: *unit_test_template
762 <<: *unit_test_template
769 <<: *unit_test_template
776 <<: *unit_test_template
783 <<: *unit_test_template
790 <<: *unit_test_template
797 <<: *unit_test_template
804 <<: *unit_test_template
811 <<: *unit_test_template
818 <<: *unit_test_template
825 <<: *unit_test_template
832 <<: *unit_test_template
839 <<: *unit_test_template
846 <<: *unit_test_template