System tests should cleanup after themselves

[ATorrise]

What It Does
This PR enhances the test framework to simplify and automate the cleanup of test resources, such as datasets, USS files, jobs, and local files. The TestEnvironment, ITestEnvironment, and TestUtils classes have been updated to track and delete resources after system tests, preventing any leftover artifacts on the mainframe or local filesystem.

How to Test : Run System Tests

• Execute the system tests as usual. Verify that all created resources (datasets, USS files, jobs, local files) are automatically cleaned up after the tests complete.
• Ensure that no traces of jobs, USS files, or datasets are left behind on the mainframe.

Review Checklist
I certify that I have:

• tested my changes
• added/updated automated tests
• updated the changelog
• followed the contribution guidelines

Additional Comments

• Test Stability
  • Occasionally, environment-specific issues may arise, especially with test datasets like IEFBR14 files. I'm not sure how to rectify this and definitely need areas using these files double-checked.
• Unchanged Files:
  • zowe-cli\packages\zosjobs\__tests__\__system__\MonitorJobs.system.test.ts only had minor indentation changes and was left intact as it leaves no jobs behind on the mainframe.
  • If a test file cleans up all resources, it was left without changes to avoid unnecessary modifications since most of these test files are large and would require many lines of renovations.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.26%. Comparing base (53e863d) to head (7f50352).
Report is 104 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff            @@
##           master    #2216    +/-   ##
========================================
  Coverage   91.26%   91.26%            
========================================
  Files         628      628            
  Lines       17821    17821            
  Branches     3715     3820   +105     
========================================
  Hits        16264    16264            
  Misses       1556     1556            
  Partials        1        1            

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Changes requested were addressed 😋

[zFernand0]

Final requested changes, I promise. 😓
And we can determine if we want to address them here, or in a future PR 😅

As it stands, there are a few system tests failing with this branch. 😢

Happy to discuss specifics offline 😋

[gejohnston]

I am unable to find any concern beyond what others have already raised.

There are so many file changes it is difficult to identify new-common-cleanup logic from many test fixes and test additions. If there is an opportunity, maybe sometime you can walk me through the fundamental changes that enable common-cleanup.

[zFernand0]

This is looking good 🙏🏽

just a few final items and we should be good to go 🥳

---

For those reviewing, this is a quick link with the changes since the last time that changes where requested.
https://github.com/zowe/zowe-cli/pull/2216/files/201ecc185d4bd31e0477231ea562e6cac4cf63c9..9de05a22fa6e78c334b3cac2943b64aad5d085c1?diff=unified&w=1

[zFernand0]

it seems that we don't always need to assign real_session.
TEST_ENVIRONMENT.resources.session = REAL_SESSION;

Curious what might be the consequences. 🤔
Happy to look into it this afternoon in more detail 🙏🏽

[zFernand0]

I think that grouping everything in a single describe might be beneficial here. 😋
This suggestion applies to many test files in this PR 😓
Not a hard requirement though. 🥳

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud