Introduced a JSON schema of a leapp report #681

fernflower · 2021-01-13T14:56:50Z

Generated by https://jsonschema.net and adjusted manually.

OAMG-4263

centos-ci · 2021-01-13T14:57:03Z

Can one of the admins verify this patch?

leapp-bot · 2021-01-13T14:59:30Z

Thank you for contributing to the Leapp project!

Please note that every PR needs to comply with the
Leapp Guidelines and must pass all tests in order to be mergable.

If you want to re-run tests or request review, you can use following commands as a comment:

leapp-ci build to run unit tests, copr build and e2e tests in OAMG CI
e2e tests to run unit tests, copr build and end-to-end tests in Murphy CI (OAMG members only) [OLD PIPELINE]
review please to notify leapp developers of review request

Note: In case there are problems with tests not being triggered automatically on new PR/commit or pending for a long time, please consider rerunning the CI by commenting leapp-ci build (might require several comments). If the problem persists, contact leapp-infra.

pirat89 · 2021-01-18T17:48:18Z

@fernflower We should refer to the schema from the upstream documentation.

fernflower · 2021-01-19T22:49:53Z

@pirat89 I will put the reference once the schema is merged. Are you ok with the placing in leapp's root?

pirat89 · 2021-01-20T16:58:56Z

@fernflower I am thinking where to put it as we want to even reduce the main topic menu - it's already too long. We should discuss it in future with @mportman12 probably. But temporary it could be ok. Btw, why to do it separately? Why not in this PR? As these two things are two sides of the same coin. I guess it's ok if the jira task is kept in development or if you create the followup task, so we do not forget to finish it.

pirat89 · 2021-01-21T16:49:19Z

@fernflower aah...I thought you are talking about readthedocs menu. Now I see where the file is located :) I think it should be in a subdir. As well, haven't we talked about version schema? As we plan to change it in future, so I believe there should be something like version 1.0 .. maybe the file should reflect that as well and should be called report-schema-v1.0.json. wdyt?
I am not sure which directory to use to put the schema inside. @vinzenz any idea?

pirat89 · 2021-01-22T11:23:42Z

leapp-ci build

fernflower · 2021-01-26T12:54:47Z

@pirat89 what about putting 'version' in the schema itself (did it in the latest commit)? I'd rather keep the filename as it is report-schema.json tbh, if we follow the 'do not remove any fields from json' concept the latest file should be supported anyway.

pirat89 · 2021-01-28T09:25:34Z

@fernflower And how you will point people to various versions of schemas then? we will need keep several versions of schemas documented in the same time..

pirat89 · 2021-01-28T09:26:16Z

I really believe we need to have info about the version inside the schema and reflect that in the filename as well.

pirat89

giving my approval to not block the pr. I will try to think where to move the file. in the worst case, we can still move it after the PR merge.

pirat89 · 2021-02-03T18:23:26Z

replaced tabs by whitespaces in the fixup commits

pirat89 · 2021-02-03T18:32:46Z

report-schema-v100.json

+                                                    "properties": {
+                                                        "url": {
+                                                            "$id": "#/properties/entries/items/anyOf/0/properties/detail/properties/external/items/anyOf/0/properties/url",
+                                                            "type": "string",


What about to add the uri format to make validation even more strict?"

Suggested change

"type": "string",

"type": "string",

"format": "uri",

ref: https://json-schema.org/understanding-json-schema/reference/string.html#resource-identifiers

pirat89 · 2021-02-03T19:52:37Z

Fixing the indentation as it was broken on several places (maybe after may edit)

pirat89 · 2021-02-03T21:19:36Z

report-schema-v100.json

+                                                                        [
+                                                                            "rm -rf /tmp/42"
+                                                                        ]
+                                                                    ],


This is wrong actually. E.g.

{ "type": "command", "context": [ "leapp", "answer", "--section", "remove_pam_pkcs11_module_check.confirm=True" ] }

We should add more examples to be able to validate the json schema better. Let's do it the next morning.

pirat89 · 2021-02-03T21:21:02Z

report-schema-v100.json

+                                                    "properties": {
+                                                        "anyOf": [
+                                                            {
+                                                                "type": {
+                                                                    "$id": "#/properties/detail/properties/remediations/items/anyOf/0/properties/type",


and this is probably not possible as well. properties should be always key-value dicts as it looks like.

Generated by https://jsonschema.net and adjusted manually. The patch contains 2 schema files: - 1.0.0 that matches the version that foreman_leapp relies on - 1.1.0 that has the stable report key. Basic unit test coverage is presented in test_reporting.py - the sample leapp-report.json from vagrant box is checked against json schema v 1.0.0 and 1.1.0. OAMG-4263 Co-Authored-By: Petr Stodůlka <[email protected]>

pirat89

🥳

## Packaging - Add JSON schema of leapp reports for validation (oamg#681) - Bump leapp-framework capability to 1.4 (oamg#684) ## Framework ### Fixes - Fix Py2/Py3 issues for unit-tests relying on __wrapped__ for decorators (oamg#674) ### Enhancements - Add a stable report identifier for each generated report (oamg#669) ## Additional changes interesting for devels - Add a possibility to overwrite virtualenv name for testing `$VENVNAME` (oamg#675) - Add a way to override default python version using `$PYTHON_VENV` (oamg#675) Related leapp-repository release: https://github.com/oamg/leapp-repository/releases/tag/v0.13.0

## Packaging - Add JSON schema of leapp reports for validation (#681) - Bump leapp-framework capability to 1.4 (#684) ## Framework ### Fixes - Fix Py2/Py3 issues for unit-tests relying on __wrapped__ for decorators (#674) ### Enhancements - Add a stable report identifier for each generated report (#669) ## Additional changes interesting for devels - Add a possibility to overwrite virtualenv name for testing `$VENVNAME` (#675) - Add a way to override default python version using `$PYTHON_VENV` (#675) Related leapp-repository release: https://github.com/oamg/leapp-repository/releases/tag/v0.13.0

fernflower requested review from Rezney and shaded-enmity January 19, 2021 22:48

pirat89 previously approved these changes Jan 29, 2021

View reviewed changes

fernflower changed the title ~~Introduced a JSON schema of a leapp report~~ [DO NOT MERGE] [TESTING WANTED] Introduced a JSON schema of a leapp report Feb 3, 2021

fernflower dismissed pirat89’s stale review via ea0c9b7 February 3, 2021 16:22

pirat89 reviewed Feb 3, 2021

View reviewed changes

pirat89 force-pushed the reportjsonschema branch from 8655ef8 to 73e7f59 Compare February 3, 2021 19:51

pirat89 reviewed Feb 3, 2021

View reviewed changes

fernflower changed the title ~~[DO NOT MERGE] [TESTING WANTED] Introduced a JSON schema of a leapp report~~ Introduced a JSON schema of a leapp report Feb 4, 2021

fernflower changed the title ~~Introduced a JSON schema of a leapp report~~ [SQUASH COMMITS BEFORE MERGE] Introduced a JSON schema of a leapp report Feb 4, 2021

drehak mentioned this pull request Feb 4, 2021

Release 0.12.0 #685

Merged

pirat89 previously approved these changes Feb 4, 2021

View reviewed changes

fernflower dismissed pirat89’s stale review via a3d426a February 4, 2021 16:15

fernflower force-pushed the reportjsonschema branch from 0c56624 to a3d426a Compare February 4, 2021 16:15

fernflower changed the title ~~[SQUASH COMMITS BEFORE MERGE] Introduced a JSON schema of a leapp report~~ Introduced a JSON schema of a leapp report Feb 4, 2021

pirat89 approved these changes Feb 4, 2021

View reviewed changes

pirat89 merged commit f4ed32e into oamg:master Feb 4, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduced a JSON schema of a leapp report #681

Introduced a JSON schema of a leapp report #681

fernflower commented Jan 13, 2021

centos-ci commented Jan 13, 2021

leapp-bot commented Jan 13, 2021

pirat89 commented Jan 18, 2021

fernflower commented Jan 19, 2021

pirat89 commented Jan 20, 2021 •

edited

Loading

pirat89 commented Jan 21, 2021

pirat89 commented Jan 22, 2021

fernflower commented Jan 26, 2021

pirat89 commented Jan 28, 2021

pirat89 commented Jan 28, 2021

pirat89 left a comment

pirat89 commented Feb 3, 2021

pirat89 Feb 3, 2021

pirat89 commented Feb 3, 2021 •

edited

Loading

pirat89 Feb 3, 2021

pirat89 Feb 3, 2021

pirat89 left a comment

Introduced a JSON schema of a leapp report #681

Introduced a JSON schema of a leapp report #681

Conversation

fernflower commented Jan 13, 2021

centos-ci commented Jan 13, 2021

leapp-bot commented Jan 13, 2021

Thank you for contributing to the Leapp project!

pirat89 commented Jan 18, 2021

fernflower commented Jan 19, 2021

pirat89 commented Jan 20, 2021 • edited Loading

pirat89 commented Jan 21, 2021

pirat89 commented Jan 22, 2021

fernflower commented Jan 26, 2021

pirat89 commented Jan 28, 2021

pirat89 commented Jan 28, 2021

pirat89 left a comment

Choose a reason for hiding this comment

pirat89 commented Feb 3, 2021

pirat89 Feb 3, 2021

Choose a reason for hiding this comment

pirat89 commented Feb 3, 2021 • edited Loading

pirat89 Feb 3, 2021

Choose a reason for hiding this comment

pirat89 Feb 3, 2021

Choose a reason for hiding this comment

pirat89 left a comment

Choose a reason for hiding this comment

pirat89 commented Jan 20, 2021 •

edited

Loading

pirat89 commented Feb 3, 2021 •

edited

Loading