Improve code fixing IDF version on build (#3066)

***NO_CI***

Author: josesimoes

CMake/binutils.ESP32.cmake

@@ -602,20 +602,33 @@ macro(nf_add_idf_as_library)
 
     include(${IDF_PATH_CMAKED}/tools/cmake/idf.cmake)
 
-    # "fix" the reported version so it doesn't show '-dirty' 
+    # if needed, "fix" the reported version so it doesn't show '-dirty'
     # this is because we could be deleting some files and tweaking others in the IDF
     get_property(MY_IDF_VER TARGET __idf_build_target PROPERTY IDF_VER)
-    string(REPLACE "-dirty" "" MY_IDF_VER_FIXED "${MY_IDF_VER}")
-    set_property(TARGET __idf_build_target PROPERTY IDF_VER ${MY_IDF_VER_FIXED})
-    set(IDF_VER_FIXED ${MY_IDF_VER_FIXED} CACHE INTERNAL "IDF version as CMake var")
 
-    # for COMPILE DEFINITIONS it's a bit more work
-    get_property(IDF_COMPILE_DEFINITIONS TARGET __idf_build_target PROPERTY COMPILE_DEFINITIONS )
+    # sanity check
+    if(${MY_IDF_VER} STREQUAL "")
+        message(FATAL_ERROR "Couldn't get IDF version from target __idf_build_target")
+    endif()
 
-    string(REPLACE "-dirty" "" IDF_COMPILE_DEFINITIONS_FIXED "${IDF_COMPILE_DEFINITIONS}")
-    set_property(TARGET __idf_build_target PROPERTY COMPILE_DEFINITIONS ${IDF_COMPILE_DEFINITIONS_FIXED})
-    
-    message(STATUS "Fixed IDF version. Is now: ${MY_IDF_VER_FIXED}")
+    message(STATUS "Current IDF version is: ${MY_IDF_VER}")
+
+    string(FIND ${MY_IDF_VER} "-dirty" MY_IDF_VER_DIRTY)
+    if(${MY_IDF_VER_DIRTY} GREATER -1)
+
+        # found '-dirty' in the version string
+        string(REPLACE "-dirty" "" MY_IDF_VER_FIXED "${MY_IDF_VER}")
+        set_property(TARGET __idf_build_target PROPERTY IDF_VER ${MY_IDF_VER_FIXED})
+        set(IDF_VER_FIXED ${MY_IDF_VER_FIXED} CACHE INTERNAL "IDF version as CMake var")
+
+        # for COMPILE DEFINITIONS it's a bit more work
+        get_property(IDF_COMPILE_DEFINITIONS TARGET __idf_build_target PROPERTY COMPILE_DEFINITIONS )
+
+        string(REPLACE "-dirty" "" IDF_COMPILE_DEFINITIONS_FIXED "${IDF_COMPILE_DEFINITIONS}")
+        set_property(TARGET __idf_build_target PROPERTY COMPILE_DEFINITIONS ${IDF_COMPILE_DEFINITIONS_FIXED})
+        
+        message(STATUS "Fixed IDF version. Is now: ${MY_IDF_VER_FIXED}")
+    endif()
 
     # check for SDK config from build options
     if(SDK_CONFIG_FILE)

azure-pipelines-nightly.yml

@@ -558,39 +558,46 @@ jobs:
       IDF_PATH: "D:/a/1/s/esp-idf"
       PIP_CACHE_DIR: $(Pipeline.Workspace)/.pip
       TargetPlatform: "esp32"
+      IDF_TAG: "v5.2.3"
 
     steps:
       - checkout: self
-      - checkout: esp32_idf
-        fetchDepth: 1
+        path: s/nf-interpreter
 
+      - template: azure-pipelines-templates/checkout-idf.yml
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s'
       - template: azure-pipelines-templates/build-preparations.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/nb-gitversioning.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/download-install-esp32-build-components.yml
       - template: azure-pipelines-templates/download-install-ninja.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/build-espressif-esp32-targets.yml
-
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
+          partitionsDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter/targets/ESP32/_IDF/$(IDF_Target)'
       - task: CopyFiles@2
         condition: succeeded()
         displayName: Copying bootloader
         inputs:
-          sourceFolder: '$(Build.SourcesDirectory)\nf-interpreter\build\bootloader'
+          sourceFolder: '$(Agent.BuildDirectory)/s/nf-interpreter/build/bootloader'
           Contents: |
             bootloader.bin
           TargetFolder: '$(Build.ArtifactStagingDirectory)\$(TargetPublishName)'
           flattenFolders: true
           ignoreMakeDirErrors: true
 
       - template: azure-pipelines-templates/copy-sdkconfig.yml
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/pack-publish-artifacts.yml
         parameters:
-          buildDirectory: '$(Build.SourcesDirectory)\nf-interpreter\build'
+          buildDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter/build'
       - template: azure-pipelines-templates/publish-cloudsmith.yml
       - template: azure-pipelines-templates/publish-sdkconfig.yml
 

azure-pipelines-templates/build-espressif-esp32-targets.yml

@@ -14,13 +14,6 @@ steps:
     parameters:
       repoDirectory: ${{ parameters.repoDirectory }}
 
-  - task: Cache@2
-    displayName: Cache IDF components
-    inputs:
-      key: 'esp-idf-components-cache | 5_2_3'
-      path: $(Agent.BuildDirectory)/s/esp-idf/components
-      cacheHitVar: ESP32_COMPONENTS_RESTORED
-
   - task: CMake@1
     condition: succeeded()
     displayName: Setup build with CMake

azure-pipelines-templates/checkout-idf.yml

@@ -0,0 +1,28 @@
+# Copyright (c) .NET Foundation and Contributors
+# See LICENSE file in the project root for full license information.
+
+parameters:
+  - name: repoDirectory
+    type: string
+    default: $(Agent.BuildDirectory)/s
+
+steps:
+
+  - task: Cache@2
+    displayName: Cache IDF repository
+    inputs:
+      key: 'esp-idf | "$(IDF_TAG)"'
+      path: $(Agent.BuildDirectory)/s/esp-idf
+      cacheHitVar: ESP32_IDF_REPO_RESTORED
+
+  - task: PowerShell@2
+    displayName: Checkout IDF repository
+    condition: ne(variables.ESP32_IDF_REPO_RESTORED, 'true')
+    inputs:
+      targetType: "inline"
+      script: |
+        # create directory for IDF, ignore if it already exists
+        New-Item -Path ${{ parameters.repoDirectory }} -ItemType "directory" -ErrorAction SilentlyContinue
+        # move to the build sources directory
+        Set-Location -Path ${{ parameters.repoDirectory }}
+        git clone --recurse-submodules --shallow-submodules --single-branch --depth 1 --branch $(IDF_TAG)  https://github.com/espressif/esp-idf

azure-pipelines-templates/copy-sdkconfig.yml

@@ -1,12 +1,17 @@
 # Copyright (c) .NET Foundation and Contributors
 # See LICENSE file in the project root for full license information.
 
+parameters:
+  - name: repoDirectory
+    type: string
+    default: $(Build.SourcesDirectory)\nf-interpreter
+
 steps:
   - task: CopyFiles@2
     condition: succeeded()
     displayName: Copying SDKCONFIG
     inputs:
-      sourceFolder: '$(Build.SourcesDirectory)\nf-interpreter'
+      sourceFolder: "${{ parameters.repoDirectory }}"
       Contents: |
         sdkconfig
       TargetFolder: '$(Build.ArtifactStagingDirectory)\$(TargetPublishName)_sdkconfig'

azure-pipelines-templates/download-install-esp32-build-components.yml

@@ -6,8 +6,7 @@ steps:
   - task: Cache@2
     displayName: Cache ESP32 tools
     inputs:
-      key: "esp32_tools | 5_2_3"
-      restoreKeys: 5_2_3
+      key: 'esp32_tools | "$(IDF_TAG)"'
       path: $(UserProfile)\.espressif\tools
       cacheHitVar: ESP32_TOOLS_CACHE_RESTORED
 

azure-pipelines.yml

@@ -48,7 +48,7 @@ resources:
       type: github
       name: espressif/esp-idf
       endpoint: nanoframework
-      ref: 'refs/tags/v5.2.3'
+      ref: refs/tags/v5.2.3
     - repository: mscorlib
       type: github
       name: nanoframework/CoreLibrary
@@ -557,39 +557,46 @@ jobs:
       IDF_PATH: "D:/a/1/s/esp-idf"
       PIP_CACHE_DIR: $(Pipeline.Workspace)/.pip
       TargetPlatform: "esp32"
+      IDF_TAG: "v5.2.3"
 
     steps:
       - checkout: self
-      - checkout: esp32_idf
-        fetchDepth: 1
+        path: s/nf-interpreter
 
+      - template: azure-pipelines-templates/checkout-idf.yml
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s'
       - template: azure-pipelines-templates/build-preparations.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/nb-gitversioning.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/download-install-esp32-build-components.yml
       - template: azure-pipelines-templates/download-install-ninja.yml
         parameters:
-          repoDirectory: '$(Build.SourcesDirectory)\nf-interpreter'
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/build-espressif-esp32-targets.yml
-
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
+          partitionsDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter/targets/ESP32/_IDF/$(IDF_Target)'
       - task: CopyFiles@2
         condition: succeeded()
         displayName: Copying bootloader
         inputs:
-          sourceFolder: '$(Build.SourcesDirectory)\nf-interpreter\build\bootloader'
+          sourceFolder: '$(Agent.BuildDirectory)/s/nf-interpreter/build/bootloader'
           Contents: |
             bootloader.bin
           TargetFolder: '$(Build.ArtifactStagingDirectory)\$(TargetPublishName)'
           flattenFolders: true
           ignoreMakeDirErrors: true
 
       - template: azure-pipelines-templates/copy-sdkconfig.yml
+        parameters:
+          repoDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter'
       - template: azure-pipelines-templates/pack-publish-artifacts.yml
         parameters:
-          buildDirectory: '$(Build.SourcesDirectory)\nf-interpreter\build'
+          buildDirectory: '$(Agent.BuildDirectory)/s/nf-interpreter/build'
       - template: azure-pipelines-templates/publish-cloudsmith.yml
       - template: azure-pipelines-templates/publish-sdkconfig.yml
 

targets/ESP32/CMakeLists.txt

@@ -167,3 +167,4 @@ add_subdirectory(_nanoCLR)
 if(USE_NETWORKING_OPTION)
     add_subdirectory(_Network)
 endif()
+