Miqa's Output Explorer is built for pairwise or standalone evaluation of execution results. It can be used for ad hoc result exploration, including detecting and troubleshooting differences between executions, or can be used to easily build up test blocks for your automated tests.
This guide will cover the different elements of the tool and how they may be used to accelerate your testing process.
Accessing and Using the Output Explorer tool
From any completed execution page, click on the green Output Explorer button to open the tool.
Changing Baseline/Test Executions
By default, opening Output Explorer from an execution page will show you results against the latest comparable execution.
Change the baseline and test executions using the Hover over any execution ID in the dropdown to show the execution date and time, or the workflow name to show workflow/variation details.
Changing View Settings
Which Files to Explore
By default, to prevent a poor user experience in case of output folders with very large numbers of irrelevant files, Miqa's Output Explorer only displays files of types that are known to it and immediately actionable (e.g. VCF, BAM, TXT, CSV, TSV, PDF, PNG, etc.) using built-in or previously-user-configured tests. However, you can still opt to view all files: simply toggle the Tracked Files / All Files button at the top right of your screen.
Toggle Visibility
Click the Toggle Sidebar button to show or hide the left control panel. Click the Toggle Help Text button to show or hide detailed help text in each tab.
Explorer Tabs
Summary Tab
The Summary Tab shows high-level results at the file level. Click on the card titles to view the details corresponding to each statistic.
By default, for comparison views (i.e. with both baseline and test executions present), the Summary Tab will have the Comparison: File Presence and Comparison: File Contents sections visible, while the File Summary section (which shows the total number of files and size of files in the test execution) is collapsed. When there is no comparison execution, only the File Summary section will be visible.
Files Tab
From the Files Tab, you can quickly see the output folder structure of your test.execution and how the files present compare against the baseline. Click on any file in the File Tree to view its contents in the right-hand display panel. Right-click on any file to show additional actions, including Show Diffs (shows a git-style file diff), Show Report (loads an interactive reporting module) or Add Test (pops up a modal listing the available built-in tests for that file, which you can select to start building your assertions).
File Tree Legend
Green: matching file is present in both baseline and test output folder and is an exact or presumed match
Blue: matching file is present in both baseline and test output folder
Red: either missing from the baseline or the test output folder (as indicated by the left or right arrows)
Test Builder Tab
Use the Test Builder tab to easily build up a set of assertions to use for reproducible and automated testing, or to perform quick checks on your results.
The Test Builder tab contains three sub-tabs:
Suggested: built-in tests that are recommended for a quick-start, based on the filetypes present in your outputs. Simply click on the plus sign or edit symbol to add or configure default tests, which will then show up in the right-hand display panel. Click the highlighted checkmark on an already-selected test to remove it from the display.
Library: built-in tests organized by test type and not specific to a particular filetype. Click on the test name to add it to the configuration and show it in the right-hand display.
JSON: fully customizable JSON test configuration, where you can add new or modify existing test assertions to meet your needs. Click the View Results button to update the right-hand display panel based on your JSON changes.
Once you have created a set of assertions to your liking, you can save this for later use by clicking » Create Block at the bottom of the tab, which will save all of these assertions into a Test Block.
Quick Report Tab
Use the Quick Report Tab to apply any existing Test Blocks to your current executions. This allows for ad hoc testing using the same assertions that go into your reproducible automated tests. You may also choose an existing Test Block to use as a starting point, then go back to the Test Builder to add or modify assertions.
