Add an instance variable to the Step Name

[kiragengis]

To give more context to the step, I want to be able to refer to a property value of the class in the step name. This is an example:

public class LogMore
{
    [AllureStep("This method logs with more context when {parameter1} is identified within {this.NameThatIdentifiesThisClass}")]
    public void ILogWithMoreContext(string parameter1)
    {

    }

    /// <summary>
    /// This property uniquely identifies the instances of the class
    /// </summary>
    public string NameThatIdentifiesThisClass { get; set; }
}

My approach would be to modify AllureStepParameterHelper.GetStepName to receive an instance from AllureStepAspectBase, and then add something similar to this to the if-else statement:

else if (TrySplit(pattern, '.', out var parts2) && parts2.Length == 2 && parts2[0] == "this")
{
    // We probably need to do some validation around this line
    stepName = stepName?.Replace(match.Value, instance?.GetType().GetProperty(parts2[1]).GetValue(instance).ToString());
}

[delatrie]

Hi again, @kiragengis !

I've created a feature request from this discussion: allure-framework/allure-csharp#470. Feel free to open a PR on that matter.

Until it's implemented, however, the solution below should work.

You can bypass GetStepName messing with your custom pattern. Just don't forward the pattern to AllureStepAttribute, but store it in your attribute instead:

[Injection(typeof(RenameAspect), Priority = 0)]
[Injection(typeof(Allure.Net.Commons.Steps.AllureStepAspectBase), Priority = 1)]
public class StepWithPropertiesAttribute : AllureStepAttribute
{
    public string? NamePattern { get; }
    public StepWithScreenshotAttribute(string? name = null) : base(null)
    {
        this.NamePattern = name;
    }
}

The RenameAspect could be similar to AddScreenshotAspect.
Just provide it with an extra [Argument(Source.Metadata)] MethodBase metadata parameter, and replace AddScreenshot with something like that:

public class RenameAspect
{
    /* ... */

    void UpdateStepName(object? instance, MethodBase metadata)
    {
        var pattern = metadata.GetCustomAttribute<StepWithPropertiesAttribute>().NamePattern

        if (instance is not null)
        {
            // Insert instance fields/properties here.
            // You may optionally use FormatFunctions.Format with AllureLifecycle.Instance.TypeFormatters.
            pattern = "...";
        }

        // Call GetStepName to insert parameters.
        var name = AllureStepParameterHelper.GetStepName(
            pattern,
            metadata,
            args,
            AllureLifecycle.Instance.TypeFormatters
        );

        AllureApi.SetStepName(name);
    }
}

[kiragengis]

Thank you, that solved my problem. I am going to try to create a PR for this.