feat(ci): ci enhanced

Author: gytxxsy

.gitlab-ci.yml

@@ -40,6 +40,14 @@ pre_commit:
   - ./install.sh
   - . ./export.sh
 
+.setup_idf_master: &setup_idf_master
+  - cd $CI_PROJECT_DIR
+  - git clone --depth=1 -b master ${ESP_IDF_HTTP}
+  - cd esp-idf
+  - git submodule update --init --depth=1
+  - ./install.sh
+  - . ./export.sh
+
 .build_basic_thread_border_router: &build_basic_thread_border_router
   - cd $IDF_PATH/examples/openthread/ot_rcp
   - idf.py set-target esp32h2
@@ -106,9 +114,12 @@ build_examples:
     image: espressif/idf:latest
     script:
         - *submodule_update
+        - cd $ESP_THREAD_BR_PATH
+        - python3 ${CI_TOOLS_PATH}/get_component_version.py $ESP_THREAD_BR_PATH/examples/basic_thread_border_router/main/idf_component.yml build_examples_result.txt esp_ot_cli_extension
+        - python3 ${CI_TOOLS_PATH}/get_component_version.py $ESP_THREAD_BR_PATH/examples/basic_thread_border_router/main/idf_component.yml build_examples_result.txt esp_rcp_update
         - *build_basic_thread_border_router
         - cd $ESP_THREAD_BR_PATH
-        - echo "build_examples_result=true" > build_examples_result.txt
+        - echo "Success" > build_examples_result.txt
     artifacts:
         when: always
         paths:
@@ -134,10 +145,12 @@ build_idf_otbr_examples:
     image: $ESP_ENV_IMAGE
     allow_failure: true
     script:
-        - *setup_idf
+        - *setup_idf_master
+        - cd $ESP_THREAD_BR_PATH
+        - python3 ${CI_TOOLS_PATH}/get_component_version.py $IDF_PATH/examples/openthread/ot_br/main/idf_component.yml build_idf_otbr_example_result.txt esp_ot_cli_extension
         - *build_idf_example_ot_br
         - cd $ESP_THREAD_BR_PATH
-        - echo "build_idf_otbr_example_result=true" > build_idf_otbr_example_result.txt
+        - echo "Success" > build_idf_otbr_example_result.txt
     artifacts:
         when: always
         paths:
@@ -151,10 +164,12 @@ build_idf_otbr_autostart_examples:
     image: $ESP_ENV_IMAGE
     allow_failure: true
     script:
-        - *setup_idf
+        - *setup_idf_master
+        - cd $ESP_THREAD_BR_PATH
+        - python3 ${CI_TOOLS_PATH}/get_component_version.py $IDF_PATH/examples/openthread/ot_br/main/idf_component.yml build_idf_otbr_autostart_example_result.txt esp_ot_cli_extension
         - *build_idf_example_ot_br_autostart
         - cd $ESP_THREAD_BR_PATH
-        - echo "build_idf_otbr_autostart_example_result=true" > build_idf_otbr_autostart_example_result.txt
+        - echo "Success" > build_idf_otbr_autostart_example_result.txt
     artifacts:
         when: always
         paths:
@@ -168,10 +183,12 @@ build_idf_otcli_examples:
     image: $ESP_ENV_IMAGE
     allow_failure: true
     script:
-        - *setup_idf
+        - *setup_idf_master
+        - cd $ESP_THREAD_BR_PATH
+        - python3 ${CI_TOOLS_PATH}/get_component_version.py $IDF_PATH/examples/openthread/ot_cli/main/idf_component.yml build_idf_otcli_example_result.txt esp_ot_cli_extension
         - *build_idf_example_ot_cli
         - cd $ESP_THREAD_BR_PATH
-        - echo "build_idf_otcli_example_result=true" > build_idf_otcli_example_result.txt
+        - echo "Success" > build_idf_otcli_example_result.txt
     artifacts:
         when: always
         paths:
@@ -208,29 +225,8 @@ check_build_result:
         - build_idf_otcli_examples
     script:
         - *submodule_update
-        - chmod 700 ./check_components_version.sh
-        - ALLOW_EXT_CMD_FAILURE_OUTPUT=$(./check_components_version.sh "components/esp_ot_cli_extension")
-        - ALLOW_EXT_CMD_FAILURE_VALUE=$(echo "$ALLOW_EXT_CMD_FAILURE_OUTPUT" | cut -d'=' -f2)
-        - echo "ALLOW_EXT_CMD_FAILURE_VALUE=$ALLOW_EXT_CMD_FAILURE_VALUE"
-        - ALLOW_RCP_UPDATE_FAILURE_OUTPUT=$(./check_components_version.sh "components/esp_rcp_update")
-        - ALLOW_RCP_UPDATE_FAILURE_VALUE=$(echo "$ALLOW_RCP_UPDATE_FAILURE_OUTPUT" | cut -d'=' -f2)
-        - echo "ALLOW_RCP_UPDATE_FAILURE_VALUE=$ALLOW_RCP_UPDATE_FAILURE_VALUE"
-        - |
-          if [ "$ALLOW_EXT_CMD_FAILURE_VALUE" == "true" ] || [ "$ALLOW_RCP_UPDATE_FAILURE_VALUE" == "true" ]; then
-            echo "allow failure"
-            exit 0;
-          else
-            if [ -f "build_examples_result.txt" ] &&
-               [ -f "build_idf_otbr_example_result.txt" ] &&
-               [ -f "build_idf_otbr_autostart_example_result.txt" ] &&
-               [ -f "build_idf_otcli_example_result.txt" ]; then
-               echo "Success!!!"
-               exit 0
-            else
-               echo "Fail!!!"
-               exit 1
-            fi
-          fi
+        - chmod 700 ./check_build_results.sh
+        - ./check_build_results.sh
     tags:
         - build
 

.pre-commit-config.yaml

@@ -6,3 +6,11 @@ repos:
     rev: 'v14.0.6'  # Use the sha / tag you want to point at
     hooks:
     - id: clang-format
+
+  - repo: local
+    hooks:
+      - id: check-version-increment
+        name: Check Version Increment in Specific idf_component.yml
+        entry: python3 check_components_version.py
+        language: python
+        files: "(components/esp_rcp_update/idf_component.yml|components/esp_ot_cli_extension/idf_component.yml)"

check_build_results.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+# Define the commands in a list
+commands=(
+    "components/esp_rcp_update build_examples_result.txt"
+    "components/esp_ot_cli_extension build_examples_result.txt"
+    "components/esp_ot_cli_extension build_idf_otbr_example_result.txt"
+    "components/esp_ot_cli_extension build_idf_otbr_autostart_example_result.txt"
+    "components/esp_ot_cli_extension build_idf_otcli_example_result.txt"
+)
+
+# Loop through the list and run the commands
+for cmd in "${commands[@]}"; do
+    python3 check_idf_example_build_results.py $cmd
+    if [ $? -eq 1 ]; then
+        echo "Error: The check for $cmd failed."
+        exit 1
+    fi
+done
+
+# Exit with 0 if all commands succeed
+exit 0

check_components_version.py

@@ -0,0 +1,78 @@
+import sys
+import subprocess
+
+# Get the path parameters passed to the script
+if len(sys.argv) < 2:
+    print("Error: No idf_component.yml path provided")
+    sys.exit(1)
+
+file_paths = sys.argv[1:]
+
+# Print the received file paths for debugging
+print(f"Processing the following files: {file_paths}")
+
+# Get the version number from the file
+def get_version_from_file(file_path):
+    try:
+        with open(file_path, 'r') as f:
+            first_line = f.readline().strip()
+            if first_line.startswith('version:'):
+                return first_line.split(":")[1].strip().strip('"')
+            else:
+                print(f"Error: No version found in {file_path}")
+                return None
+    except Exception as e:
+        print(f"Error reading {file_path}: {e}")
+        return None
+
+# Get the version number from the main branch
+def get_version_from_main_branch(file_path):
+    try:
+        # Get the version number from the main branch of the git repository
+        result = subprocess.run(['git', 'show', 'main:' + file_path], capture_output=True, text=True)
+        first_line = result.stdout.strip().split('\n')[0]
+        if first_line.startswith('version:'):
+            return first_line.split(":")[1].strip().strip('"')
+        else:
+            print(f"Error: No version found in {file_path} from main branch")
+            return None
+    except Exception as e:
+        print(f"Error reading from main branch for {file_path}: {e}")
+        return None
+
+# Check the version to ensure the current version is not lower than the main branch version
+def check_version_increment(main_version, current_version):
+    main_parts = list(map(int, main_version.split('.')))
+    current_parts = list(map(int, current_version.split('.')))
+
+    if current_parts[0] < main_parts[0]:
+        print(f"Error: Major version downgrade detected. Current version {current_version} is less than main version {main_version}.")
+        return False
+    if current_parts[0] == main_parts[0] and current_parts[1] < main_parts[1]:
+        print(f"Error: Minor version downgrade detected. Current version {current_version} is less than main version {main_version}.")
+        return False
+    if current_parts[0] == main_parts[0] and current_parts[1] == main_parts[1] and current_parts[2] < main_parts[2]:
+        print(f"Error: Patch version downgrade detected. Current version {current_version} is less than main version {main_version}.")
+        return False
+
+    return True
+
+# Perform checks for each of the provided file paths
+for file_path in file_paths:
+    print(f"Processing file: {file_path}")
+
+    # Get the current branch version number
+    current_version = get_version_from_file(file_path)
+    if current_version is None:
+        sys.exit(1)
+
+    # Get the main branch version number
+    main_version = get_version_from_main_branch(file_path)
+    if main_version is None:
+        sys.exit(1)
+
+    # Compare the version numbers
+    if not check_version_increment(main_version, current_version):
+        sys.exit(1)
+
+print("Version check passed successfully.")