Adding support for the ingestion of test results from a test result f…

…ile. WIP

RoboClerk.DependenciesFile/DependenciesFilePlugin.cs

@@ -11,8 +11,6 @@ public class DependenciesFilePlugin : DataSourcePluginBase
         private List<string> fileLocations = new List<string>();
         private List<string> fileFormats = new List<string>();
 
-        private List<ExternalDependency> externalDependencies = new List<ExternalDependency>();
-
         public DependenciesFilePlugin(IFileSystem fileSystem)
             : base(fileSystem)
         {
@@ -51,7 +49,7 @@ public override void Initialize(IConfiguration configuration)
         public override void RefreshItems()
         {
             logger.Info("Refreshing the external dependencies from file.");
-            externalDependencies.Clear();
+            dependencies.Clear();
             for (int i = 0; i < fileLocations.Count; i++)
             {
                 switch (fileFormats[i])
@@ -85,7 +83,7 @@ private void ParseDotnetFile(string filename)
                     {
                         throw new Exception($"DOTNET dependencies file does not match expected format. Error in line \"{trimmedLine}\". Cannot continue.");
                     }
-                    externalDependencies.Add(new ExternalDependency(elements[1], elements[3], elements[2] != elements[3]));
+                    dependencies.Add(new ExternalDependency(elements[1], elements[3], elements[2] != elements[3]));
                 }
             }
         }
@@ -113,7 +111,7 @@ private void ParseGradleFile(string filename)
                         version = version.Split("->")[0].Trim();
                         conflict = true;
                     }
-                    externalDependencies.Add(new ExternalDependency($"{elements[0]}:{elements[1]}", version, conflict));
+                    dependencies.Add(new ExternalDependency($"{elements[0]}:{elements[1]}", version, conflict));
                 }
             }
         }

RoboClerk.TestResultsFilePlugin/Configuration/TestResultsFilePlugin.toml

@@ -0,0 +1,20 @@
+# This is the RoboClerk test results file plugin configuration. Using this plugin,
+# test results, both system, integration and unit test results can be read from files. 
+# The plugin is intended to support different file formats.
+
+# Dependencies file locations array, supports multiple files
+
+FileLocations = ["{PROJECTROOT}results.json"]
+
+# The following formats are supported:
+# JSON - assumes the following format for the contents of the file:
+# [
+#  {
+#    "id": "12264",    <--- REQUIRED matching with known test cases / unit tests
+#    "name": "testLoginSuccess",
+#    "type": "UNIT", <--- REQUIRED can be either "UNIT" or "SYSTEM"
+#    "status": "PASS",    <----- REQUIRED can be either "PASS" or "FAIL"
+#	 "message": "all good",
+#    "executionTime": "2023-10-01T12:34:56Z"
+#  }
+# ]

RoboClerk.TestResultsFilePlugin/RoboClerk.TestResultsFilePlugin.csproj

@@ -0,0 +1,56 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+	  <OutputType>Library</OutputType>
+	  <StartupObject />
+	  <EnableDynamicLoading>true</EnableDynamicLoading>
+	  <Authors>Meindert Niemeijer</Authors>
+	  <Company>RoboClerk Project</Company>
+	  <Product>Test Results File Plugin</Product>
+	  <ProduceReferenceAssembly>false</ProduceReferenceAssembly>
+	  <Configurations>Debug;Release;ReleasePublish</Configurations>
+	  <BaseOutputPath>bin</BaseOutputPath>
+  </PropertyGroup>
+
+	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='ReleasePublish|AnyCPU'">
+		<Optimize>True</Optimize>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\RoboClerk\RoboClerk.csproj">
+			<Private>false</Private>
+			<ExcludeAssets>runtime</ExcludeAssets>
+		</ProjectReference>
+	</ItemGroup>
+
+	<Target Name="CopyFiles" AfterTargets="Build" Condition=" '$(Configuration)' == 'ReleasePublish' ">
+		<ItemGroup>
+			<PluginFiles Include="$(ProjectDir)$(OutDir)*.dll" />
+		</ItemGroup>
+
+		<Copy SourceFiles="@(PluginFiles)" DestinationFolder="$(ProjectDir)../RoboClerkDocker/publish/plugins" />
+		<Copy SourceFiles="$(ProjectDir)$(OutDir)RoboClerk.TestResultsFilePlugin.runtimeconfig.json" DestinationFolder="$(ProjectDir)../RoboClerkDocker/publish/plugins" />
+		<Copy SourceFiles="$(ProjectDir)$(OutDir)RoboClerk.TestResultsFilePlugin.deps.json" DestinationFolder="$(ProjectDir)../RoboClerkDocker/publish/plugins" />
+	</Target>
+	<Target Name="CopyPlugin" AfterTargets="Build">
+		<ItemGroup>
+			<PluginFiles Include="$(ProjectDir)$(OutDir)*.dll" />
+		</ItemGroup>
+		<Copy SourceFiles="$(ProjectDir)Configuration/TestResultsFilePlugin.toml" DestinationFolder="$(ProjectDir)../RoboClerk/$(OutDir)RoboClerk_input/PluginConfig" />
+		<Copy SourceFiles="@(PluginFiles)" DestinationFolder="$(ProjectDir)../RoboClerk/$(OutDir)plugins" />
+	</Target>
+	<Target Name="AdaptConfigFiles" AfterTargets="Build" Condition=" '$(Configuration)' != 'ReleasePublish' ">
+		<ReplaceFileText
+			InputFileName="$(ProjectDir)../RoboClerk/$(OutDir)RoboClerk_input/PluginConfig/TestResultsFilePlugin.toml"
+			MatchExpression="{PROJECTROOT}"
+			ReplacementText="$(ProjectDir)../" />
+	</Target>
+	<Target Name="AdaptConfigFilesRP" AfterTargets="Build" Condition=" '$(Configuration)' == 'ReleasePublish' ">
+		<ReplaceFileText
+			InputFileName="$(ProjectDir)../RoboClerk/$(OutDir)RoboClerk_input/PluginConfig/TestResultsFilePlugin.toml"
+			MatchExpression="{PROJECTROOT}"
+			ReplacementText="/mnt/" />
+	</Target>
+
+</Project>

RoboClerk.TestResultsFilePlugin/TestResultJSONObject.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Text.Json.Serialization;
+
+namespace RoboClerk.TestResultsFilePlugin
+{
+    public class TestResultJSONObject
+    {
+        [JsonPropertyName("id")]
+        [JsonRequired] 
+        public string? ID { get; set; }
+
+        [JsonPropertyName("name")]
+        public string? Name { get; set; }
+
+        [JsonPropertyName("type")]
+        [JsonRequired]
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public TestResultType Type { get; set; }
+
+        [JsonPropertyName("status")]
+        [JsonRequired]
+        [JsonConverter(typeof(JsonStringEnumConverter))]
+        public TestResultStatus Status { get; set; }
+
+        [JsonPropertyName("message")]
+        public string? Message { get; set; }
+
+        [JsonPropertyName("executionTime")]
+        public DateTime? ExecutionTime { get; set; }
+    }
+
+}

RoboClerk.TestResultsFilePlugin/TestResultsFilePlugin.cs

@@ -0,0 +1,72 @@
+using RoboClerk.Configuration;
+using System.Collections.Generic;
+using System.IO.Abstractions;
+using System.Text.Json;
+using Tomlyn.Model;
+using System;
+
+namespace RoboClerk.TestResultsFilePlugin
+{
+    public class TestResultsFilePlugin : DataSourcePluginBase
+    {
+        private List<string> fileLocations = new List<string>();
+
+        public TestResultsFilePlugin(IFileSystem fileSystem)
+            : base(fileSystem)
+        {
+            name = "TestResultsFilePlugin";
+            description = "A plugin that retrieves the test results via one or more files.";
+        }
+
+        public override void Initialize(IConfiguration configuration)
+        {
+            logger.Info("Initializing the Test Results File Plugin");
+            try
+            {
+                var config = GetConfigurationTable(configuration.PluginConfigDir, $"{name}.toml");
+                foreach (var item in (TomlArray)config["FileLocations"])
+                {
+                    if (item == null)
+                    {
+                        logger.Warn($"In the Test Results File Plugin configuration file (\"{name}.toml\"), there is a null valued item in \"FileLocations\".");
+                        continue;
+                    }
+                    fileLocations.Add((string)item);
+                }
+            }
+            catch (Exception e)
+            {
+                logger.Error("Error reading configuration file for Test Results File plugin.");
+                logger.Error(e);
+                throw new Exception("The Test Results File plugin could not read its configuration. Aborting...");
+            }
+        }
+
+        public override void RefreshItems()
+        {
+            logger.Info("Refreshing the test results from file.");
+            testResults.Clear();
+            for (int i = 0; i < fileLocations.Count; i++)
+            {
+                string json = fileSystem.File.ReadAllText(fileLocations[i]);
+                try
+                {
+                    var fileTestResults = JsonSerializer.Deserialize<List<TestResultJSONObject>>(json);
+
+                    foreach (var result in testResults)
+                    {
+                        if (string.IsNullOrEmpty(result.ID))
+                            throw new JsonException("The 'id' field is required.");
+
+                        testResults.Add(new TestResult(result.ID,result.Type,result.Status,result.Name,result.Message,result.ExecutionTime));
+                    }
+                }
+                catch (JsonException)
+                {
+                    logger.Error($"Error parsing the file with test results: {fileLocations[i]}");
+                    throw;
+                }
+            }
+        }
+    }
+}