From e5714bad78790aa852f3d3652ff2c57fa5245239 Mon Sep 17 00:00:00 2001
From: mu88 <4560672+mu88@users.noreply.github.com>
Date: Mon, 20 May 2024 16:15:59 +0200
Subject: [PATCH] build: build and push multi-arch Docker images

See https://github.com/dotnet/sdk-container-builds/issues/87
---
 .github/workflows/CI_CD.yml  |   9 ++-
 ShopAndEat/ShopAndEat.csproj | 105 +++++++++++++++++++++++++++++++++++
 2 files changed, 109 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/CI_CD.yml b/.github/workflows/CI_CD.yml
index d836e6b..d9bbebb 100644
--- a/.github/workflows/CI_CD.yml
+++ b/.github/workflows/CI_CD.yml
@@ -38,7 +38,6 @@ jobs:
         run: dotnet sonarscanner end /d:sonar.token=${{ secrets.SONAR_TOKEN }}
       - name: Login to DockerHub
         uses: docker/login-action@v3
-        if: ${{ env.IS_RELEASE == 'true' }}
         with:
           registry: registry.hub.docker.com
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -52,10 +51,10 @@ jobs:
       - name: Build Docker
         if: ${{ env.IS_RELEASE != 'true' }}
         run: |
-          dotnet publish ShopAndEat/ShopAndEat.csproj --os linux --arch arm64 /t:PublishContainer '-p:ContainerImageTags="dev"'
-          dotnet publish ShopAndEat/ShopAndEat.csproj --os linux --arch arm64 /t:PublishContainer '-p:ContainerImageTags="dev-chiseled"' -p:ContainerFamily=jammy-chiseled
+          dotnet publish ShopAndEat/ShopAndEat.csproj /t:MultiArchPublish '-p:ContainerImageTags="dev"' -p:ContainerRegistry=registry.hub.docker.com
+          dotnet publish ShopAndEat/ShopAndEat.csproj /t:MultiArchPublish '-p:ContainerImageTags="dev-chiseled"' -p:ContainerFamily=jammy-chiseled -p:ContainerRegistry=registry.hub.docker.com
       - name: Push Docker
         if: ${{ env.IS_RELEASE == 'true' }}
         run: |
-          dotnet publish ShopAndEat/ShopAndEat.csproj --os linux --arch arm64 /t:PublishContainer '-p:ContainerImageTags="${{ env.VERSION }};latest"' -p:ContainerRegistry=registry.hub.docker.com
-          dotnet publish ShopAndEat/ShopAndEat.csproj --os linux --arch arm64 /t:PublishContainer '-p:ContainerImageTags="${{ env.VERSION }}-chiseled;latest-chiseled"' -p:ContainerRegistry=registry.hub.docker.com -p:ContainerFamily=jammy-chiseled
\ No newline at end of file
+          dotnet publish ShopAndEat/ShopAndEat.csproj /t:MultiArchPublish '-p:ContainerImageTags="${{ env.VERSION }};latest"' -p:ContainerRegistry=registry.hub.docker.com
+          dotnet publish ShopAndEat/ShopAndEat.csproj /t:MultiArchPublish '-p:ContainerImageTags="${{ env.VERSION }}-chiseled;latest-chiseled"' -p:ContainerRegistry=registry.hub.docker.com -p:ContainerFamily=jammy-chiseled
\ No newline at end of file
diff --git a/ShopAndEat/ShopAndEat.csproj b/ShopAndEat/ShopAndEat.csproj
index 2a694d1..db51f77 100644
--- a/ShopAndEat/ShopAndEat.csproj
+++ b/ShopAndEat/ShopAndEat.csproj
@@ -22,4 +22,109 @@
   <ItemGroup>
     <InternalsVisibleTo Include="Tests" />
   </ItemGroup>
+
+  <!-- Multi-arch images (see https://github.com/dotnet/sdk-container-builds/issues/87) -->
+  <PropertyGroup>
+    <RuntimeIdentifiers>linux-x64;linux-arm64</RuntimeIdentifiers>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <SingleRegistryPublish
+            Include="$(MSBuildProjectFullPath)"
+            AdditionalProperties="ContainerRegistry=%(DestinationRegistry)"/>
+  </ItemGroup>
+
+  <Target
+          Name="MultiRidBuild">
+    <ItemGroup>
+      <_rids Include="$(RuntimeIdentifiers)"/>
+      <_InnerBuild Include="$(MSBuildProjectFullPath)"
+                   AdditionalProperties="RuntimeIdentifier=%(_rids.Identity)"
+                   PropertiesToUnset="RuntimeIdentifiers"/>
+    </ItemGroup>
+    <MSBuild
+            Projects="@(_InnerBuild)"
+            Targets="Build"
+            BuildInParallel="true"/>
+  </Target>
+
+  <Target
+          Name="MultiPush"
+          DependsOnTargets="Publish">
+    <MSBuild
+            Projects="@(SingleRegistryPublish)"
+            Targets="PublishContainer"
+            BuildInParallel="true"/>
+  </Target>
+
+  <Target Name="MultiArchPublish">
+    <Error Text="ContainerRegistry MUST BE SET" Condition="'$(ContainerRegistry)' == ''"/>
+
+    <ItemGroup>
+      <!-- first, define the container tags you want to create. these will be the roots of the arch-specific manifests - what users will mostly be using. -->
+      <_TagsToPublish Include="$(ContainerImageTags)"/>
+
+      <!-- next, define the architectures you want to publish for. we could have just used RuntimeIdentifiers from above, but I wanted to use golang-style tag parts,
+           so that these images would look and feel like other container images. -->
+      <_RIDItems Include="linux-x64" GolangArch="amd64"/>
+      <_RIDItems Include="linux-arm64" GolangArch="arm64"/>
+    </ItemGroup>
+
+    <!-- Ideally at this point we'd call some target that would map .NET RIDs to Golang architecture items, but this doesn't currently exist -->
+    <!-- <MapRidsToGolangArch RIDs="@(_RIDItems)">
+      <Output TaskParameter="RidsWithArch" ItemName="_RIDItems" />
+    </MapRidsToGolangArch> -->
+
+    <ItemGroup>
+      <!-- this next part is kind of gross - we're trying to construct an MSBuild property value like 'ContainerImageTags=<tagbase>-<arch>;<tagbase>-<arch>'
+           this means we need a map of each specific arch to the list of tags we'd like to push for that arch. the easiest way I found to do that is
+            * create unique items that 'splat' the RIDs across each of the tags
+            * batch by the RIDs - thus capturing all of the tags in the ItemGroup for that batch. we can now transform that ItemGroup to make our final property string -->
+
+      <_RIDSForTag Include="@(_TagsToPublish)" RID="%(_RIDItems.Identity)" GolangArch="%(_RIDItems.GolangArch)"/>
+      <_TagsForRID Include="%(_RIDSForTag.RID)" ContainerTags="@(_RIDSForTag->'%(Identity)-%(GolangArch)', ';')"/>
+
+      <!-- now that we have our mappings, we can build this project for each RID, passing the full set of tags to create -->
+      <_ContainerPublish
+              Include="$(MSBuildProjectFullPath)"
+              AdditionalProperties="RuntimeIdentifier=%(_TagsForRID.Identity);ContainerImageTags=%(_TagsForRID.ContainerTags)"/>
+    </ItemGroup>
+
+    <MSBuild
+            Projects="@(_ContainerPublish)"
+            Targets="Publish;PublishContainer"
+            BuildInParallel="true"/>
+
+    <Message Text="Created architecture-specific images, now creating manifest list" Condition="'$(ContainerRegistry)' != ''" Importance="High"/>
+
+    <!--
+      If we pushed to an actual registry we can make a multi-arch image here. We need the image name and the tags to do so.
+      However, the PublishContainer targt doesn't actually emit the name or tags so we have to reconstruct it.
+      This is a gap, we should fill it in the SDK.
+
+      NOTE: We can only create the multi-arch manifest if we pushed to a registry. This is a fundamental constraint, so that condition has been applied to all of this code
+    -->
+    <!-- Call ComputeContainerConfig on this project so that the properties it sets are visible -->
+    <MSBuild Projects="$(MSBuildThisFile)" Targets="ComputeContainerConfig" Condition="'$(ContainerRegistry)' != ''"/>
+
+    <!-- To make a manifest we need to know the name of the manifest (e.g. mcr.microsoft.com/dotnet/sdk:8.0) and the names of all of the
+         architecture-specific images that go into that manifest (e.g. mcr.microsoft.com/dotnet/sdk:8.0-arm64, mcr.microsoft.com/dotnet/sdk:8.0-amd64, etc).
+         Again, the easiest way to do that is to make add the 'parent' information to some other pience of data that already contains the tag/arch data.
+        -->
+
+    <ItemGroup Condition="'$(ContainerRegistry)' != ''">
+      <!-- We'll need to group by 'tag' here to get the manifest names (the nice tags). To make that easier, let's add the parent manifest name and the
+          'final' container name onto each of our already-RID-aware Tag items.   -->
+      <_RIDSForTag>
+        <FullImageName>$(ContainerRegistry)/$(ContainerRepository):%(Identity)-%(GolangArch)</FullImageName>
+        <ParentManifestName>$(ContainerRegistry)/$(ContainerRepository):%(Identity)</ParentManifestName>
+      </_RIDSForTag>
+    </ItemGroup>
+
+    <!-- armed with that data, we can easily batch these Task calls. '%(_RIDSForTag.ParentManifestName)' filters _RIDSForTag down to all items that have the same ParentManifestName.
+         this means that we can refer to @(_RIDSForTag) here as only the Items for the images for this manifest! From there it's easy to splat the FullImageName onto the CLI calls. -->
+    <Exec Condition="'$(ContainerRegistry)' != ''" Command="docker manifest create %(_RIDSForTag.ParentManifestName) @(_RIDSForTag->'%(FullImageName)', ' ') --amend"/>
+    <Exec Condition="'$(ContainerRegistry)' != ''" Command="docker manifest push %(_RIDSForTag.ParentManifestName)"/>
+    <Message Text="Created and pushed manifest list %(_RIDSForTag.ParentManifestName)" Condition="'$(ContainerRegistry)' != ''" Importance="High"/>
+  </Target>
 </Project>
\ No newline at end of file