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

Update NuGet Package Format and Surface Errors #619

Merged
merged 13 commits into from
Jul 30, 2024
Merged

Update NuGet Package Format and Surface Errors #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
e56b7e3
update nuget package format and surface errors
Jul 17, 2024
157a345
simplify sbom output
Jul 22, 2024
820edf7
Merge branch 'feature/sbom-targets-task' of https://github.com/micros…
Jul 22, 2024
e29e5db
update targets to use SbomPath output var for ToolTask
Jul 23, 2024
e9fdae6
fix bad merge
Jul 23, 2024
cfaa297
append manifest folder name for manifestdirpath
Jul 24, 2024
43ed373
add path.combine and property checks
Jul 25, 2024
416689b
append platform version
Jul 25, 2024
8b591e8
create ManifestDirPath if needed
Jul 25, 2024
6adece7
Merge branch 'feature/sbom-targets-task' of https://github.com/micros…
Jul 26, 2024
c21d38a
temporarily comment out
Jul 28, 2024
bcdf1f0
remove manifestdirpath logic for now
Jul 28, 2024
08be8ee
use path.combine and full path
Jul 28, 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
45 changes: 27 additions & 18 deletions src/Microsoft.Sbom.Targets/Microsoft.Sbom.Targets.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,24 @@
<GenerateSbom_TFM Condition=" '$(MSBuildRuntimeType)' == 'Full' ">net472</GenerateSbom_TFM>
<GenerateSbom_TFM Condition=" '$(MSBuildRuntimeType)' == 'Core' ">net8.0</GenerateSbom_TFM>

<SbomToolBinaryOutputPath>$([System.IO.Path]::Combine($(MSBuildThisFileDirectory),..,tasks,$(GenerateSbom_TFM),sbom-tool))</SbomToolBinaryOutputPath>
<AssemblyFilePath>$([System.IO.Path]::Combine($(MSBuildThisFileDirectory),..,tasks,$(GenerateSbom_TFM),Microsoft.Sbom.Targets.dll))</AssemblyFilePath>

<!--Set the SBOM CLI Tool path. This variable is only used in SbomCLIToolTask.cs-->
<SbomToolPath Condition=" '$(MSBuildRuntimeType)' == 'Full'">$(MSBuildThisFileDirectory)\..\tasks\$(GenerateSbom_TFM)\sbom-tool</SbomToolPath>
<SbomToolPath Condition=" '$(MSBuildRuntimeType)' == 'Full'">$(SbomToolBinaryOutputPath)</SbomToolPath>
<ManifestFolderName>_manifest</ManifestFolderName>
<SbomSpecification>spdx_2.2</SbomSpecification>
</PropertyGroup>

<!-- Copy the SBOM files to each respective target framework folder within the .nupkg -->
<PropertyGroup>
<TargetsForTfmSpecificContentInPackage>
$(TargetsForTfmSpecificContentInPackage);CopySbomOutput
</TargetsForTfmSpecificContentInPackage>
</PropertyGroup>

<!--Based on the MSBuild runtime, GenerateSbom will either pull the GenerateSbomTask or SbomCLIToolTask logic-->
<UsingTask TaskName="Microsoft.Sbom.Targets.GenerateSbom" AssemblyFile="$(MSBuildThisFileDirectory)\..\tasks\$(GenerateSbom_TFM)\Microsoft.Sbom.Targets.dll" />
<UsingTask TaskName="Microsoft.Sbom.Targets.GenerateSbom" AssemblyFile="$(AssemblyFilePath)" />

<PropertyGroup>
<GenerateSBOM Condition=" '$(GenerateSBOM)' == '' ">false</GenerateSBOM>
Expand All @@ -39,6 +50,7 @@
</PropertyGroup>

<Target Name="GenerateSbomTarget" AfterTargets="Build" Condition=" '$(GenerateSBOM)' == 'true'">
<Error Condition="'$(BuildOutputTargetFolder)' == ''" Text="The GenerationSbomTarget requires the BuildOutputTargetFolder property to be non-null. Please set a folder name."/>
<GenerateSbom
BuildDropPath="$(SbomGenerationBuildDropPath)"
BuildComponentPath="$(SbomGenerationBuildComponentPath)"
Expand All @@ -58,23 +70,20 @@
<Output TaskParameter="SbomPath" PropertyName="SbomPathResult" />
</GenerateSbom>
<Message Importance="High" Text="Task result: $(SbomPathResult)" />
</Target>

<!-- Include the generated SBOM contents within the consumer's nuget package -->
<ItemGroup >
<Content Condition=" '$(MSBuildRuntimeType)' == 'Core'" Include="$(SbomPathResult)\**">
<Pack>true</Pack>
<PackagePath>_manifest</PackagePath>
</Content>

<Content Condition=" '$(MSBuildRuntimeType)' == 'Full' And '$(SbomGenerationManifestDirPath)' == '' " Include="$(SbomGenerationBuildDropPath)\$(ManifestFolderName)\**">
<Pack>true</Pack>
<PackagePath>_manifest</PackagePath>
</Content>

<Content Condition=" '$(MSBuildRuntimeType)' == 'Full' And '$(SbomGenerationManifestDirPath)' != '' " Include="$(SbomGenerationManifestDirPath)\$(ManifestFolderName)\**">
<Pack>true</Pack>
<PackagePath>_manifest</PackagePath>
</Content>
<!-- Specify the SBOM files to copy into the nuget package -->
<Target Name="CopySbomOutput" DependsOnTargets="GenerateSbomTarget">
<PropertyGroup>
<!--When building frameworks such as net8.0-windows, the platform version is appended to the framework in the NuGet package-->
<TargetFrameworkWithPlatformVersion Condition="$(TargetPlatformVersion) != ''">$(TargetFramework)$(TargetPlatformVersion)</TargetFrameworkWithPlatformVersion>
<TargetFrameworkWithPlatformVersion Condition="$(TargetPlatformVersion) == ''">$(TargetFramework)</TargetFrameworkWithPlatformVersion>
</PropertyGroup>
<ItemGroup>
<!--Add manifest and SHA file from the GenerateSbom target execution-->
<TfmSpecificPackageFile Include="$([System.IO.Path]::Combine($(SbomPathResult),$(SbomSpecification)))\**">
<PackagePath>$([System.IO.Path]::Combine($(BuildOutputTargetFolder),$(TargetFrameworkWithPlatformVersion),$(ManifestFolderName),$(SbomSpecification)))</PackagePath>
</TfmSpecificPackageFile>
</ItemGroup>
</Target>
</Project>
29 changes: 28 additions & 1 deletion src/Microsoft.Sbom.Targets/SbomCLIToolTask.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

namespace Microsoft.Sbom.Targets;

using System.Diagnostics.Tracing;
using System;
using System.IO;
using Microsoft.Build.Utilities;

Expand All @@ -14,6 +14,31 @@ public partial class GenerateSbom : ToolTask
{
protected override string ToolName => "Microsoft.Sbom.Tool";

/// <summary>
/// Executes the SBOM CLI Tool invocation. Need to add extra logic
/// to set SbomPath to the directory containing the SBOM.
/// </summary>
/// <returns></returns>
public override bool Execute()
{
var taskResult = base.Execute();
// Set the SbomPath output variable
if (taskResult) {
var manifestFolderName = "_manifest";
if (!string.IsNullOrWhiteSpace(this.ManifestDirPath))
{
var fullManifestDirPath = Path.GetFullPath(this.ManifestDirPath);
this.SbomPath = Path.Combine(fullManifestDirPath, manifestFolderName);
} else
{
var fullBuidDropPath = Path.GetFullPath(this.BuildDropPath);
this.SbomPath = Path.Combine(fullBuidDropPath, manifestFolderName);
}
}

return taskResult;
}

/// <summary>
/// Get full path to SBOM CLI tool.
/// </summary>
Expand Down Expand Up @@ -97,5 +122,7 @@ private void SetOutputImportance()
{
this.StandardOutputImportance = "Low";
}

this.LogStandardErrorAsError = true;
}
}