A unit test framework that allows you to write unit and functional tests for Data Factory pipelines against the git integrated json resource files.
Project description
Data Factory - Testing Framework
A stand-alone test framework that allows you to write unit tests for Data Factory pipelines on Microsoft Fabric and Azure Data Factory.
Features
The 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 example
Given a WebActivity with a typeProperties.url property 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:
# Arrange
activity = pipeline.get_activity_by_name("webactivity_name")
state = PipelineRunState(
parameters=[
RunParameter(RunParameterType.Global, "BaseUrl", "https://example.com"),
],
variables=[
PipelineRunVariable("Path", "some-path"),
])
# Act
activity.evaluate(state)
# Assert
assert "https://example.com/some-path" == activity.type_properties["url"].value
Why
Data Factory does not support unit testing, nor testing your 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 the Data Factory Testing Framework has the following benefits:
- Runs locally with immediate feedback
- Easier to cover a lot of different scenarios and edge cases
- Regression testing
Concepts
The following pages go deeper into different topics and concepts of the framework to help in getting you started.
Basic
If you are a not that experienced with Python, you can follow the Getting started guide to get started with the framework.
Advanced
- Debugging your activities and pipelines
- Development workflow
- Overriding expression functions
- Framework internals
Examples
More advanced examples demonstrating the capabilities of the framework:
Fabric:
Azure Data Factory:
Contributing
This 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, visit https://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 the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
Disclaimer
This 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.
Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft'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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file data_factory_testing_framework-0.0.1a116.tar.gz.
File metadata
- Download URL: data_factory_testing_framework-0.0.1a116.tar.gz
- Upload date:
- Size: 93.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | af6c22f2dac24677b79e01a578d0c3e896f9e677910a9df1db7bdeb0f88cad14 |
|
| MD5 | 610507fca73a090e9e7a8e3dea267b65 |
|
| BLAKE2b-256 | 54870d473e7cfb7d77a543c6cd5b6e4f8936a75b5f68bb26eaddbaaa320b2488 |
File details
Details for the file data_factory_testing_framework-0.0.1a116-py3-none-any.whl.
File metadata
- Download URL: data_factory_testing_framework-0.0.1a116-py3-none-any.whl
- Upload date:
- Size: 68.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c7135174e3fb493f9984363c14adecfd6e1e0b2e0082e01032c29849fc0fbe71 |
|
| MD5 | e46cc998f80ba89524699298054be74a |
|
| BLAKE2b-256 | fa52af97495a703dea9183ba1d4257a610764c29dbd33440dd4865e275daffb5 |
