feat: health support implemented

Author: tngraf

ChangeLog.md

@@ -2,6 +2,7 @@
 
 ## NEXT
 * improved error handling.
+* new method GetHealth().
 
 ## 1.1.0 (2020-06-25)
 * supports FOSSology REST API v1.0.16 (FOSSology 3.8.0 built @ 2020/06/19).

Fossology.Rest.Dotnet.Model/DatabaseInfo.cs

@@ -0,0 +1,36 @@
+// ---------------------------------------------------------------------------
+// <copyright file="DatabaseInfo.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 Newtonsoft.Json;
+
+    /// <summary>
+    /// Fossology database information.
+    /// </summary>
+    public class DatabaseInfo
+    {
+        /// <summary>
+        /// Gets or sets the status.
+        /// </summary>
+        [JsonProperty("status")]
+        public string Status { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Status}";
+        }
+    } // DatabaseInfo
+}

Fossology.Rest.Dotnet.Model/HealthInfo.cs

@@ -0,0 +1,48 @@
+// ---------------------------------------------------------------------------
+// <copyright file="HealthInfo.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 Newtonsoft.Json;
+
+    /// <summary>
+    /// Fossology health information.
+    /// </summary>
+    public class HealthInfo
+    {
+        /// <summary>
+        /// Gets or sets the status.
+        /// </summary>
+        [JsonProperty("status")]
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Gets or sets the scheduler.
+        /// </summary>
+        [JsonProperty("scheduler")]
+        public SchedulerInfo Scheduler { get; set; }
+
+        /// <summary>
+        /// Gets or sets the database.
+        /// </summary>
+        [JsonProperty("db")]
+        public DatabaseInfo Database { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Status}: scheduler={this.Scheduler.Status}, database={this.Database.Status}";
+        }
+    } // HealthInfo
+}

Fossology.Rest.Dotnet.Model/SchedulerInfo.cs

@@ -0,0 +1,36 @@
+// ---------------------------------------------------------------------------
+// <copyright file="SchedulerInfo.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 Newtonsoft.Json;
+
+    /// <summary>
+    /// Fossology scheduler information.
+    /// </summary>
+    public class SchedulerInfo
+    {
+        /// <summary>
+        /// Gets or sets the status.
+        /// </summary>
+        [JsonProperty("status")]
+        public string Status { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return $"{this.Status}";
+        }
+    } // SchedulerInfo
+}

Fossology.Rest.Dotnet.Test/FossologyClientTest.cs

@@ -689,6 +689,20 @@ public void MyIntegrationTestLikeUnitTest()
             Assert.AreEqual(202, result.Code);
         }
 
+        /// <summary>
+        /// Unit test.
+        /// </summary>
+        [TestMethod]
+        public void TestGetHealth()
+        {
+            var client = new FossologyClient(LocalUrl, Token);
+            var actual = client.GetHealth();
+            Assert.IsNotNull(actual);
+            Assert.AreEqual("OK", actual.Status);
+            Assert.AreEqual("OK", actual.Scheduler.Status);
+            Assert.AreEqual("OK", actual.Database.Status);
+        }
+
         private static void WaitUntilUploadIsDone(FossologyClient client, int id)
         {
             while (!client.IsUploadUnpacked(id))

Fossology.Rest.Dotnet/FossologyClient.cs

@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------
 // <copyright file="FossologyClient.cs" company="Tethys">
-//   Copyright (C) 2019 T. Graf
+//   Copyright (C) 2019-2022 T. Graf
 // </copyright>
 //
 // Licensed under the MIT License.
@@ -507,13 +507,24 @@ public UploadSummary GetUploadSummary(int id)
         /// Gets the upload with the specified id.
         /// </summary>
         /// <returns>A list of <see cref="Upload"/> objects.</returns>
-        public IReadOnlyList<Upload> GetUploadList()
+        /// <param name="groupName">The group name to use while retrieving uploads.</param>
+        public IReadOnlyList<Upload> GetUploadList(string groupName = "")
         {
             Log.Debug("Getting all uploads...");
 
-            var result = this.api.Get(this.Url + "/uploads");
+            var request = new RestRequest(this.Url + $"/uploads", Method.GET);
+            request.RequestFormat = DataFormat.Json;
+            request.JsonSerializer = new JsonSerializer();
+            request.Parameters.Clear();
+            if (!string.IsNullOrEmpty(groupName))
+            {
+                request.AddHeader("groupName", groupName);
+            } // if
+
+            var response = this.api.Execute(request);
+
             var list = JsonConvert.DeserializeObject<List<Upload>>(
-                result.Content,
+                response.Content,
                 new JsonSerializerSettings
                     {
                         NullValueHandling = NullValueHandling.Ignore,
@@ -818,6 +829,26 @@ public IReadOnlyList<SearchResult> Search(
             return result;
         } // Search()
         #endregion // SEARCH SUPPORT
+
+        #region HEALTH SUPPORT
+        /// <summary>
+        /// Gets the health information.
+        /// </summary>
+        /// <returns><see cref="HealthInfo"/>.</returns>
+        public HealthInfo GetHealth()
+        {
+            Log.Debug($"Getting health info...");
+
+            var result = this.api.Get(this.Url + $"/health");
+            var info = JsonConvert.DeserializeObject<HealthInfo>(
+                result.Content,
+                new JsonSerializerSettings
+                {
+                    NullValueHandling = NullValueHandling.Ignore,
+                });
+            return info;
+        } // GetHealth()
+        #endregion
         #endregion // PUBLIC METHODS
     } // FossologyClient
 }