Skip to content
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

Jump to bottom

Create a new label with TFM of the app and the SDK used to build the image #39196

Merged
merged 4 commits into from
Mar 26, 2024
Merged

Create a new label with TFM of the app and the SDK used to build the image #39196

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
082887c
add SDK and TFM labels to generated images
baronfel Mar 4, 2024
91b009a
add missing true default value
baronfel Mar 5, 2024
490d34d
add missing generated string value
baronfel Mar 14, 2024
565fe0d
Fix whitespace style
baronfel Mar 25, 2024
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
22 changes: 11 additions & 11 deletions src/Containers/Microsoft.NET.Build.Containers/Resources/Strings.Designer.cs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 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 @@ -141,6 +141,7 @@
<ContainerGenerateLabelsImageTitle Condition="'$(ContainerGenerateLabelsImageTitle)' == ''">true</ContainerGenerateLabelsImageTitle>
<ContainerGenerateLabelsImageBaseDigest Condition="'$(ContainerGenerateLabelsImageBaseDigest)' == ''">true</ContainerGenerateLabelsImageBaseDigest>
<ContainerGenerateLabelsImageBaseName Condition="'$(ContainerGenerateLabelsImageBaseName)' == ''">true</ContainerGenerateLabelsImageBaseName>
<ContainerGenerateLabelsDotnetToolset Condition="'$(ContainerGenerateLabelsDotnetToolset)' == ''">true</ContainerGenerateLabelsDotnetToolset>
</PropertyGroup>

<PropertyGroup Label="Defaults for Container Labels">
Expand All @@ -167,6 +168,8 @@
<!-- Need to compute digests, not just names, before we can light this up. This suggests we need a task where all of the 'read' steps are done. -->
<!-- <ContainerLabel Condition="'$(ContainerGenerateLabelsImageBaseDigest)' == 'true' and '$(ContainerBaseImageDigest)' != ''" Include="org.opencontainers.image.base.digest" Value="$(ContainerBaseImageDigest)" /> -->
<ContainerLabel Condition="'$(ContainerGenerateLabelsImageBaseName)' == 'true' and '$(ContainerBaseImage)' != ''" Include="org.opencontainers.image.base.name" Value="$(ContainerBaseImage)" />
<ContainerLabel Condition="'$(ContainerGenerateLabelsDotnetToolset)' == 'true' and '$(TargetFrameworkIdentifier)' == '.NETCoreApp'" Include="net.dot.runtime.majorminor" Value="$(_TargetFrameworkVersionWithoutV)"/>
<ContainerLabel Condition="'$(ContainerGenerateLabelsDotnetToolset)' == 'true'" Include="net.dot.sdk.version" Value="$(NETCoreSdkVersion)"/>
baronfel marked this conversation as resolved.
Show resolved Hide resolved
</ItemGroup>

<!-- These sourcelink-derived properties are only allowed to flow to generated artifacts if `PublishRepositoryUrl` is set as a user signal for opt-in.
Expand Down
2 changes: 1 addition & 1 deletion src/Tests/Microsoft.NET.Build.Containers.IntegrationTests/ProjectInitializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public static (Project, CapturingLogger, IDisposable) InitProject(Dictionary<str
props["TargetFramework"] = "net7.0";
props["_NativeExecutableExtension"] = ".exe"; //TODO: windows/unix split here
props["Version"] = "1.0.0"; // TODO: need to test non-compliant version strings here
props["NetCoreSdkVersion"] = "7.0.100"; // TODO: float this to current SDK?
props["NETCoreSdkVersion"] = "7.0.100"; // TODO: float this to current SDK?
// test setup parameters so that we can load the props/targets/tasks
props["ContainerCustomTasksAssembly"] = Path.GetFullPath(Path.Combine(".", "Microsoft.NET.Build.Containers.dll"));
props["_IsTest"] = "true";
Expand Down
33 changes: 33 additions & 0 deletions src/Tests/Microsoft.NET.Build.Containers.IntegrationTests/TargetsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,39 @@ public void ShouldIncludeBaseImageLabelsUnlessUserOptsOut(bool includeBaseImageL
};
}

[InlineData(true)]
[InlineData(false)]
[Theory]
public void ShouldIncludeSDKAndRuntimeVersionLabelsUnlessUserOptsOut(bool includeToolsetVersionLabels)
{
var runtimeMajorMinor = "7.0";
var randomSdkVersion = "8.0.100";
var expectedBaseImage = $"mcr.microsoft.com/dotnet/runtime:{runtimeMajorMinor}";
var (project, logger, d) = ProjectInitializer.InitProject(new()
{
["ContainerGenerateLabelsDotnetToolset"] = includeToolsetVersionLabels.ToString(),
["ContainerBaseImage"] = expectedBaseImage,
["ContainerGenerateLabels"] = true.ToString(), // always include other labels, but not necessarily the toolset labels
["NETCoreSdkVersion"] = randomSdkVersion // not functionally relevant for the test, just need a known version
}, projectName: $"{nameof(ShouldIncludeSDKAndRuntimeVersionLabelsUnlessUserOptsOut)}_{includeToolsetVersionLabels}");
using var _ = d;
var instance = project.CreateProjectInstance(global::Microsoft.Build.Execution.ProjectInstanceSettings.None);
instance.Build(new[] { ComputeContainerConfig }, new[] { logger }, null, out var outputs).Should().BeTrue("Build should have succeeded but failed due to {0}", String.Join("\n", logger.AllMessages));
var labels = instance.GetItems(ContainerLabel);
if (includeToolsetVersionLabels)
{
labels.Should().NotBeEmpty("Should have evaluated some labels by default")
.And.ContainSingle(label => LabelMatch("net.dot.runtime.majorminor", runtimeMajorMinor, label))
.And.ContainSingle(label => LabelMatch("net.dot.sdk.version", randomSdkVersion, label));
}
else
{
labels.Should().NotBeEmpty("Should have evaluated some labels by default")
.And.NotContain(label => LabelMatch("net.dot.runtime.majorminor", runtimeMajorMinor, label))
.And.NotContain(label => LabelMatch("net.dot.sdk.version", randomSdkVersion, label));
};
}

[InlineData("7.0.100", "v7.0", "7.0")]
[InlineData("7.0.100-preview.7", "v7.0", "7.0")]
[InlineData("7.0.100-rc.1", "v7.0", "7.0")]
Expand Down
Loading