UW Strangler Façade Release Requirements

[WeirAE]

The requirements for releasing the strangler façade should largely reflect the requirements for the UW standalone tools, with some additions.

• The facade should meet, at minimum, existing requirements/tests as implemented in the host App/component.
• There should be some way to warn the user or fail when a known invalid entry is provided.
• Supported conda environments should be installed on all the standard platforms before UW can be adopted by a host App/component.
• Inclusion of the facade will be through the relevant externals management system of the host App/component -- git submodules or manage externals.
• Test suite should capture any of the existing test cases included in host App/component.
• The façade should include and handle existing logging and error handling of the app, as well as the internal tools

Specifics of the strangler façade first release:

• We need to be able to run the apps as currently configured with no perceptible difference
• We need to include the foundations of a service 'switch' that will allow us to use the facade exclusively without removing any existing code
• We also need to ensure the tools called are externally exposed so the apps can integrate them on their own

The primary goal here is to identify any missing requirements as well as any potential open-ended items, so any suggestions are greatly appreciated. Additionally, we'll need to document any necessary changes to the RDHPCS conda environments and provide a strategy for supporting versioning them.

See also Applying the Strangler Fig Pattern to UFS Apps as well as Implementation of a Service Oriented Architecture Façade

External Testing Instructions

For each line in the table, the External Tester listed should:

1. Test the release to confirm the changes work as expected.
2. ON THE ISSUE ITSELF: Document their testing with a comment using the template provided below.
3. ON THIS DISCUSSION: Add a comment linking to their issue comment created above.

Copy/paste the following template into your ISSUE COMMENT:

<h3>Release Acceptance Testing Summary</h3>

Date:
Platform/Location:
Status (PASS/FAIL):
Notes:

The External Tester is set to NA for any issues that do not require external acceptance testing.

SRW (config.yaml)

Description	Tester	Platform	Status (OPEN/PASS/FAIL)	Link to Acceptance Testing Comment
Load a YAML config file and generate necessary SRW config files (config.yaml)	NA	Hera	NA
Validate the generated config file	NA	Hera	NA
Create the experiment directory	NA	Hera	NA
Create workflow manager files	NA	Hera	NA
Link fix files	NA	Hera	NA

Global Workflow (config.base)

Description	Tester	Platform	Status (OPEN/PASS/FAIL)	Link to Acceptance Testing Comment
Load a YAML config file and generate necessary GW config files (config.base)	NA	Hera	NA
Validate the generated config file	NA	Hera	NA
Create the experiment directory	NA	Hera	NA
Create workflow manager files	NA	Hera	NA

HAFS (hafs.conf)

Description	Tester	Platform	Status (OPEN/PASS/FAIL)	Link to Acceptance Testing Comment
Load a YAML config file and generate necessary HAFS config files (hafs.conf)	NA	Hera	NA
Validate the generated config file	NA	Hera	NA
Create the experiment directory	NA	Hera	NA
Create workflow manager files	NA	Hera	NA