Merge branch 'main' into dev

ditkrg · Apr 28, 2024 · 599ffc3 · 599ffc3
2 parents 8ec528f + 86c2f3e
commit 599ffc3
Show file tree

Hide file tree

Showing 9 changed files with 94 additions and 24 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "dotnet-sonarscanner": {
-      "version": "5.6.0",
+      "version": "5.7.2",
       "commands": [
         "dotnet-sonarscanner"
       ]
@@ -15,4 +15,4 @@
       ]
     }
   }
-}
+}
diff --git a/.github/workflows/deploy-nuget.yaml b/.github/workflows/deploy-nuget.yaml
@@ -38,5 +38,5 @@ jobs:
         run: |-
           dotnet nuget push "packages/*.nupkg" \
             --skip-duplicate \
-            --api-key ${{ secrets.NUGET__API_KEY }} \
+            --api-key ${{ secrets.NUGET_API_KEY }} \
             --source https://api.nuget.org/v3/index.json
diff --git a/.github/workflows/sonarqube.yaml b/.github/workflows/sonarqube.yaml
@@ -0,0 +1,23 @@
+---
+name: Run SonarQube Analysis
+
+on:
+  push:
+    branches:
+      - main
+
+    paths-ignore:
+      - "**.md"
+      - ".vscode/**"
+
+concurrency:
+  group: sonarqube-analysis
+
+jobs:
+  test:
+    uses: ./.github/workflows/tests-base.yaml
+    with:
+      sonarqube: true
+      sonarqube_host: ${{ vars.SONARQUBE_HOST }}
+    secrets:
+      SONARQUBE_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
diff --git a/.github/workflows/tests-base.yaml b/.github/workflows/tests-base.yaml
@@ -2,6 +2,9 @@ name: Run Tests
 
 on:
   push:
+    branches-ignore:
+      - main
+
     paths-ignore:
       - "**.md"
 
@@ -15,9 +18,11 @@ on:
         required: false
         default: false
 
-    secrets:
-      SONARQUBE_HOST:
+      sonarqube_host:
+        type: string
         required: false
+
+    secrets:
       SONARQUBE_TOKEN:
         required: false
 
@@ -28,9 +33,6 @@ jobs:
     runs-on: ubuntu-latest
 
     env:
-      PROJECT_KEY: ditkrg_DIT.Workflower_AYF14rjSb80e2b0bns3t
-      SONARQUBE_HOST: ${{ secrets.SONARQUBE_HOST }}
-      SONARQUBE_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
       ASPNETCORE_ENVIRONMENT: Testing
 
     steps:
@@ -42,7 +44,6 @@ jobs:
         if: ${{ !inputs.sonarqube }}
 
       - name: Run tests
-        if: ${{ !inputs.sonarqube }}
         run: dotnet test
 
       ###############################
@@ -69,7 +70,7 @@ jobs:
         run: |
           dotnet tool run dotnet-sonarscanner begin -k:"$PROJECT_KEY" \
             -d:sonar.login="$SONARQUBE_TOKEN" \
-            -d:sonar.host.url="$SONARQUBE_HOST" \
+            -d:sonar.host.url="${{ inputs.sonarqube_host }}" \
             -d:sonar.cs.vscoveragexml.reportsPaths=coverage.xml
 
           dotnet build --no-incremental

diff --git a/src/DIT.Workflower.DependencyInjection/Common.cs b/src/DIT.Workflower.DependencyInjection/Common.cs
@@ -0,0 +1,3 @@
+namespace DIT.Workflower.DependencyInjection;
+
+public record DIContextWrapper<TContext>(TContext Context, IServiceProvider ServiceProvider);
diff --git a/src/DIT.Workflower.DependencyInjection/Extensions/IServiceCollectionExtensions.cs b/src/DIT.Workflower.DependencyInjection/Extensions/IServiceCollectionExtensions.cs
@@ -5,33 +5,33 @@ namespace DIT.Workflower.DependencyInjection.Extensions;
 public static class IServiceCollectionExtensions
 {
 
-    public static ITransitionStart<TState, TCommand, TContext> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, in int version = 1)
+    public static ITransitionStart<TState, TCommand, DIContextWrapper<TContext>> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, in int version = 1)
         where TState : struct
         where TCommand : struct
     {
         var id = WorkflowDefinitionWrapper<TState, TCommand, TContext>.GetDefaultId();
         return AddWorkflowDefinition<TState, TCommand, TContext>(services, id, version);
     }
 
-    public static ITransitionStart<TState, TCommand, TContext> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, in string id)
+    public static ITransitionStart<TState, TCommand, DIContextWrapper<TContext>> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, in string id)
         where TState : struct
         where TCommand : struct
     {
         return AddWorkflowDefinition<TState, TCommand, TContext>(services, id, version: 1);
     }
 
-    public static ITransitionStart<TState, TCommand, TContext> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, string id, int version)
+    public static ITransitionStart<TState, TCommand, DIContextWrapper<TContext>> AddWorkflowDefinition<TState, TCommand, TContext>(this IServiceCollection services, string id, int version)
         where TState : struct
         where TCommand : struct
     {
-        var builder = WorkflowDefinitionBuilder<TState, TCommand, TContext>.Create();
+        var builder = WorkflowDefinitionBuilder<TState, TCommand, DIContextWrapper<TContext>>.Create();
 
-        services.TryAddSingleton<IWorkflowFactory<TState, TCommand, TContext>, DefaultWorkflowFactory<TState, TCommand, TContext>>();
+        services.TryAddSingleton<IWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>>, DefaultWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>>>();
 
-        services.AddSingleton<IWorkflow<TState, TCommand, TContext>, WorkflowDefinitionWrapper<TState, TCommand, TContext>>(sp =>
+        services.AddSingleton<IWorkflow<TState, TCommand, DIContextWrapper<TContext>>, WorkflowDefinitionWrapper<TState, TCommand, DIContextWrapper<TContext>>>(sp =>
         {
-            var definition = (WorkflowDefinitionBuilder<TState, TCommand, TContext>)builder;
-            var wrapper = new WorkflowDefinitionWrapper<TState, TCommand, TContext>(definition, id, version);
+            var definition = (WorkflowDefinitionBuilder<TState, TCommand, DIContextWrapper<TContext>>)builder;
+            var wrapper = new WorkflowDefinitionWrapper<TState, TCommand, DIContextWrapper<TContext>>(definition, id, version);
             return wrapper;
         });
 

diff --git a/src/DIT.Workflower.DependencyInjection/Extensions/IServiceProviderExtensions.cs b/src/DIT.Workflower.DependencyInjection/Extensions/IServiceProviderExtensions.cs
@@ -0,0 +1,35 @@
+namespace DIT.Workflower.DependencyInjection.Extensions;
+
+public static class IServiceProviderExtensions
+{
+    public static IWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>> GetRequiredWorkflowFactory<TState, TCommand, TContext>(this IServiceProvider sp)
+        where TState : struct
+        where TCommand : struct
+    {
+        return sp.GetRequiredService<IWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>>>();
+    }
+
+    public static IWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>>? GetWorkflowFactory<TState, TCommand, TContext>(this IServiceProvider sp)
+        where TState : struct
+        where TCommand : struct
+    {
+        return sp.GetService<IWorkflowFactory<TState, TCommand, DIContextWrapper<TContext>>>();
+    }
+
+    public static IWorkflow<TState, TCommand, DIContextWrapper<TContext>> CreateWorkflow<TState, TCommand, TContext>(this IServiceProvider sp, int version = 1)
+        where TState : struct
+        where TCommand : struct
+    {
+        var factory = GetRequiredWorkflowFactory<TState, TCommand, TContext>(sp);
+        return factory.CreateWorkflow(version);
+    }
+
+    public static IWorkflow<TState, TCommand, DIContextWrapper<TContext>> CreateWorkflow<TState, TCommand, TContext>(this IServiceProvider sp, string id, int version = 1)
+        where TState : struct
+        where TCommand : struct
+    {
+        var factory = GetRequiredWorkflowFactory<TState, TCommand, TContext>(sp);
+        return factory.CreateWorkflow(id, version);
+    }
+
+}
diff --git a/src/DIT.Workflower.DependencyInjection/WorkflowDefinitionWrapper.cs b/src/DIT.Workflower.DependencyInjection/WorkflowDefinitionWrapper.cs
@@ -18,7 +18,13 @@ public WorkflowDefinitionWrapper(WorkflowDefinitionBuilder<TState, TCommand, TCo
 
     public static string GetDefaultId()
     {
-        return $"{typeof(TState).Name}_{typeof(TCommand).Name}_{typeof(TContext).Name}";
+        var ctxType = typeof(TContext);
+        var ctxName = ctxType.Name;
+
+        if (ctxType.IsGenericType)
+            ctxName = string.Join("+", typeof(TContext).GetGenericArguments().Select(x => x.Name));
+
+        return $"{typeof(TState).Name}_{typeof(TCommand).Name}_{ctxName}";
     }
 
 }
diff --git a/tests/DIT.Workflower.Tests/DependencyInjection/DependencyInjectionTests.cs b/tests/DIT.Workflower.Tests/DependencyInjection/DependencyInjectionTests.cs
@@ -40,8 +40,7 @@ public void Test()
 
         var sp = sc.BuildServiceProvider();
 
-        var workflowFactory = sp.GetRequiredService<IWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>>();
-
+        var workflowFactory = sp.GetRequiredWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>();
 
         var v1 = workflowFactory.CreateWorkflow(id);
         var v2 = workflowFactory.CreateWorkflow(id, version: 2);
@@ -62,17 +61,20 @@ public void Test()
     public void IdGenerationTest()
     {
         var sc = new ServiceCollection();
+        const string expectedId = "PhoneState_PhoneCommand_PhoneCall";
 
         sc.AddWorkflowDefinition<PhoneState, PhoneCommand, PhoneCall>(version: 1)
             .From(PhoneState.Idle)
                 .On(PhoneCommand.IncomingCall)
                 .To(PhoneState.Ringing);
 
         var sp = sc.BuildServiceProvider();
-        var workflowFactory = sp.GetRequiredService<IWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>>();
+        var workflowFactory = sp.GetRequiredWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>();
         var workflow = workflowFactory.CreateWorkflow();
 
-        Assert.Equal("PhoneState_PhoneCommand_PhoneCall", workflow.Id);
+        Assert.Equal(expectedId, workflow.Id);
+        Assert.Equal(expectedId, sp.CreateWorkflow<PhoneState, PhoneCommand, PhoneCall>().Id);
+        Assert.Equal(expectedId, sp.CreateWorkflow<PhoneState, PhoneCommand, PhoneCall>(expectedId).Id);
     }
 
     [Fact]
@@ -86,7 +88,7 @@ public void UnknownWorkflowReferenceThrows()
                 .To(PhoneState.Ringing);
 
         var sp = sc.BuildServiceProvider();
-        var workflowFactory = sp.GetRequiredService<IWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>>();
+        var workflowFactory = sp.GetRequiredWorkflowFactory<PhoneState, PhoneCommand, PhoneCall>();
         Assert.Throws<KeyNotFoundException>(() => workflowFactory.CreateWorkflow("unknown"));
     }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		namespace DIT.Workflower.DependencyInjection;

		public record DIContextWrapper<TContext>(TContext Context, IServiceProvider ServiceProvider);