diff --git a/Elsa.sln b/Elsa.sln index f0e4169fb..b452be2f2 100644 --- a/Elsa.sln +++ b/Elsa.sln @@ -304,6 +304,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Persistence.EFCore.Sql EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Alterations.IntegrationTests", "test\integration\Elsa.Alterations.IntegrationTests\Elsa.Alterations.IntegrationTests.csproj", "{51C39AF0-4F41-4FC1-AEBD-D1494407D3F9}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elsa.Activities.UnitTests", "test\unit\Elsa.Activities.UnitTests\Elsa.Activities.UnitTests.csproj", "{2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -608,6 +610,10 @@ Global {51C39AF0-4F41-4FC1-AEBD-D1494407D3F9}.Debug|Any CPU.Build.0 = Debug|Any CPU {51C39AF0-4F41-4FC1-AEBD-D1494407D3F9}.Release|Any CPU.ActiveCfg = Release|Any CPU {51C39AF0-4F41-4FC1-AEBD-D1494407D3F9}.Release|Any CPU.Build.0 = Release|Any CPU + {2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA}.Debug|Any CPU.Build.0 = Debug|Any CPU + {2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA}.Release|Any CPU.ActiveCfg = Release|Any CPU + {2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE @@ -634,7 +640,6 @@ Global {5948B0A5-7873-4DBB-BA03-EB283D6EA91B} = {5BA4A8FA-F7F4-45B3-AEC8-8886D35AAC79} {B08B4E00-C2AB-48F3-8389-449F42AEF179} = {5BA4A8FA-F7F4-45B3-AEC8-8886D35AAC79} {28818676-F6AF-4203-8B65-BD33A50CB9A2} = {C6658DE0-2B2F-47F0-BB61-2CA66D435C09} - {DC9CCAD0-7363-4691-B964-FF5B3AEA3F95} = {18453B51-25EB-4317-A4B3-B10518252E92} {29638A67-E79F-44FE-AC05-DA499EBA929E} = {2F3E1026-5054-4E1F-899B-F1A7F70F9912} {A516931E-EDBB-4FC3-BB94-1BB824D5BC61} = {5BA4A8FA-F7F4-45B3-AEC8-8886D35AAC79} {BBCE36D1-6767-4ED1-B3E8-84D2567A962A} = {A516931E-EDBB-4FC3-BB94-1BB824D5BC61} @@ -701,6 +706,8 @@ Global {71D5178D-2490-4681-8621-BF8DED964F33} = {3D0A6C71-4B96-411B-80DB-DDFAFF77C748} {698051E0-7981-43D4-B7BA-F3D8B65004A1} = {3D0A6C71-4B96-411B-80DB-DDFAFF77C748} {51C39AF0-4F41-4FC1-AEBD-D1494407D3F9} = {1B8D5897-902E-4632-8698-E89CAF3DDF54} + {DC9CCAD0-7363-4691-B964-FF5B3AEA3F95} = {18453B51-25EB-4317-A4B3-B10518252E92} + {2DA466EB-CBF0-46EC-8B86-45CAF2B68BBA} = {18453B51-25EB-4317-A4B3-B10518252E92} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {D4B5CEAA-7D70-4FCB-A68E-B03FBE5E0E5E} diff --git a/src/modules/Elsa.Workflows.Core/Activities/SetVariable.cs b/src/modules/Elsa.Workflows.Core/Activities/SetVariable.cs index a12b35086..689e847e6 100644 --- a/src/modules/Elsa.Workflows.Core/Activities/SetVariable.cs +++ b/src/modules/Elsa.Workflows.Core/Activities/SetVariable.cs @@ -89,7 +89,7 @@ public class SetVariable : CodeActivity /// The variable to assign the value to. /// [Input(Description = "The variable to assign the value to.")] - public Variable Variable { get; set; } = null!; + public Variable? Variable { get; set; } /// /// The value to assign. @@ -101,9 +101,13 @@ public class SetVariable : CodeActivity protected override void Execute(ActivityExecutionContext context) { // Always refer to the variable by ID to ensure that the variable is resolved from the correct scope. - var variableId = Variable.Id; + var variableId = Variable?.Id; var variable = context.ExpressionExecutionContext.EnumerateVariablesInScope().FirstOrDefault(x => x.Id == variableId); + + if (variable == null) + throw new InvalidOperationException($"Variable '{variableId}' not found."); + var value = context.Get(Value); - variable?.Set(context, value); + variable.Set(context, value); } } \ No newline at end of file diff --git a/src/modules/Elsa.Workflows.Core/Services/ActivityRegistry.cs b/src/modules/Elsa.Workflows.Core/Services/ActivityRegistry.cs index 282d07be3..f5b4482ca 100644 --- a/src/modules/Elsa.Workflows.Core/Services/ActivityRegistry.cs +++ b/src/modules/Elsa.Workflows.Core/Services/ActivityRegistry.cs @@ -57,7 +57,6 @@ public class ActivityRegistry(IActivityDescriber activityDescriber, IEnumerable< var activityDescriptor = await activityDescriber.DescribeActivityAsync(activityType, cancellationToken); - Add(activityDescriptor, _activityDescriptors, _manualActivityDescriptors); _manualActivityDescriptors.Add(activityDescriptor); } diff --git a/test/unit/Elsa.Activities.UnitTests/Elsa.Activities.UnitTests.csproj b/test/unit/Elsa.Activities.UnitTests/Elsa.Activities.UnitTests.csproj new file mode 100644 index 000000000..3017b8a33 --- /dev/null +++ b/test/unit/Elsa.Activities.UnitTests/Elsa.Activities.UnitTests.csproj @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/test/unit/Elsa.Activities.UnitTests/Helpers/ActivityTestHelper.cs b/test/unit/Elsa.Activities.UnitTests/Helpers/ActivityTestHelper.cs new file mode 100644 index 000000000..b8f623ed6 --- /dev/null +++ b/test/unit/Elsa.Activities.UnitTests/Helpers/ActivityTestHelper.cs @@ -0,0 +1,123 @@ +using Elsa.Common; +using Elsa.Expressions.Contracts; +using Elsa.Expressions.Services; +using Elsa.Extensions; +using Elsa.Mediator.Contracts; +using Elsa.Workflows; +using Elsa.Workflows.CommitStates; +using Elsa.Workflows.Management.Providers; +using Elsa.Workflows.Management.Services; +using Elsa.Workflows.PortResolvers; +using Microsoft.Extensions.DependencyInjection; +using NSubstitute; + +namespace Elsa.Activities.UnitTests.Helpers; + +/// +/// Helper class for unit testing activities in isolation. +/// Provides methods to execute activities with minimal setup, abstracting away the complexity +/// of creating WorkflowExecutionContext and ActivityExecutionContext. +/// +public static class ActivityTestHelper +{ + /// + /// Executes an activity in isolation for unit testing purposes and returns the execution context. + /// This method handles all the complexity of setting up the execution context, + /// evaluating inputs, and executing the activity. + /// + /// The activity to execute + /// An optional action to configure the service collection for dependency injection during activity execution. + /// The ActivityExecutionContext used for execution + public static async Task ExecuteActivityAsync(IActivity activity, Action? configureServices = null) + { + var context = await CreateMinimalActivityExecutionContext(activity, configureServices); + + // Set up variables and inputs, then execute the activity + await SetupExistingVariablesAsync(activity, context); + await context.EvaluateInputPropertiesAsync(); + await activity.ExecuteAsync(context); + + return context; + } + + /// + /// Creates a minimal ActivityExecutionContext suitable for isolated unit testing of activities. + /// This helper method creates a real WorkflowExecutionContext using the minimal workflow pattern + /// to provide proper context for activities. + /// + private static async Task CreateMinimalActivityExecutionContext(IActivity activity, Action? configureServices) + { + // Create a minimal service provider with the required services for expression evaluation + var services = new ServiceCollection(); + + // Add core services + services.AddLogging(); + services.AddSingleton(_ => Substitute.For()); + services.AddSingleton(_ => Substitute.For()); + services.AddSingleton(); + services.AddScoped(); + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + services.AddScoped(); + services.AddScoped(); + services.AddScoped(); + services.AddScoped(); + services.AddScoped(); + services.AddScoped(); + + // Add the default expression descriptor provider which includes Literal expressions + services.AddSingleton(); + services.AddSingleton(); + + services.AddSingleton(_ => Substitute.For()); + + services.AddSingleton(_ => Substitute.For()); + services.AddSingleton(_ => Substitute.For()); + services.AddSingleton(_ => Substitute.For()); + + // Call the configure services action if provided. + configureServices?.Invoke(services); + + var serviceProvider = services.BuildServiceProvider(); + var activityRegistry = serviceProvider.GetRequiredService(); + var workflowGraphBuilder = serviceProvider.GetRequiredService(); + await activityRegistry.RegisterAsync(activity.GetType()); + var workflow = Workflow.FromActivity(activity); + var workflowGraph = await workflowGraphBuilder.BuildAsync(workflow); + + // Create workflow execution context using the static factory method + var workflowExecutionContext = await WorkflowExecutionContext.CreateAsync( + serviceProvider, + workflowGraph, + $"test-instance-{Guid.NewGuid()}", + CancellationToken.None + ); + + // Create ActivityExecutionContext for the actual activity we want to test + return await workflowExecutionContext.CreateActivityExecutionContextAsync(activity); + } + + /// + /// Sets up existing variables found on the activity in the execution context. + /// This is necessary because in unit tests, variables need to be initialized. + /// + private static Task SetupExistingVariablesAsync(IActivity activity, ActivityExecutionContext context) + { + var activityType = activity.GetType(); + var variableProperties = activityType.GetProperties() + .Where(p => p.PropertyType.IsGenericType && + p.PropertyType.GetGenericTypeDefinition() == typeof(Variable<>)) + .ToList(); + + foreach (var variable in variableProperties.Select(property => (Variable)property.GetValue(activity)!)) + { + variable.Set(context.ExpressionExecutionContext, variable.Value); + } + + return Task.CompletedTask; + } +} \ No newline at end of file diff --git a/test/unit/Elsa.Activities.UnitTests/Primitives/SetVariableTests.cs b/test/unit/Elsa.Activities.UnitTests/Primitives/SetVariableTests.cs new file mode 100644 index 000000000..2f5c7ec5d --- /dev/null +++ b/test/unit/Elsa.Activities.UnitTests/Primitives/SetVariableTests.cs @@ -0,0 +1,49 @@ +using Elsa.Activities.UnitTests.Helpers; + +namespace Elsa.Activities.UnitTests.Primitives; + +public class SetVariableTests +{ + [Fact] + public async Task Should_Set_Variable_Integer() + { + // Arrange + const int expected = 42; // The answer to life, the universe and everything. + var variable = new Variable("myVar", 0, "myVar"); + var setVariable = new SetVariable(variable, new Input(expected)); + + // Act + var context = await ActivityTestHelper.ExecuteActivityAsync(setVariable); + + // Assert + var result = variable.Get(context); + Assert.Equal(expected, result); + } + + [Fact] + public async Task Should_Throw_When_Variable_Is_Null() + { + // Arrange + var setVariable = new SetVariable(null!, new Input("test value")); + + // Act & Assert + var exception = await Record.ExceptionAsync(async () => await ActivityTestHelper.ExecuteActivityAsync(setVariable)); + + Assert.NotNull(exception); + } + + [Fact] + public async Task Should_Set_Variable_To_Null_Value() + { + // Arrange + var variable = new Variable("myVar", "initial value", "myVar"); + var setVariable = new SetVariable(variable, new Input((string?)null)); + + // Act + var context = await ActivityTestHelper.ExecuteActivityAsync(setVariable); + + // Assert + var result = variable.Get(context); + Assert.Null(result); + } +} \ No newline at end of file diff --git a/test/unit/Elsa.Activities.UnitTests/Usings.cs b/test/unit/Elsa.Activities.UnitTests/Usings.cs new file mode 100644 index 000000000..b45935d97 --- /dev/null +++ b/test/unit/Elsa.Activities.UnitTests/Usings.cs @@ -0,0 +1,3 @@ +global using Elsa.Workflows.Activities; +global using Elsa.Workflows.Memory; +global using Elsa.Workflows.Models; \ No newline at end of file