Package: data-factory-testing-framework
Data Factory - Testing FrameworkA stand-alone test framework that allows to write unit tests for Data Factory pipelines onMicrosoft FabricandAzure Data Factory.FeaturesThe framework evaluates pipeline and activity definitions which can be asserted. It does so by providing the following features:Evaluate expressions by using the framework's internal expression parser. It supports all the functions and arguments that are available in the Data Factory expression language.Test an activity with a specific state and assert the evaluated expressions.Test a pipeline run by verifying the execution flow of activities for specific input parameters and assert the evaluated expressions of each activity.The framework does not support running the actual pipeline. It only gives you the ability to test the pipeline and activity definitions.High-level exampleGiven aWebActivitywith atypeProperties.urlproperty containing the following expression:@concat(pipeline().globalParameters.baseUrl, variables('JobName'))A simple test to validate that the concatenation is working as expected could look like this:# Arrangeactivity=pipeline.get_activity_by_name("webactivity_name")state=PipelineRunState(parameters=[RunParameter(RunParameterType.Global,"BaseUrl","https://example.com"),],variables=[PipelineRunVariable("Path","some-path"),])# Actactivity.evaluate(state)# Assertassert"https://example.com/some-path"==activity.type_properties["url"].resultWhyData Factory does not support unit testing, nor testing of pipelines locally. Having integration and e2e tests running on an actual Data Factory instance is great, but having unit tests on top of them provides additional means of quick iteration, validation and regression testing. Unit testing with theData Factory Testing Frameworkhas the following benefits:Runs locally with immediate feedbackEasier to cover a lot of different scenarios and edge casesRegression testingConceptsThe following pages go deeper into different topics and concepts of the framework to help in getting you started.BasicRepository setupInstalling and initializing the frameworkStateActivity testingPipeline testingIf you are a not that experienced with Python, you can follow theGetting startedguide to get started with the framework.AdvancedDebugging your activities and pipelinesDevelopment workflowOverriding expression functionsFramework internalsExamplesMore advanced examples demonstrating the capabilities of the framework:Fabric:Batch job exampleAzure Data Factory:Copy blobs exampleBatch job exampleContributingThis project welcomes contributions and suggestions.  Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
the rights to use your contribution. For details, visithttps://cla.opensource.microsoft.com.When you submit a pull request, a CLA bot will automatically determine whether you need to provide
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.This project has adopted theMicrosoft Open Source Code of Conduct.
For more information see theCode of Conduct FAQor
contactopencode@microsoft.comwith any additional questions or comments.DisclaimerThis unit test framework is not officially supported.
It is currently in an experimental state and has not been tested with every single data factory resource.
It should support all activities out-of-the-box but has not been thoroughly tested,
please report any issues in the issues section and include an example of the pipeline that is not working as expected.If there's a lot of interest in this framework, then we will continue to improve it and move it to a production-ready state.TrademarksThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must followMicrosoft's Trademark & Brand Guidelines.
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.