Validate that zowe.config.json file matches schema #192

aadityasinha-dotcom · 2023-06-26T04:56:43Z

What It Does
Resolves #74

How to Test

Review Checklist
I certify that I have:

tested my changes
added/updated automated tests
updated the changelog
followed the contribution guidelines

Additional Comments

Signed-off-by: aadityasinha-dotcom <[email protected]>

codecov · 2023-06-26T04:58:35Z

Codecov Report

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

Files	Coverage Δ
tests/unit/test_zowe_core.py	`99.44% <100.00%> (+0.09%)`	⬆️
src/core/zowe/core_for_zowe_sdk/config_file.py	`88.19% <95.23%> (+0.36%)`	⬆️
.../core/zowe/core_for_zowe_sdk/credential_manager.py	`92.30% <85.71%> (ø)`
src/core/zowe/core_for_zowe_sdk/profile_manager.py	`83.08% <76.92%> (-0.79%)`	⬇️
src/core/zowe/core_for_zowe_sdk/validators.py	`85.71% <83.33%> (-14.29%)`	⬇️

📢 Thoughts on this report? Let us know!.

aadityasinha-dotcom · 2023-06-26T04:58:51Z

@t1m0thyj @zFernand0 I have created the PR this is currently incomplete. Need some reviews on it, and how we will handle/find the errors while doing validation 😊

Signed-off-by: aadityasinha-dotcom <[email protected]>

src/core/zowe/core_for_zowe_sdk/config_file.py

src/core/zowe/core_for_zowe_sdk/profile_manager.py

Signed-off-by: aadityasinha-dotcom <[email protected]>

src/core/zowe/core_for_zowe_sdk/profile_manager.py

src/core/zowe/core_for_zowe_sdk/config_file.py

src/core/zowe/core_for_zowe_sdk/profile_manager.py

Signed-off-by: aadityasinha-dotcom <[email protected]>

…lidation errors Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom · 2023-06-30T09:07:34Z

@t1m0thyj made some changes, please review it ☺️

src/core/zowe/core_for_zowe_sdk/profile_manager.py

src/core/zowe/core_for_zowe_sdk/validators.py

Signed-off-by: aadityasinha-dotcom <[email protected]>

…ethod will be called automatically Signed-off-by: aadityasinha-dotcom <[email protected]>

Signed-off-by: aadityasinha-dotcom <[email protected]>

src/core/zowe/core_for_zowe_sdk/config_file.py

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom · 2023-08-21T16:59:02Z

tests/unit/test_zowe_core.py

+            props: dict = prof_manager.load(profile_name="zosmf", validate_schema=True)
+
+    @patch("keyring.get_password", side_effect=keyring_get_password)
+    def test_profile_loading_with_invalid_schema_internet_URI(self, get_pass_func):


Added test for SchemaError with InternetURI

tests/unit/test_zowe_core.py

src/core/zowe/core_for_zowe_sdk/profile_manager.py

src/core/zowe/core_for_zowe_sdk/config_file.py

src/core/zowe/core_for_zowe_sdk/profile_manager.py

src/core/zowe/core_for_zowe_sdk/config_file.py

Signed-off-by: aadityasinha-dotcom <[email protected]>

t1m0thyj

Thanks for addressing earlier comments, validating schema works for me now with a global team config file in home dir 👍

Left a few comments on config_file.py. Once those are addressed I'll approve since coverage looks good as well 🙂

src/core/zowe/core_for_zowe_sdk/config_file.py

tests/unit/test_zowe_core.py

Signed-off-by: Aaditya Sinha <[email protected]>

Signed-off-by: aadityasinha-dotcom <[email protected]>

tests/unit/test_zowe_core.py

zFernand0

changes LGTM!
left a few comments, not a huge deal though 😋

still going through the tests to see what's happening 😋

src/core/zowe/core_for_zowe_sdk/validators.py

src/core/zowe/core_for_zowe_sdk/profile_manager.py

src/core/zowe/core_for_zowe_sdk/config_file.py

aadityasinha-dotcom · 2023-09-07T17:15:49Z

changes LGTM! left a few comments, not a huge deal though 😋

still going through the tests to see what's happening 😋

I tested this locally, it was working fine though 🤔

Signed-off-by: aadityasinha-dotcom <[email protected]>

Signed-off-by: Aaditya Sinha <[email protected]>

Signed-off-by: aadityasinha-dotcom <[email protected]>

t1m0thyj · 2023-09-25T15:18:11Z

changes LGTM! left a few comments, not a huge deal though 😋
still going through the tests to see what's happening 😋

I tested this locally, it was working fine though 🤔

@aadityasinha-dotcom For the validate_schema PR, do you have any of the following files either in your project directory or in ~/.zowe?

zowe.config.json
zowe.config.user.json
zowe.schema.json

If you have any of those files present locally, can you try deleting them or moving them out of the way so that tests are running in a clean environment without config?

Signed-off-by: zFernand0 <[email protected]>

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0

LGTM! 😋

moved the validation logic into ProfileManager

883a0fc

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom requested review from t1m0thyj and zFernand0 June 26, 2023 05:00

aadityasinha-dotcom added 3 commits June 26, 2023 21:35

added validation error warning

e83fb65

Signed-off-by: aadityasinha-dotcom <[email protected]>

added jsonschema exceptions

ffc42e8

Signed-off-by: aadityasinha-dotcom <[email protected]>

fixed indentation

267f700

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom marked this pull request as ready for review June 27, 2023 16:18

aadityasinha-dotcom commented Jun 27, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/config_file.py Show resolved Hide resolved

aadityasinha-dotcom commented Jun 27, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

aadityasinha-dotcom commented Jun 27, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

aadityasinha-dotcom added 2 commits June 28, 2023 11:23

raised error

6465b67

Signed-off-by: aadityasinha-dotcom <[email protected]>

fixed test

b93d818

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom commented Jun 28, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

t1m0thyj reviewed Jun 28, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/config_file.py Outdated Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

aadityasinha-dotcom added 2 commits June 29, 2023 17:35

enhanced the validators.py and made some changes to validate schema

69d983f

Signed-off-by: aadityasinha-dotcom <[email protected]>

fixed tests

f07ebec

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom requested a review from t1m0thyj June 30, 2023 04:41

fixed validator if there is not path, fixed raising exceptions for va…

8f8d80c

…lidation errors Signed-off-by: aadityasinha-dotcom <[email protected]>

t1m0thyj reviewed Jul 5, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/profile_manager.py Outdated Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/validators.py Outdated Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/validators.py Outdated Show resolved Hide resolved

moved the validate_schema method to ConfigFile class

c2ae1ec

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom requested a review from t1m0thyj July 6, 2023 12:41

aadityasinha-dotcom added 4 commits July 7, 2023 10:04

changelog

6108ebf

Signed-off-by: aadityasinha-dotcom <[email protected]>

moved the validation logic to init_from_file so the validate_schema m…

042a4ac

…ethod will be called automatically Signed-off-by: aadityasinha-dotcom <[email protected]>

fixed test

708da24

Signed-off-by: aadityasinha-dotcom <[email protected]>

changes

19ede33

Signed-off-by: aadityasinha-dotcom <[email protected]>

t1m0thyj reviewed Jul 12, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/config_file.py Outdated Show resolved Hide resolved

simplified path_config_json

dd0be07

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom added 4 commits August 10, 2023 18:24

refactored the code

e01ffb0

Signed-off-by: aadityasinha-dotcom <[email protected]>

added test for invalid schema and updated requirements.txt

0030a10

Signed-off-by: aadityasinha-dotcom <[email protected]>

added test for internet URI

8edec11

Signed-off-by: aadityasinha-dotcom <[email protected]>

did some changes, added unit test for internet URI

6f34785

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom commented Aug 21, 2023

View reviewed changes

t1m0thyj requested changes Aug 22, 2023

View reviewed changes

t1m0thyj reviewed Aug 22, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/config_file.py Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/config_file.py Outdated Show resolved Hide resolved

few changes added file protocol, fixed tests

cba960c

Signed-off-by: aadityasinha-dotcom <[email protected]>

t1m0thyj mentioned this pull request Aug 29, 2023

[core] Dynamically generate invalid config files in unit tests #209

Closed

t1m0thyj reviewed Aug 29, 2023

View reviewed changes

aadityasinha-dotcom and others added 3 commits August 30, 2023 17:50

Merge branch 'main' into validate_schema

535ca88

Signed-off-by: Aaditya Sinha <[email protected]>

Merge branch 'main' into validate_schema

c0b9d9b

removed verify parameter

6917e60

Signed-off-by: aadityasinha-dotcom <[email protected]>

aadityasinha-dotcom commented Sep 5, 2023

View reviewed changes

tests/unit/test_zowe_core.py Outdated Show resolved Hide resolved

aadityasinha-dotcom requested a review from t1m0thyj September 6, 2023 12:56

zFernand0 reviewed Sep 7, 2023

View reviewed changes

src/core/zowe/core_for_zowe_sdk/validators.py Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/profile_manager.py Show resolved Hide resolved

src/core/zowe/core_for_zowe_sdk/config_file.py Outdated Show resolved Hide resolved

aadityasinha-dotcom and others added 3 commits September 13, 2023 18:47

removed config_type parameter

fc5aa3a

Signed-off-by: aadityasinha-dotcom <[email protected]>

Merge branch 'main' into validate_schema

26e997f

Signed-off-by: Aaditya Sinha <[email protected]>

Merge branch 'main' into validate_schema

1ba06a2

aadityasinha-dotcom requested a review from zFernand0 September 14, 2023 16:16

fix tests

561b370

Signed-off-by: aadityasinha-dotcom <[email protected]>

zFernand0 added 4 commits September 27, 2023 20:30

attempt to add the entire env/lib dir

f749d60

Signed-off-by: zFernand0 <[email protected]>

cannot assume that env/lib is the reason why the merging didn't work

e355a7c

Signed-off-by: zFernand0 <[email protected]>

try to load jsonschema

b824ac0

Signed-off-by: zFernand0 <[email protected]>

Merge branch 'main' into validate_schema

a7e61a9

Signed-off-by: Fernando Rijo Cedeno <[email protected]>

zFernand0 approved these changes Sep 27, 2023

View reviewed changes

t1m0thyj approved these changes Sep 27, 2023

View reviewed changes

t1m0thyj merged commit 18c9385 into zowe:main Sep 27, 2023
19 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Validate that zowe.config.json file matches schema #192

Validate that zowe.config.json file matches schema #192

aadityasinha-dotcom commented Jun 26, 2023 •

edited

Loading

codecov bot commented Jun 26, 2023 •

edited

Loading

aadityasinha-dotcom commented Jun 26, 2023 •

edited

Loading

aadityasinha-dotcom commented Jun 30, 2023

aadityasinha-dotcom Aug 21, 2023

t1m0thyj left a comment •

edited

Loading

zFernand0 left a comment

aadityasinha-dotcom commented Sep 7, 2023 •

edited

Loading

t1m0thyj commented Sep 25, 2023 •

edited

Loading

zFernand0 left a comment

Validate that zowe.config.json file matches schema #192

Validate that zowe.config.json file matches schema #192

Conversation

aadityasinha-dotcom commented Jun 26, 2023 • edited Loading

codecov bot commented Jun 26, 2023 • edited Loading

Codecov Report

aadityasinha-dotcom commented Jun 26, 2023 • edited Loading

aadityasinha-dotcom commented Jun 30, 2023

aadityasinha-dotcom Aug 21, 2023

Choose a reason for hiding this comment

t1m0thyj left a comment • edited Loading

Choose a reason for hiding this comment

zFernand0 left a comment

Choose a reason for hiding this comment

aadityasinha-dotcom commented Sep 7, 2023 • edited Loading

t1m0thyj commented Sep 25, 2023 • edited Loading

zFernand0 left a comment

Choose a reason for hiding this comment

aadityasinha-dotcom commented Jun 26, 2023 •

edited

Loading

codecov bot commented Jun 26, 2023 •

edited

Loading

aadityasinha-dotcom commented Jun 26, 2023 •

edited

Loading

t1m0thyj left a comment •

edited

Loading

aadityasinha-dotcom commented Sep 7, 2023 •

edited

Loading

t1m0thyj commented Sep 25, 2023 •

edited

Loading