Add Golden Copy Tests #1674

pluckyswan · 2024-12-23T21:19:08Z

Description

Added golden copy test to RS-E2E tests. The golden copy workflow will take the input files and submit them through the workflow. Then, it will fetch the output from Azure and compare them to the expected files. This utilizes the existing automated staging test submit workflow to send all files and adds a new run workflow specific to golden copy test.

Issue

#1600

Checklist

I have added tests to cover my changes
I have added logging where useful (with appropriate log level)
I have updated the documentation accordingly

Note: You may remove items that are not applicable

Co-Authored-By: Sylvie <[email protected]> Co-Authored-By: Samuel Aquino <[email protected]>

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

Co-authored-by: saquino0827 <[email protected]>

Co-authored-by: saquino0827 <[email protected]> Co-authored-by: Sylvie <[email protected]> Co-authored-by: jcrichlake <[email protected]>

Co-authored-by: jcrichlake <[email protected]>

…structure Co-authored-by: jcrichlake <[email protected]>

Co-authored-by: jcrichlake <[email protected]>

Co-authored-by: jcrichlake <[email protected]> Co-authored-by: James Herr <[email protected]>

Co-authored-by: James Herr <[email protected]> Co-authored-by: jcrichlake <[email protected]>

Co-authored-by: James Herr <[email protected]>

github-actions · 2024-12-23T21:20:12Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶 1600 - Partially compliant Fully compliant requirements: Modify automated staging test workflows (submit and run). Create test. Add input and expected files. Update/add README. Not compliant requirements: Every validation message from the UCSD implementation is tested as defined in the provided spreadsheet. Golden copy tests failing do not impact whether or not existing RS e2e test will run, and vice versa. Possible modify cron schedule if needed for golden copy. Add new receivers in RS. Test.
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Environment Variable Dependency The code heavily relies on the 'LOCAL_FILE_PATH' environment variable without a fallback, which could lead to runtime errors if not set. String files_path = System.getenv("LOCAL_FILE_PATH"); if (files_path == null \|\| files_path.isEmpty()) { throw new IllegalArgumentException("Environment variable LOCAL_FILE_PATH is not set"); }

github-actions · 2024-12-23T21:20:12Z

rs-e2e/src/main/java/gov/hhs/cdc/trustedintermediary/rse2e/AzureBlobOrganizer.java

+                // when its pulled down and modify destinationName to be test folder specific
+                // possibly use a different receiver and filter on that
+
+                String testTypeAndSourceName = "Automated/" + sourceName;


Consider refactoring the blob naming and organizing logic into a separate method or class to improve modularity and testability. This change would help isolate the blob management logic, making the code cleaner and easier to maintain. [important]

github-actions · 2024-12-23T21:20:12Z

rs-e2e/src/test/groovy/gov/hhs/cdc/trustedintermediary/rse2e/GoldenCopyTest.groovy

+        for (filePair in matchedFiles) {
+            def actualFile = filePair.getKey()
+            def expectedFile = filePair.getValue()
+            if (!actualFile.equals(expectedFile)) {


Implement additional logging for each file comparison in the 'Compare files' test to provide more detailed feedback on which files are being compared and the result of each comparison. This enhancement would be beneficial for debugging and understanding test failures. [medium]

github-actions · 2024-12-23T21:20:13Z

rs-e2e/src/main/java/gov/hhs/cdc/trustedintermediary/rse2e/AzureBlobFileFetcher.java

+        if (files_path.contains("GoldenCopy")) {
+            pathPrefix += datePrefix + "GoldenCopy/";
+        }
+
        ListBlobsOptions options = new ListBlobsOptions().setPrefix(pathPrefix);


Add error handling for the Azure blob fetching process to manage exceptions and provide meaningful error messages if the fetching fails. This would improve the robustness of the file fetching mechanism. [important]

github-actions · 2024-12-23T21:20:57Z

PR Code Suggestions ✨

No code suggestions found for the PR.

Co-authored-by: James Herr <[email protected]> Co-authored-by: basiliskus <[email protected]>

Co-authored-by: basiliskus <[email protected]>

basiliskus · 2024-12-27T17:03:48Z

rs-e2e/src/main/java/gov/hhs/cdc/trustedintermediary/rse2e/AzureBlobFileFetcher.java

    @Override
    public List<HL7FileStream> fetchFiles() {
+        String files_path = System.getenv("LOCAL_FILE_PATH");


Just a reminder to add instructions to the readme on how to set up the LOCAL_FILE_PATH env var. You could also consider adding it to generate_env.sh

I didn't realize this changes are in AzureBlobFileFetcher. This class is meant only for blobs in Azure. To grab local files, the correct one is LocalFileFetcher

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]>

…rmediary into golden-tests

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Luis Pabon <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

sonarqubecloud · 2024-12-27T18:48:41Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

jherrflexion and others added 30 commits December 16, 2024 16:56

WIP Initial setup

07b96d1

add notes for later and initial setup/cleanup

2d14e9a

Added basic compare

f8afd54

Co-Authored-By: Sylvie <[email protected]> Co-Authored-By: Samuel Aquino <[email protected]>

Testing workflow dispatch

dad2cd3

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

Aded Golden tests to gradle

1d8877c

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

Adding Golden tests to Workflows

9b81688

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

Added fetch parameter

d4867f7

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

Removed comments

87dbc14

Co-Authored-By: Samuel Aquino <[email protected]> Co-Authored-By: Bella L. Quintero <[email protected]>

add input files and delete unused input files

5bef9f0

Co-authored-by: saquino0827 <[email protected]>

refactor file fetcher and implementation

83edb87

Co-authored-by: saquino0827 <[email protected]>

refactor file fetcher calls

084387d

add env to workflow and rename file path

1e49731

Co-authored-by: saquino0827 <[email protected]>

modify example files to be aligned with readme reqs

3de1187

move directory up one and fix file paths

ebe7a46

move golden copy to automated to get files after transformed

9605cc1

use correct syntax

f63c56c

Co-authored-by: saquino0827 <[email protected]>

make variables strings

de61fb5

Co-authored-by: saquino0827 <[email protected]>

add dollar sign to echo

96cae6c

Co-authored-by: saquino0827 <[email protected]>

try fixing format

e17f1e9

Co-authored-by: saquino0827 <[email protected]>

change syntax

0747ee8

Co-authored-by: saquino0827 <[email protected]>

remove line break at end of line in example files

bdbed53

Co-authored-by: saquino0827 <[email protected]> Co-authored-by: Sylvie <[email protected]> Co-authored-by: jcrichlake <[email protected]>

add double quotes to if statement

71a243d

Co-authored-by: jcrichlake <[email protected]>

add golden copy versions of example files and revert to og directory …

24e5ac3

…structure Co-authored-by: jcrichlake <[email protected]>

modify msh-10 header in example file

401c50f

Co-authored-by: jcrichlake <[email protected]>

fix syntax

229af63

Co-authored-by: jcrichlake <[email protected]>

remove breaks from example file

9485cda

Co-authored-by: jcrichlake <[email protected]> Co-authored-by: James Herr <[email protected]>

add example file

3c850de

Co-authored-by: James Herr <[email protected]> Co-authored-by: jcrichlake <[email protected]>

remove comment, add quotes to variable, and create workflow file

1f0dde2

Co-authored-by: James Herr <[email protected]>

remove done

d7623ae

Co-authored-by: James Herr <[email protected]>

remove unused workflow

92c039c

Co-authored-by: James Herr <[email protected]>

pluckyswan and others added 2 commits December 23, 2024 14:11

delete unused workflow

000d590

Co-authored-by: James Herr <[email protected]>

rename reusable workflow

06558f7

Co-authored-by: James Herr <[email protected]>

github-actions bot reviewed Dec 23, 2024

View reviewed changes

pluckyswan and others added 11 commits December 23, 2024 14:30

readd the og workflow and delete new one

0fba3fb

Co-authored-by: James Herr <[email protected]> Co-authored-by: basiliskus <[email protected]>

move folders around

a9cf564

Co-authored-by: James Herr <[email protected]> Co-authored-by: basiliskus <[email protected]>

fix file changes

7a13855

Co-authored-by: James Herr <[email protected]> Co-authored-by: basiliskus <[email protected]>

change file path

8ca3337

Co-authored-by: James Herr <[email protected]> Co-authored-by: basiliskus <[email protected]>

remove semi colon

5086197

Co-authored-by: basiliskus <[email protected]>

mess with pathing regex

85b11b6

Co-authored-by: basiliskus <[email protected]>

correct naming in workflow

17a5382

use correct inputs syntax

77d9c71

workflow fixes

b67cd88

pass secrets to workflow

7143562

fix file path and exclude from test

c87d402

pluckyswan temporarily deployed to internal December 24, 2024 19:20 — with GitHub Actions Inactive

pluckyswan temporarily deployed to internal December 24, 2024 19:23 — with GitHub Actions Inactive

pluckyswan deployed to internal December 24, 2024 19:26 — with GitHub Actions View deployment

remove incorrect expected files and replace input files

e6e7fbd

pluckyswan marked this pull request as draft December 27, 2024 16:46

Merge branch 'main' into golden-tests

4977b2f

basiliskus reviewed Dec 27, 2024

View reviewed changes

jherrflexion and others added 6 commits December 27, 2024 11:05

Fixed bad character

f5b1220

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]>

Merge branch 'golden-tests' of https://github.com/CDCgov/trusted-inte…

b0da8ac

…rmediary into golden-tests

Updated readme with env variable steps

870cfdb

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

Added pull_request to the workflow

4412f6e

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

Temp testing

59f0c1a

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

Added expected files for testing

8e9b069

Co-Authored-By: Bella L. Quintero <[email protected]> Co-Authored-By: Luis Pabon <[email protected]> Co-Authored-By: Jeremy Rosenfeld <[email protected]> Co-Authored-By: Basilio Bogado <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Golden Copy Tests #1674

Add Golden Copy Tests #1674

pluckyswan commented Dec 23, 2024 •

edited

Loading

github-actions bot commented Dec 23, 2024

github-actions bot Dec 23, 2024

github-actions bot Dec 23, 2024

github-actions bot Dec 23, 2024

github-actions bot commented Dec 23, 2024

basiliskus Dec 27, 2024

basiliskus Dec 27, 2024

sonarqubecloud bot commented Dec 27, 2024

Add Golden Copy Tests #1674

Are you sure you want to change the base?

Add Golden Copy Tests #1674

Conversation

pluckyswan commented Dec 23, 2024 • edited Loading

Description

Issue

Checklist

github-actions bot commented Dec 23, 2024

PR Reviewer Guide 🔍

github-actions bot Dec 23, 2024

Choose a reason for hiding this comment

github-actions bot Dec 23, 2024

Choose a reason for hiding this comment

github-actions bot Dec 23, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 23, 2024

PR Code Suggestions ✨

basiliskus Dec 27, 2024

Choose a reason for hiding this comment

basiliskus Dec 27, 2024

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 27, 2024

Quality Gate passed

pluckyswan commented Dec 23, 2024 •

edited

Loading