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.

Sign up for GitHub

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

Jump to bottom

--help fail on config json error #2301

Merged
merged 28 commits into from
Nov 8, 2024
Merged

--help fail on config json error #2301

merged 28 commits into from
Nov 8, 2024

Conversation

ATorrise
Copy link
Contributor

@ATorrise ATorrise commented Oct 9, 2024 •
edited
Loading

What It Does
Ensures users can still access the help documentation and version details, even when config files contain errors.

How to Test

  1. Create a zowe.config.json file with invalid JSON or syntax errors.
  2. Run a Zowe CLI command with the --help flag, ie: zowe zosmf --help
  3. Confirm that the help text is displayed with a warning about the invalid JSON.
  4. Run the same command without the --help flag to ensure it still fails as expected with a JSON error.

Review Checklist
I certify that I have:

@ATorrise
all needed changes to meet AC besides tests
99e5630 
Signed-off-by: ATorrise <amber.torrise@broadcom.com>
@ATorrise ATorrise linked an issue Oct 9, 2024 that may be closed by this pull request
Zowe commands with --help fail if config file cannot be parsed #2293
Closed
@codecov Codecov
Copy link

codecov bot commented Oct 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.17%. Comparing base (192a3d7) to head (672cac3).
Report is 29 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #2301      +/-   ##
==========================================
+ Coverage   91.15%   91.17%   +0.01%     
==========================================
  Files         636      636              
  Lines       18039    18052      +13     
  Branches     3879     3779     -100     
==========================================
+ Hits        16444    16459      +15     
+ Misses       1594     1592       -2     
  Partials        1        1

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

@ATorrise
changelog and codeql change
6a39c50 
Signed-off-by: ATorrise <amber.torrise@broadcom.com>
@ATorrise
still more tests to fix
1e84a49 
Signed-off-by: ATorrise <amber.torrise@broadcom.com>
@ATorrise ATorrise changed the title all needed changes to meet AC besides tests --help fail on config json error Oct 22, 2024
@ATorrise ATorrise marked this pull request as ready for review October 22, 2024 20:54
@ATorrise
linting
d978e0a 
Signed-off-by: Amber Torrise <amber.torrise@broadcom.com>
@ATorrise
removing tests because tests in command processor seem to be enough?
a307dd5 
Signed-off-by: Amber Torrise <amber.torrise@broadcom.com>
zFernand0
zFernand0 reviewed Oct 28, 2024
View reviewed changes
Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

A few tests failing, but changes LGTM! 😋

Curious if we agreed on having the error at the bottom of the output of towards the top.
Just seeing it in practice, someone could miss the error if they are viewing the help text 😋

packages/imperative/CHANGELOG.md Outdated Show resolved Hide resolved
packages/imperative/src/config/src/Config.ts Outdated Show resolved Hide resolved
packages/imperative/src/config/src/doc/IConfigLayer.ts Outdated Show resolved Hide resolved
zowe-cli Outdated Show resolved Hide resolved
packages/imperative/src/config/src/api/ConfigLayers.ts Outdated Show resolved Hide resolved
packages/imperative/src/config/src/api/ConfigLayers.ts Outdated Show resolved Hide resolved
t1m0thyj
t1m0thyj previously requested changes Oct 29, 2024
View reviewed changes
packages/imperative/src/cmd/__tests__/CommandProcessor.unit.test.ts Outdated Show resolved Hide resolved
packages/imperative/src/config/src/Config.ts Outdated Show resolved Hide resolved
packages/imperative/src/config/src/Config.ts Outdated Show resolved Hide resolved
ATorrise and others added 2 commits October 30, 2024 08:33
@ATorrise @zFernand0
Update packages/imperative/CHANGELOG.md
6387262 
Co-authored-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
Signed-off-by: Amber Torrise <112635587+ATorrise@users.noreply.github.com>
@ATorrise
attempting to fix unit test
0b3ebc9 
Signed-off-by: Amber Torrise <amber.torrise@broadcom.com>
@ATorrise
Copy link
Contributor Author

ATorrise commented Nov 5, 2024

was testing a revert to see if error in test persisted

adding a note so that theres less confusion when reviewing... i went back in my commit history locally by doing a git reset –soft [commit hash] to check if my failing tests were still failing. rather than deleting this local branch and re downloading from remote, i instead pushed all those changes back up, making several commits and merges look like 1 commit in an attempt to restore the progress made.

ATorrise and others added 4 commits November 5, 2024 10:24
@ATorrise @zFernand0
removing unneeded snaps
82fd8f2 
Signed-off-by: Amber <amber.torrise@broadcom.com>
Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
@ATorrise @zFernand0
adding node 22 support and also removing private config constructor t…
1edf977 
…hat was missed in imperative cleanup

Signed-off-by: Amber <amber.torrise@broadcom.com>
Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
@ATorrise @zFernand0
trying to fix my 2 added unit tests for terminal output given flags
f8f520d 
Signed-off-by: Amber <amber.torrise@broadcom.com>
Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
@zFernand0
Merge branch 'master' of https://github.com/zowe/zowe-cli into error-…
6545a33 
…msg-help-version

Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
zFernand0 and others added 2 commits November 5, 2024 10:39
@zFernand0
chore: cherry pick d7ea329
ab791ec 
Signed-off-by: Amber <amber.torrise@broadcom.com>
Signed-off-by: Fernando Rijo Cedeno <37381190+zFernand0@users.noreply.github.com>
@ATorrise
getting back to normal with changes
1b793ac 
Signed-off-by: Amber <amber.torrise@broadcom.com>
t1m0thyj
t1m0thyj previously requested changes Nov 6, 2024
View reviewed changes
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

Thanks for addressing feedback, will approve once the unit test is fixed 😋

packages/imperative/src/config/__tests__/Config.api.unit.test.ts Show resolved Hide resolved
packages/imperative/src/config/__tests__/Config.api.unit.test.ts Outdated Show resolved Hide resolved
packages/imperative/src/config/__tests__/Config.api.unit.test.ts Outdated Show resolved Hide resolved
@ATorrise
correcting spy
a2e9282 
Signed-off-by: Amber <amber.torrise@broadcom.com>
anaxceron
anaxceron approved these changes Nov 6, 2024
View reviewed changes
Copy link
Contributor

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

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

Left some notes for minor edits to the changelog entry

packages/imperative/CHANGELOG.md Outdated Show resolved Hide resolved
@ATorrise
writing errors
d332d6c 
Signed-off-by: Amber <amber.torrise@broadcom.com>
zFernand0
zFernand0 approved these changes Nov 6, 2024
View reviewed changes
Copy link
Member

@zFernand0 zFernand0 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the feedback and for being patient 🙏

LGTM! 😋

@t1m0thyj
Fix config errors not being ignored
71b032a 
Signed-off-by: Timothy Johnson <timothy.johnson@broadcom.com>
t1m0thyj
t1m0thyj reviewed Nov 6, 2024
View reviewed changes
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

When testing the PR I was still seeing a fatal error, which I fixed in 71b032a 🙂

Please add an integration test that runs zowe --help and zowe --version with a bad config to verify the error is non-fatal.

@t1m0thyj t1m0thyj dismissed their stale review November 6, 2024 21:49

original requests were addressed

ATorrise and others added 3 commits November 7, 2024 13:00
@ATorrise
Merge branch 'master' into error-msg-help-version
9cba533 
Signed-off-by: Amber Torrise <112635587+ATorrise@users.noreply.github.com>
@ATorrise
ty fernando for walking me through this
7a86db7 
Signed-off-by: Amber <amber.torrise@broadcom.com>
@ATorrise
Merge branch 'master' into error-msg-help-version
342828d 
Signed-off-by: Amber Torrise <112635587+ATorrise@users.noreply.github.com>
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Nov 7, 2024

Quality Gate Passed Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

traeok
traeok approved these changes Nov 8, 2024
View reviewed changes
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.

Thanks Amber for the fix! LGTM

@ATorrise ATorrise requested a review from awharn November 8, 2024 15:50
@zFernand0 zFernand0 merged commit f532f09 into master Nov 8, 2024
17 checks passed
@zFernand0 zFernand0 deleted the error-msg-help-version branch November 8, 2024 16:05
@zFernand0 zFernand0 added the release-current Indicates that there is no new functionality being delivered label Nov 8, 2024
@ATorrise ATorrise mentioned this pull request Nov 13, 2024
Merged
4 tasks
ATorrise added a commit that referenced this pull request Nov 13, 2024
@ATorrise
Merge pull request #2361 from zowe/help-web
53cc0d0 
Enhanced #2301 to include "--help-web" commands to pass even if presence of a faulty configuration
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zFernand0 zFernand0 zFernand0 approved these changes

@anaxceron anaxceron anaxceron approved these changes

@traeok traeok traeok approved these changes

@awharn awharn awharn approved these changes

@t1m0thyj t1m0thyj t1m0thyj approved these changes

@gejohnston gejohnston Awaiting requested review from gejohnston

@jace-roell jace-roell Awaiting requested review from jace-roell

Assignees

@ATorrise ATorrise

Labels
no-changelog release-current Indicates that there is no new functionality being delivered
Projects
Zowe CLI Squad
Status: Closed
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Zowe commands with --help fail if config file cannot be parsed
6 participants
@ATorrise @zFernand0 @t1m0thyj @awharn @traeok @anaxceron