Add Azure Functions unit testing sample #312
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jviau
approved these changes
May 15, 2024
jviau
reviewed
May 15, 2024
davidmrdavid
commented
May 17, 2024
Comment on lines
18
to
19
| ILogger logger = context.CreateReplaySafeLogger(nameof(AzureFunctionsApp)); | ||
| logger.LogInformation("Saying hello."); |
There was a problem hiding this comment.
I'll add this back right after the change to make CreateReplaySafeLogger virtual is released.
There was a problem hiding this comment.
Will this be needed if you use Moq.Protected?
There was a problem hiding this comment.
Nope, added it back just now
jviau
reviewed
May 17, 2024
jviau
reviewed
May 17, 2024
Co-authored-by: Jacob Viau <javia@microsoft.com>
Co-authored-by: Jacob Viau <javia@microsoft.com>
Co-authored-by: Jacob Viau <javia@microsoft.com>
jviau
reviewed
May 17, 2024
Comment on lines
18
to
19
| ILogger logger = context.CreateReplaySafeLogger(nameof(AzureFunctionsApp)); | ||
| logger.LogInformation("Saying hello."); |
There was a problem hiding this comment.
Will this be needed if you use Moq.Protected?
Co-authored-by: Jacob Viau <javia@microsoft.com>
jviau
approved these changes
May 17, 2024
jviau
reviewed
May 17, 2024
| @@ -385,7 +385,7 @@ public virtual Task CallSubOrchestratorAsync(TaskName orchestratorName, TaskOpti | |||
| /// </summary> | |||
| /// <param name="categoryName">The logger's category name.</param> | |||
| /// <returns>An instance of <see cref="ILogger"/> that is replay-safe.</returns> | |||
| public ILogger CreateReplaySafeLogger(string categoryName) | |||
| public virtual ILogger CreateReplaySafeLogger(string categoryName) | |||
There was a problem hiding this comment.
If you still want this change, it is fine to leave in. Otherwise if you think Moq.Protected is sufficient, we can remove this.
There was a problem hiding this comment.
I'd like to keep this as I'd like for customer to be able to mock this directly :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We've received a few requests to provide unit testing samples for Azure Functions. This PR provides a minimal example of how to set up such tests.
In general, I had no issue mocking the DF APIs except for the
CreateReplaySafeLoggerAPI, and the Azure Functions workerGetLoggerAPI, both of which are not marked as virtual or abstract, and therefore cannot be mocked. Not sure what's the guidance for dealing with those APIs, perhaps it's just a gap in the unit testing experience today. As a result, I removed the logger usage in the Azure Functions samples, so that the methods there could be unit tested in their entirerty.To help bridge the gap on the DF-side, I marked
CreateReplaySafeLoggeras virtual. On the Functions worker side, we may need guidance or assistance.