Tidy interfaces just a bit (#1044)

DaveTryon · web-flow · commit 969ad1b05724 · 2025-05-09T13:27:18.000-07:00
* Use ISet instead of HashSet in IConformanceEnforcer
* Use IList instead of List in interfaces
* Use IDictionary instead of Dictionary in ILicenseInformationFetcher
* Rename GenerationResult back to GeneratorResult
diff --git a/src/Microsoft.Sbom.Api/Executors/ComponentDetectionBaseWalker.cs b/src/Microsoft.Sbom.Api/Executors/ComponentDetectionBaseWalker.cs
@@ -141,7 +141,7 @@ async Task Scan(string path)
                 {
                     licenseInformationRetrieved = true;
 
-                    List<string> apiResponses;
+                    IList<string> apiResponses;
 
                     apiResponses = await licenseInformationFetcher.FetchLicenseInformationAsync(listOfComponentsForApi, configuration.LicenseInformationTimeoutInSeconds.Value);
 
diff --git a/src/Microsoft.Sbom.Api/Executors/GeneratorResult.cs b/src/Microsoft.Sbom.Api/Executors/GeneratorResult.cs
@@ -11,11 +11,11 @@ namespace Microsoft.Sbom.Api.Workflows.Helpers;
 /// <summary>
 /// Result from GenerateAsync
 /// </summary>
-public class GenerationResult
+public class GeneratorResult
 {
-    public List<FileValidationResult> Errors { get; }
+    public IList<FileValidationResult> Errors { get; }
 
-    public IReadOnlyDictionary<IManifestToolJsonSerializer, List<JsonDocument>> SerializerToJsonDocuments { get; }
+    public IReadOnlyDictionary<IManifestToolJsonSerializer, IList<JsonDocument>> SerializerToJsonDocuments { get; }
 
     public IReadOnlyDictionary<ISbomConfig, bool> JsonArrayStartedForConfig { get; }
 
@@ -25,7 +25,7 @@ public class GenerationResult
     /// <param name="errors">List of FileValidationResult errors.</param>
     /// <param name="serializerToJsonDocuments">Dictionary to map serializer to the JSON document that should be written to it.</param>
     /// <param name="jsonArrayStartedForConfig">This value determines whether a JSON array for a section is started for the specified config. This is only used for SPDX 2.2 SBOM generation.</param>
-    public GenerationResult(List<FileValidationResult> errors, IReadOnlyDictionary<IManifestToolJsonSerializer, List<JsonDocument>> serializerToJsonDocuments, IReadOnlyDictionary<ISbomConfig, bool> jsonArrayStartedForConfig)
+    public GeneratorResult(IList<FileValidationResult> errors, IReadOnlyDictionary<IManifestToolJsonSerializer, IList<JsonDocument>> serializerToJsonDocuments, IReadOnlyDictionary<ISbomConfig, bool> jsonArrayStartedForConfig)
     {
         Errors = errors;
         SerializerToJsonDocuments = serializerToJsonDocuments;
diff --git a/src/Microsoft.Sbom.Api/Executors/IJsonSerializationStrategy.cs b/src/Microsoft.Sbom.Api/Executors/IJsonSerializationStrategy.cs
@@ -59,5 +59,5 @@ internal interface IJsonSerializationStrategy
     /// <param name="sbomConfig"></param>
     public void EndGraphArray(ISbomConfig sbomConfig);
 
-    public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList);
+    public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList);
 }
diff --git a/src/Microsoft.Sbom.Api/Executors/ILicenseInformationFetcher.cs b/src/Microsoft.Sbom.Api/Executors/ILicenseInformationFetcher.cs
@@ -15,15 +15,15 @@ public interface ILicenseInformationFetcher
     /// </summary>
     /// <param name="scannedComponents"> An IEnumerable of ScannedComponents given by the Component Detection libraries after a scan is completed.</param>
     /// <returns></returns>
-    public List<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents);
+    public IList<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents);
 
     /// <summary>
     /// Calls the ClearlyDefined API to get the license information for the list of components.
     /// </summary>
     /// <param name="listOfComponentsForApi"> A list of strings formatted into a list of strings that can be used to call the batch ClearlyDefined API.</param>
     /// <param name="timeoutInSeconds">Timeout in seconds to use when making web requests. Caller owns sanitizing this value</param>
     /// <returns></returns>
-    public Task<List<string>> FetchLicenseInformationAsync(List<string> listOfComponentsForApi, int timeoutInSeconds);
+    public Task<IList<string>> FetchLicenseInformationAsync(IList<string> listOfComponentsForApi, int timeoutInSeconds);
 
     /// <summary>
     /// Gets the dictionary of licenses that were fetched from the ClearlyDefined API.
@@ -36,14 +36,14 @@ public interface ILicenseInformationFetcher
     /// </summary>
     /// <param name="httpResponse"> The response from a ClearlyDefined API request.</param>
     /// <returns></returns>
-    public Dictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent);
+    public IDictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent);
 
     /// <summary>
     /// Appends the licenses from the partialLicenseDictionary to the licenseDictionary.
     /// We only request license information for 400 components at a time so we can end up with multiple responses. This function is used to combine the responses into a single dictionary.
     /// </summary>
     /// <param name="partialLicenseDictionary"> A dictionary of licenses and component names in the {name@version, license} format</param>
-    public void AppendLicensesToDictionary(Dictionary<string, string> partialLicenseDictionary);
+    public void AppendLicensesToDictionary(IDictionary<string, string> partialLicenseDictionary);
 
     /// <summary>
     /// Gets the license from the licenseDictionary.
diff --git a/src/Microsoft.Sbom.Api/Executors/ILicenseInformationService.cs b/src/Microsoft.Sbom.Api/Executors/ILicenseInformationService.cs
@@ -8,5 +8,5 @@ namespace Microsoft.Sbom.Api.Executors;
 
 public interface ILicenseInformationService
 {
-    public Task<List<string>> FetchLicenseInformationFromAPI(List<string> listOfComponentsForApi, int timeoutInSeconds);
+    public Task<IList<string>> FetchLicenseInformationFromAPI(IList<string> listOfComponentsForApi, int timeoutInSeconds);
 }
diff --git a/src/Microsoft.Sbom.Api/Executors/LicenseInformationFetcher.cs b/src/Microsoft.Sbom.Api/Executors/LicenseInformationFetcher.cs
@@ -28,7 +28,7 @@ public LicenseInformationFetcher(ILogger log, IRecorder recorder, ILicenseInform
         this.licenseInformationService = licenseInformationService ?? throw new ArgumentNullException(nameof(licenseInformationService));
     }
 
-    public List<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents)
+    public IList<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents)
     {
         var listOfComponentsForApi = new List<string>();
 
@@ -82,13 +82,13 @@ public List<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent>
         return listOfComponentsForApi;
     }
 
-    public async Task<List<string>> FetchLicenseInformationAsync(List<string> listOfComponentsForApi, int timeoutInSeconds)
+    public async Task<IList<string>> FetchLicenseInformationAsync(IList<string> listOfComponentsForApi, int timeoutInSeconds)
     {
         return await licenseInformationService.FetchLicenseInformationFromAPI(listOfComponentsForApi, timeoutInSeconds);
     }
 
     // Will attempt to extract license information from a clearlyDefined batch API response. Will always return a dictionary which may be empty depending on the response.
-    public Dictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent)
+    public IDictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent)
     {
         var extractedLicenses = new Dictionary<string, string>();
 
@@ -142,7 +142,7 @@ public ConcurrentDictionary<string, string> GetLicenseDictionary()
         return licenseDictionary;
     }
 
-    public void AppendLicensesToDictionary(Dictionary<string, string> partialLicenseDictionary)
+    public void AppendLicensesToDictionary(IDictionary<string, string> partialLicenseDictionary)
     {
         foreach (var kvp in partialLicenseDictionary)
         {
diff --git a/src/Microsoft.Sbom.Api/Executors/LicenseInformationService.cs b/src/Microsoft.Sbom.Api/Executors/LicenseInformationService.cs
@@ -28,7 +28,7 @@ public LicenseInformationService(ILogger log, IRecorder recorder, HttpClient htt
         this.httpClient = httpClient ?? throw new ArgumentNullException(nameof(httpClient));
     }
 
-    public async Task<List<string>> FetchLicenseInformationFromAPI(List<string> listOfComponentsForApi, int timeoutInSeconds)
+    public async Task<IList<string>> FetchLicenseInformationFromAPI(IList<string> listOfComponentsForApi, int timeoutInSeconds)
     {
         var batchSize = 500;
         var responses = new List<HttpResponseMessage>();
diff --git a/src/Microsoft.Sbom.Api/Executors/Spdx22SerializationStrategy.cs b/src/Microsoft.Sbom.Api/Executors/Spdx22SerializationStrategy.cs
@@ -76,14 +76,14 @@ public void EndGraphArray(ISbomConfig sbomConfig)
     /// <summary>
     /// Writes the json objects to the manifest in SPDX 2.2 format.
     /// </summary>
-    /// <param name="generationResult"></param>
+    /// <param name="generatorResult"></param>
     /// <param name="config"></param>
     /// <param name="elementsSpdxIdList">Not used for deduplication. Only used for >= SPDX 3.0.</param>
-    public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList)
+    public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList)
     {
         var serializer = config.JsonSerializer;
 
-        if (generationResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))
+        if (generatorResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))
         {
             if (jsonDocuments.Count > 0)
             {
@@ -94,7 +94,7 @@ public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomC
             }
         }
 
-        var jsonArrayStarted = generationResult.JsonArrayStartedForConfig[config];
+        var jsonArrayStarted = generatorResult.JsonArrayStartedForConfig[config];
         if (jsonArrayStarted)
         {
             config.JsonSerializer.EndJsonArray();
diff --git a/src/Microsoft.Sbom.Api/Executors/Spdx30SerializationStrategy.cs b/src/Microsoft.Sbom.Api/Executors/Spdx30SerializationStrategy.cs
@@ -87,14 +87,14 @@ public void EndGraphArray(ISbomConfig sbomConfig)
     /// <summary>
     /// Writes the JSON objects in SPDX 3.0 format.
     /// </summary>
-    /// <param name="generationResult"></param>
+    /// <param name="generatorResult"></param>
     /// <param name="config"></param>
     /// <param name="elementsSpdxIdList">Hashes for deduplication in SPDX 3.0.</param>
-    public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList)
+    public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList)
     {
         var serializer = config.JsonSerializer;
 
-        if (generationResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))
+        if (generatorResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))
         {
             foreach (var jsonDocument in jsonDocuments)
             {
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/ExternalDocumentReferenceGenerator.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/ExternalDocumentReferenceGenerator.cs
@@ -36,7 +36,7 @@ public ExternalDocumentReferenceGenerator(
         this.recorder = recorder ?? throw new ArgumentNullException(nameof(recorder));
     }
 
-    public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
+    public async Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
     {
         using (recorder.TraceEvent(Events.ExternalDocumentReferenceGeneration))
         {
@@ -50,7 +50,7 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe
             if (!externalDocumentReferenceSourcesProvider.Any())
             {
                 log.Debug($"No source providers found for {ProviderType.ExternalDocumentReference}");
-                return new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
+                return new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
             }
 
             // Write the start of the array, if supported.
@@ -83,16 +83,16 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe
                 }
             }
 
-            var generationResult = new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
+            var generatorResult = new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
             foreach (var config in targetConfigs)
             {
                 var serializationStrategy = JsonSerializationStrategyFactory.GetStrategy(config.ManifestInfo.Version);
-                serializationStrategy.WriteJsonObjectsToManifest(generationResult, config, elementsSpdxIdList);
+                serializationStrategy.WriteJsonObjectsToManifest(generatorResult, config, elementsSpdxIdList);
             }
 
             jsonDocumentCollection.DisposeAllJsonDocuments();
 
-            return generationResult;
+            return generatorResult;
         }
     }
 }
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/FileArrayGenerator.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/FileArrayGenerator.cs
@@ -41,7 +41,7 @@ public FileArrayGenerator(
     /// <see cref="GenerationResult"/> objects that can be used to trace the error.
     /// </summary>
     /// <returns></returns>
-    public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
+    public async Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
     {
         using (recorder.TraceEvent(Events.FilesGeneration))
         {
@@ -81,17 +81,17 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe
                 }
             }
 
-            var generationResult = new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
+            var generatorResult = new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
 
             foreach (var config in targetConfigs)
             {
                 var serializationStrategy = JsonSerializationStrategyFactory.GetStrategy(config.ManifestInfo.Version);
-                serializationStrategy.WriteJsonObjectsToManifest(generationResult, config, elementsSpdxIdList);
+                serializationStrategy.WriteJsonObjectsToManifest(generatorResult, config, elementsSpdxIdList);
             }
 
             jsonDocumentCollection.DisposeAllJsonDocuments();
 
-            return generationResult;
+            return generatorResult;
         }
     }
 }
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/IJsonArrayGenerator.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/IJsonArrayGenerator.cs
@@ -16,6 +16,6 @@ public interface IJsonArrayGenerator<T>
     /// <summary>
     /// Generates all the JSON objects that need to be written to the SBOM.
     /// </summary>
-    /// <returns>GenerationResult with objects to write to the SBOM and failures.</returns>
-    public Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList);
+    /// <returns>GeneratorResult with objects to write to the SBOM and failures.</returns>
+    public Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList);
 }
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/JsonDocumentCollection.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/JsonDocumentCollection.cs
@@ -8,11 +8,11 @@ namespace Microsoft.Sbom.Api.Workflows.Helpers;
 
 public class JsonDocumentCollection<T>
 {
-    public Dictionary<T, List<JsonDocument>> SerializersToJson { get; }
+    public Dictionary<T, IList<JsonDocument>> SerializersToJson { get; }
 
     public JsonDocumentCollection()
     {
-        SerializersToJson = new Dictionary<T, List<JsonDocument>>();
+        SerializersToJson = new Dictionary<T, IList<JsonDocument>>();
     }
 
     public void AddJsonDocument(T key, JsonDocument document)
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/PackageArrayGenerator.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/PackageArrayGenerator.cs
@@ -39,7 +39,7 @@ public PackageArrayGenerator(
         this.recorder = recorder ?? throw new ArgumentNullException(nameof(recorder));
     }
 
-    public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
+    public async Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
     {
         using (recorder.TraceEvent(Events.PackagesGeneration))
         {
@@ -101,16 +101,16 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe
                 }
             }
 
-            var generationResult = new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
+            var generatorResult = new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
             foreach (var config in targetConfigs)
             {
                 var serializationStrategy = JsonSerializationStrategyFactory.GetStrategy(config.ManifestInfo.Version);
-                serializationStrategy.WriteJsonObjectsToManifest(generationResult, config, elementsSpdxIdList);
+                serializationStrategy.WriteJsonObjectsToManifest(generatorResult, config, elementsSpdxIdList);
             }
 
             jsonDocumentCollection.DisposeAllJsonDocuments();
 
-            return generationResult;
+            return generatorResult;
         }
     }
 }
diff --git a/src/Microsoft.Sbom.Api/Workflows/Helpers/RelationshipsArrayGenerator.cs b/src/Microsoft.Sbom.Api/Workflows/Helpers/RelationshipsArrayGenerator.cs
@@ -40,7 +40,7 @@ public RelationshipsArrayGenerator(
         this.recorder = recorder;
     }
 
-    public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
+    public async Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)
     {
         using (recorder.TraceEvent(Events.RelationshipsGeneration))
         {
@@ -108,16 +108,16 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe
                 }
             }
 
-            var generationResult = new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
+            var generatorResult = new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);
             foreach (var config in targetConfigs)
             {
                 var serializationStrategy = JsonSerializationStrategyFactory.GetStrategy(config.ManifestInfo.Version);
-                serializationStrategy.WriteJsonObjectsToManifest(generationResult, config, elementsSpdxIdList);
+                serializationStrategy.WriteJsonObjectsToManifest(generatorResult, config, elementsSpdxIdList);
             }
 
             jsonDocumentCollection.DisposeAllJsonDocuments();
 
-            return generationResult;
+            return generatorResult;
         }
     }
 
diff --git a/src/Microsoft.Sbom.Api/Workflows/SbomGenerationWorkflow.cs b/src/Microsoft.Sbom.Api/Workflows/SbomGenerationWorkflow.cs
@@ -113,19 +113,19 @@ public virtual async Task<bool> RunAsync()
                     });
 
                     // Write all the JSON documents from the generationResults to the manifest based on the manifestInfo.
-                    var fileGenerationResult = await fileArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
+                    var fileGeneratorResult = await fileArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
 
-                    var packageGenerationResult = await packageArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
+                    var packageGeneratorResult = await packageArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
 
-                    var externalDocumentReferenceGenerationResult = await externalDocumentReferenceGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
+                    var externalDocumentReferenceGeneratorResult = await externalDocumentReferenceGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
 
-                    var relationshipGenerationResult = await relationshipsArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
+                    var relationshipGeneratorResult = await relationshipsArrayGenerator.GenerateAsync(targetConfigs, elementsSpdxIdList);
 
                     // Concatenate all the errors from the generationResults.
-                    validErrors = validErrors.Concat(fileGenerationResult.Errors);
-                    validErrors = validErrors.Concat(packageGenerationResult.Errors);
-                    validErrors = validErrors.Concat(externalDocumentReferenceGenerationResult.Errors);
-                    validErrors = validErrors.Concat(relationshipGenerationResult.Errors);
+                    validErrors = validErrors.Concat(fileGeneratorResult.Errors);
+                    validErrors = validErrors.Concat(packageGeneratorResult.Errors);
+                    validErrors = validErrors.Concat(externalDocumentReferenceGeneratorResult.Errors);
+                    validErrors = validErrors.Concat(relationshipGeneratorResult.Errors);
 
                     // Write metadata dictionary to SBOM. This is a no-op for SPDX 3.0 and above.
                     ForEachConfig(targetConfigs, config =>
diff --git a/src/Microsoft.Sbom.Common/Conformance/Interfaces/IConformanceEnforcer.cs b/src/Microsoft.Sbom.Common/Conformance/Interfaces/IConformanceEnforcer.cs
diff --git a/src/Microsoft.Sbom.Common/Conformance/NTIAMinConformanceEnforcer.cs b/src/Microsoft.Sbom.Common/Conformance/NTIAMinConformanceEnforcer.cs
diff --git a/src/Microsoft.Sbom.Common/Conformance/NoneConformanceEnforcer.cs b/src/Microsoft.Sbom.Common/Conformance/NoneConformanceEnforcer.cs
diff --git a/test/Microsoft.Sbom.Api.Tests/Executors/LicenseInformationFetcherTests.cs b/test/Microsoft.Sbom.Api.Tests/Executors/LicenseInformationFetcherTests.cs
diff --git a/test/Microsoft.Sbom.Api.Tests/VersionSpecificPins/Version_4_0/InterfaceConcretionTests.cs b/test/Microsoft.Sbom.Api.Tests/VersionSpecificPins/Version_4_0/InterfaceConcretionTests.cs
diff --git a/test/Microsoft.Sbom.Api.Tests/Workflows/ManifestGenerationWorkflowTests.cs b/test/Microsoft.Sbom.Api.Tests/Workflows/ManifestGenerationWorkflowTests.cs

Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,7 @@ async Task Scan(string path)`
`141`	`141`	`{`
`142`	`142`	`licenseInformationRetrieved = true;`
`143`	`143`
`144`		`- List<string> apiResponses;`
	`144`	`+ IList<string> apiResponses;`
`145`	`145`
`146`	`146`	`apiResponses = await licenseInformationFetcher.FetchLicenseInformationAsync(listOfComponentsForApi, configuration.LicenseInformationTimeoutInSeconds.Value);`
`147`	`147`
Original file line number	Diff line number	Diff line change
`@@ -59,5 +59,5 @@ internal interface IJsonSerializationStrategy`
`59`	`59`	`/// <param name="sbomConfig"></param>`
`60`	`60`	`public void EndGraphArray(ISbomConfig sbomConfig);`
`61`	`61`
`62`		`- public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList);`
	`62`	`+ public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList);`
`63`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,5 @@ namespace Microsoft.Sbom.Api.Executors;`
`8`	`8`
`9`	`9`	`public interface ILicenseInformationService`
`10`	`10`	`{`
`11`		`- public Task<List<string>> FetchLicenseInformationFromAPI(List<string> listOfComponentsForApi, int timeoutInSeconds);`
	`11`	`+ public Task<IList<string>> FetchLicenseInformationFromAPI(IList<string> listOfComponentsForApi, int timeoutInSeconds);`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public LicenseInformationFetcher(ILogger log, IRecorder recorder, ILicenseInform`
`28`	`28`	`this.licenseInformationService = licenseInformationService ?? throw new ArgumentNullException(nameof(licenseInformationService));`
`29`	`29`	`}`
`30`	`30`
`31`		`- public List<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents)`
	`31`	`+ public IList<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent> scannedComponents)`
`32`	`32`	`{`
`33`	`33`	`var listOfComponentsForApi = new List<string>();`
`34`	`34`
`@@ -82,13 +82,13 @@ public List<string> ConvertComponentsToListForApi(IEnumerable<ScannedComponent>`
`82`	`82`	`return listOfComponentsForApi;`
`83`	`83`	`}`
`84`	`84`
`85`		`- public async Task<List<string>> FetchLicenseInformationAsync(List<string> listOfComponentsForApi, int timeoutInSeconds)`
	`85`	`+ public async Task<IList<string>> FetchLicenseInformationAsync(IList<string> listOfComponentsForApi, int timeoutInSeconds)`
`86`	`86`	`{`
`87`	`87`	`return await licenseInformationService.FetchLicenseInformationFromAPI(listOfComponentsForApi, timeoutInSeconds);`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`// Will attempt to extract license information from a clearlyDefined batch API response. Will always return a dictionary which may be empty depending on the response.`
`91`		`- public Dictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent)`
	`91`	`+ public IDictionary<string, string> ConvertClearlyDefinedApiResponseToList(string httpResponseContent)`
`92`	`92`	`{`
`93`	`93`	`var extractedLicenses = new Dictionary<string, string>();`
`94`	`94`
`@@ -142,7 +142,7 @@ public ConcurrentDictionary<string, string> GetLicenseDictionary()`
`142`	`142`	`return licenseDictionary;`
`143`	`143`	`}`
`144`	`144`
`145`		`- public void AppendLicensesToDictionary(Dictionary<string, string> partialLicenseDictionary)`
	`145`	`+ public void AppendLicensesToDictionary(IDictionary<string, string> partialLicenseDictionary)`
`146`	`146`	`{`
`147`	`147`	`foreach (var kvp in partialLicenseDictionary)`
`148`	`148`	`{`
Original file line number	Diff line number	Diff line change
`@@ -76,14 +76,14 @@ public void EndGraphArray(ISbomConfig sbomConfig)`
`76`	`76`	`/// <summary>`
`77`	`77`	`/// Writes the json objects to the manifest in SPDX 2.2 format.`
`78`	`78`	`/// </summary>`
`79`		`- /// <param name="generationResult"></param>`
	`79`	`+ /// <param name="generatorResult"></param>`
`80`	`80`	`/// <param name="config"></param>`
`81`	`81`	`/// <param name="elementsSpdxIdList">Not used for deduplication. Only used for >= SPDX 3.0.</param>`
`82`		`- public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList)`
	`82`	`+ public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList)`
`83`	`83`	`{`
`84`	`84`	`var serializer = config.JsonSerializer;`
`85`	`85`
`86`		`- if (generationResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))`
	`86`	`+ if (generatorResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))`
`87`	`87`	`{`
`88`	`88`	`if (jsonDocuments.Count > 0)`
`89`	`89`	`{`
`@@ -94,7 +94,7 @@ public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomC`
`94`	`94`	`}`
`95`	`95`	`}`
`96`	`96`
`97`		`- var jsonArrayStarted = generationResult.JsonArrayStartedForConfig[config];`
	`97`	`+ var jsonArrayStarted = generatorResult.JsonArrayStartedForConfig[config];`
`98`	`98`	`if (jsonArrayStarted)`
`99`	`99`	`{`
`100`	`100`	`config.JsonSerializer.EndJsonArray();`
Original file line number	Diff line number	Diff line change
`@@ -87,14 +87,14 @@ public void EndGraphArray(ISbomConfig sbomConfig)`
`87`	`87`	`/// <summary>`
`88`	`88`	`/// Writes the JSON objects in SPDX 3.0 format.`
`89`	`89`	`/// </summary>`
`90`		`- /// <param name="generationResult"></param>`
	`90`	`+ /// <param name="generatorResult"></param>`
`91`	`91`	`/// <param name="config"></param>`
`92`	`92`	`/// <param name="elementsSpdxIdList">Hashes for deduplication in SPDX 3.0.</param>`
`93`		`- public void WriteJsonObjectsToManifest(GenerationResult generationResult, ISbomConfig config, ISet<string> elementsSpdxIdList)`
	`93`	`+ public void WriteJsonObjectsToManifest(GeneratorResult generatorResult, ISbomConfig config, ISet<string> elementsSpdxIdList)`
`94`	`94`	`{`
`95`	`95`	`var serializer = config.JsonSerializer;`
`96`	`96`
`97`		`- if (generationResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))`
	`97`	`+ if (generatorResult.SerializerToJsonDocuments.TryGetValue(serializer, out var jsonDocuments))`
`98`	`98`	`{`
`99`	`99`	`foreach (var jsonDocument in jsonDocuments)`
`100`	`100`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public ExternalDocumentReferenceGenerator(`
`36`	`36`	`this.recorder = recorder ?? throw new ArgumentNullException(nameof(recorder));`
`37`	`37`	`}`
`38`	`38`
`39`		`- public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)`
	`39`	`+ public async Task<GeneratorResult> GenerateAsync(IEnumerable<ISbomConfig> targetConfigs, ISet<string> elementsSpdxIdList)`
`40`	`40`	`{`
`41`	`41`	`using (recorder.TraceEvent(Events.ExternalDocumentReferenceGeneration))`
`42`	`42`	`{`
`@@ -50,7 +50,7 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe`
`50`	`50`	`if (!externalDocumentReferenceSourcesProvider.Any())`
`51`	`51`	`{`
`52`	`52`	`log.Debug($"No source providers found for {ProviderType.ExternalDocumentReference}");`
`53`		`- return new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);`
	`53`	`+ return new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`// Write the start of the array, if supported.`
`@@ -83,16 +83,16 @@ public async Task<GenerationResult> GenerateAsync(IEnumerable<ISbomConfig> targe`
`83`	`83`	`}`
`84`	`84`	`}`
`85`	`85`
`86`		`- var generationResult = new GenerationResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);`
	`86`	`+ var generatorResult = new GeneratorResult(totalErrors, jsonDocumentCollection.SerializersToJson, jsonArrayStartedForConfig);`
`87`	`87`	`foreach (var config in targetConfigs)`
`88`	`88`	`{`
`89`	`89`	`var serializationStrategy = JsonSerializationStrategyFactory.GetStrategy(config.ManifestInfo.Version);`
`90`		`- serializationStrategy.WriteJsonObjectsToManifest(generationResult, config, elementsSpdxIdList);`
	`90`	`+ serializationStrategy.WriteJsonObjectsToManifest(generatorResult, config, elementsSpdxIdList);`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`jsonDocumentCollection.DisposeAllJsonDocuments();`
`94`	`94`
`95`		`- return generationResult;`
	`95`	`+ return generatorResult;`
`96`	`96`	`}`
`97`	`97`	`}`
`98`	`98`	`}`