Pipeline Testing Suit

The Pipeline Testing functionality page enables users to validate and verify the performance of each component within a pipeline using defined test cases.

The Pipeline Testing framework allows users to create, execute, and manage pipeline test cases efficiently, ensuring consistent validation of pipeline outputs for each concerned pipeline component. This ensures that data transformations and outputs meet the expected quality and schema requirements.

The Test suite provides the following comparisons:

Accessing the Pipeline Testing Framework

  1. Navigate to the Pipeline Toolbar in the Pipeline Editor.

  2. Click Pipeline Testing.

The Pipeline Testing page opens, displaying details of the selected pipeline. The Create Test Case tab opens by default.

  • Search Component: Use the search bar to locate components associated with the pipeline.

  • Component Panel: Displays all components linked to the selected pipeline.

  • Create Test Case: Opens the test case creation dialog.

Creating a Test Case

  1. On the Pipeline Testing page, click Create Test Case.

  2. In the Test Case dialog box, select a component from the component panel (for example, Mongo Reader Lite).

  3. Configure the following details:

    • Test Name: Enter a name for the test case.

    • Test Description: Describe the test case.

    • Input Data File: Upload the input data file (required for transformation and writer components).

    • Output Data File: Upload the expected output data file.

    • Schema File: Upload the schema of the expected output.

    • Input Data Type: Currently supports JSON.

    • Assertion Method: Currently supports the equals assertion method.

    • Sort: Enable sorting of string or integer column values in the actual output.

    • Comparison Logic: Select from the following options:

      • Compare Number of Columns: Compares input and output data columns.

      • Compare Data: Compares input and output data values.

      • Compare Number of Rows: Compares the number of rows in input and output data.

      • Check Data Matches Schema: Validates the expected schema against the output data.

  4. Click Save.

Note: By clicking the Cross ()or Cancel option, the Test Case dialog box will be closed without saving the changes.

Running a Test Case

Once a test case is created, the user can run it by using the Run Test Case button from the Pipeline Testing suite.

  1. On the Pipeline Testing page, select a test case.

  2. Click Run Test Case.

  3. In the Run Test Case dialog box, click Run.

Please note: After running a test case, you can track progress in the Component Status, Logs, and Reports tabs, respectively.

You can track progress through the following tabs:

  • Component Status: Displays running component pods, executors, and drivers.

    • Executors and drivers are displayed in green once active.

    • Click Refresh to update the status view.

  • Logs: Provides log details of the component execution.

  • Reports: Displays the latest test case report, including:

    • Test Case Name

    • Component Version

    • Comparison Logic (columns, schema, data)

    • Run Date

Managing Test Cases

Viewing Test Cases

The Test Case list displays:

  • Checkbox: Select multiple or individual test cases for execution.

  • Test Name: Displays the name of the test case.

  • Test Case Description: Displays a description.

  • Created Date: Shows when the test case was created.

  • Delete Icon: Removes a test case.

  • View Option: Opens the test case report.

Updating a Test Case

  1. Click a test case in the Test Case list to open it in edit mode.

  2. Update the following fields as required:

    • Test Case Name

    • Test Description

    • Output Schema File:

      • Upload a new schema with the Upload icon.

      • View the schema using the View icon.

      • Remove the schema with the Cross (X) icon.

    • Sort Column Name

  3. Click Update to save changes.