zowe/zowe-explorer-vscode

FTP: Add test coverage for two remaining uncovered API methods

Open

#2,989 opened on Jul 5, 2024

View on GitHubContributor guide
 (2 comments) (1 reaction) (0 assignees)TypeScript (119 forks)auto 404
Technical Debtenhancementhelp wantedkeeppriority-low

Repository metrics

Stars
 (189 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe.

For V2 compliance, there is a best practice to implement tests for all API methods. For the V2 FTP extension, two uncovered functions remain in /packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpJesApi.ts: https://github.com/zowe/zowe-explorer-vscode/blob/a2cff84ae183a23dd95c375ff19ddf240cffc91a/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpJesApi.ts#L200 https://github.com/zowe/zowe-explorer-vscode/blob/a2cff84ae183a23dd95c375ff19ddf240cffc91a/packages/zowe-explorer-ftp-extension/src/ZoweExplorerFtpJesApi.ts#L204

The functions in question simply throw errors, so unit tests would have limited value; and, for compliance, this is only a best practice, not a requirement.

Describe the solution you'd like

Add unit test for these functions.

Describe alternatives you've considered

Additional context

Contributor guide

Research direction
Write unit tests for the two uncovered functions in ZoweExplorerFtpJesApi.ts that throw errors. Use Jest to verify the functions throw the expected error type and message.
Tech stack
typescriptnodejs
Domain
backendtesting qa
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsJest
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80