Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auth order spike #2372

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

Auth order spike #2372

wants to merge 10 commits into from

Conversation

gejohnston
Copy link
Member

@gejohnston gejohnston commented Nov 19, 2024

What It Does

This PR contains a design document proposing how Zowe clients could enable users to specify their own preferred order of authentication.

Certainly, the proposed approach should be the primary focus of reviews. Several secondary items to consider are:

  • I purposely chose to place this design document in the Zowe GitHub repository.

    • It is reasonable to allow interested, external people see the design of our open source app before it is implemented.
    • Even after implementation, we can point people to such a document as an easy way to explain how the app is intended to operate.
    • We can consider whether or not we want our future designs to follow this publicly-available approach.
  • This is a draft PR.

    • The last section has not been sufficiently investigated to ensure that we have a viable approach. My intention is to do that confirmation.
    • None-the-less, I think it would be good to review the early concepts to confirm whether it is even worth pursuing the details of the last section.
  • It will be easier to read the document from the repo than from the file diffs.
    https://github.com/zowe/zowe-cli/blob/auth-order-spike/docs/Design_for_selecting_auth_type.md

  • Alternatively, if you download the file and view it in the VSCode "Markdown Preview" window, you get a little splash of color which make some things easier to identify.

Review Checklist
I certify that I have:

  • Completed analysis and/or prototype of proposed software
  • Created stories for future implementation
  • updated the changelog

Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.27%. Comparing base (e684b78) to head (aa08d0b).

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #2372    +/-   ##
========================================
  Coverage   91.27%   91.27%            
========================================
  Files         638      638            
  Lines       18141    18141            
  Branches     3914     3805   -109     
========================================
  Hits        16559    16559            
  Misses       1581     1581            
  Partials        1        1            

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

Copy link
Member

@traeok traeok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know that the tests are failing, but I approve of the design document, hence my approval. Very comprehensive and covered any questions that I had throughout my review. Thanks Gene for writing this proposal.

Given the context of where the changes would need to be made and following up on our previous in-person discussion, we may be able to leverage the Config class for these new functions. ProfileInfo has access to the loaded, merged config instance, so we can leverage this in Zowe Explorer to get access to the authentication order for a given profile. It seems that ImperativeConfig.instance.config might also be valid at the time a CLI command is run, so it could be used to access the authentication order as part of building the session.

Copy link

sonarcloud bot commented Nov 25, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants