fix (Laerdal.Dfu.Bindings.iOS.csproj): milestone refactoring to suppo…

…rt mac-catalyst we now build against ios sdk 18.1 and maccatalyst sdk 15.1 while using xcode 16.1 on macos-15 vmimage (up from 14)
Laerdal · Nov 15, 2024 · 8394f4f · 8394f4f
1 parent 835ccc4
commit 8394f4f
Show file tree

Hide file tree

Showing 8 changed files with 527 additions and 573 deletions.
diff --git a/.github/workflows/github-actions.yml b/.github/workflows/github-actions.yml
@@ -30,6 +30,14 @@ env:
 
   DOTNET_TARGET_WORKLOAD_VERSION: "8.0.402" # dont upgrade this lightheartedly   the workload snapshot implicitly defines which versions of Android/iOS/MacCatalyst SDKs are supported
 
+  BINDINGS_IOS___SDK_VERSION: "18.1" # for xcodebuild
+  BINDINGS_IOS___XCODE_IDE_DEV_PATH: "/Applications/Xcode_16.1.app/Contents/Developer" # for xcodebuild
+  BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION: "17.0" # for the csproj file
+
+  BINDINGS_MACCATALYST___SDK_VERSION: "15.1" # for xcodebuild
+  BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH: "/Applications/Xcode_16.1.app/Contents/Developer" # for xcodebuild
+  BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION: "17.0" # for the csproj file
+
 
 on:
   workflow_call: #     so that other workflows can trigger this
@@ -48,7 +56,7 @@ jobs:
 
   build:
 
-    runs-on: 'macos-14'
+    runs-on: 'macos-15'
     timeout-minutes: 20
 
     steps:
@@ -90,6 +98,14 @@ jobs:
                                               -p:Laerdal_Github_Access_Token="${{ env.SCL_GITHUB_ACCESS_TOKEN     }}"                                                                   \
                                   -p:Laerdal_Should_Generate_and_Upload_Sbom="true"                                                                                                     \
                                                                                                                                                                                         \
+                                       -p:Laerdal_Bindings_iOS___Sdk_Version="${{env.BINDINGS_IOS___SDK_VERSION}}"                                                                      \
+                                -p:Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path="${{env.BINDINGS_IOS___XCODE_IDE_DEV_PATH}}"                                                               \
+                       -p:Laerdal_Bindings_iOS___DotnetTargetPlatformVersion="${{env.BINDINGS_IOS___DOTNET_TARGET_PLATFORM_VERSION}}"                                                   \
+                                                                                                                                                                                        \
+                               -p:Laerdal_Bindings_MacCatalyst___Sdk_Version="${{env.BINDINGS_MACCATALYST___SDK_VERSION}}"                                                              \
+                        -p:Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path="${{env.BINDINGS_MACCATALYST___XCODE_IDE_DEV_PATH}}"                                                       \
+               -p:Laerdal_Bindings_MacCatalyst___DotnetTargetPlatformVersion="${{env.BINDINGS_MACCATALYST___DOTNET_TARGET_PLATFORM_VERSION}}"                                           \
+                                                                                                                                                                                        \
                                     -p:Laerdal_Dependency_Tracker_Server_Url="${{ env.SCL_DEPENDENCY_TRACKER_SERVER_URL  }}"                                                            \
                              -p:Laerdal_Dependency_Tracker_Api_Key_File_Path="${{ env.BUILD_REPOSITORY_FOLDERPATH        }}/Laerdal.Scripts/dependency_tracker_api_key.ppk"             \
                  -p:Laerdal_Dependency_Tracker_Private_Signing_Key_File_Path="${{ env.BUILD_REPOSITORY_FOLDERPATH        }}/Laerdal.Scripts/dependency_tracker_private_signing_key.ppk" \

diff --git a/.gitignore b/.gitignore
@@ -406,7 +406,8 @@ ASALocalRun/
 
 Output/
 Laerdal.Dfu.Bindings.iOS/Carthage/
-# Laerdal.Dfu.Bindings.iOS/Sharpie/
+Laerdal.Dfu.Bindings.iOS/Sharpie/
+Laerdal.Dfu.Bindings.iOS/Frameworks/
 
 *.binlog
 *.csproj.xml

diff --git a/Laerdal.Dfu.Bindings.iOS/Laerdal.Dfu.Bindings.iOS.csproj b/Laerdal.Dfu.Bindings.iOS/Laerdal.Dfu.Bindings.iOS.csproj
@@ -9,8 +9,6 @@
     </PropertyGroup>
 
     <PropertyGroup>
-        <IsBindingProject>true</IsBindingProject>
-
         <TargetFrameworks>$(TargetFrameworks)net8.0-ios;</TargetFrameworks>
         <TargetFrameworks>$(TargetFrameworks)net8.0-maccatalyst</TargetFrameworks>
 
@@ -21,6 +19,8 @@
     </PropertyGroup>
 
     <PropertyGroup>
+        <IsBindingProject>true</IsBindingProject>
+
         <DebugType>full</DebugType>
         <Optimized>false</Optimized>
         <MtouchExtraArgs>-v -v -v -v</MtouchExtraArgs>
@@ -30,6 +30,15 @@
 
         <DefaultItemExcludes>$(DefaultItemExcludes);Carthage\**</DefaultItemExcludes>
 
+        <NativeFrameworkParentFolderpath>$([System.IO.Path]::Combine($(MSBuildThisFileDirectory), 'Frameworks'))</NativeFrameworkParentFolderpath>
+        <NativeFrameworkActualTargetFolderpath>$(NativeFrameworkParentFolderpath)/NordicDFU.framework</NativeFrameworkActualTargetFolderpath>
+
+        <!-- set these explicitly here only for experimentation    as far as cicd is concerned these values should be set in the .yml file of the pipeline                                                               -->
+        <!-- <Laerdal_Bindings_iOS___Sdk_Version Condition="           '$(Laerdal_Bindings_iOS___Sdk_Version)'           == '' ">17.0</Laerdal_Bindings_iOS___Sdk_Version>                                               -->
+        <!-- <Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path Condition="    '$(Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path)'    == '' ">/Applications/Xcode_15.4.app/Contents/Developer/</Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path> -->
+        <!-- <Laerdal_Bindings_MacCatalyst___Sdk_Version Condition="        '$(Laerdal_Bindings_MacCatalyst___Sdk_Version)'        == '' ">17.0</Laerdal_Bindings_MacCatalyst___Sdk_Version>                                               -->
+        <!-- <Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path Condition=" '$(Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path)' == '' ">/Applications/Xcode_15.4.app/Contents/Developer</Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path>  -->
+
         <!-- 1. under net8 we need Optimized=false otherwise release builds cause the resulting apps to crash right upon getting launched in the iphone! -->
         <!-- 2. NoBindingEmbedding=true per https://github.com/Laerdal/Laerdal.Dfu/issues/29#issuecomment-1904057544 -->
     </PropertyGroup>
@@ -62,6 +71,16 @@
 
     <Import Project="Laerdal.targets"/>
 
+    <!-- considering the highly customized nature of the build system we need to ensure that parallelization is turned off otherwise we will end up with   -->
+    <!-- cryptic errors in azure due to target-frameworks trying to build themselves in parallel thus stepping onto eachothers toes    thats because the   -->
+    <!-- intended way of building stuff is to let net8.0-maccatalyst build the maccatalyst libs and once that is done then and only then proceed to        -->
+    <!-- compiling any additional target-framework which will find the compiled framework-libs already in place                                            -->
+    <Target Name="EnsureThatParallelizedBuildingIsDisabled"
+            BeforeTargets="CompileProxyProjectAndGenerateFatLibs">
+        <Error Condition=" '$(MSBuildNodeCount)' != '' and $(MSBuildNodeCount) &gt; 1 "
+               Text="Detected that parallelization is turned on (MSBuildNodeCount: $(MSBuildNodeCount) > 1). Refusing to build because parallelized builds are destined to fail with cryptic errors. Turn off parallelization via BuildInParallel=false or /m:1 (see: https://stackoverflow.com/a/76340699/863651)"/>
+    </Target>
+
     <ItemGroup>
         <!-- unfortunately the files autogenerated by sharpie need a lot of hand tweaking to -->
         <!-- be really aligned with the underlying native libs so we cannot use them as-is   -->
@@ -72,63 +91,104 @@
         <ObjcBindingApiDefinition Include="ApiDefinition.cs"/>
     </ItemGroup>
 
-    <ItemGroup>
-        <NativeReference Include="Carthage/Carthage/Build/NordicDFU.xcframework/ios-arm64/NordicDFU.framework">
-            <Kind>Framework</Kind>
-            <SmartLink>False</SmartLink>
-            <Frameworks>Foundation</Frameworks>
-        </NativeReference>
-    </ItemGroup>
 
-    <Target Condition=" '$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true' and !Exists('Carthage\Carthage\Checkouts\IOS-Pods-DFU-Library\Package.swift') "
-            Name="_DownloadAndBuildIosNativeLibraries"
-            BeforeTargets="PrepareForBuild">
+    <!-- 1  its important to ensure that we only build the native libs once and only once otherwise we will get them build twice in parallel       -->
+    <!--                                                                                                                                           -->
+    <!-- 2  also note that we hook onto the PrepareForBuild task    if we target the task CoreCompile then this task will be invoked on localdev   -->
+    <!--    but on in the azure pipelines for some weird reason                                                                                    -->
+    <Target Name="CompileProxyProjectAndGenerateFatLibs"
+            BeforeTargets="PrepareForBuild"
+            Condition=" '$(DesignTimeBuild)' != 'true' and '$(BuildingProject)' == 'true' ">
 
         <Error Condition=" '$(IsOSX)' != 'true'                   " Text="This project can only be built on MacOS because it relies on the Carthage family of cli utils."/>
         <Error Condition=" '$(Laerdal_Github_Access_Token)' == '' " Text="'Laerdal_Github_Access_Token' is not defined. Please define it in your environment variables otherwise Carthage will fail most of the times."/>
 
-        <Message Importance="High" Text="** Downloading Carthage iOS packages ..."/>
+        <!-- 0. checkout the libraries -->
+        <ItemGroup>
+            <_PreexistingFilesToClean Include="$(NativeFrameworkActualTargetFolderpath)\**\*"/>
+        </ItemGroup>
 
+        <Delete Files="@(_PreexistingFilesToClean)" ContinueOnError="true"/>
+
+        <!-- 1. checkout the libraries -->
+        <Message Importance="High" Text="** Downloading Carthage Packages ..."/>
         <WriteLinesToFile
                 File="Carthage\Cartfile"
                 Lines="github    &quot;NordicSemiconductor/IOS-Pods-DFU-Library&quot;    &quot;$(Nordic_Package_Version)&quot;"
                 Overwrite="true"/>
 
         <PropertyGroup>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) GITHUB_ACCESS_TOKEN=&quot;github.com=$(Laerdal_Github_Access_Token)&quot;</_CarthageBuildCommand>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) carthage update</_CarthageBuildCommand>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) --platform iOS</_CarthageBuildCommand>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) --no-use-binaries</_CarthageBuildCommand>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) --use-xcframeworks</_CarthageBuildCommand>
-            <_CarthageBuildCommand>$(_CarthageBuildCommand) --project-directory Carthage</_CarthageBuildCommand>
+            <_CarthageCheckoutCommand>$(_CarthageCheckoutCommand) GITHUB_ACCESS_TOKEN=&quot;github.com=$(Laerdal_Github_Access_Token)&quot;</_CarthageCheckoutCommand>
+            <_CarthageCheckoutCommand>$(_CarthageCheckoutCommand) carthage update</_CarthageCheckoutCommand>
+            <_CarthageCheckoutCommand>$(_CarthageCheckoutCommand) --no-build</_CarthageCheckoutCommand>
+
+            <_CarthageBase_FolderPath>$(MSBuildThisFileDirectory)\Carthage</_CarthageBase_FolderPath>
+            <_CarthageCheckout_FolderPath>$(_CarthageBase_FolderPath)\Carthage\Checkouts</_CarthageCheckout_FolderPath>
+            <_CarthageCheckoutNordicIosPodsDfuLibrary_FolderPath>$(_CarthageCheckout_FolderPath)\IOS-Pods-DFU-Library</_CarthageCheckoutNordicIosPodsDfuLibrary_FolderPath>
+
+            <_CompileAndGenerateFatLibs_FilePath>$(MSBuildThisFileDirectory)/Laerdal.Mac.CompileAndGenerateFatLibs.sh</_CompileAndGenerateFatLibs_FilePath>
         </PropertyGroup>
 
         <!-- noticed that we had to resort to no-use-bindaries because we would constantly -->
         <!-- into ratelimiting problems without it causing our github pipelines to fail    -->
-        <Exec WorkingDirectory="$(MSBuildThisFileDirectory)" Command=" $(_CarthageBuildCommand) "/>
+        <Exec WorkingDirectory="$(_CarthageBase_FolderPath)" Command=" $(_CarthageCheckoutCommand) "/>
 
-        <RemoveDir
-                Condition="Exists('Carthage\Carthage\Checkouts\IOS-Pods-DFU-Library\Example')"
-                Directories="Carthage\Carthage\Checkouts\IOS-Pods-DFU-Library\Example"/>
+        <RemoveDir Directories="$(_CarthageCheckoutNordicIosPodsDfuLibrary_FolderPath)\Example" Condition="Exists('$(_CarthageCheckoutNordicIosPodsDfuLibrary_FolderPath)\Example')"/>
 
-        <!-- use this whenever you need to refresh apidefinition.cs and structsandenums.cs   -->
-        <!--                                                                                 -->
-        <!-- unfortunately the files autogenerated by sharpie need a lot of hand tweaking to -->
-        <!-- be really aligned with the underlying native libs so we cannot use them as-is   -->
-        <!--                                                                                 -->
-        <!--        <Message Importance="High" Text="** Regenerating sharpie files ..."/>    -->
-        <!--        <Exec Command="sharpie bind -o Sharpie &#45;&#45;namespace=Laerdal.Dfu.Bindings.iOS -f Carthage/Carthage/Build/NordicDFU.xcframework/ios-arm64/NordicDFU.framework"/>-->
+        <!-- 2. build and generate the fat libs from the proxy swift project -->
+        <Exec WorkingDirectory="$(MSBuildThisFileDirectory)" Command=" bash -c &quot; chmod +x  '$(_CompileAndGenerateFatLibs_FilePath)' &quot; "/>
+
+        <PropertyGroup Condition=" '$(IsNetIOS)' == 'true' ">
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) SUPPORTS_MACCATALYST='NO'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODEBUILD_TARGET_SDK='iphoneos'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODE_IDE_DEV_PATH='$(Laerdal_Bindings_iOS___Xcode_Ide_Dev_Path)'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODEBUILD_TARGET_SDK_VERSION='$(Laerdal_Bindings_iOS___Sdk_Version)'</_CompileAndGenerateFatLibs_Config>
+        </PropertyGroup>
+
+        <PropertyGroup Condition=" '$(IsNetMacCatalyst)' == 'true' ">
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) SUPPORTS_MACCATALYST='YES'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODEBUILD_TARGET_SDK='macosx'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODE_IDE_DEV_PATH='$(Laerdal_Bindings_MacCatalyst___Xcode_Ide_Dev_Path)'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) XCODEBUILD_TARGET_SDK_VERSION='$(Laerdal_Bindings_MacCatalyst___Sdk_Version)'</_CompileAndGenerateFatLibs_Config>
+        </PropertyGroup>
+
+        <PropertyGroup>
+            <!-- common flags for both ios and maccatalyst -->
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) INVOKE_SHARPIE='NO'</_CompileAndGenerateFatLibs_Config>
+            <_CompileAndGenerateFatLibs_Config>$(_CompileAndGenerateFatLibs_Config) SWIFT_OUTPUT_PATH='$(NativeFrameworkParentFolderpath)'</_CompileAndGenerateFatLibs_Config>
+        </PropertyGroup>
+
+        <Exec WorkingDirectory="$(_CarthageCheckout_FolderPath)" Command=" $(_CompileAndGenerateFatLibs_Config)  '$(_CompileAndGenerateFatLibs_FilePath)' "/>
+
+        <!-- warning   its absolutely vital to remove any softlink files as they are causing        -->
+        <!-- warning   codesign to fail when using the resulting nuget in maui apps   go figure ... -->
+        <Exec WorkingDirectory="$(NativeFrameworkParentFolderpath)" Command=" bash -c &quot; find . -type l -ls -delete &quot; "/>
+
+        <!-- remove any .DS_Store files from the .framework folder just be on the safe side -->
+        <Exec WorkingDirectory="$(NativeFrameworkParentFolderpath)" Command=" bash -c &quot; find . -name '.DS_Store' -type f -delete &quot; "/>
+    </Target>
+
+    <!-- this is meant to be invoked by the builder script separately before the main build kicks in   so keep it around -->
+    <Target Name="EnsureFrameworkFolderIsCreated">
+        <MakeDir Directories="$(NativeFrameworkActualTargetFolderpath)" Condition=" !Exists('$(NativeFrameworkActualTargetFolderpath)') "  />
     </Target>
 
-    <!--    use this whenever you need to refresh apidefinition.cs and structsandenums.cs                                                                                             -->
-    <!--                                                                                                                                                                              -->
-    <!--             Condition=" Exists('Carthage\Carthage\Build\NordicDFU.xcframework') and !Exists('Sharpie\') and '$(ContinuousIntegrationBuild)' != 'true' "                      -->
-    <!--                                                                                                                                                                              -->
-    <!--    <Target Name="_RunObjectiveSharpie"-->
-    <!--            BeforeTargets="PrepareForBuild"-->
-    <!--            DependsOnTargets="_DownloadAndBuildIosNativeLibraries">-->
-    <!--        <Message Importance="High" Text="** Regenerating sharpie files ..."/>-->
-    <!--                                                                                                                                                                              -->
-    <!--        <Exec Command="sharpie bind -o Sharpie &#45;&#45;namespace=Laerdal.Dfu.Bindings.iOS -f Carthage/Carthage/Build/NordicDFU.xcframework/ios-arm64/NordicDFU.framework"/> -->
-    <!--    </Target>-->
+    <Target Name="CreateKeepMeFileUnderFrameworkFolder" AfterTargets="CoreBuild">
+        <!-- to future maintainers     we need to keep this dummy file around in order to ensure that the folder Frameworks/McuMgrBindingsiOS.framework -->
+        <!-- to future maintainers     will always be automatically created upon git checkout in the azure pipelines  if we dont do this then the azure -->
+        <!-- to future maintainers     pipelines will generate a nuget without the Frameworks/McuMgrBindingsiOS.framework folder as a <NativeReference> -->
+        <!-- to future maintainers     causing the iOS nuget to be poisoned and cause cryptic errors in runtime about missing symbols etc               -->
+
+        <Touch Files="$(NativeFrameworkActualTargetFolderpath)/.keepme_in_git_otherwise_azure_pipelines_will_break" AlwaysCreate="true"/>
+    </Target>
+
+    <!-- https://learn.microsoft.com/en-us/xamarin/ios/platform/binding-objective-c/walkthrough?tabs=windows#create-a-xamarinios-binding-project -->
+    <ItemGroup>
+        <NativeReference Include="$(NativeFrameworkActualTargetFolderpath)">
+            <Kind>Framework</Kind>
+            <SmartLink>False</SmartLink>
+            <Frameworks>Foundation</Frameworks>
+        </NativeReference>
+    </ItemGroup>
+
 </Project>