This Github repo develops a report dashbaord on the automated regression tests from the repo slurm_testing. This automated regression testing repo is specifically made for testing C-PAC. Currently, the regression test only runs default pipeline.
This script parses through C-PAC output directories to find log, output, and working directories. These paths are written in a YAML file, which will get used in the following script for correlating.
Arguments:
--pipeline1 {/path/to/CPAC/output} CPAC output directory for correlating against `pipeline2`.
Its following subdirectory should be `log`, `output`
and `working`
--pipeline2 {/path/to/CPAC/output} CPAC output directory for correlating against `pipeline1`.
Its following subdirectory should be `log`, `output`
and `working`.
--workspace $GITHUB_WORKSPACE Github workspace. Ensure that all files get saved here
for easy accessibility.
--branch $GITHUB_BRANCH Developer's branch name. This ensures that all files created
have a unique name (no overwriting in cluster).
--data_source Site_Name Name of Site data comes from. Will be HNU_1, Site-CBIC, and Site-SI
Output:
{branch_name}.yml YAML file that contains the file paths of CPAC output directories.
This script calculates correlations of the files from the YAML file created above. These file paths contains images from the C-PAC output directories in which we want to correlate against. These JSON files are created in the cluster and must be sent back to Github Actions from the cluster when completed.
Arguments:
input_yaml {/path/to/branch_name.yml} This is a positional argument!! Meaning there is no flag
so first argument must be the YAML file that was output
from `create_yml.py`
--branch $GITHUB_BRANCH Developer's branch name. This ensures that all files created
have a unique name (no overwriting in cluster).
--data_source Site_Name Name of Site data comes from. Will be HNU_1, Site-CBIC, and Site-SI
Output:
{data_source}_{branch}.json The output are JSON files with correlations of every file in the C-PAC
output directories.
This script builds the dashboard based on the correlations calculated above. Currently, the dashboard is saved onto a temporary HTML file that automatically opens up in a browser.
Arguments:
--json_files JSON files created from `calculate_correlations.py` script.
If multiple JSON files, can separate then by a comma (NO SPACES).
--json_files HNU_1_{branch}.json,Site-SI_{branch}.json,Site-CBIC_{branch}.json
--branch $GITHUB_BRANCH Developer's branch name. This ensures that all files created
have a unique name (no overwriting in cluster).
Output:
temp.html Temporary HTML file that automatically opens in browser. Tempoary
because it does not get saved to computer unless you save it.
If you exit browser, will need to build again.
The dashboard is a heat map where value < 0.98 will be red and value ≥ 0.98 will be green. Y-Axis: File names X-Axis: Data Source (data Site name)
Top part of Dashboard:
![Screen Shot 2023-07-24 at 9 56 09 PM](https://private-user-images.githubusercontent.com/58920810/255766454-a536075e-ef76-4a14-93c2-def326de4dcf.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYwODUxMTcsIm5iZiI6MTcyNjA4NDgxNywicGF0aCI6Ii81ODkyMDgxMC8yNTU3NjY0NTQtYTUzNjA3NWUtZWY3Ni00YTE0LTkzYzItZGVmMzI2ZGU0ZGNmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTExVDIwMDAxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTY0OTJkN2Y2Yjg1N2Q2MjhjNWNjMDZmZDg0YTlkYmMzNDk5YmU1MzY4YmUxMDZkYmE0ZDMyNjU5OWFhMjM0NzkmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Mfam1UPZrjhYYQzNgutTSp3-SEbjs-fi1bzVmtYLlWg)
Bottom X-Axis of Dashboard:
![Screen Shot 2023-07-24 at 9 56 38 PM](https://private-user-images.githubusercontent.com/58920810/255766469-ede1cac1-3391-4722-b689-900e575fdb13.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYwODUxMTcsIm5iZiI6MTcyNjA4NDgxNywicGF0aCI6Ii81ODkyMDgxMC8yNTU3NjY0NjktZWRlMWNhYzEtMzM5MS00NzIyLWI2ODktOTAwZTU3NWZkYjEzLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTExVDIwMDAxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTFiMzlhOWU0YTgwOTBjMTBiNDY4N2JiYjk1MDA4ZTgyMThhMTA2MmFjMzU5MTI3MGI3Nzk4ZmJiYTNjNmRjYmUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.AYric6BOw3HPCJWukot2AlpVJp3nXwWIPELF_fbriSM)
Interactive:
If you hover over each block, it will also highlight the file name, Site name, and correlation value.
![Screen Shot 2023-07-24 at 9 56 27 PM](https://private-user-images.githubusercontent.com/58920810/255766497-8e4fc6ea-15c2-404c-8a6f-ff763269c056.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjYwODUxMTcsIm5iZiI6MTcyNjA4NDgxNywicGF0aCI6Ii81ODkyMDgxMC8yNTU3NjY0OTctOGU0ZmM2ZWEtMTVjMi00MDRjLThhNmYtZmY3NjMyNjljMDU2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA5MTElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwOTExVDIwMDAxN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTQ1ODJjYWRlOGVhM2ViZTdiYjYwNGFjODhhZDU5NTMxOGZlM2I0MjY4YjJhZGRiZWJhYjc0NGVkNGFiMWQxYzMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.Fb2MgVNz78GwOLHN_W-j7vR-6zUEAdKpRzLM55BnVK8)