stages: - build - assign_test - unit_test - test - test_report - deploy 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" # We use get_sources.sh script to fetch the submodules and/or re-fetch the repo # if it was corrupted (if submodule update fails this can happen) GIT_STRATEGY: fetch GIT_SUBMODULE_STRATEGY: none # IDF environment IDF_PATH: "$CI_PROJECT_DIR" before_script: # 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 # Set IS_PRIVATE or IS_PUBLIC depending on if our branch is public or not # # (the same regular expressions are used to set these are used in 'only:' sections below - source tools/ci/configure_ci_environment.sh # fetch the submodules (& if necessary re-fetch repo) from gitlab - time ./tools/ci/get-full-sources.sh .do_nothing_before: before_script: &do_nothing_before - echo "Not setting up GitLab key, not fetching submodules" - source tools/ci/configure_ci_environment.sh .add_gitlab_key_before: before_script: &add_gitlab_key_before - echo "Not fetching submodules" - source tools/ci/configure_ci_environment.sh # 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 build_template_app: stage: build image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build variables: BATCH_BUILD: "1" IDF_CI_BUILD: "1" script: - git clone https://github.com/espressif/esp-idf-template.git - cd esp-idf-template # 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 - git checkout ${CI_COMMIT_REF_NAME} || echo "Using esp-idf-template default branch..." # 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 tags: - build variables: BATCH_BUILD: "1" V: "0" build_ssc: <<: *build_template artifacts: paths: - SSC/ssc_bin expire_in: 6 mos script: - git clone $SSC_REPOSITORY - cd SSC - git checkout ${CI_COMMIT_REF_NAME} || echo "Using SSC default branch..." - MAKEFLAGS= ./gen_misc_ng.sh build_esp_idf_tests: <<: *build_template artifacts: paths: - tools/unit-test-app/build/*.bin - tools/unit-test-app/build/*.elf - tools/unit-test-app/build/*.map - tools/unit-test-app/build/download.config - tools/unit-test-app/build/bootloader/*.bin - components/idf_test/unit_test/TestCaseAll.yml - components/idf_test/unit_test/CIConfigs/*.yml expire_in: 6 mos script: - cd tools/unit-test-app - make TESTS_ALL=1 # cut last line in case make V=0/1 is set by default - make print_flash_cmd | tail -n 1 > build/download.config - python tools/UnitTestParser.py .build_examples_template: &build_examples_template <<: *build_template artifacts: paths: - build_examples/*/*/*/build/*.bin - build_examples/*/*/*/build/*.elf - build_examples/*/*/*/build/*.map - build_examples/*/*/*/build/bootloader/*.bin expire_in: 1 week variables: IDF_CI_BUILD: "1" 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 - ${IDF_PATH}/tools/ci/build_examples.sh "${CI_JOB_NAME}" build_examples_00: <<: *build_examples_template build_examples_01: <<: *build_examples_template build_examples_02: <<: *build_examples_template build_examples_03: <<: *build_examples_template build_examples_04: <<: *build_examples_template build_examples_05: <<: *build_examples_template build_examples_06: <<: *build_examples_template build_docs: stage: build image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build_docs artifacts: when: always paths: - docs/doxygen-warning-log.txt - docs/sphinx-warning-log.txt - docs/_build/html expire_in: 1 mos script: - cd docs - doxygen # If there are Doxygen warnings, print them and bail out - test $(cat doxygen-warning-log.txt | wc -l) -eq 0 || ( echo "Doxygen pass had some warnings:" && cat doxygen-warning-log.txt && false ) - make gh-linkcheck - make html # If there are Sphinx warnings, print them and bail out # Ignore warnings (sphinx-known-warnings.txt) already reported in: # https://github.com/sphinx-doc/sphinx/issues/2683 # https://github.com/sphinx-doc/sphinx/issues/4041 # If a new warning has to be added, then it should be documented as above # Note: this check is not clever enough to ignore the same warning # but reported for different line of documentation. # If s warning stays the same and the line number has changed, # then update 'sphinx-known-warnings.txt' to reflect the new lines numbers. - DIFF_FORMAT="--changed-group-format=%<%> --unchanged-group-format=" - LOG_DIFF=$(diff $DIFF_FORMAT sphinx-known-warnings.txt sphinx-warning-log.txt) - test -z "$LOG_DIFF" || ( echo "Sphinx pass had some new warnings:" && echo "$LOG_DIFF" && false ) test_nvs_on_host: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - nvs_host_test dependencies: [] script: - cd components/nvs_flash/test_nvs_host - make test test_partition_table_on_host: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build dependencies: [] script: - cd components/partition_table/test_gen_esp32part_host - ./gen_esp32part_tests.py test_wl_on_host: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - wl_host_test artifacts: paths: - components/wear_levelling/test_wl_host/coverage_report.zip dependencies: [] script: - cd components/wear_levelling/test_wl_host - make test test_multi_heap_on_host: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - wl_host_test script: - cd components/heap/test_multi_heap_host - make test test_build_system: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build_test dependencies: [] 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_report: stage: test_report image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - report only: - master - triggers - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ variables: LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA" TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test" REPORT_PATH: "$CI_PROJECT_DIR/CI_Test_Report" MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/tools/unit-test-app/tools/ModuleDefinition.yml" #dependencies: #We need all UT* and IT* artifacts except for only a few other artifacts: when: always paths: - $REPORT_PATH - $LOG_PATH expire_in: 12 mos script: # calc log path - VER_NUM=`git rev-list HEAD | wc -l | awk '{print $1}'` - SHA_ID=`echo $CI_COMMIT_SHA | cut -c 1-7` - REVISION="${VER_NUM}_${SHA_ID}" # replace / to _ in branch name - ESCAPED_BRANCH_NAME=`echo $CI_COMMIT_REF_NAME | sed 's/\//___/g'` # result path and artifacts path - RESULT_PATH="$CI_PROJECT_NAME/$ESCAPED_BRANCH_NAME/$REVISION" - ARTIFACTS_PATH="$GITLAB_HTTP_SERVER/idf/esp-idf/builds/$CI_JOB_ID/artifacts/browse/$CI_COMMIT_SHA" # clone test bench - git clone $GITLAB_SSH_SERVER/yinling/auto_test_script.git - cd auto_test_script # generate report - TEST_RESULT=Pass - 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 # commit to CI-test-result project - git clone $GITLAB_SSH_SERVER/qa/CI-test-result.git - rm -rf "CI-test-result/RawData/$RESULT_PATH" - cp -R $CI_PROJECT_NAME CI-test-result/RawData - cd CI-test-result # config git user - git config --global user.email "ci-test-result@espressif.com" - git config --global user.name "ci-test-result" # commit test result - git add . - git commit . -m "update test result for $CI_PROJECT_NAME/$CI_COMMIT_REF_NAME/$CI_COMMIT_SHA, pipeline ID $CI_PIPELINE_ID" || exit 0 - git push origin master - test "${TEST_RESULT}" = "Pass" || exit 1 push_master_to_github: stage: deploy image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - deploy only: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ when: on_success dependencies: [] variables: GITHUB_PUSH_REFS: refs/remotes/origin/release refs/remotes/origin/master before_script: *do_nothing_before 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 # What the next line of script does: goes through the list of refs for all branches we push to github, # generates a snippet of shell which is evaluated. The snippet checks CI_COMMIT_SHA against the SHA # (aka objectname) at tip of each branch, and if any SHAs match then it checks out the local branch # and then pushes that ref to a corresponding github branch - 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) deploy_docs: stage: deploy image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - deploy only: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - triggers dependencies: - build_docs before_script: *do_nothing_before script: - mkdir -p ~/.ssh - chmod 700 ~/.ssh - echo -n $DOCS_DEPLOY_KEY > ~/.ssh/id_rsa_base64 - base64 --decode --ignore-garbage ~/.ssh/id_rsa_base64 > ~/.ssh/id_rsa - chmod 600 ~/.ssh/id_rsa - echo -e "Host $DOCS_SERVER\n\tStrictHostKeyChecking no\n\tUser $DOCS_SERVER_USER\n" >> ~/.ssh/config - export GIT_VER=$(git describe --always) - cd docs/_build/ - mv html $GIT_VER - tar czvf $GIT_VER.tar.gz $GIT_VER - scp $GIT_VER.tar.gz $DOCS_SERVER:$DOCS_PATH - ssh $DOCS_SERVER -x "cd $DOCS_PATH && tar xzvf $GIT_VER.tar.gz && rm -f latest && ln -s $GIT_VER latest" check_doc_links: stage: test image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - check_doc_links only: # can only be triggered - triggers artifacts: paths: - docs/_build/linkcheck expire_in: 1 mos 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_commit_msg: stage: deploy image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build except: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ dependencies: [] before_script: *do_nothing_before 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_submodule_sync: stage: deploy image: $CI_DOCKER_REGISTRY/esp32-ci-env tags: - build except: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ dependencies: [] variables: GIT_STRATEGY: clone before_script: *do_nothing_before script: # check if all submodules are correctly synced to public repostory - git submodule update --init --recursive assign_test: <<: *build_template stage: assign_test dependencies: - build_esp_idf_tests - build_ssc artifacts: paths: - test_bins - components/idf_test/*/CIConfigs - components/idf_test/*/TC.sqlite expire_in: 1 mos before_script: *add_gitlab_key_before script: # first move test bins together: test_bins/CHIP_SDK/TestApp/bin_files - mkdir -p test_bins/ESP32_IDF/UT - cp -r tools/unit-test-app/build/* test_bins/ESP32_IDF/UT - cp -r SSC/ssc_bin/* test_bins/ESP32_IDF # clone test script to assign tests - git clone $TEST_SCRIPT_REPOSITORY - cd auto_test_script - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..." # assign unit test cases - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/unit_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/test_bins # assgin integration test cases - python CIAssignTestCases.py -t $IDF_PATH/components/idf_test/integration_test -c $IDF_PATH/.gitlab-ci.yml -b $IDF_PATH/test_bins .test_template: &test_template stage: test when: on_success only: - master - /^release\/v/ - /^v\d+\.\d+(\.\d+)?($|-)/ - triggers allow_failure: true dependencies: - assign_test artifacts: when: always paths: - $LOG_PATH expire_in: 6 mos variables: LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF" LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA" TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/integration_test" MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml" CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/integration_test/CIConfigs/$CI_JOB_NAME.yml" before_script: *add_gitlab_key_before script: # first test if config file exists, if not exist, exit 0 - test -e $CONFIG_FILE || exit 0 # clone local test env configs - git clone $TEST_ENV_CONFIG_REPOSITORY # clone test bench - git clone $TEST_SCRIPT_REPOSITORY - cd auto_test_script - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..." # run test - 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 # template for unit test jobs .unit_test_template: &unit_test_template <<: *test_template allow_failure: false stage: unit_test variables: LOCAL_ENV_CONFIG_PATH: "$CI_PROJECT_DIR/ci-test-runner-configs/$CI_RUNNER_DESCRIPTION/ESP32_IDF" LOG_PATH: "$CI_PROJECT_DIR/$CI_COMMIT_SHA" TEST_CASE_FILE_PATH: "$CI_PROJECT_DIR/components/idf_test/unit_test" MODULE_UPDATE_FILE: "$CI_PROJECT_DIR/components/idf_test/ModuleDefinition.yml" CONFIG_FILE: "$CI_PROJECT_DIR/components/idf_test/unit_test/CIConfigs/$CI_JOB_NAME.yml" nvs_compatible_test: <<: *test_template artifacts: when: always paths: - $LOG_PATH - nvs_wifi.bin expire_in: 6 mos tags: - ESP32_IDF - NVS_Compatible script: # clone local test env configs - git clone $TEST_ENV_CONFIG_REPOSITORY # clone test bench - git clone $TEST_SCRIPT_REPOSITORY - cd auto_test_script - git checkout ${CI_COMMIT_REF_NAME} || echo "Using default branch..." # prepare nvs bins - ./Tools/prepare_nvs_bin.sh # run test - 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 UT_001_01: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_001_02: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_001_03: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_001_04: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 UT_001_05: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_SDMODE UT_001_06: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_SPIMODE UT_001_07: <<: *unit_test_template tags: - ESP32_IDF - UT_T1_1 IT_001_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_02: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_03: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_04: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_05: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_06: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_07: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_08: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_001_09: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 IT_002_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_2 IT_003_01: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_02: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_03: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_04: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_05: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_06: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_003_07: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 IT_004_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_APC IT_005_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_WEP IT_006_01: <<: *test_template tags: - ESP32_IDF - SSC_T3_PhyMode IT_007_01: <<: *test_template tags: - ESP32_IDF - SSC_T2_PhyMode IT_008_01: <<: *test_template tags: - ESP32_IDF - SSC_T2_PhyMode IT_009_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_3 IT_501_01: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 - stress_test IT_501_02: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 - stress_test IT_501_03: <<: *test_template tags: - ESP32_IDF - SSC_T1_1 - stress_test IT_502_01: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 - stress_test IT_502_02: <<: *test_template tags: - ESP32_IDF - SSC_T2_1 - stress_test IT_503_01: <<: *test_template tags: - ESP32_IDF - SSC_T5_1 - stress_test IT_503_02: <<: *test_template tags: - ESP32_IDF - SSC_T5_1 - stress_test IT_503_03: <<: *test_template tags: - ESP32_IDF - SSC_T5_1 - stress_test