stages: - build - assign_test - host_test - target_test - check - deploy - post_check default: retry: max: 2 # In case of a runner failure we could hop to another one, or a network error could go away. when: runner_system_failure variables: # System environment # Common parameters for the 'make' during CI tests MAKEFLAGS: "-j5 --no-keep-going" # GitLab-CI environment # more attempts for more robust GET_SOURCES_ATTEMPTS: "10" ARTIFACT_DOWNLOAD_ATTEMPTS: "10" # GIT_STRATEGY is not defined here. # Use an option from "CI / CD Settings" - "General pipelines". # we will download archive for each submodule instead of clone. # we don't do "recursive" when fetch submodule as they're not used in CI now. GIT_SUBMODULE_STRATEGY: none SUBMODULE_FETCH_TOOL: "tools/ci/ci_fetch_submodule.py" # by default we will fetch all submodules # jobs can overwrite this variable to only fetch submodules they required # set to "none" if don't need to fetch submodules SUBMODULES_TO_FETCH: "all" # tell build system do not check submodule update as we download archive instead of clone IDF_SKIP_CHECK_SUBMODULES: 1 UNIT_TEST_BUILD_SYSTEM: make # IDF environment IDF_PATH: "$CI_PROJECT_DIR" BATCH_BUILD: "1" V: "0" APPLY_BOT_FILTER_SCRIPT: "$CI_PROJECT_DIR/tools/ci/apply_bot_filter.py" CHECKOUT_REF_SCRIPT: "$CI_PROJECT_DIR/tools/ci/checkout_project_ref.py" # Docker images BOT_DOCKER_IMAGE_TAG: ":latest" # target test repo parameters TEST_ENV_CONFIG_REPO: "https://gitlab-ci-token:${BOT_TOKEN}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/qa/ci-test-runner-configs.git" CI_AUTO_TEST_SCRIPT_REPO_URL: "https://gitlab-ci-token:${BOT_TOKEN}@${CI_SERVER_HOST}:${CI_SERVER_PORT}/qa/auto_test_script.git" CI_AUTO_TEST_SCRIPT_REPO_BRANCH: "ci/v3.1" # Versioned esp-idf-doc env image to use for all document building jobs ESP_IDF_DOC_ENV_IMAGE: "$CI_DOCKER_REGISTRY/esp-idf-doc-env:v7" # before each job, we need to check if this job is filtered by bot stage/job filter .apply_bot_filter: &apply_bot_filter python $APPLY_BOT_FILTER_SCRIPT || exit 0 .setup_tools_unless_target_test: &setup_tools_unless_target_test | if [[ "$SETUP_TOOLS" == "1" || "$CI_JOB_STAGE" != "target_test" ]]; then tools/idf_tools.py --non-interactive install && eval "$(tools/idf_tools.py --non-interactive export)" || exit 1 fi .show_submodule_urls: &show_submodule_urls | git config --get-regexp '^submodule\..*\.url$' || true .fetch_submodules: &fetch_submodules | python $SUBMODULE_FETCH_TOOL -s $SUBMODULES_TO_FETCH before_script: - source tools/ci/setup_python.sh # apply bot filter in before script - *apply_bot_filter # add gitlab ssh key - mkdir -p ~/.ssh - chmod 700 ~/.ssh - echo -n $GITLAB_KEY > ~/.ssh/id_rsa_base64 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa - chmod 600 ~/.ssh/id_rsa - echo -e "Host gitlab.espressif.cn\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config - if [ "${LOCAL_GITLAB_SSH_SERVER:-}" ]; then SRV=${LOCAL_GITLAB_SSH_SERVER##*@};SRV=${SRV%%:*};printf "Host %s\n\tStrictHostKeyChecking no\n" "${SRV}" >> ~/.ssh/config; fi # Download and install tools, if needed - *setup_tools_unless_target_test # Set some options and environment for CI - source tools/ci/configure_ci_environment.sh - export PYTHONPATH="${PYTHONPATH}:${CI_PROJECT_DIR}/tools/ci/python_packages" - *fetch_submodules # used for check scripts which we want to run unconditionally .before_script_lesser_nofilter: &before_script_lesser_nofilter variables: GIT_SUBMODULE_STRATEGY: none before_script: - echo "Not setting up GitLab key, not fetching submodules, not applying bot filter" - source tools/ci/setup_python.sh - source tools/ci/configure_ci_environment.sh # used for everything else where we want to do no prep, except for bot filter .before_script_lesser: &before_script_lesser variables: GIT_SUBMODULE_STRATEGY: none before_script: - echo "Not setting up GitLab key, not fetching submodules" - source tools/ci/setup_python.sh # apply bot filter in before script - *apply_bot_filter - source tools/ci/configure_ci_environment.sh build_template_app: stage: build image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - build variables: BATCH_BUILD: "1" only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_REGULAR_TEST script: # Set the variable for 'esp-idf-template' testing - ESP_IDF_TEMPLATE_GIT=${ESP_IDF_TEMPLATE_GIT:-"https://github.com/espressif/esp-idf-template.git"} - git clone ${ESP_IDF_TEMPLATE_GIT} # Try to use the same branch name for esp-idf-template that we're # using on esp-idf. If it doesn't exist then just stick to the default # branch - python $CHECKOUT_REF_SCRIPT esp-idf-template esp-idf-template - cd esp-idf-template - make defconfig # Test debug build (default) - make all V=1 # Now test release build - make clean - sed -i.bak -e's/CONFIG_OPTIMIZATION_LEVEL_DEBUG\=y/CONFIG_OPTIMIZATION_LEVEL_RELEASE=y/' sdkconfig - make all V=1 # Check if there are any stray printf/ets_printf references in WiFi libs - cd ../components/esp32/lib - test $(xtensa-esp32-elf-nm *.a | grep -w printf | wc -l) -eq 0 - test $(xtensa-esp32-elf-nm *.a | grep -w ets_printf | wc -l) -eq 0 .build_template: &build_template stage: build image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - build variables: BATCH_BUILD: "1" V: "0" build_ssc: <<: *build_template parallel: 3 artifacts: paths: - SSC/ssc_bin expire_in: 1 week variables: SSC_CONFIG_FOLDER: "$CI_PROJECT_DIR/SSC/configs/ESP32_IDF" only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_INTEGRATION_TEST - $BOT_LABEL_REGULAR_TEST script: - git clone $SSC_REPOSITORY - python $CHECKOUT_REF_SCRIPT SSC SSC - cd SSC - MAKEFLAGS= ./ci_build_ssc.sh .build_esp_idf_unit_test_template: &build_esp_idf_unit_test_template <<: *build_template artifacts: paths: - tools/unit-test-app/output - components/idf_test/unit_test/TestCaseAll.yml expire_in: 4 days only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_UNIT_TEST - $BOT_LABEL_REGULAR_TEST build_esp_idf_tests_make: <<: *build_esp_idf_unit_test_template script: - export EXTRA_CFLAGS=${PEDANTIC_CFLAGS} - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS} - cd $CI_PROJECT_DIR/tools/unit-test-app - MAKEFLAGS= make help # make sure kconfig tools are built in single process - make ut-clean-all-configs - make ut-build-all-configs - python tools/UnitTestParser.py # Check if the tests demand Make built binaries. If not, delete them - if [ "$UNIT_TEST_BUILD_SYSTEM" == "make" ]; then exit 0; fi - rm -rf builds output sdkconfig - rm $CI_PROJECT_DIR/components/idf_test/unit_test/TestCaseAll.yml build_esp_idf_tests_cmake: <<: *build_esp_idf_unit_test_template script: - export PATH="$IDF_PATH/tools:$PATH" - export EXTRA_CFLAGS=${PEDANTIC_CFLAGS} - export EXTRA_CXXFLAGS=${EXTRA_CFLAGS} - cd $CI_PROJECT_DIR/tools/unit-test-app - idf.py ut-clean-all-configs - idf.py ut-build-all-configs - python tools/UnitTestParser.py # Check if the tests demand CMake built binaries. If not, delete them - if [ "$UNIT_TEST_BUILD_SYSTEM" == "cmake" ]; then exit 0; fi - rm -rf builds output sdkconfig - rm $CI_PROJECT_DIR/components/idf_test/unit_test/TestCaseAll.yml build_examples_make: <<: *build_template parallel: 8 # This is a workaround for a rarely encountered issue with building examples in CI. # Probably related to building of Kconfig in 'make clean' stage retry: 1 artifacts: when: always paths: - build_examples/*/*/*/build/*.bin - build_examples/*/*/*/sdkconfig - build_examples/*/*/*/build/*.elf - build_examples/*/*/*/build/*.map - build_examples/*/*/*/build/download.config - build_examples/*/*/*/build/bootloader/*.bin - $LOG_PATH expire_in: 4 days variables: LOG_PATH: "$CI_PROJECT_DIR/log_examples_make" only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_EXAMPLE_TEST - $BOT_LABEL_REGULAR_TEST - $BOT_LABEL_WEEKEND_TEST script: # it's not possible to build 100% out-of-tree and have the "artifacts" # mechanism work, but this is the next best thing - rm -rf build_examples - mkdir build_examples - cd build_examples # build some of examples - mkdir -p ${LOG_PATH} - ${IDF_PATH}/tools/ci/build_examples.sh # same as above, but for CMake build_examples_cmake: <<: *build_template parallel: 5 artifacts: when: always paths: - build_examples_cmake/*/*/*/build/*.bin - build_examples_cmake/*/*/*/sdkconfig - build_examples_cmake/*/*/*/build/*.elf - build_examples_cmake/*/*/*/build/*.map - build_examples_cmake/*/*/*/build/flasher_args.json - build_examples_cmake/*/*/*/build/bootloader/*.bin - $LOG_PATH expire_in: 4 days variables: LOG_PATH: "$CI_PROJECT_DIR/log_examples_cmake" only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_EXAMPLE_TEST - $BOT_LABEL_REGULAR_TEST - $BOT_LABEL_WEEKEND_TEST script: # it's not possible to build 100% out-of-tree and have the "artifacts" # mechanism work, but this is the next best thing - rm -rf build_examples_cmake - mkdir build_examples_cmake - cd build_examples_cmake # build some of examples - mkdir -p ${LOG_PATH} - ${IDF_PATH}/tools/ci/build_examples_cmake.sh .build_docs_template: &build_docs_template stage: build image: $ESP_IDF_DOC_ENV_IMAGE tags: - build_docs artifacts: when: always paths: - docs/*/*.txt - docs/_build/*/html/* - docs/_build/*/latex/* expire_in: 4 days only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_BUILD_DOCS - $BOT_LABEL_REGULAR_TEST dependencies: [] script: # Active python 3.6.10 env as this is where Sphinx is installed - source /opt/pyenv/activate && pyenv global 3.6.10 # Setup a build dir with both languages to simplify deployment - cd docs - mkdir -p _build/$DOCLANG - ./check_lang_folder_sync.sh - cd $DOCLANG - make gh-linkcheck - make html - ../check_doc_warnings.sh - make latexpdf LATEXMKOPTS="--f --interaction=nonstopmode --quiet --outdir=build" - ../check_doc_warnings.sh - mv -f _build/* ../_build/$DOCLANG build_docs_en: extends: .build_docs_template variables: DOCLANG: "en" build_docs_zh_CN: extends: .build_docs_template variables: DOCLANG: "zh_CN" .check_job_template: &check_job_template stage: check image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - host_test dependencies: [] <<: *before_script_lesser_nofilter verify_cmake_style: <<: *check_job_template stage: build only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD - $BOT_LABEL_REGULAR_TEST script: tools/cmake/run_cmake_lint.sh build_docker: stage: build image: espressif/docker-builder:1 tags: - build_docker_amd64_brno only: refs: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - schedules variables: DOCKER_TMP_IMAGE_NAME: "idf_tmp_image" before_script: [] script: - export LOCAL_CI_REPOSITORY_URL=$CI_REPOSITORY_URL - if [ -n "$LOCAL_GITLAB_HTTPS_HOST" ]; then export LOCAL_CI_REPOSITORY_URL="https://gitlab-ci-token:${CI_JOB_TOKEN}@${LOCAL_GITLAB_HTTPS_HOST}/${CI_PROJECT_PATH}"; fi - echo "Using repository at $LOCAL_CI_REPOSITORY_URL" - export DOCKER_BUILD_ARGS="--build-arg IDF_CLONE_URL=${LOCAL_CI_REPOSITORY_URL} --build-arg IDF_CLONE_BRANCH_OR_TAG=${CI_COMMIT_REF_NAME} --build-arg IDF_CHECKOUT_REF=${CI_COMMIT_TAG:-$CI_COMMIT_SHA}" # Build - docker build --tag ${DOCKER_TMP_IMAGE_NAME} ${DOCKER_BUILD_ARGS} tools/docker/ # We can't mount $PWD/examples/get-started/blink into the container, see https://gitlab.com/gitlab-org/gitlab-ce/issues/41227. # The workaround mentioned there works, but leaves around directories which need to be cleaned up manually. # Therefore, build a copy of the example located inside the container. - docker run --rm --workdir /opt/esp/idf/examples/get-started/blink ${DOCKER_TMP_IMAGE_NAME} idf.py build .host_test_template: &host_test_template stage: host_test image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - host_test dependencies: [] only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_HOST_TEST - $BOT_LABEL_REGULAR_TEST test_nvs_on_host: <<: *host_test_template script: - cd components/nvs_flash/test_nvs_host - make test test_nvs_coverage: <<: *host_test_template artifacts: paths: - components/nvs_flash/test_nvs_host/coverage_report expire_in: 1 week only: refs: - triggers variables: - $BOT_LABEL_NVS_COVERAGE script: - cd components/nvs_flash/test_nvs_host - make coverage_report test_partition_table_on_host: <<: *host_test_template tags: - build script: - cd components/partition_table/test_gen_esp32part_host - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./gen_esp32part_tests.py test_wl_on_host: <<: *host_test_template artifacts: paths: - components/wear_levelling/test_wl_host/coverage_report.zip expire_in: 1 week script: - cd components/wear_levelling/test_wl_host - make test test_fatfs_on_host: <<: *host_test_template script: - cd components/fatfs/test_fatfs_host/ - make test test_ldgen_on_host: <<: *host_test_template script: - cd tools/ldgen/test - ./test_fragments.py - ./test_generation.py .host_fuzzer_test_template: &host_fuzzer_test_template stage: host_test image: $CI_DOCKER_REGISTRY/afl-fuzzer-test tags: - host_test dependencies: [] artifacts: when: always paths: - ${FUZZER_TEST_DIR}/out/crashes - ${FUZZER_TEST_DIR}/fuzz_output.log expire_in: 1 week only: refs: # can only be triggered - triggers variables: - $BOT_LABEL_FUZZER_TEST script: - export AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 && export AFL_SKIP_CPUFREQ=1 - cd ${FUZZER_TEST_DIR} # run AFL fuzzer for one hour - ( ( make ${FUZZER_PARAMS} fuzz | tee fuzz_output.log | grep -v '\(Fuzzing test case\|Entering queue cycle\)' ) || pkill sleep ) & - ( sleep 3600 || mkdir -p out/crashes/env_failed ) && pkill afl-fuz # check no crashes found - test -z "$(ls out/crashes/)" || exit 1 test_mdns_fuzzer_on_host: <<: *host_fuzzer_test_template variables: BOT_NEEDS_TRIGGER_BY_NAME: 1 FUZZER_TEST_DIR: components/mdns/test_afl_fuzz_host test_lwip_dns_fuzzer_on_host: <<: *host_fuzzer_test_template variables: BOT_NEEDS_TRIGGER_BY_NAME: 1 FUZZER_TEST_DIR: components/lwip/test_afl_host FUZZER_PARAMS: MODE=dns test_lwip_dhcp_fuzzer_on_host: <<: *host_fuzzer_test_template variables: BOT_NEEDS_TRIGGER_BY_NAME: 1 FUZZER_TEST_DIR: components/lwip/test_afl_host FUZZER_PARAMS: MODE=dhcp_client test_lwip_dhcps_fuzzer_on_host: <<: *host_fuzzer_test_template variables: BOT_NEEDS_TRIGGER_BY_NAME: 1 FUZZER_TEST_DIR: components/lwip/test_afl_host FUZZER_PARAMS: MODE=dhcp_server test_spiffs_on_host: <<: *host_test_template script: - cd components/spiffs/test_spiffs_host/ - make test test_multi_heap_on_host: <<: *host_test_template script: - cd components/heap/test_multi_heap_host - ./test_all_configs.sh test_confserver: <<: *host_test_template script: - cd tools/kconfig_new/test - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./test_confserver.py test_build_system: <<: *host_test_template script: - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh - rm -rf test_build_system - mkdir test_build_system - cd test_build_system - ${IDF_PATH}/tools/ci/test_build_system.sh test_build_system_cmake: <<: *host_test_template script: - ${IDF_PATH}/tools/ci/test_configure_ci_environment.sh - rm -rf test_build_system - mkdir test_build_system - cd test_build_system - ${IDF_PATH}/tools/ci/test_build_system_cmake.sh test_idf_monitor: <<: *host_test_template artifacts: # save artifacts always in order to access results which were retried without consequent failure when: always paths: - tools/test_idf_monitor/outputs/* expire_in: 1 week script: - cd ${IDF_PATH}/tools/test_idf_monitor - ./run_test_idf_monitor.py test_idf_size: <<: *host_test_template artifacts: when: on_failure paths: - tools/test_idf_size/output - tools/test_idf_size/.coverage expire_in: 1 week script: - cd ${IDF_PATH}/tools/test_idf_size - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./test.sh test_esp_err_to_name_on_host: <<: *host_test_template artifacts: when: on_failure paths: - components/esp32/esp_err_to_name.c expire_in: 1 week script: - cd ${IDF_PATH}/tools/ - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 2.7.15 ./gen_esp_err_to_name.py - 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; } - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.4.8 ./gen_esp_err_to_name.py - git diff --exit-code -- ../components/esp32/esp_err_to_name.c || { echo 'Differences found between running under Python 2 and 3.'; exit 1; } test_esp_efuse_table_on_host: <<: *host_test_template artifacts: when: on_failure paths: - components/efuse/esp32/esp_efuse_table.c expire_in: 1 week script: - cd ${IDF_PATH}/components/efuse/ - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 2.7.15 ./efuse_table_gen.py ${IDF_PATH}/components/efuse/esp32/esp_efuse_table.csv - git diff --exit-code -- esp32/esp_efuse_table.c || { echo 'Differences found. Please run make efuse_common_table or idf.py efuse_common_table and commit the changes.'; exit 1; } - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.4.8 ./efuse_table_gen.py ${IDF_PATH}/components/efuse/esp32/esp_efuse_table.csv - git diff --exit-code -- esp32/esp_efuse_table.c || { echo 'Differences found between running under Python 2 and 3.'; exit 1; } - cd ${IDF_PATH}/components/efuse/test_efuse_host - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./efuse_tests.py test_espcoredump: <<: *host_test_template artifacts: when: always paths: - components/espcoredump/test/.coverage - components/espcoredump/test/output expire_in: 1 week script: - cd components/espcoredump/test/ - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ./test_espcoredump.sh push_to_github: stage: deploy image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - deploy only: refs: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ variables: - $BOT_TRIGGER_WITH_LABEL == null when: on_success dependencies: [] <<: *before_script_lesser script: - mkdir -p ~/.ssh - chmod 700 ~/.ssh - echo -n $GH_PUSH_KEY > ~/.ssh/id_rsa_base64 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa - chmod 600 ~/.ssh/id_rsa - echo -e "Host github.com\n\tStrictHostKeyChecking no\n" >> ~/.ssh/config - git remote remove github &>/dev/null || true - git remote add github git@github.com:espressif/esp-idf.git - tools/ci/push_to_github.sh .deploy_docs_template: extends: .before_script_lesser stage: deploy image: $ESP_IDF_DOC_ENV_IMAGE tags: - deploy - shiny dependencies: - build_docs_en - build_docs_zh_CN variables: DOCS_BUILD_DIR: "${IDF_PATH}/docs/_build/" PYTHONUNBUFFERED: 1 script: - mkdir -p ~/.ssh - chmod 700 ~/.ssh - echo -n $DOCS_DEPLOY_PRIVATEKEY > ~/.ssh/id_rsa_base64 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa - chmod 600 ~/.ssh/id_rsa - echo -e "Host $DOCS_DEPLOY_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_DEPLOY_SERVER_USER\n" >> ~/.ssh/config - export GIT_VER=$(git describe --always) - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.6.10 ${IDF_PATH}/tools/ci/deploy_docs.py # deploys docs to CI_DOCKER_REGISTRY webserver, for internal review deploy_docs_preview: extends: .deploy_docs_template only: refs: - triggers variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD_DOCS variables: TYPE: "preview" # older branches use DOCS_DEPLOY_KEY, DOCS_SERVER, DOCS_SERVER_USER, DOCS_PATH for preview server so we keep these names for 'preview' DOCS_DEPLOY_PRIVATEKEY: "$DOCS_DEPLOY_KEY" DOCS_DEPLOY_SERVER: "$DOCS_SERVER" DOCS_DEPLOY_SERVER_USER: "$DOCS_SERVER_USER" DOCS_DEPLOY_PATH: "$DOCS_PATH" DOCS_DEPLOY_URL_BASE: "https://$DOCS_PREVIEW_SERVER_URL/docs/esp-idf" # deploy docs to production webserver deploy_docs_production: extends: .deploy_docs_template only: refs: # The DOCS_PROD_* variables used by this job are "Protected" so these branches must all be marked "Protected" in Gitlab settings - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ variables: - $BOT_TRIGGER_WITH_LABEL == null variables: TYPE: "preview" DOCS_DEPLOY_PRIVATEKEY: "$DOCS_PROD_DEPLOY_KEY" DOCS_DEPLOY_SERVER: "$DOCS_PROD_SERVER" DOCS_DEPLOY_SERVER_USER: "$DOCS_PROD_SERVER_USER" DOCS_DEPLOY_PATH: "$DOCS_PROD_PATH" DOCS_DEPLOY_URL_BASE: "https://docs.espressif.com/projects/esp-idf" check_doc_links: stage: host_test image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - check_doc_links only: refs: # can only be triggered - triggers variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_BUILD_DOCS artifacts: paths: - docs/_build/linkcheck expire_in: 1 week script: # must be triggered with CHECK_LINKS=Yes, otherwise exit without test - test "$CHECK_LINKS" = "Yes" || exit 0 # can only run on master branch (otherwise the commit is not on Github yet) - test "${CI_COMMIT_REF_NAME}" = "master" || exit 0 - cd docs - make linkcheck check_line_endings: <<: *check_job_template script: - tools/ci/check-line-endings.sh ${IDF_PATH} check_commit_msg: <<: *check_job_template script: - git status - git log -n10 --oneline # commit start with "WIP: " need to be squashed before merge - 'git log --pretty=%s master.. -- | grep "^WIP: " && exit 1 || exit 0' check_permissions: <<: *check_job_template script: - tools/ci/check-executable.sh check_version: <<: *check_job_template # Don't run this for feature/bugfix branches, so that it is possible to modify # esp_idf_version.h in a branch before tagging the next version. only: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ script: - export IDF_PATH=$PWD - tools/ci/check_idf_version.sh check_examples_cmake_make: <<: *check_job_template except: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ <<: *before_script_lesser script: - tools/ci/check_examples_cmake_make.sh check_python_style: <<: *check_job_template artifacts: when: on_failure paths: - flake8_output.txt expire_in: 1 week <<: *before_script_lesser script: # run it only under Python 3 (it is very slow under Python 2) - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh -p 3.4.8 python -m flake8 --config=$IDF_PATH/.flake8 --output-file=flake8_output.txt --tee --benchmark $IDF_PATH check_kconfigs: <<: *check_job_template artifacts: when: on_failure paths: - components/*/Kconfig*.new - examples/*/*/*/Kconfig*.new - examples/*/*/*/*/Kconfig*.new - tools/*/Kconfig*.new - tools/*/*/Kconfig*.new - tools/*/*/*/Kconfig*.new expire_in: 1 week <<: *before_script_lesser script: - ${IDF_PATH}/tools/ci/multirun_with_pyenv.sh ${IDF_PATH}/tools/test_check_kconfigs.py - ${IDF_PATH}/tools/check_kconfigs.py check_ut_cmake_make: stage: check image: $CI_DOCKER_REGISTRY/esp32-ci-env$BOT_DOCKER_IMAGE_TAG tags: - build except: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ dependencies: [] <<: *before_script_lesser script: - tools/ci/check_ut_cmake_make.sh check_submodule_sync: <<: *check_job_template tags: - github_sync retry: 2 variables: GIT_STRATEGY: clone GIT_SUBMODULE_STRATEGY: none PUBLIC_IDF_URL: "https://github.com/espressif/esp-idf.git" before_script: [] after_script: [] script: - git submodule deinit --force . # setting the default remote URL to the public one, to resolve relative location URLs - git config remote.origin.url ${PUBLIC_IDF_URL} # check if all submodules are correctly synced to public repostory - git submodule init - *show_submodule_urls - git submodule update --recursive - echo "IDF was cloned from ${PUBLIC_IDF_URL} completely" check_artifacts_expire_time: <<: *check_job_template script: # check if we have set expire time for all artifacts - python tools/ci/check_artifacts_expire_time.py check_pipeline_triggered_by_label: <<: *check_job_template stage: post_check only: variables: - $BOT_TRIGGER_WITH_LABEL script: # If the pipeline is triggered with label, the pipeline will only succeeded if "regular_test" label is added. # We want to make sure some jobs are always executed to detect regression. - test "$BOT_LABEL_REGULAR_TEST" = "true" || exit -1 # For release tag pipelines only, make sure the tag was created with 'git tag -a' so it will update # the version returned by 'git describe' check_version_tag: extends: .check_job_template only: refs: - /^v\d+\.\d+(\.\d+)?($|-)/ variables: - $BOT_TRIGGER_WITH_LABEL == null script: - (git cat-file -t $CI_COMMIT_REF_NAME | grep tag) || (echo "ESP-IDF versions must be annotated tags." && exit 1) assign_test: tags: - assign_test image: $CI_DOCKER_REGISTRY/ubuntu-test-env$BOT_DOCKER_IMAGE_TAG stage: assign_test # gitlab ci do not support match job with RegEx or wildcard now in dependencies. # we have a lot build example jobs. now we don't use dependencies, just download all artificats of build stage. dependencies: - build_ssc - build_esp_idf_tests_make - build_esp_idf_tests_cmake variables: TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw" EXAMPLE_CONFIG_OUTPUT_PATH: "$CI_PROJECT_DIR/examples/test_configs" INTEGRATION_CONFIG_OUTPUT_PATH: "${CI_PROJECT_DIR}/components/idf_test/integration_test/CIConfigs" TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/auto_test_script/TestCaseFiles" ASSIGN_TEST_CASE_SCRIPT: "${CI_PROJECT_DIR}/auto_test_script/bin/CIAssignTestCases.py" PYTHONPATH: "${CI_PROJECT_DIR}/auto_test_script/packages" PYTHON_VER: 3.7.7 artifacts: paths: - components/idf_test/*/CIConfigs - components/idf_test/*/TC.sqlite - $EXAMPLE_CONFIG_OUTPUT_PATH expire_in: 1 week only: variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_UNIT_TEST - $BOT_LABEL_INTEGRATION_TEST - $BOT_LABEL_EXAMPLE_TEST script: # assign example tests - python $TEST_FW_PATH/CIAssignExampleTest.py $IDF_PATH/examples $IDF_PATH/.gitlab-ci.yml $EXAMPLE_CONFIG_OUTPUT_PATH # assign unit test cases - 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 # clone test script to assign tests - ./tools/ci/retry_failed.sh git clone ${CI_AUTO_TEST_SCRIPT_REPO_URL} -b empty_branch - ./tools/ci/retry_failed.sh git -C auto_test_script checkout -f ${CI_AUTO_TEST_SCRIPT_REPO_BRANCH} - python $CHECKOUT_REF_SCRIPT auto_test_script auto_test_script # assgin integration test cases - python ${ASSIGN_TEST_CASE_SCRIPT} -t $TEST_CASE_FILE_PATH -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/SSC/ssc_bin -o $INTEGRATION_CONFIG_OUTPUT_PATH .define_config_file_name: &define_config_file_name | JOB_NAME_PREFIX=$(echo ${CI_JOB_NAME} | awk '{print $1}') JOG_FULL_NAME="${JOB_NAME_PREFIX}_${CI_NODE_INDEX}" CONFIG_FILE="${CONFIG_FILE_PATH}/${JOG_FULL_NAME}.yml" .example_test_template: &example_test_template stage: target_test when: on_success only: refs: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - triggers - schedules variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_EXAMPLE_TEST dependencies: - assign_test - build_examples_make - build_examples_cmake artifacts: when: always paths: - $LOG_PATH expire_in: 1 week reports: junit: $LOG_PATH/*/XUNIT_RESULT.xml variables: SUBMODULES_TO_FETCH: "components/esptool_py/esptool" TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw" TEST_CASE_PATH: "$CI_PROJECT_DIR/examples" CONFIG_FILE_PATH: "${CI_PROJECT_DIR}/examples/test_configs" LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS" ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml" PYTHON_VER: 3 script: - *define_config_file_name # first test if config file exists, if not exist, exit 0 - test -e $CONFIG_FILE || exit 0 # clone test env configs - ./tools/ci/retry_failed.sh git clone $TEST_ENV_CONFIG_REPO - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs ci-test-runner-configs # git clone the known failure cases repo, run test - ./tools/ci/retry_failed.sh git clone $KNOWN_FAILURE_CASES_REPO known_failure_cases # run test - cd $TEST_FW_PATH - python Runner.py $TEST_CASE_PATH -c $CONFIG_FILE -e $ENV_FILE --known_failure_cases_file $CI_PROJECT_DIR/known_failure_cases/known_failure_cases.txt .unit_test_template: &unit_test_template <<: *example_test_template stage: target_test dependencies: - assign_test - build_esp_idf_tests_make - build_esp_idf_tests_cmake only: refs: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - triggers - schedules variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_UNIT_TEST variables: TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw" TEST_CASE_PATH: "$CI_PROJECT_DIR/tools/unit-test-app" CONFIG_FILE_PATH: "${CI_PROJECT_DIR}/components/idf_test/unit_test/CIConfigs" LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS" ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml" .test_template: &test_template stage: target_test when: on_success only: refs: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - triggers - schedules variables: - $BOT_TRIGGER_WITH_LABEL == null - $BOT_LABEL_INTEGRATION_TEST dependencies: - assign_test - build_ssc artifacts: when: always paths: - $LOG_PATH expire_in: 1 week variables: SUBMODULES_TO_FETCH: "none" LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF" LOG_PATH: "${CI_PROJECT_DIR}/TEST_LOGS" TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/auto_test_script/TestCaseFiles" MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml" CONFIG_FILE_PATH: "${CI_PROJECT_DIR}/components/idf_test/integration_test/CIConfigs" KNOWN_ISSUE_FILE: "${CI_PROJECT_DIR}/components/idf_test/integration_test/KnownIssues" PYTHONPATH: "${CI_PROJECT_DIR}/auto_test_script/packages" CI_RUNNER_SCRIPT: "${CI_PROJECT_DIR}/auto_test_script/bin/CIRunner.py" PYTHON_VER: 3.7.7 script: - *define_config_file_name # first test if config file exists, if not exist, exit 0 - test -e $CONFIG_FILE || exit 0 # clone local test env configs - ./tools/ci/retry_failed.sh git clone $TEST_ENV_CONFIG_REPO - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs ci-test-runner-configs # clone test bench - ./tools/ci/retry_failed.sh git clone ${CI_AUTO_TEST_SCRIPT_REPO_URL} -b empty_branch - ./tools/ci/retry_failed.sh git -C auto_test_script checkout -f ${CI_AUTO_TEST_SCRIPT_REPO_BRANCH} - python $CHECKOUT_REF_SCRIPT auto_test_script auto_test_script - cat ${KNOWN_ISSUE_FILE} >> ${TEST_CASE_FILE_PATH}/KnownIssues # run test - python ${CI_RUNNER_SCRIPT} -l "$LOG_PATH/$JOG_FULL_NAME" -c $CONFIG_FILE -e $LOCAL_ENV_CONFIG_PATH -t $TEST_CASE_FILE_PATH nvs_compatible_test: <<: *test_template artifacts: when: always paths: - $LOG_PATH - nvs_wifi.bin expire_in: 1 mos tags: - ESP32_IDF - NVS_Compatible script: - *define_config_file_name # first test if config file exists, if not exist, exit 0 - test -e $CONFIG_FILE || exit 0 # clone local test env configs - ./tools/ci/retry_failed.sh git clone $TEST_ENV_CONFIG_REPO - python $CHECKOUT_REF_SCRIPT ci-test-runner-configs ci-test-runner-configs # clone test bench - ./tools/ci/retry_failed.sh git clone ${CI_AUTO_TEST_SCRIPT_REPO_URL} -b empty_branch - ./tools/ci/retry_failed.sh git -C auto_test_script checkout -f ${CI_AUTO_TEST_SCRIPT_REPO_BRANCH} - python $CHECKOUT_REF_SCRIPT auto_test_script "$CI_PROJECT_DIR/auto_test_script/TestCaseFiles" # prepare nvs bins - cd auto_test_script - ./tools/prepare_nvs_bin.sh # run test - python ${CI_RUNNER_SCRIPT} -l "$LOG_PATH/$JOG_FULL_NAME" -c $CONFIG_FILE -e $LOCAL_ENV_CONFIG_PATH -t $TEST_CASE_FILE_PATH example_test_001: <<: *example_test_template parallel: 3 tags: - ESP32 - Example_WIFI example_test_002: <<: *example_test_template image: $CI_DOCKER_REGISTRY/ubuntu-test-env$BOT_DOCKER_IMAGE_TAG tags: - ESP32 - Example_ShieldBox_Basic variables: SUBMODULES_TO_FETCH: "all" TEST_FW_PATH: "$CI_PROJECT_DIR/tools/tiny-test-fw" TEST_CASE_PATH: "$CI_PROJECT_DIR/examples" CONFIG_FILE_PATH: "${CI_PROJECT_DIR}/examples/test_configs" LOG_PATH: "$CI_PROJECT_DIR/TEST_LOGS" ENV_FILE: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/EnvConfig.yml" PYTHON_VER: 3 .example_test_003: <<: *example_test_template tags: - ESP32 - Example_SDIO example_test_004A: <<: *example_test_template tags: - ESP32 - Example_CAN1 example_test_004B: <<: *example_test_template tags: - ESP32 - Example_CAN2 example_test_005: <<: *example_test_template tags: - ESP32 - Example_WIFI_BT example_test_006: <<: *example_test_template image: $CI_DOCKER_REGISTRY/ubuntu-test-env$BOT_DOCKER_IMAGE_TAG only: variables: - $BOT_LABEL_IPERF_STRESS_TEST tags: - ESP32 - Example_ShieldBox example_test_007: <<: *example_test_template tags: - ESP32 - Example_I2C_CCS811_SENSOR UT_001: <<: *unit_test_template parallel: 50 tags: - ESP32_IDF - UT_T1_1 # Max. allowed value of 'parallel' is 50. UT_002: <<: *unit_test_template parallel: 16 tags: - ESP32_IDF - UT_T1_1 - psram UT_003: <<: *unit_test_template parallel: 3 tags: - ESP32_IDF - UT_T1_SDMODE UT_004: <<: *unit_test_template parallel: 3 tags: - ESP32_IDF - UT_T1_SPIMODE UT_005: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_SDMODE - psram UT_006: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_SPIMODE - psram UT_007: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_GPIO UT_008: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_GPIO - psram UT_009: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_PCNT UT_010: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_PCNT - psram UT_011: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_LEDC UT_012: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_LEDC - psram UT_013: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T2_RS485 UT_014: <<: *unit_test_template tags: - ESP32_IDF - UT_T2_RS485 - psram UT_015: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_RMT UT_016: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_RMT - psram UT_017: <<: *unit_test_template parallel: 3 tags: - ESP32_IDF - EMMC UT_018: <<: *unit_test_template parallel: 5 tags: - ESP32_IDF - UT_T1_1 - 8Mpsram UT_019: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - Example_SPI_Multi_device UT_020: <<: *unit_test_template tags: - ESP32_IDF - Example_SPI_Multi_device - psram UT_021: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T2_I2C UT_022: <<: *unit_test_template tags: - ESP32_IDF - UT_T2_I2C - psram UT_023: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_MCPWM UT_024: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_MCPWM - psram UT_025: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T1_I2S UT_026: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_I2S - psram UT_027: <<: *unit_test_template parallel: 4 tags: - ESP32_IDF - UT_T2_1 UT_028: <<: *unit_test_template tags: - ESP32_IDF - UT_T2_1 - psram UT_029: <<: *unit_test_template tags: - ESP32_IDF - UT_T2_1 - 8Mpsram UT_030: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_031: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_032: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 - psram UT_033: extends: .unit_test_template parallel: 2 tags: - ESP32_IDF - UT_T1_PSRAMV0 - psram UT_034: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_no32kXTAL UT_035: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_no32kXTAL UT_036: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_no32kXTAL UT_037: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_no32kXTAL - psram UT_038: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_32kXTAL UT_039: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_32kXTAL UT_040: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_32kXTAL UT_041: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_32kXTAL - psram IT_001: <<: *test_template parallel: 3 tags: - ESP32_IDF - SSC_T1_4 IT_002: <<: *test_template tags: - ESP32_IDF - SSC_T1_2 IT_003: <<: *test_template parallel: 14 tags: - ESP32_IDF - SSC_T2_5 IT_004: <<: *test_template tags: - ESP32_IDF - SSC_T1_APC IT_005: <<: *test_template parallel: 2 tags: - ESP32_IDF - SSC_T1_5 IT_006: <<: *test_template parallel: 13 tags: - ESP32_IDF - SSC_T1_6 IT_007: <<: *test_template parallel: 3 tags: - ESP32_IDF - SSC_T1_7 IT_008: <<: *test_template tags: - ESP32_IDF - SSC_T1_8 IT_009: <<: *test_template tags: - ESP32_IDF - SSC_T1_3 IT_011: <<: *test_template tags: - ESP32_IDF - SSC_T1_MESH1 IT_012: <<: *test_template parallel: 2 tags: - ESP32_IDF - SSC_T2_MESH1 IT_011_03: <<: *test_template tags: - ESP32_IDF - SSC_T2_MESH1 IT_013: <<: *test_template tags: - ESP32_IDF - SSC_T3_MESH1 IT_014: <<: *test_template tags: - ESP32_IDF - SSC_T6_MESH1 IT_015: <<: *test_template tags: - ESP32_IDF - SSC_T12_MESH1 IT_016: <<: *test_template allow_failure: true tags: - ESP32_IDF - SSC_T50_MESH1 IT_017: <<: *test_template tags: - ESP32_IDF - SSC_T1_MESH2 IT_018: <<: *test_template tags: - ESP32_IDF - SSC_T1_9 IT_019: <<: *test_template parallel: 2 tags: - ESP32_IDF - SSC_T2_2 IT_020: <<: *test_template tags: - ESP32_IDF - SSC_T2_3 IT_021: <<: *test_template tags: - ESP32_IDF - SSC_T2_4