Implemented unix command #2515

likhithanimma1 · 2023-10-16T14:47:06Z

Proposed changes

Implemented "Issue Unix Command" feature in Zowe Explorer

Release Notes

Milestone:

Changelog:

Types of changes

What types of changes does your code introduce to Zowe Explorer?
Put an x in the boxes that apply

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Updates to Documentation or Tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This checklist will be used as reference for both the contributor and the reviewer

Further comments

JillieBeanSim · 2023-10-17T12:30:04Z

@likhithanimma1 shouldn't this point to the zowe:next branch?

likhithanimma1 · 2023-10-17T12:36:15Z

@likhithanimma1 shouldn't this point to the zowe:next branch?

Yes

packages/zowe-explorer/src/command/UnixCommandHandler.ts

+                    await Profiles.getInstance().checkCurrentProfile(profile);
+                }
+                if (Profiles.getInstance().validProfile !== ValidProfileEnum.INVALID) {
+                    session = ZoweExplorerApiRegister.getUssApi(profile).getSession();


packages/zowe-explorer/__tests__/__unit__/command/unixCommandHandler.unit.test.ts

+        failNotFound: false,
+    };
+
+    const profileTwo: imperative.IProfileLoaded = {


codecov · 2023-10-17T12:57:56Z

Codecov Report

Attention: 17 lines in your changes are missing coverage. Please review.

Comparison is base (14b3734) 92.95% compared to head (d195934) 92.91%.
Report is 2 commits behind head on next.

Files	Patch %	Lines
...es/zowe-explorer/src/command/UnixCommandHandler.ts	89.82%	17 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #2515      +/-   ##
==========================================
- Coverage   92.95%   92.91%   -0.04%     
==========================================
  Files         108      109       +1     
  Lines        9898    10083     +185     
  Branches     2053     2107      +54     
==========================================
+ Hits         9201     9369     +168     
- Misses        696      713      +17     
  Partials        1        1

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

Signed-off-by: Likhitha Nimma <[email protected]>

packages/zowe-explorer/i18n/sample/src/command/UnixCommandHandler.i18n.json

packages/zowe-explorer/src/command/UnixCommandHandler.ts

Signed-off-by: Likhitha Nimma <[email protected]>

Requested changes have been addressed

Signed-off-by: Likhitha Nimma <[email protected]>

JillieBeanSim

Leaving some comments here after looking over the code, still planning to test functionality.

I wonder if we should begin registering ssh profiles since it would be required to do UNIX cmds via zosmf profiles, as well as zftp profiles if we choose to add the functionality there too. This addition may be out of scope for this PR though.

CodeCov warnings that can be addressed should be, like the unused variable notifications.

Should we have a limit on stored commands, some items stored in history use the global values for save limit. Also, should we make the different types of commands have their own history so we don't see MVS & TSO commands from history show with the UNIX commands?
This could also be handled in a separate PR but wanted to bring it up for discussion.

packages/zowe-explorer-api/src/extend/interfaces.ts

packages/zowe-explorer-api/CHANGELOG.md

packages/zowe-explorer/CHANGELOG.md

Signed-off-by: Billie Simmons <[email protected]>

Signed-off-by: Likhitha Nimma <[email protected]>

JillieBeanSim

This LGTM! thanks @likhithanimma1 for adding this awesome feature for v3 and thanks for addressing all our concerns and requests

Signed-off-by: Likhitha Nimma <[email protected]>

JillieBeanSim · 2023-11-20T19:17:35Z

packages/zowe-explorer/CHANGELOG.md

+
+## TBD Release
+
+- Added the Issue UNIX Commands feature. [#1326](https://github.com/zowe/vscode-extension-for-zowe/issues/1326)


can we get this changelog moved to top of file please

Yes moved to the top

traeok

Thanks for addressing the missing ssh profiles from the quick pick @likhithanimma1! I'm now seeing the ssh profiles in that list as expected.

However, after selecting my SSH profile and entering a path, an error dialog appears saying that Zowe Explorer tried to call a non-existing Common API:

t1m0thyj

@likhithanimma1 Thanks for implementing this new feature 🙂

A few comments:

In the quickpick I would expect z/OSMF profiles to be excluded from the list:

I think we can use ProfileManagement.getRegisteredProfileNameList to filter the profile list, but his may depend on Check if profile is registered to tree the action relies on for quickpick list #2539 which is being merged into "next" in [next] Merge from maintenance with 2.12.1 & 2.12.2 #2588.
For the path prompt, can we make entering a path optional? If no path is entered, we could default to the user home directory (~) which matches the behavior of SSH.

zFernand0 · 2023-11-21T10:51:38Z

In the quickpick I would expect z/OSMF profiles to be excluded from the list

I agree with that. Maybe we can add those back whenever we leverage the z/OSMF APIs for dealing with z/OS Unix commands

Signed-off-by: Likhitha Nimma <[email protected]>

sonarcloud · 2023-11-30T19:46:38Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

JillieBeanSim

LGTM! Thanks @likhithanimma1 for this new functionality and for addressing all of the feedback

adam-wolfe · 2023-11-30T20:59:15Z

All I see are zosmf profiles in the quick pick despite having a team config that contains ssh profiles:

If I select one of the zosmf profiles, I am still able to issue Unix commands.

JillieBeanSim · 2023-11-30T21:11:27Z

All I see are zosmf profiles in the quick pick despite having a team config that contains ssh profiles: If I select one of the zosmf profiles, I am still able to issue Unix commands.

The Profile seen in the list when going through the command palette are profiles registered with the UNIX files tree view that the action is driven from. The functionality here uses the default ssh profile, which is a good starting point and can be expanded in separate PRs to bring in capability to support a choice from multiple ssh profiles if available.

Extenders may not require the ssh profile, and why this includes an additional API for profile types that do require the assistance of the ssh profile to complete the action. This is the logic behind the choice of profile registered with the tree similar to issuing a TSO command that zosmf requires the TSO profile.

traeok · 2023-12-01T18:20:39Z

The Profile seen in the list when going through the command palette are profiles registered with the UNIX files tree view that the action is driven from. The functionality here uses the default ssh profile, which is a good starting point and can be expanded in separate PRs to bring in capability to support a choice from multiple ssh profiles if available.

I think it makes sense to offer the profile selection as a future enhancement - since the current logic selects the default SSH profile regardless of what a user chooses in this quick pick, can we hide/comment this out until profile selection is supported? The quick pick might inspire confusion from end users if it doesn't respect their selection.

JillieBeanSim · 2023-12-01T20:53:21Z

The Profile seen in the list when going through the command palette are profiles registered with the UNIX files tree view that the action is driven from. The functionality here uses the default ssh profile, which is a good starting point and can be expanded in separate PRs to bring in capability to support a choice from multiple ssh profiles if available.

I think it makes sense to offer the profile selection as a future enhancement - since the current logic selects the default SSH profile regardless of what a user chooses in this quick pick, can we hide/comment this out until profile selection is supported? The quick pick might inspire confusion from end users if it doesn't respect their selection.

@traeok this profile quick pick is offered when the user chooses to issue command from the command palette. Yes if only using zosmf profiles it seems redundant but if using an extender profile, the extender may not have the api yet or the extender doesn't require ssh connection to issue unix command. There are a lot of variables when looking at it from an extender's pov. Also, the procedure follows other issue command procedures from the command palette like TSO & MVS.

This PR has the basic functionality with extender's in mind and can be built upon in future, progress over perfection especially with the v3 work. With future PRs we can add checks and handling of multiple ssh profiles, we can even update the procedure to check for extender types and if only zosmf profiles or all types require ssh profile then proceed with default or offer ssh profile option. There are many ways to build on top of this work, but it's good to go ahead and get basic functionality in.

traeok

@JillieBeanSim Thank you for clarifying on extenders, I did not fully realize the scenario for extenders that do not require SSH for Unix commands.

Since a default SSH profile would be a pre-requisite for profile types that don't support UNIX commands out of the box, we might want to mention this behavior in Zowe Docs for awareness. Otherwise users might try to execute Unix commands through a z/OSMF profile without having a default SSH profile set in their config.

I also realize that there is still a good bit of time before v3 GA, so the behavior or UX may change in the future.

@anaxceron tagging for reference regarding v3 readiness/feature doc 😅

Thanks @likhithanimma1 for this feature & addressing the feedback! Tested and working as expected, this is an awesome addition for v3 😋 LGTM

feedback addressed

likhithanimma1 changed the base branch from main to next October 17, 2023 12:42

github-advanced-security bot found potential problems Oct 17, 2023

View reviewed changes

JillieBeanSim added this to the v3 pre-release 2 milestone Oct 17, 2023

likhithanimma1 marked this pull request as draft October 17, 2023 17:42

UnixImplementation

29467b8

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 force-pushed the Issue-Unix-Command branch from a34145c to 29467b8 Compare October 18, 2023 09:51

likhithanimma1 marked this pull request as ready for review October 18, 2023 09:53

Linting fixed

f5dceac

Signed-off-by: Likhitha Nimma <[email protected]>

zFernand0 requested review from zFernand0, traeok, JillieBeanSim and rudyflores October 18, 2023 20:24

Changelog Updated

ee1b9f0

Signed-off-by: Likhitha Nimma <[email protected]>

adam-wolfe previously requested changes Oct 20, 2023

View reviewed changes

Updated the UnixCommandHandlerfile

982399a

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 requested a review from adam-wolfe October 20, 2023 17:16

likhithanimma1 added 4 commits October 24, 2023 15:01

Updated with Unit Testing

c5e1ad7

Signed-off-by: Likhitha Nimma <[email protected]>

Included test in init file

fa3c3ea

Signed-off-by: Likhitha Nimma <[email protected]>

Updated UnixFile

0cb79d7

Signed-off-by: Likhitha Nimma <[email protected]>

code coverage

484b47b

Signed-off-by: Likhitha Nimma <[email protected]>

JillieBeanSim reviewed Oct 30, 2023

View reviewed changes

packages/zowe-explorer-api/src/extend/interfaces.ts Outdated Show resolved Hide resolved

packages/zowe-explorer-api/CHANGELOG.md Outdated Show resolved Hide resolved

packages/zowe-explorer/CHANGELOG.md Outdated Show resolved Hide resolved

JillieBeanSim and others added 3 commits October 30, 2023 08:06

Merge branch 'next' into Issue-Unix-Command

0354c0a

Signed-off-by: Billie Simmons <[email protected]>

Change in api interface and changelog

4d2f40e

Signed-off-by: Likhitha Nimma <[email protected]>

Linting Fixed

f88cebf

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 requested a review from JillieBeanSim November 2, 2023 15:00

tests modified

4ef6c1f

Signed-off-by: Likhitha Nimma <[email protected]>

Conflicts Resolved

9b6b045

Signed-off-by: Likhitha Nimma <[email protected]>

JillieBeanSim previously approved these changes Nov 20, 2023

View reviewed changes

Changelog modified

da72a7b

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 dismissed JillieBeanSim’s stale review via da72a7b November 20, 2023 19:13

JillieBeanSim self-requested a review November 20, 2023 19:14

JillieBeanSim approved these changes Nov 20, 2023

View reviewed changes

JillieBeanSim requested changes Nov 20, 2023

View reviewed changes

traeok requested changes Nov 20, 2023

View reviewed changes

t1m0thyj previously requested changes Nov 20, 2023

View reviewed changes

likhithanimma1 requested a review from JillieBeanSim November 21, 2023 13:26

likhithanimma1 added 6 commits November 22, 2023 22:11

Merge remote-tracking branch 'zowe/next' into Issue-Unix-Command

22da2b7

Changelog and optional path updated

28ea8e6

Signed-off-by: Likhitha Nimma <[email protected]>

Linting Fixed

1677a4c

Signed-off-by: Likhitha Nimma <[email protected]>

Code Coverage

d1f4cbe

Signed-off-by: Likhitha Nimma <[email protected]>

Coverage

faf156f

Signed-off-by: Likhitha Nimma <[email protected]>

tests modified

92d040c

Signed-off-by: Likhitha Nimma <[email protected]>

likhithanimma1 requested review from t1m0thyj and traeok November 23, 2023 11:47

likhithanimma1 and others added 2 commits November 26, 2023 13:07

Modified Actions to InputPath

42bf71e

Signed-off-by: Likhitha Nimma <[email protected]>

Merge branch 'next' into Issue-Unix-Command

d195934

JillieBeanSim approved these changes Nov 30, 2023

View reviewed changes

traeok approved these changes Dec 1, 2023

View reviewed changes

JillieBeanSim merged commit 8571be2 into zowe:next Dec 1, 2023
23 of 24 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implemented unix command #2515

Implemented unix command #2515

likhithanimma1 commented Oct 16, 2023

JillieBeanSim commented Oct 17, 2023

likhithanimma1 commented Oct 17, 2023

codecov bot commented Oct 17, 2023 •

edited

Loading

JillieBeanSim left a comment

JillieBeanSim left a comment

JillieBeanSim Nov 20, 2023

likhithanimma1 Nov 23, 2023

traeok left a comment •

edited

Loading

t1m0thyj left a comment

zFernand0 commented Nov 21, 2023

sonarcloud bot commented Nov 30, 2023

JillieBeanSim left a comment

adam-wolfe commented Nov 30, 2023 •

edited by JillieBeanSim

Loading

JillieBeanSim commented Nov 30, 2023 •

edited

Loading

traeok commented Dec 1, 2023 •

edited

Loading

JillieBeanSim commented Dec 1, 2023 •

edited

Loading

traeok left a comment •

edited

Loading


		## TBD Release

		- Added the Issue UNIX Commands feature. [#1326](https://github.com/zowe/vscode-extension-for-zowe/issues/1326)

Implemented unix command #2515

Implemented unix command #2515

Conversation

likhithanimma1 commented Oct 16, 2023

Proposed changes

Release Notes

Types of changes

Checklist

Further comments

JillieBeanSim commented Oct 17, 2023

likhithanimma1 commented Oct 17, 2023

codecov bot commented Oct 17, 2023 • edited Loading

Codecov Report

JillieBeanSim left a comment

Choose a reason for hiding this comment

JillieBeanSim left a comment

Choose a reason for hiding this comment

JillieBeanSim Nov 20, 2023

Choose a reason for hiding this comment

likhithanimma1 Nov 23, 2023

Choose a reason for hiding this comment

traeok left a comment • edited Loading

Choose a reason for hiding this comment

t1m0thyj left a comment

Choose a reason for hiding this comment

zFernand0 commented Nov 21, 2023

sonarcloud bot commented Nov 30, 2023

JillieBeanSim left a comment

Choose a reason for hiding this comment

adam-wolfe commented Nov 30, 2023 • edited by JillieBeanSim Loading

JillieBeanSim commented Nov 30, 2023 • edited Loading

traeok commented Dec 1, 2023 • edited Loading

JillieBeanSim commented Dec 1, 2023 • edited Loading

traeok left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Oct 17, 2023 •

edited

Loading

traeok left a comment •

edited

Loading

adam-wolfe commented Nov 30, 2023 •

edited by JillieBeanSim

Loading

JillieBeanSim commented Nov 30, 2023 •

edited

Loading

traeok commented Dec 1, 2023 •

edited

Loading

JillieBeanSim commented Dec 1, 2023 •

edited

Loading

traeok left a comment •

edited

Loading