fix: fix UploadLicenses data structure

Author: tngraf

Fossology.Rest.Dotnet.Model/Findings.cs

@@ -0,0 +1,59 @@
+// ---------------------------------------------------------------------------
+// <copyright file="Findings.cs" company="Tethys">
+//   Copyright (C) 2022 T. Graf
+// </copyright>
+//
+// Licensed under the MIT License.
+// SPDX-License-Identifier: MIT
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+// either express or implied.
+// ---------------------------------------------------------------------------
+
+namespace Fossology.Rest.Dotnet.Model
+{
+    using System.Collections.Generic;
+    using Newtonsoft.Json;
+
+    /// <summary>
+    /// Information about the licenses of the uploaded files.
+    /// </summary>
+    public class Findings
+    {
+        /// <summary>
+        /// Gets the short names of the licenses found by the scanner.
+        /// </summary>
+        [JsonProperty("scanner")]
+        public List<string> Scanner { get; }
+
+        /// <summary>
+        /// Gets the conclusions, i.e. license(s) decided by user.
+        /// </summary>
+        [JsonProperty("conclusions")]
+        public List<string> Conclusions { get; }
+
+        /// <summary>
+        /// Gets the copyrights.
+        /// </summary>
+        [JsonProperty("copyright")]
+        public List<string> Copyrights { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="Findings"/> class.
+        /// </summary>
+        public Findings()
+        {
+            this.Scanner = new List<string>();
+            this.Conclusions = new List<string>();
+            this.Copyrights = new List<string>();
+        } // UploadLicenses()
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"S={Support.ListToString(this.Scanner)}, C={Support.ListToString(this.Conclusions)}: Copy={Support.ListToString(this.Copyrights)}";
+        } // ToString()
+    } // Findings
+}

Fossology.Rest.Dotnet.Model/UploadLicenses.cs

@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------
 // <copyright file="UploadLicenses.cs" company="Tethys">
-//   Copyright (C) 2020 T. Graf
+//   Copyright (C) 2020-2022 T. Graf
 // </copyright>
 //
 // Licensed under the MIT License.
@@ -14,7 +14,6 @@
 
 namespace Fossology.Rest.Dotnet.Model
 {
-    using System.Collections.Generic;
     using Newtonsoft.Json;
 
     /// <summary>
@@ -29,30 +28,23 @@ public class UploadLicenses
         public string FilePath { get; set; }
 
         /// <summary>
-        /// Gets the short names of the found licenses.
+        /// Gets the findings for this file.
         /// </summary>
-        [JsonProperty("agentFindings")]
-        public List<string> AgentFindings { get; }
-
-        /// <summary>
-        /// Gets the conclusions, i.e. license(s) decided by user.
-        /// </summary>
-        [JsonProperty("conclusions")]
-        public List<string> Conclusions { get; }
+        [JsonProperty("findings")]
+        public Findings Findings { get; }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="UploadLicenses"/> class.
         /// </summary>
         public UploadLicenses()
         {
-            this.AgentFindings = new List<string>();
-            this.Conclusions = new List<string>();
+            this.Findings = new Findings();
         } // UploadLicenses()
 
         /// <inheritdoc />
         public override string ToString()
         {
-            return $"{this.FilePath}: C={Support.ListToString(this.Conclusions)}: F={Support.ListToString(this.AgentFindings)}";
+            return $"{this.FilePath}: {this.Findings}";
         } // ToString()
     } // UploadLicenses
 }

Fossology.Rest.Dotnet.Test/DeserializationTest.cs

@@ -88,21 +88,49 @@ public void TestSerializeStringList()
         /// Unit test.
         /// </summary>
         [TestMethod]
-        public void TestDeserializeComplex1()
+        public void TestDeserializeFindings()
         {
             const string JsonText =
-                "{"
-                + "\"filePath\":\"fetch-retry-master.zip/fetch-retry-master/package.json\","
-                + "\"agentFindings\":[\"MIT\"],"
-                + "\"conclusions\":null"
-                + "}";
+                "{" +
+                  "\"scanner\":[" +
+                "\"No_license_found\"" +
+                "]," +
+                "\"conclusion\":null," +
+                "\"copyright\":null" +
+                "}";
 
-            var actual = JsonConvert.DeserializeObject<UploadLicenses>(JsonText);
+            var actual = JsonConvert.DeserializeObject<Findings>(JsonText);
             Assert.IsNotNull(actual);
-            Assert.IsNotNull(actual.AgentFindings);
-            Assert.AreEqual(1, actual.AgentFindings.Count);
+            Assert.AreEqual(1, actual.Scanner.Count);
+            Assert.AreEqual("No_license_found", actual.Scanner[0]);
+            Assert.AreEqual(0, actual.Copyrights.Count);
+            Assert.AreEqual(0, actual.Copyrights.Count);
+        }
 
-            // ==> no correct deserialization without constructor...
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestDeserializeUploadLicenses()
+        {
+            const string JsonText =
+                "[" +
+                  "{" +
+                    "\"filePath\":\"Tethys.xml_v1.0.0.zip/Tethys.Xml-1.0.0/Tethys.Xml.sln\"," +
+                    "\"findings\":" +
+                    "{" +
+                      "\"scanner\":[" +
+                        "\"No_license_found\"" +
+                      "]," +
+                      "\"conclusion\":null," +
+                      "\"copyright\":null" +
+                    "}" +
+                  "}" +
+                "]";
+
+            var actual = JsonConvert.DeserializeObject<List<UploadLicenses>>(JsonText);
+            Assert.IsNotNull(actual);
+            Assert.AreEqual(1, actual.Count);
         }
     }
 }