ITestRunner.WorkflowTerminationCode can be a string but the framework uses int?

[nunoviaes]

Hi @mark-abrams ,

First and foremost, thank you for the great framework and all the hard work you and all the contributors have done on it.

During some logic app standard test that my team and I are working on, we were trying to assert the WorkflowTerminationCode in the following two scenarios:

• When we have Terminate action and we set a message and code, but we use the code as a string (since the workflow designer accepts it) and not as a HTTP status code

• When the workflow fails and the engine provides back the default termination message 'An action failed. No dependent actions succeeded.'. This engine error sets the code with the value of 'ActionFailed'

Please note that there might be other examples that set the code to string in logic app standard engine, but at the moment we cannot really assert the WorkflowTerminationCode because its set as 'int?'.

The example below shows that we cannot also not assert against what the engine returns when an action fails. The same happens if we use a Terminate action.

During investigation we can see the framework is actually catching an exception as per screenshots below:

The suggestion here is to treat the WorkflowTerminationCode as a string, since the logic app standard engine uses it as a string and the developers can also use it as a string and not set the code in the Terminate action as a HTTP status or an int value.

Hope it helps.

Thanks.

Best Regards,

[mark-abrams]

Hi @nunoviaes , thanks for raising this. I wasn't aware that the termination code was a string and not a numeric code. I've checked the workflow schema reference for the Terminate action and it confirms this:

I just need to ensure that changing the response type for TestRunner.WorkflowTerminationCode() from int? to string is a backwards-compatible change.

[mark-abrams]

Hi @nunoviaes , I've looked into this and changing the response type for TestRunner.WorkflowTerminationCode from int? to string will break and unit tests that are expecting an integer return type.

I can't add an overload of the property. So I'm thinking of adding a new property to the TestRunner called string WorkflowTerminationCodeAsString that does the same as the existing property, but casts the code to a string data type.

/// <inheritdoc cref="ITestRunner.WorkflowTerminationCodeAsString" />
public string WorkflowTerminationCodeAsString
{
    get
    {
        return _apiHelper.WorkflowRunContent()["properties"]["error"]?["code"]?.ToObject<string>();
    }
}

Would this work for you?

[nunoviaes]

Hi @mark-abrams ,

That would work perfectly for my usage of the termination error code in both scenarios described in this ticket. When using HTTP codes or numbered codes we can use the existing field.

Thanks.

Best Regards

[mark-abrams]

Hi @nunoviaes , this will be fixed in the next version of LogicAppUnit, version 1.11.0.

[nunoviaes]

Thanks @mark-abrams . Much appreciated.

[mark-abrams]

@nunoviaes , version 1.11.0 has been released to NuGet.