Skip to content

Add missing VcpkgComponent converter and use port version as int #175

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

Merged
merged 2 commits into from
Jul 22, 2022
Merged

Add missing VcpkgComponent converter and use port version as int #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5765395
Add missing VcpkgComponent converter and use port version as int
grvillic Jul 22, 2022
2eb0208
nit
grvillic Jul 22, 2022
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
3 changes: 2 additions & 1 deletion src/Microsoft.ComponentDetection.Contracts/BcdeModels/TypedComponentConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using System;
using System;
using System.Collections.Generic;
using Microsoft.ComponentDetection.Contracts.TypedComponent;
using Newtonsoft.Json;
Expand All @@ -24,6 +24,7 @@ public class TypedComponentConverter : JsonConverter
{ ComponentType.Linux, typeof(LinuxComponent) },
{ ComponentType.Conda, typeof(CondaComponent) },
{ ComponentType.DockerReference, typeof(DockerReferenceComponent) },
{ ComponentType.Vcpkg, typeof(VcpkgComponent) }
};

public override bool CanConvert(Type objectType)
Expand Down
12 changes: 7 additions & 5 deletions src/Microsoft.ComponentDetection.Contracts/TypedComponent/VcpkgComponent.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using PackageUrl;
using PackageUrl;

namespace Microsoft.ComponentDetection.Contracts.TypedComponent
{
Expand All @@ -11,10 +11,12 @@ private VcpkgComponent()

public VcpkgComponent(string spdxid, string name, string version, string triplet = null, string portVersion = null, string description = null, string downloadLocation = null)
{
int.TryParse(portVersion, out var port);

SPDXID = ValidateRequiredInput(spdxid, nameof(SPDXID), nameof(ComponentType.Vcpkg));
Name = ValidateRequiredInput(name, nameof(Name), nameof(ComponentType.Vcpkg));
Version = version;
PortVersion = portVersion;
PortVersion = port;
Triplet = triplet;
Description = description;
DownloadLocation = downloadLocation;
Expand All @@ -32,15 +34,15 @@ public VcpkgComponent(string spdxid, string name, string version, string triplet

public string Description { get; set; }

public string PortVersion { get; set; }
public int PortVersion { get; set; }

public override ComponentType Type => ComponentType.Vcpkg;

public override string Id
{
get
{
if (PortVersion != null)
if (PortVersion > 0)
{
return $"{Name} {Version}#{PortVersion} - {Type}";
}
Expand All @@ -55,7 +57,7 @@ public override PackageURL PackageUrl
{
get
{
if (PortVersion != null)
if (PortVersion > 0)
{
return new PackageURL($"pkg:vcpkg/{Name}@{Version}?port_version={PortVersion}");
}
Expand Down
6 changes: 3 additions & 3 deletions test/Microsoft.ComponentDetection.Detectors.Tests/VcpkgComponentDetectorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public async Task TestNlohmann()
{
""name"": ""nlohmann-json"",
""SPDXID"": ""SPDXRef-port"",
""versionInfo"": ""3.10.4"",
""versionInfo"": ""3.10.4#5"",
""downloadLocation"": ""git+https://github.com/Microsoft/vcpkg#ports/nlohmann-json"",
""homepage"": ""https://github.com/nlohmann/json"",
""licenseConcluded"": ""NOASSERTION"",
Expand Down Expand Up @@ -67,10 +67,10 @@ public async Task TestNlohmann()
Assert.AreEqual(1, components.Count());
Assert.AreEqual("nlohmann-json", sbomComponent.Name);
Assert.AreEqual("3.10.4", sbomComponent.Version);
Assert.AreEqual("0", sbomComponent.PortVersion);
Assert.AreEqual(5, sbomComponent.PortVersion);
Assert.AreEqual("SPDXRef-port", sbomComponent.SPDXID);
Assert.AreEqual("git+https://github.com/Microsoft/vcpkg#ports/nlohmann-json", sbomComponent.DownloadLocation);
Assert.AreEqual("pkg:vcpkg/nlohmann-json@3.10.4?port_version=0", sbomComponent.PackageUrl.ToString());
Assert.AreEqual("pkg:vcpkg/nlohmann-json@3.10.4?port_version=5", sbomComponent.PackageUrl.ToString());
}

[TestMethod]
Expand Down