Merge pull request #1042 from microsoft/mk/add-license-spdx-identifier

Add license SPDX identifier

Author: MaggieKimani1

src/Microsoft.OpenApi.Readers/V3/OpenApiLicenseDeserializer.cs

@@ -22,6 +22,12 @@ internal static partial class OpenApiV3Deserializer
                     o.Name = n.GetScalarValue();
                 }
             },
+            {
+                "identifier", (o, n) =>
+                {
+                    o.Identifier = n.GetScalarValue();
+                }
+            },
             {
                 "url", (o, n) =>
                 {

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

@@ -120,6 +120,11 @@ public static class OpenApiConstants
         /// </summary>
         public const string Name = "name";
 
+        /// <summary>
+        /// Field: Identifier
+        /// </summary>
+        public const string Identifier = "identifier";
+
         /// <summary>
         /// Field: Namespace
         /// </summary>

src/Microsoft.OpenApi/Models/OpenApiLicense.cs

@@ -19,6 +19,11 @@ public class OpenApiLicense : IOpenApiSerializable, IOpenApiExtensible
         /// </summary>
         public string Name { get; set; }
 
+        /// <summary>
+        /// An SPDX license expression for the API. The identifier field is mutually exclusive of the url field.
+        /// </summary>
+        public string Identifier { get; set; }
+
         /// <summary>
         /// The URL pointing to the contact information. MUST be in the format of a URL.
         /// </summary>
@@ -40,6 +45,7 @@ public OpenApiLicense() {}
         public OpenApiLicense(OpenApiLicense license)
         {
             Name = license?.Name ?? Name;
+            Identifier = license?.Identifier ?? Identifier;
             Url = license?.Url != null ? new Uri(license.Url.OriginalString) : null;
             Extensions = license?.Extensions != null ? new Dictionary<string, IOpenApiExtension>(license.Extensions) : null;
         }
@@ -72,6 +78,9 @@ private void WriteInternal(IOpenApiWriter writer, OpenApiSpecVersion specVersion
             // name
             writer.WriteProperty(OpenApiConstants.Name, Name);
 
+            // identifier
+            writer.WriteProperty(OpenApiConstants.Identifier, Identifier);
+
             // url
             writer.WriteProperty(OpenApiConstants.Url, Url?.OriginalString);
 

test/Microsoft.OpenApi.Readers.Tests/Microsoft.OpenApi.Readers.Tests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFrameworks>net6.0</TargetFrameworks>
         <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
@@ -164,6 +164,9 @@
       <EmbeddedResource Include="V3Tests\Samples\OpenApiInfo\basicInfo.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>
+      <EmbeddedResource Include="V3Tests\Samples\OpenApiLicense\licenseWithSpdxIdentifier.yaml">
+        <CopyToOutputDirectory>Never</CopyToOutputDirectory>
+      </EmbeddedResource>
       <EmbeddedResource Include="V3Tests\Samples\OpenApiInfo\minimalInfo.yaml">
         <CopyToOutputDirectory>Never</CopyToOutputDirectory>
       </EmbeddedResource>

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiLicenseTests.cs

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT license. 
+
+using Microsoft.OpenApi.Models;
+using Microsoft.OpenApi.Readers.ParseNodes;
+using Microsoft.OpenApi.Readers.V3;
+using SharpYaml.Serialization;
+using System.IO;
+using Xunit;
+using System.Linq;
+using FluentAssertions;
+
+namespace Microsoft.OpenApi.Readers.Tests.V3Tests
+{
+
+    public class OpenApiLicenseTests
+    {
+        private const string SampleFolderPath = "V3Tests/Samples/OpenApiLicense/";
+
+        [Fact]
+        public void ParseLicenseWithSpdxIdentifierShouldSucceed()
+        {
+            using var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "licenseWithSpdxIdentifier.yaml"));
+            var yamlStream = new YamlStream();
+            yamlStream.Load(new StreamReader(stream));
+            var yamlNode = yamlStream.Documents.First().RootNode;
+
+            var diagnostic = new OpenApiDiagnostic();
+            var context = new ParsingContext(diagnostic);
+
+            var node = new MapNode(context, (YamlMappingNode)yamlNode);
+
+            // Act
+            var license = OpenApiV3Deserializer.LoadLicense(node);
+
+            // Assert
+            license.Should().BeEquivalentTo(
+                new OpenApiLicense
+                {
+                    Name = "Apache 2.0",
+                    Identifier = "Apache-2.0"
+                });
+        }
+    }
+}

test/Microsoft.OpenApi.Readers.Tests/V3Tests/Samples/OpenApiLicense/licenseWithSpdxIdentifier.yaml

@@ -0,0 +1,2 @@
+name: Apache 2.0
+identifier: Apache-2.0

test/Microsoft.OpenApi.Tests/Models/OpenApiLicenseTests.cs

@@ -30,6 +30,12 @@ public class OpenApiLicenseTests
             }
         };
 
+        public static OpenApiLicense LicenseWithIdentifier = new OpenApiLicense
+        {
+            Name = "Apache 2.0",
+            Identifier = "Apache-2.0"
+        };
+
         [Theory]
         [InlineData(OpenApiSpecVersion.OpenApi3_0)]
         [InlineData(OpenApiSpecVersion.OpenApi2_0)]
@@ -123,5 +129,36 @@ public void ShouldCopyFromOriginalObjectWithoutMutating()
             Assert.NotEqual(AdvanceLicense.Name, licenseCopy.Name);
             Assert.NotEqual(AdvanceLicense.Url, licenseCopy.Url);
         }
+
+        [Fact]
+        public void SerializeLicenseWithIdentifierAsJsonWorks()
+        {
+            // Arrange
+            var expected =
+                @"{
+  ""name"": ""Apache 2.0"",
+  ""identifier"": ""Apache-2.0""
+}";
+
+            // Act
+            var actual = LicenseWithIdentifier.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0);
+
+            // Assert
+            Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
+        }
+        
+        [Fact]
+        public void SerializeLicenseWithIdentifierAsYamlWorks()
+        {
+            // Arrange
+            var expected = @"name: Apache 2.0
+identifier: Apache-2.0";
+
+            // Act
+            var actual = LicenseWithIdentifier.SerializeAsYaml(OpenApiSpecVersion.OpenApi3_0);
+
+            // Assert
+            Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
+        }
     }
 }