README

Aqovia.DurableFunctions.Testing

Nuget Info

Build status

About

Aqovia.DurableFunctions.Testing provides functionality to test a durable functions end-to-end using standard test frameworks. It allows the possibility to remove mocks from the testing process and utilise the real durable task extensions during execution of the test. It is not intended to replace standard unit tests as full code execution coverage is not possible due to external/third party tool requirements. It can be used for testing the integration of azure functions with orchestrations and any related activity function/sub-orchestrations for success/happy path scenarios. This test approach allows the testing of the azure function stack (with external components) to be run as part of a CI/CD pipeline.

Getting started

• Install and start Azure Storage Emulator (or Azurite)
• Include the Nuget package in your test project
  • https://www.nuget.org/packages/Aqovia.DurableFunctions.Testing/
• Include the durable task libs in your project

Project overview

The project contains the following directory structure

src/
    Aqovia.DurableFunctions.Testing
test/
    Aqovia.DurableFunctions.Testing.EndToEndTests
    SampleFunctionApp

src/Aqovia.DurableFunctions.Testing

Contains the source library code for creating an in-process job host. A wrapper is provided to configure this job host as the per the function app which is under test by providing fake service instances to the DI container.

test/SampleFunctionApp

Contains a basic function app (created from visual studio template) - which can be used as a test app for demonstrating/testing the test library.

test/Aqovia.DurableFunctions.Testing.EndToEndTests

Contains sample tests for demonstrating the usage of the test library.

Tests include:

1. Http triggered function -> Orchestration function -> Activity function
2. Service Bus triggered function -> Orchestration function -> Activity function
3. Service Bus triggered function -> Orchestration function -> Http Client (Todo)
4. Queue triggered function -> Orchestration function -> Sub-Orchestration -> Activity Function (Todo)

Contributing

Assuming the repository is cloned and up-to-date (master branch)

1. Create a branch from master using git checkout -b new_feature_branch
2. Implement changes on new feature branch
3. Test and build locally - updating tests if required
4. Push to remote and fix any remote build/test issues
5. Create a pull request to the master branch

• include a well-formed title and description as these will be included in the release notes if/when the feature is merged to master
• include also in your description one of the following strings
  • 'bump: patch' - if this PR implements a new fix
  • 'bump: minor' - if this PR implements a new feature
  • 'bump: major' - if this PR implements a new feature with breaking changes

Release Process

• The release process is automated by the CI process for every successful merge to master.
• The PR request title and description are used to create the Release note found via the Releases link on the repo landing page
• Inclusion of the keywords (bump: major|minor|patch) in the PR description is sufficient for the developer to control the upgrade to the final semantic version of the package
• Branch Preview packages are also available via the Aqovia Nuget OSS Feeds (publically available)
• Release packages are available on the Nuget.org
• Github release info is also available to view/compare and download source via the repo landing page