feat: new method IsUploadUnpacked()

Author: tngraf

Fossology.Rest.Dotnet.Test/FossologyClientTest.cs

@@ -45,7 +45,7 @@ public class FossologyClientTest
         /// <summary>
         /// The access token.
         /// </summary>
-        private const string Token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1OTMwNDMxOTksIm5iZiI6MTU5MjA5MjgwMCwianRpIjoiTWk0eiIsInNjb3BlIjoid3JpdGUifQ.q7vgcRWR596ShkHrRoHxn2vOn7hsJl8UvjXYpVN4PSU";
+        private const string Token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1OTM1NjE1OTksIm5iZiI6MTU5MjI2NTYwMCwianRpIjoiTWk0eiIsInNjb3BlIjoid3JpdGUifQ.h9oNRGV_N-GkEJGNZPp2qQCgOkb1rDv0_bnEnWjCnkg";
 
         /// <summary>
         /// The filename of a test package.
@@ -80,6 +80,24 @@ public void TestGetVersion()
             Debug.WriteLine($"Version = {result}");
         }
 
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestGetToken()
+        {
+            var client = new FossologyClient(LocalUrl, string.Empty);
+            var request = new TokenRequest();
+            request.Username = "fossy";
+            request.Password = "fossy";
+            request.TokenName = "TestToken1";
+            request.TokenScope = "write";
+            request.TokenExpire = DateTime.Today.AddDays(3).ToString("yyyy-MM-dd");
+            var result = client.GetToken(request);
+            Assert.IsNotNull(result);
+            Assert.IsTrue(result.Length > 20);
+        }
+
         /// <summary>
         /// Unit test.
         /// </summary>
@@ -222,6 +240,33 @@ public void TestUploadPackageAndCheckLookAt()
             } // catch
         }
 
+        private static void WaitUntilUploadIsDone(FossologyClient client, int id)
+        {
+            while (!client.IsUploadUnpacked(id))
+            {
+                Debug.WriteLine($"Waiting for upload {id} to get unpacked...");
+                Thread.Sleep(500);
+            } // while
+        }
+
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestUploadPackageCheckUnpackStatus()
+        {
+            var client = new FossologyClient(LocalUrl, Token);
+            var result = client.UploadPackage(@"..\..\..\TestData\xtxgd.zip", 5);
+            Assert.IsNotNull(result);
+            Assert.AreEqual("INFO", result.Type);
+            Assert.AreEqual(201, result.Code);
+            var uploadId = int.Parse(result.Message);
+            Debug.WriteLine($"Upload id = {uploadId}");
+
+            WaitUntilUploadIsDone(client, uploadId);
+            Debug.WriteLine($"Upload id = {uploadId} is now available");
+        }
+
         /// <summary>
         /// Unit test.
         /// </summary>
@@ -300,7 +345,7 @@ public void TestGetUploadList()
         [TestMethod]
         public void TestGetUploadLicenses()
         {
-            const int Id = 2;
+            const int Id = 5;
 
             var client = new FossologyClient(LocalUrl, Token);
             var licenses = client.GetUploadLicenses(Id, "nomos", true);
@@ -503,24 +548,6 @@ public void TestSearch()
             Assert.IsNotNull(result);
         }
 
-        /// <summary>
-        /// Unit test.
-        /// </summary>
-        [TestMethod]
-        public void TestGetToken()
-        {
-            var client = new FossologyClient(LocalUrl, string.Empty);
-            var request = new TokenRequest();
-            request.Username = "fossy";
-            request.Password = "fossy";
-            request.TokenName = "TestToken1";
-            request.TokenScope = "write";
-            request.TokenExpire = DateTime.Today.AddDays(3).ToString("yyyy-MM-dd");
-            var result = client.GetToken(request);
-            Assert.IsNotNull(result);
-            Assert.IsTrue(result.Length > 20);
-        }
-
         /// <summary>
         /// Finds the folder with the given name.
         /// </summary>
@@ -555,6 +582,17 @@ public void MyIntegrationTestLikeUnitTest()
             Assert.IsNotNull(version);
             Debug.WriteLine($"Version = {version}");
 
+            var request = new TokenRequest();
+            request.Username = "fossy";
+            request.Password = "fossy";
+            request.TokenName = "TestToken1";
+            request.TokenScope = "write";
+            request.TokenExpire = DateTime.Today.AddDays(3).ToString("yyyy-MM-dd");
+            //var tokenResult = client.GetToken(request);
+            //Assert.IsNotNull(tokenResult);
+            //Assert.IsTrue(tokenResult.Length > 20);
+
+
             var folderlist = client.GetFolderList();
             Assert.IsNotNull(folderlist);
             if ((folderlist.Count != 1) && (folderlist.Count != 2))
@@ -585,8 +623,7 @@ public void MyIntegrationTestLikeUnitTest()
             var uploadId = int.Parse(result.Message);
             Assert.IsTrue(uploadId > 0);
 
-            // ugly but required: wait some time until upload is available
-            Thread.Sleep(3000);
+            WaitUntilUploadIsDone(client, uploadId);
 
             var uploadlist = client.GetUploadList();
             Assert.IsNotNull(uploadlist);
@@ -640,6 +677,17 @@ public void MyIntegrationTestLikeUnitTest()
             Assert.IsNotNull(job);
             Assert.AreEqual(jobId, job.Id);
 
+            // PHP Fatal error:  Uncaught Exception: cannot find uploadId = 14 in /usr/local/share/fossology/lib/php/Dao/UploadDao.php:201
+            //var summary = client.GetUploadSummary(uploadId);
+            //Assert.IsNotNull(summary);
+            //Assert.AreEqual(uploadId, summary.Id);
+
+            var licensesFound = client.GetUploadLicenses(
+                uploadId, "nomos", true);
+            Assert.IsNotNull(licensesFound);
+            Assert.IsTrue(licensesFound.Count > 0);
+            Assert.AreEqual("MIT", licensesFound[0].AgentFindings[0]);
+
             result = client.TriggerReportGeneration(uploadId, "spdx2");
             Assert.IsNotNull(result);
             Assert.AreEqual("INFO", result.Type);

Fossology.Rest.Dotnet/FossologyClient.cs

@@ -19,6 +19,7 @@ namespace Fossology.Rest.Dotnet
     using System;
     using System.Collections.Generic;
     using System.IO;
+    using System.Linq;
     using System.Net;
     using Model;
 
@@ -407,6 +408,28 @@ public Result UploadPackageFromServer(int folderId, ServerUpload details, string
             return result;
         } // UploadPackageFromServer()
 
+        /// <summary>
+        /// Determines whether the upload with the given id has been successfully
+        /// uploaded and unpacked. Only when unpacking has been done, we can access
+        /// the upload and trigger jobs.
+        /// </summary>
+        /// <param name="id">The identifier.</param>
+        /// <returns><c>true</c> if the upload has been successfully unpacked;
+        /// otherwise, <c>false</c>.</returns>
+        public bool IsUploadUnpacked(int id)
+        {
+            Log.Debug($"Checking status for upload {id}...");
+
+            var result = this.api.Get(this.Url + $"/jobs?upload={id}");
+            var jobs = JsonConvert.DeserializeObject<List<Job>>(result.Content,
+                new JsonSerializerSettings
+                {
+                    NullValueHandling = NullValueHandling.Ignore
+                });
+
+            return jobs.All(job => job.Status == "Completed");
+        } // IsUploadUnpacked()
+
         /// <summary>
         /// Gets the upload with the specified id.
         /// </summary>