Skip to main content

A stand-alone test framework that allows to write unit tests for Data Factory pipelines on Microsoft Fabric, Azure Data Factory and Azure Synapse Analytics.

Project description

Data Factory - Testing Framework :hammer_and_wrench:

A stand-alone test framework that allows to write unit tests for Data Factory pipelines on Microsoft Fabric, Azure Data Factory and Azure Synapse Analytics.

The framework is community supported only, hence there's no official Microsoft SLA for features or bug fixes. Please file an issue for bugs or feature requests. The framework is open source and contributions are welcome!

Features :star:

The framework evaluates pipeline and activity definitions which can be asserted. It does so by providing the following features:

  1. 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.
  2. Test an activity with a specific state and assert the evaluated expressions.
  3. 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 :bulb:

Given a WebActivity with a typeProperties.url property containing the following expression:

@concat(pipeline().globalParameters.BaseUrl, variables('Path'))

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"].result

Why :question:

Data 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 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

Getting started :rocket:

Before you start writing tests, you need to set up the repository and install the framework:

  1. Repository setup
  2. Installing and initializing the framework

If you are not that experienced with Python and prefer a step-by-step guide, use the more detailed getting started guide.

The framework allows you to write two types of tests:

Concepts :books:

The following pages go deeper into different topics and concepts of the framework to help in getting you started.

Basic :seedling:

  1. Repository setup
  2. Installing and initializing the framework
  3. State
  4. Activity testing
  5. Pipeline testing

Advanced :microscope:

  1. Debugging your activities and pipelines
  2. Development workflow
  3. Overriding expression functions
  4. Framework internals

Examples :memo:

More advanced examples demonstrating the capabilities of the framework:

Fabric:

  1. Batch job example

Azure Data Factory:

  1. Copy blobs example
  2. Batch job example

Azure Synapse Analytics:

  1. Copy blobs example

Contributing :handshake:

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.

Trademarks :tm:

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.

Project details


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

data_factory_testing_framework-1.4.0.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

data_factory_testing_framework-1.4.0-py3-none-any.whl (15.1 MB view details)

Uploaded Python 3

File details

Details for the file data_factory_testing_framework-1.4.0.tar.gz.

File metadata

File hashes

Hashes for data_factory_testing_framework-1.4.0.tar.gz
Algorithm Hash digest
SHA256 5a5f250b4c33da81c0a7135581028c8c2df1b35e89d897aba5d8ecdeb4898eed
MD5 6a2bac84aaa9b507b243ebc3ed61c940
BLAKE2b-256 2bd8564decac8fb2a657ca0d7a62382d641ff75c276205bbcf75c970e733cd33

See more details on using hashes here.

File details

Details for the file data_factory_testing_framework-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for data_factory_testing_framework-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fe5c987160939fe7f1d25c0b459f80297e20afa78db26425246b7bafbc059f29
MD5 86bb44d1b4798a6a27bf798e8ba30d5e
BLAKE2b-256 3e622ec66e9fb5e993591c8f0158dc2c27ad9f7876b0d6c34820c35293c97a75

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page