Introduce C++ SDK component type (#1599) (#1626)

* Introduce C++ SDK component type

Author: grvillic

src/Microsoft.ComponentDetection.Contracts/BcdeModels/TypedComponentMapping.cs

@@ -36,6 +36,7 @@ internal static class TypedComponentMapping
         { nameof(ComponentType.Spdx), typeof(SpdxComponent) },
         { nameof(ComponentType.DotNet), typeof(DotNetComponent) },
         { nameof(ComponentType.Swift), typeof(SwiftComponent) },
+        { nameof(ComponentType.CppSdk), typeof(CppSdkComponent) },
     };
 
     /// <summary>

src/Microsoft.ComponentDetection.Contracts/TypedComponent/ComponentType.cs

@@ -64,4 +64,7 @@ public enum ComponentType : byte
 
     [EnumMember]
     DotNet = 19,
+
+    [EnumMember]
+    CppSdk = 20,
 }

src/Microsoft.ComponentDetection.Contracts/TypedComponent/CppSdkComponent.cs

@@ -0,0 +1,55 @@
+#nullable disable
+namespace Microsoft.ComponentDetection.Contracts.TypedComponent;
+
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+using PackageUrl;
+
+/// <summary>
+/// Represents a C++ SDK component.
+/// </summary>
+public class CppSdkComponent : TypedComponent
+{
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CppSdkComponent"/> class.
+    /// </summary>
+    public CppSdkComponent()
+    {
+        /* Reserved for deserialization */
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="CppSdkComponent"/> class.
+    /// </summary>
+    /// <param name="name">The name of the component.</param>
+    /// <param name="version">The version of the component.</param>
+    public CppSdkComponent(string name, string version)
+    {
+        this.Name = this.ValidateRequiredInput(name, nameof(this.Name), nameof(ComponentType.CppSdk));
+        this.Version = this.ValidateRequiredInput(version, nameof(this.Version), nameof(ComponentType.CppSdk));
+    }
+
+    [JsonPropertyName("name")]
+    public string Name { get; set; }
+
+    [JsonPropertyName("version")]
+    public string Version { get; set; }
+
+    [JsonIgnore]
+    public override ComponentType Type => ComponentType.CppSdk;
+
+    [JsonPropertyName("packageUrl")]
+    public override PackageURL PackageUrl
+    {
+        get
+        {
+            var qualifiers = new SortedDictionary<string, string>
+            {
+                { "type", "cppsdk" },
+            };
+            return new PackageURL("generic", null, this.Name, this.Version, qualifiers, null);
+        }
+    }
+
+    protected override string ComputeId() => $"{this.Name} {this.Version} - {this.Type}";
+}

test/Microsoft.ComponentDetection.Contracts.Tests/CppSdkComponentTests.cs

@@ -0,0 +1,88 @@
+#nullable disable
+namespace Microsoft.ComponentDetection.Contracts.Tests;
+
+using System;
+using AwesomeAssertions;
+using Microsoft.ComponentDetection.Contracts.TypedComponent;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+[TestClass]
+[TestCategory("Governance/All")]
+[TestCategory("Governance/ComponentDetection")]
+public class CppSdkComponentTests
+{
+    [TestMethod]
+    public void Constructor_ShouldInitializeProperties()
+    {
+        var name = "AwesomeCppLibrary";
+        var version = "1.2.3";
+
+        var component = new CppSdkComponent(name, version);
+
+        component.Name.Should().Be(name);
+        component.Version.Should().Be(version);
+        component.Type.Should().Be(ComponentType.CppSdk);
+        component.Id.Should().Be($"{name} {version} - {component.Type}");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenNameIsNull()
+    {
+        Action action = () => new CppSdkComponent(null, "1.2.3");
+        action.Should().Throw<ArgumentException>().WithMessage("*Name*");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenNameIsWhitespace()
+    {
+        Action action = () => new CppSdkComponent("   ", "1.2.3");
+        action.Should().Throw<ArgumentException>().WithMessage("*Name*");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenNameIsEmpty()
+    {
+        Action action = () => new CppSdkComponent(string.Empty, "1.2.3");
+        action.Should().Throw<ArgumentException>().WithMessage("*Name*");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenVersionIsNull()
+    {
+        Action action = () => new CppSdkComponent("AwesomeCppLibrary", null);
+        action.Should().Throw<ArgumentException>().WithMessage("*Version*");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenVersionIsWhitespace()
+    {
+        Action action = () => new CppSdkComponent("AwesomeCppLibrary", "   ");
+        action.Should().Throw<ArgumentException>().WithMessage("*Version*");
+    }
+
+    [TestMethod]
+    public void Constructor_ShouldThrowException_WhenVersionIsEmpty()
+    {
+        Action action = () => new CppSdkComponent("AwesomeCppLibrary", string.Empty);
+        action.Should().Throw<ArgumentException>().WithMessage("*Version*");
+    }
+
+    [TestMethod]
+    public void PackageUrl_ShouldReturnCorrectFormat()
+    {
+        var name = "AwesomeCppLibrary";
+        var version = "1.2.3";
+        var component = new CppSdkComponent(name, version);
+
+        var packageUrl = component.PackageUrl;
+
+        packageUrl.Type.Should().Be("generic");
+#pragma warning disable CA1308 // PackageURL normalizes to lowercase
+        packageUrl.Name.Should().Be(name.ToLowerInvariant());
+#pragma warning restore CA1308
+        packageUrl.Version.Should().Be(version);
+        packageUrl.Namespace.Should().BeNull();
+        packageUrl.Qualifiers.Should().ContainKey("type");
+        packageUrl.Qualifiers["type"].Should().Be("cppsdk");
+    }
+}

test/Microsoft.ComponentDetection.Contracts.Tests/TypedComponentSerializationTests.cs

@@ -346,4 +346,16 @@ public void TypedComponentMapping_TryGetType_WhitespaceDiscriminator_ReturnsFals
         result.Should().BeFalse("TryGetType should return false for whitespace-only discriminator");
         targetType.Should().BeNull("targetType should be null for whitespace-only discriminator");
     }
+
+    [TestMethod]
+    public void TypedComponent_Serialization_CppSdk()
+    {
+        TypedComponent tc = new CppSdkComponent("SomeCppSdk", "1.2.3");
+        var result = JsonSerializer.Serialize(tc);
+        var deserializedTC = JsonSerializer.Deserialize<TypedComponent>(result);
+        deserializedTC.Should().BeOfType(typeof(CppSdkComponent));
+        var cppSdkComponent = (CppSdkComponent)deserializedTC;
+        cppSdkComponent.Name.Should().Be("SomeCppSdk");
+        cppSdkComponent.Version.Should().Be("1.2.3");
+    }
 }