Skip to content

ensure that single-rid container publishes populate all container information #48584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

ensure that single-rid container publishes populate all container information #48584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ad0526
ensure that single-rid container publishes populate all container inf…
baronfel Apr 18, 2025
66582ea
fix e2e tests CanDeferContainerAppCommand and CanComputeContainerUser
surayya-MS Apr 24, 2025
783b1be
use ComputeContainerConfig for tests CanComputeContainerUser and CanD…
surayya-MS Apr 24, 2025
17f10b6
fix computing ContainerUser
surayya-MS Apr 24, 2025
4641973
Merge branch 'main' into restore-computecontainerconfig-data-for-sing…
surayya-MS Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 28 additions & 15 deletions src/Containers/packaging/build/Microsoft.NET.Build.Containers.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
<ContainerRuntimeIdentifier Condition="'$(ContainerRuntimeIdentifier)' == '' and '$(RuntimeIdentifier)' != ''">$(RuntimeIdentifier)</ContainerRuntimeIdentifier>
<ContainerRuntimeIdentifiers Condition="'$(BuildingInsideVisualStudio)' != 'true' and '$(ContainerRuntimeIdentifiers)' == '' and '$(IsRidAgnostic)' != 'true'">$(RuntimeIdentifiers)</ContainerRuntimeIdentifiers>
<ContainerRuntimeIdentifier Condition="'$(ContainerRuntimeIdentifier)' == '' and '$(ContainerRuntimeIdentifiers)' == ''">linux-$(NETCoreSdkPortableRuntimeIdentifier.Split('-')[1])</ContainerRuntimeIdentifier>
<!-- We want to save customer provided ContainerBaseImage to later set ContainerUser. -->
<_InitialContainerBaseImage>$(ContainerBaseImage)</_InitialContainerBaseImage>
</PropertyGroup>

<ItemGroup>
Expand All @@ -67,7 +69,9 @@
</ItemGroup>
</Target>

<Target Name="ComputeContainerConfig" DependsOnTargets="ComputeContainerBaseImage">
<!-- This Target is called early on in the chain for both single-RID and multi-RID containers - but for single-RID it's important
that we ensure all of the data necessary to create a single-RID container is computed after we exit this target. -->
<Target Name="ComputeContainerConfig" DependsOnTargets="ComputeContainerBaseImage;_ComputeContainerExecutionArgs">
<PropertyGroup Label="VS defaults">
<!-- RegistryUrl is used by existing VS targets for Docker builds - this lets us fill that void -->
<ContainerRegistry Condition="'$(RegistryUrl)' != ''">$(RegistryUrl)</ContainerRegistry>
Expand Down Expand Up @@ -177,26 +181,27 @@
<PropertyGroup>
<PublishContainerDependsOn>
_ContainerVerifySDKVersion;
_ContainerEstablishRIDNess;
ComputeContainerConfig;
_CheckContainersPackage
</PublishContainerDependsOn>
</PropertyGroup>

<!-- These args are relevant to container execution and are per-RID by nature. Therefore they're a direct dependency of the _PublishSingleContainer
target and not computed at the outer layer. -->
<Target Name="_ComputeContainerExecutionArgs">
target and not computed at the outer, multi-RID build layer. -->
<Target Name="_ComputeContainerExecutionArgs" Condition="'$(_IsSingleRIDBuild)' == 'true'">
<PropertyGroup>
<!-- The Container RID should default to the RID used for the entire build (to ensure things run on the platform they are built for), but the user knows best and so should be able to set it explicitly.
For builds that have a RID, we default to that RID. Otherwise, we default to the Linux RID matching the architecture of the currently-executing SDK. -->
<_ContainerIsTargetingWindows>false</_ContainerIsTargetingWindows>
<_ContainerIsTargetingWindows Condition="$(ContainerRuntimeIdentifier.StartsWith('win'))">true</_ContainerIsTargetingWindows>

<!-- Set the WorkingDirectory depending on the RID -->
<ContainerWorkingDirectory Condition="'$(ContainerWorkingDirectory)' == '' and !$(_ContainerIsTargetingWindows)">/app/</ContainerWorkingDirectory>
<ContainerWorkingDirectory Condition="'$(ContainerWorkingDirectory)' == '' and $(_ContainerIsTargetingWindows)">C:\app\</ContainerWorkingDirectory>
<_ContainerIsUsingMicrosoftDefaultImages Condition="'$(ContainerBaseImage)' == ''">true</_ContainerIsUsingMicrosoftDefaultImages>
<_ContainerIsUsingMicrosoftDefaultImages Condition="'$(ContainerBaseImage)' != ''">false</_ContainerIsUsingMicrosoftDefaultImages>

<_ContainerIsUsingMicrosoftDefaultImages Condition="'$(_InitialContainerBaseImage)' == ''">true</_ContainerIsUsingMicrosoftDefaultImages>
<_ContainerIsUsingMicrosoftDefaultImages Condition="'$(_InitialContainerBaseImage)' != ''">false</_ContainerIsUsingMicrosoftDefaultImages>
</PropertyGroup>

<!-- We only set a default user when the base image is Microsoft-authored, and we're targeting a version of those images that supports a nonroot user -->
Expand Down Expand Up @@ -245,7 +250,9 @@
Text="The $(_ContainersPackageIdentity) NuGet package is explicitly referenced but the current SDK can natively publish the project as a container. Consider removing the package reference to $(_ContainersPackageIdentity) because it is no longer needed." />
</Target>

<Target Name="_PublishSingleContainer" DependsOnTargets="_ComputeContainerExecutionArgs" Returns="@(GeneratedContainer)">
<!-- There is an implicit dependency here in that both of ComputeContainerConfig and _ComputeContainerExecutionArgs must have been run, but because we call this Target
in a few different ways we can't express that dependency directly here. -->
<Target Name="_PublishSingleContainer" Returns="@(GeneratedContainer)">
<PropertyGroup Condition="'$(DOTNET_HOST_PATH)' == ''">
<DotNetHostDirectory>$(NetCoreRoot)</DotNetHostDirectory>
<DotNetHostFileName>dotnet</DotNetHostFileName>
Expand Down Expand Up @@ -342,14 +349,17 @@
ContainerGenerateLabels=$(ContainerGenerateLabels);
ContainerGenerateLabelsImageBaseDigest=$(ContainerGenerateLabelsImageBaseDigest);
_SkipContainerPublishing=$(_SkipContainerPublishing);
ContainerImageFormat=$(_SingleImageContainerFormat)
ContainerImageFormat=$(_SingleImageContainerFormat);
_IsMultiRIDBuild=false;
_IsSingleRIDBuild=true;
_InitialContainerBaseImage=$(_InitialContainerBaseImage)
"/>
<_rids Remove ="$(_rids)" />
</ItemGroup>

<MSBuild
Projects="@(_InnerBuild)"
Targets="Publish;_ParseItemsForPublishingSingleContainer;_PublishSingleContainer"
Targets="Publish;_ParseItemsForPublishingSingleContainer;_ComputeContainerExecutionArgs;_PublishSingleContainer"
BuildInParallel="$([MSBuild]::ValueOrDefault('$(ContainerPublishInParallel)', 'true'))">
<Output TaskParameter="TargetOutputs" ItemName="GeneratedContainer" />
</MSBuild>
Expand Down Expand Up @@ -401,11 +411,7 @@
</ItemGroup>
</Target>

<Target Name="PublishContainer"
DependsOnTargets="$(PublishContainerDependsOn)"
Condition="'$(IsPublishable)' == 'true' AND '$(EnableSdkContainerSupport)' == 'true'"
Returns="@(GeneratedContainer)"
>
<Target Name="_ContainerEstablishRIDNess">
<PropertyGroup>
<_IsMultiTFMBuild Condition="'$(TargetFrameworks)' != '' and '$(TargetFramework)' == ''">true</_IsMultiTFMBuild>
<!-- we are multi-RID if:
Expand All @@ -415,10 +421,17 @@
<_HasCRIDsAndNoCRID Condition="'$(ContainerRuntimeIdentifiers)' != '' and '$(ContainerRuntimeIdentifier)' == ''">true</_HasCRIDsAndNoCRID>
<_HasRIDs Condition="'$(RuntimeIdentifiers)' != ''">true</_HasRIDs>
<_NoCRIDsOrCRIDorRID Condition="'$(ContainerRuntimeIdentifiers)' == '' and '$(ContainerRuntimeIdentifier)' == '' and '$(RuntimeIdentifier)' == ''">true</_NoCRIDsOrCRIDorRID>
<!-- these two are load-bearing for other comparisons - see _ComputeContainerExecutionArgs -->
<_IsMultiRIDBuild Condition="'$(BuildingInsideVisualStudio)' != 'true' and ('$(_HasCRIDsAndNoCRID)' == true or ('$(_HasRIDs)' == 'true' and '$(_NoCRIDsOrCRIDorRID)' == 'true'))">true</_IsMultiRIDBuild>
<_IsSingleRIDBuild Condition="'$(_IsMultiRIDBuild)' == ''">true</_IsSingleRIDBuild>
</PropertyGroup>
</Target>

<Target Name="PublishContainer"
DependsOnTargets="$(PublishContainerDependsOn)"
Condition="'$(IsPublishable)' == 'true' AND '$(EnableSdkContainerSupport)' == 'true'"
Returns="@(GeneratedContainer)"
>
<!-- Call _PublishMultiArchContainers if we are in a multi-rid build, and call _PublishSingleContainer if we are in a single-RID build -->
<CallTarget Condition="'$(_IsMultiRIDBuild)' == 'true' " Targets="_PublishMultiArchContainers">
<Output TaskParameter="TargetOutputs" ItemName="GeneratedContainer" />
Expand Down
8 changes: 5 additions & 3 deletions test/Microsoft.NET.Build.Containers.IntegrationTests/TargetsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ public void CanDeferContainerAppCommand(
{
[prop] = value.ToString(),
[ContainerRuntimeIdentifier] = $"{os}-x64",
["_IsSingleRIDBuild"] = "true",

}, projectName: $"{nameof(CanDeferContainerAppCommand)}_{prop}_{value}_{string.Join("_", expectedAppCommandArgs)}");
using var _ = d;
var instance = project.CreateProjectInstance(ProjectInstanceSettings.None);
instance.Build([ _ComputeContainerExecutionArgs ], []);
instance.Build([ ComputeContainerConfig ], []);
var computedAppCommand = instance.GetItems(ContainerAppCommand).Select(i => i.EvaluatedInclude);

// The test was not testing anything previously, as the list returned was zero length,
Expand Down Expand Up @@ -310,11 +311,12 @@ public void CanComputeContainerUser(string tfm, string rid, string? expectedUser
["TargetFrameworkIdentifier"] = ".NETCoreApp",
["TargetFrameworkVersion"] = tfm,
["TargetFramework"] = "net" + tfm.TrimStart('v'),
["ContainerRuntimeIdentifier"] = rid
["ContainerRuntimeIdentifier"] = rid,
["_IsSingleRIDBuild"] = "true",
}, projectName: $"{nameof(CanComputeContainerUser)}_{tfm}_{rid}_{expectedUser}");
using var _ = d;
var instance = project.CreateProjectInstance(ProjectInstanceSettings.None);
instance.Build(new[] { _ComputeContainerExecutionArgs }, new[] { logger }, null, out var outputs).Should().BeTrue(String.Join(Environment.NewLine, logger.Errors));
instance.Build(new[] { ComputeContainerConfig }, new[] { logger }, null, out var outputs).Should().BeTrue(String.Join(Environment.NewLine, logger.Errors));
var computedTag = instance.GetProperty("ContainerUser")?.EvaluatedValue;
computedTag.Should().Be(expectedUser);
}
Expand Down
Loading