much work

Author: jsinglet

.github/workflows/demo-run-codeql-unit-tests.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Export unit test matrix
         id: export-unit-test-matrix
         run: |
-          echo "matrix=$(cat supported_codeql_configs.json | jq --compact-output '.supported_environment | map([.+{os: "ubuntu-20.04-xl", codeql_standard_library_ident : .codeql_standard_library | sub("\/"; "_")}]) | flatten | {include: .}')" >> $GITHUB_OUTPUT
+          echo "matrix=$(qlt test run get-matrix --os-version ubuntu-latest)" >> $GITHUB_OUTPUT
 
   run-test-suites:
     name: Run Unit Tests

qlt.conf.json

@@ -0,0 +1,5 @@
+{
+  "CodeQLCLI": "2.11.6",
+  "CodeQLStandardLibrary": "codeql-cli/v2.11.6",
+  "CodeQLCLIBundle": "codeql-bundle-20221211"
+}

src/CodeQLToolkit.Features.Test/Commands/BaseGetMatrixCommandTarget.cs

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CodeQLToolkit.Features.Test.Commands
+{
+    public abstract class BaseGetMatrixCommandTarget : CommandTarget
+    {
+        public string[] OSVersions { get; set; }    
+    }
+}

src/CodeQLToolkit.Features.Test/Commands/Targets/Actions/GetMatrixCommandTarget.cs

@@ -0,0 +1,66 @@
+using CodeQLToolkit.Shared.Utils;
+using System.Text.Json;
+
+namespace CodeQLToolkit.Features.Test.Commands.Targets.Actions
+{
+    [AutomationType(AutomationType.ACTIONS)]
+    public class GetMatrixCommandTarget : BaseGetMatrixCommandTarget
+    {
+        public override void Run()
+        {
+
+            // based on the current configuration of the repository, generate a matrix 
+            // for actions, it looks like this:
+
+            // {
+            //     "include": [
+            //         {
+            //             "codeql_cli": "2.12.6",
+            //             "codeql_standard_library": "codeql-cli/v2.12.6",
+            //             "codeql_cli_bundle": "codeql-bundle-20230403",
+            //             "os": "ubuntu-latest",
+            //             "codeql_standard_library_ident": "codeql-cli_v2.12.6"
+            //         }
+            //     ]
+            // }
+
+            // For now, we only support a single version but this is easy to extend. The options for runners are what create different matrix types.
+            var c = new QLTConfig()
+            {
+                Base = Base
+            };
+
+            if (!File.Exists(c.CodeQLConfigFilePath))
+            {
+                ProcessUtils.DieWithError($"Cannot read values from missing file {c.CodeQLConfigFilePath}");
+            }
+
+            var config = c.FromFile();
+
+            List<object> configs = new List<object>();
+
+            foreach(var os in OSVersions)
+            {
+                Log<TestCommandFeature>.G().LogInformation($"Creating matrix for {os}");
+
+                configs.Add(new
+                {
+                    codeql_cli = config.CodeQLCLI,
+                    codeql_standard_library = config.CodeQLStandardLibrary,
+                    codeql_cli_bundle = config.CodeQLCLIBundle,
+                    os = os,
+                    codeql_standard_library_ident = $"codeql-cli_v{config.CodeQLCLI}"
+                });
+            }
+
+            var data = new
+            {
+                include = configs
+            };
+
+            var json = JsonSerializer.Serialize(data);
+            Console.WriteLine(json);
+
+        }
+    }
+}

src/CodeQLToolkit.Features.Test/Commands/TestCommandFeature.cs

@@ -0,0 +1,55 @@
+using CodeQLToolkit.Features.Test.Lifecycle;
+using CodeQLToolkit.Shared.Types;
+using System;
+using System.Collections.Generic;
+using System.CommandLine;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace CodeQLToolkit.Features.Test.Commands
+{
+    public class TestCommandFeature : FeatureBase, IToolkitLifecycleFeature
+    {
+        public TestCommandFeature()
+        {
+            FeatureName = "Test";
+        }
+
+        public void Register(Command parentCommand)
+        {
+            Log<TestCommandFeature>.G().LogInformation("Registering command submodule.");
+
+
+            var runCommand = new Command("run", "Functions pertaining to running test-related commands.");
+            parentCommand.Add(runCommand);
+
+            // a command that installs query packs
+            var getMatrixTestCommand = new Command("get-matrix", "Gets a CI/CD matrix based on the current configuration.");
+
+            var matrixOSVersion = new Option<string>("--os-version", () => "ubuntu-latest", "A comma-seperated list of operating systems to use. Example: `ubuntu-latest`.") { IsRequired = true };
+            getMatrixTestCommand.Add(matrixOSVersion);
+
+            runCommand.Add(getMatrixTestCommand);
+
+            getMatrixTestCommand.SetHandler((basePath, automationType, osVersions) => {
+
+                Log<TestCommandFeature>.G().LogInformation("Executing get-matrix command...");
+
+                // dispatch at runtime to the correct automation type
+                var featureTarget = AutomationFeatureFinder.FindTargetForAutomationType<BaseGetMatrixCommandTarget>(AutomationTypeHelper.AutomationTypeFromString(automationType));
+
+                featureTarget.Base = basePath;
+                featureTarget.OSVersions = osVersions.Split(",");
+
+                featureTarget.Run();
+
+            }, Globals.BasePathOption, Globals.AutomationTypeOption, matrixOSVersion);            
+        }
+
+        public int Run()
+        {
+            throw new NotImplementedException();
+        }
+    }
+}

src/CodeQLToolkit.Features.Test/Lifecycle/BaseLifecycleTarget.cs

@@ -8,8 +8,5 @@ namespace CodeQLToolkit.Features.Test.Lifecycle
 {
     abstract public class BaseLifecycleTarget : ILifecycleTarget
     {
-        public string Base { get; set; }
-
-
     }
 }

src/CodeQLToolkit.Features.Test/Lifecycle/TestLifecycleFeature.cs

@@ -25,11 +25,8 @@ public void Register(Command parentCommand)
             {
                 Log<TestLifecycleFeature>.G().LogInformation("Executing init command...");
 
-
-                var attribute = typeof(InitLifecycleTarget).GetCustomAttribute(typeof(AutomationTypeAttribute));
-
-
                 // dispatch at runtime to the correct automation type
+
                 var featureTarget = AutomationFeatureFinder.FindTargetForAutomationType<BaseLifecycleTarget>(AutomationTypeHelper.AutomationTypeFromString(automationType));
 
                 featureTarget.Base = basePath;

src/CodeQLToolkit.Features.Test/TestFeatureMain.cs

@@ -1,4 +1,5 @@
-using CodeQLToolkit.Features.Test.Lifecycle;
+using CodeQLToolkit.Features.Test.Commands;
+using CodeQLToolkit.Features.Test.Lifecycle;
 using CodeQLToolkit.Shared.Feature;
 using System.CommandLine;
 
@@ -8,6 +9,7 @@ public class TestFeatureMain : IToolkitFeature
 
     {
         readonly TestLifecycleFeature lifecycleFeature;
+        readonly TestCommandFeature commandFeature;
         readonly static TestFeatureMain instance;
 
         static TestFeatureMain()
@@ -18,15 +20,21 @@ static TestFeatureMain()
         private TestFeatureMain()
         {
             lifecycleFeature = new TestLifecycleFeature();
+            commandFeature = new TestCommandFeature();  
         }
         public static TestFeatureMain Instance { get { return instance; } }
 
         public void Register(Command parentCommand)
         {
             var testCommand = new Command("test", "Features related to the running and processing of CodeQL Unit Tests.");
             parentCommand.Add(testCommand);
+
             Log<TestFeatureMain>.G().LogInformation("Registering scaffolding submodule.");
             lifecycleFeature.Register(testCommand);
+
+            Log<TestFeatureMain>.G().LogInformation("Registering command submodule.");
+            commandFeature.Register(testCommand);
+
         }
 
         public int Run()