Tokens #412

gejohnston · 2020-06-11T19:57:17Z

Add token handling capabilities and prompting for missing connection options.

Each round of changes were previously reviewed as PRs from other feature branches into this tokens branch.

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Signed-off-by: Jack (T.) Jia <jack-tiefeng.jia@ibm.com>

Switch to SonarCloud

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

[next] Use new Zowe artifactory and fix yargs vulnerability

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

* adding generic GET and PUT methods returning full response - response can be tailored - created needed interfaces Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * - `extractExpectedData` now returns full `client` object as default - `getFull` and `putFull` now returns only one type, i.e. `IRestClientResponse` Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * adding methods for post and delete Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * - remove unneeded comments - refactor according to new naming - changed `performRest` into a wrapper for `performRestCall` - marked `performRest` as deprecated Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * Get build to pass with latest yargs Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Get help and version commands to work with new yargs Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix undefined value error in plugin (un)install handlers Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix undefined error that was missed in plugin install handler Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Update Yargs on the other package.json files Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com> * Hopefully fix cmd cli integration tests Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Make linter happy and update Keytar in test CLIs Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Simplify code to obtain command line text Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix missing keytar dep in imperative-test-cli Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Bump version to 4.4.5 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Fix unit tests for Node 12 Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix integration tests for Node 12 Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Update yargs to 15.1.0 Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * adding few unit tests Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * add specific version regarding depreciation of AbstractRestClient method Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * fix lint issue regarding shadowed variable Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * update unit test switch from snapshot verification to checking if values are defined or not Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * linting again :P Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * Fix several formatting issues in web help HTML Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix script errors in Edge and print button alignment Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Remove unnecessary snapshots from tests Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix line breaks getting lost during Markdown to HTML conversion Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Bump version to 4.4.6 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Bump version to 4.4.7 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * addressing comments on PR #348 - change name from `performRestCall` to `request` - remove useless interface `IFullResponseOptions` - rename interface from `IOptionsFullRequest` to `IOptionsFullResponse` since it defines input options related to fullResponse expects - added missing tydoc information - Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * fix linting Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * update unit test following Interface name change Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * - added more unit tests - moved deprecation message to the top - updated all restClient methods to call .request() instead of .performRest() Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * remove unnecessary comments Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * skipped a few comments :( hopefully this time all are gone Signed-off-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> * Update Jenkinsfile Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Add missing colon. Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com> * Bump version to 4.5.0 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Mirror master branch to zowe-v1-lts Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Exported IRestOptions in packages/rest/index.ts Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Made the new changes Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Changed the type of symlink from dir to junction Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Resolved the error Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Revert "Resolved the error" This reverts commit ae326ef. Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Resolved the type of symlink Signed-off-by: Megha Kumari <meghajais.mj@hotmail.com> * Don't load secure profile fields when deleting profile Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Allow specifying secure values as optional to ignore when they are missing Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Add unit tests around loading optional secure fields Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Bump version to 4.5.1 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Bump version to 4.5.2 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Update changelog for zowe-v1-lts Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Update contribution guidelines Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Fix breaking change listed in changelog for v4 Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * fixed alignment Signed-off-by: mheuzey <michael.heuzey@gmail.com> * Add changelog automation Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com> * Updating dependencies [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Bump version to 4.5.3 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Fix vulnerabilities and remove unnecessary mkdirp dependency Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Update package-lock and remove for test CLIs Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Update changelog Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Remove lines parameter for changelog stages in pipeline Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Remove lines parameter for changelog stages in pipeline Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com> * Bump version to 4.5.4 [ci skip] Signed-off-by: zowe-robot <zowe.robot@gmail.com> * Update Changelog [ci skip] Co-authored-by: Alexandru-Paul Dumitru <alexandru.dumitru@broadcom.com> Co-authored-by: Andrew W. Harn <andrew.harn@broadcom.com> Co-authored-by: zowe-robot <zowe.robot@gmail.com> Co-authored-by: Fernando Rijo Cedeno <fernando.rijocedeno@broadcom.com> Co-authored-by: Megha Kumari <meghajais.mj@hotmail.com> Co-authored-by: mheuzey <michael.heuzey@gmail.com> Signed-off-by: zFernand0 <fernando.rijocedeno@broadcom.com>

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Signed-off-by: BrandonJenkins14 <36675406+BrandonJenkins14@users.noreply.github.com>

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

…into token-help-text

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Implement UX changes for tokens

that were used to enable zowe-cli to build with an unpublished imperative.. Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Remove build hacks

codecov · 2020-06-11T20:11:30Z

Codecov Report

Merging #412 into master will increase coverage by 0.58%.
The diff coverage is 90.94%.

@@            Coverage Diff             @@
##           master     zowe/imperative#412      +/-   ##
==========================================
+ Coverage   81.02%   81.61%   +0.58%     
==========================================
  Files         150      157       +7     
  Lines        7241     7635     +394     
  Branches     1286     1378      +92     
==========================================
+ Hits         5867     6231     +364     
- Misses       1370     1400      +30     
  Partials        4        4

Impacted Files	Coverage Δ
...imperative/src/plugins/PluginManagementFacility.ts	`92.77% <ø> (ø)`
...e/src/plugins/utilities/npm-interface/uninstall.ts	`93.10% <ø> (ø)`
...ive/src/profiles/handlers/CreateProfilesHandler.ts	`5.26% <ø> (ø)`
...es/imperative/src/auth/handlers/BaseAuthHandler.ts	`67.10% <67.10%> (ø)`
packages/rest/src/client/AbstractRestClient.ts	`79.74% <81.81%> (+0.08%)`	⬆️
packages/utilities/src/CliUtils.ts	`84.37% <82.05%> (-0.89%)`	⬇️
packages/cmd/src/profiles/CliProfileManager.ts	`96.05% <83.33%> (+0.03%)`	⬆️
packages/imperative/src/DefinitionTreeResolver.ts	`95.34% <90.90%> (-1.80%)`	⬇️
packages/cmd/src/profiles/CommandProfileLoader.ts	`97.93% <92.30%> (-0.89%)`	⬇️
packages/cmd/src/CommandPreparer.ts	`96.82% <93.75%> (-0.35%)`	⬇️
... and 25 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12fe1c4...23ed18f. Read the comment docs.

zFernand0

Overall looks great!
Left a few comments but nothing that needs addressed here.

CHANGELOG.md

package.json

packages/cmd/src/CommandProcessor.ts

packages/rest/src/session/AbstractSession.ts

packages/imperative/src/auth/builders/AuthLogoutCommandBuilder.ts

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

ghost

Looks good overall! Left a few comments, nothing that necessarily needs to be changed.

CHANGELOG.md

packages/cmd/src/doc/profiles/definition/ICommandProfileAuthCommand.ts

ghost · 2020-06-12T13:57:50Z

packages/rest/src/session/AbstractSession.ts

+            } else {
+                throw new ImperativeError({
+                    msg: "Must have user & password OR base64 encoded credentials",
+                    additionalDetails: "For CLI usage, see '<your-cli> auth login <service> --help'"


This message makes sense below where the session type is SessConstants.AUTH_TYPE_TOKEN. In this case when session type is SessConstants.AUTH_TYPE_BASIC, should the message be changed to the following?
For CLI usage, see '<your-cli> profiles create <service> --help'

I agree that the message should be changed to something that deals with basic auth. That looks good to me, but we may want to quickly see what doc or UX think.

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

sonarcloud · 2020-06-12T16:38:18Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 2 Security Hotspots to review)
0 Code Smells

84.9% Coverage
0.0% Duplication

The version of Java (1.8.0_212) you have used to run this analysis is deprecated and we will stop accepting it from October 2020. Please update to at least Java 11.
Read more here

awharn

Looks good to me, once the comments above are resolved.

dkelosky and others added 30 commits October 29, 2019 21:39

parse token and add type to cookier

bf18ff1

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

Fix #37

fb7941b

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

remove token from basic auth check

e504317

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

pass IProfileLoaded to commands

a138f5e

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

get base64 credentials

2c0e7ae

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

fix #316

f8e0292

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

typo

d25531e

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

correctly obtain token value

694882c

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

use new typings

2fd92c7

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

pipeline updates for branch

f69f024

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

update api method name

63a3dc4

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

node 12 typings

a3829ff

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

revert loader change

577bf5e

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

add a note for CLI users

652682f

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

stage in next branch

4aafa31

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

eliminate unused function

3d47c18

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

lint fix

f7e43b3

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

here i go again

b581ab4

Signed-off-by: Dan Kelosky <dkelosky@gmail.com>

Updating dependencies [ci skip]

7e793b9

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Bump version to 5.0.0-next.201911011856 [ci skip]

76cd7db

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Switch to SonarCloud

51f77ac

Signed-off-by: Jack (T.) Jia <jack-tiefeng.jia@ibm.com>

rename stage

37b9417

Signed-off-by: Jack (T.) Jia <jack-tiefeng.jia@ibm.com>

Merge pull request #331 from zowe/users/jack/sonarcloud-next

a54eee8

Switch to SonarCloud

Update to Zowe artifactory and get building with Node 12

fe6bd53

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Merge branch 'master' into fix-next

5e335d4

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Merge pull request #351 from zowe/fix-next

65788e7

[next] Use new Zowe artifactory and fix yargs vulnerability

Updating dependencies [ci skip]

83091d8

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Bump version to 5.0.0-next.202001151750 [ci skip]

4762405

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

Bump version to 5.0.0-next.202003262002 [ci skip]

fb579b9

Signed-off-by: zowe-robot <zowe.robot@gmail.com>

t1m0thyj and others added 13 commits June 10, 2020 13:00

Fix code smell

42f66ec

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

very minor grammar

b2a1e31

Signed-off-by: BrandonJenkins14 <36675406+BrandonJenkins14@users.noreply.github.com>

Update failing test

14405c8

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

More test fixes

3689d5a

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Another wording update.

3cf5a48

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Remove word per Brandon's suggestion

ba444df

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Merge branch 'token-help-text' of https://github.com/zowe/imperative …

54ba7f5

…into token-help-text

Update text again to fix tests.

b61c8c4

Signed-off-by: Andrew W. Harn <andrew.harn@broadcom.com>

Merge pull request #410 from zowe/token-help-text

3b23252

Implement UX changes for tokens

Remove temporary build modifications

656e113

that were used to enable zowe-cli to build with an unpublished imperative.. Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Update changelog.

0bf1f9d

Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Doc new ConnectionPropsForSessCfg.addPropsOrPrompt

552166d

Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Merge pull request #411 from zowe/remove_build_hacks

e2b3716

Remove build hacks

gejohnston requested review from awharn, dkelosky, a user and zFernand0 June 11, 2020 20:02

zFernand0 approved these changes Jun 12, 2020

View reviewed changes

Remove commented code

4fd13f1

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

ghost approved these changes Jun 12, 2020

View reviewed changes

t1m0thyj and others added 4 commits June 12, 2020 10:11

Fix Imperative unit test

f6eee40

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Added comments to changelog for various feature changes.

617fb90

Signed-off-by: Gene Johnston <eugene.johnston@broadcom.com>

Add IPartialCommandDefinition interface

808f12d

Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>

Merge branch 'tokens' of https://github.com/zowe/imperative into tokens

23ed18f

awharn approved these changes Jun 12, 2020

View reviewed changes

gejohnston merged commit be08769 into master Jun 12, 2020

gejohnston deleted the tokens branch June 12, 2020 17:31

ghost mentioned this pull request Jun 18, 2020

Enhancement: Login and logout commands for auth services #405

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tokens #412

Tokens #412

gejohnston commented Jun 11, 2020

codecov bot commented Jun 11, 2020 •

edited

Loading

zFernand0 left a comment

ghost left a comment

ghost Jun 12, 2020

awharn Jun 12, 2020

sonarcloud bot commented Jun 12, 2020

awharn left a comment

Tokens #412

Tokens #412

Conversation

gejohnston commented Jun 11, 2020

codecov bot commented Jun 11, 2020 • edited Loading

Codecov Report

zFernand0 left a comment

Choose a reason for hiding this comment

ghost left a comment

Choose a reason for hiding this comment

ghost Jun 12, 2020

Choose a reason for hiding this comment

awharn Jun 12, 2020

Choose a reason for hiding this comment

sonarcloud bot commented Jun 12, 2020

awharn left a comment

Choose a reason for hiding this comment

codecov bot commented Jun 11, 2020 •

edited

Loading