Control leapp-report format #686

fernflower · 2021-02-09T21:08:06Z

In order to be completely safe that any changes that land in leapp
reporting don't break older clients there should be a possibility
to force specific version of json schema.
Currently there are 2 schemas that are actually backward compatible,
but it may not be the rule soon.

This patch adds a --report-schema option to leapp preupgrade/upgrade
commands that force sticking to specific version of the report schema.
For example with --report-schema '1.0.0' passed there will be no stable
keys in the report messages, as those have been added in the recent
'1.1.0' report schema.

centos-ci · 2021-02-09T21:09:02Z

Can one of the admins verify this patch?

leapp-bot · 2021-02-09T21:09:38Z

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-02-10T14:15:26Z

@fernflower no review yet; just I think that the argument for the --report-schema option should be enumarated list of values. If in example we provide schema e.g. 1.5.0 in upstream, but customer will use older version of leapp (e.g. because the new one was not delivered yet), obviously such a schema will not be valid. from that point, leapp should check whether the required schema is supported or not. as well, it could happen we will have to drop completely some old schemas, because it will be completely incompatible with the new one (not searching for possible reasons, it's just possibility that could happen in future). so the enumeration/list of supported schemas should be rather present. wdyt?

fernflower · 2021-02-11T10:24:06Z

@fernflower no review yet; just I think that the argument for the --report-schema option should be enumarated list of values. If in example we provide schema e.g. 1.5.0 in upstream, but customer will use older version of leapp (e.g. because the new one was not delivered yet), obviously such a schema will not be valid. from that point, leapp should check whether the required schema is supported or not. as well, it could happen we will have to drop completely some old schemas, because it will be completely incompatible with the new one (not searching for possible reasons, it's just possibility that could happen in future). so the enumeration/list of supported schemas should be rather present. wdyt?

Hmm why a list of values? My idea was that --report-schema version will mandatory force leapp to create a leapp-report.json compatible with selected version of report schema (1.0.0 without "key" and 1.1.0 with "key" for example).
If the client uses super old version of leapp he won't be able to use --report-schema cli option anyway. If leapp version is not that old but doesn't match the one in upstream (say, 1.4.0 for client and 1.5.0 for upstream) then only conversions to earlier than 1.4.0 versions are available, and the user will choose the one he wants and pass as a single string --report-schema argument.

Maybe I got you wrong and you meant that --report-schema command should output the list of possible report-schema versions to use in command description? That would make total sense.

fernflower · 2021-02-11T12:39:30Z

leapp-ci build

fernflower · 2021-02-11T12:41:31Z

@oamg/developers please review

pirat89 · 2021-02-11T14:26:33Z

Passing the choices to argparse (as you did already) was the answer :)

pirat89 · 2021-02-11T14:28:08Z

I think this could be very good candidate for our ci-hackathon, btw.

leapp/cli/upgrade/__init__.py

drehak · 2021-02-11T21:04:18Z

Seens good to me!

leapp/cli/upgrade/__init__.py

tests/scripts/test_reporting.py

drehak

Looks good to me!

fernflower · 2021-02-15T10:46:37Z

@pirat89 love the idea, got rid of the separate report schema processing. Thanks!

leapp/utils/report.py

pirat89

Lgtm and works as expected. Just some english nitpicks and I think the help message is not so clear. But thiking about that, I am not sure how to re-word it to keep it short and clear.

man/leapp.1

leapp/cli/upgrade/__init__.py

pirat89 · 2021-04-17T07:48:51Z

@fernflower is it still WIP? If not, I would like to merge it after the next release.

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower · 2021-12-17T11:34:59Z

/rerun

github-actions · 2021-12-17T11:39:23Z

Copr build succeeded: https://copr.fedorainfracloud.org/coprs/build/3060649

github-actions · 2021-12-17T11:39:24Z

Testing Farm request for tmt test was created. Once finished, results should be available here.
Full pipeline log.

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower · 2022-01-07T13:42:55Z

/rerun

github-actions · 2022-01-07T13:46:48Z

Copr build succeeded: https://copr.fedorainfracloud.org/coprs/build/3132308

github-actions · 2022-01-07T13:46:49Z

Testing Farm request for tmt test was created. Once finished, results should be available here.
Full pipeline log.

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

In order to be completely safe that any changes that land in leapp reporting don't break older clients there should be a possibility to force specific version of json schema. Currently there are 2 schemas that are actually backward compatible, but it may not be the rule soon. This patch adds a --report-schema option to leapp preupgrade/upgrade commands that force sticking to specific version of the report schema. For example with --report-schema '1.0.0' passed there will be no stable keys in the report messages, as those have been added in the recent '1.1.0' report schema.

pirat89

works as expected and lgtm.

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

## Packaging - Add depency on `python3` for el8+ (`python3` refers to the distribution python) - Bump `leapp-framework` to 2.2 - Bump `leapp-framework-dependencies` to 6 - Doc: --report-schema in manpage (oamg#686) ## Framework ### Fixes - Fix issues with initialisation of loggers (oamg#764) - Fix TypeError during JSON serialization in dialogs on Python3 (oamg#760) - Prevent breaking the answerfile when dialog fields contain newlines (oamg#757) - Check answerfile upon loading (oamg#759) - Fix the multiprocessing on Python 3.9 on Mac OS ### Enhancements - Dialogs: print the reason field for question in the answerfile (oamg#762) - Added possibility to specify the report format version (oamg#686) ## stdlib ### Enhancements - Introduced `stdlib.path` library `get_common_*_path` functions for the scanning repositories, actors, etc. paths outside of the actor execution (oamg#742)

## Packaging - Add depency on `python3` for el8+ (`python3` refers to the distribution python) - Bump `leapp-framework` to 2.2 - Bump `leapp-framework-dependencies` to 6 - Doc: --report-schema in manpage (#686) ## Framework ### Fixes - Fix issues with initialisation of loggers (#764) - Fix TypeError during JSON serialization in dialogs on Python3 (#760) - Prevent breaking the answerfile when dialog fields contain newlines (#757) - Check answerfile upon loading (#759) - Fix the multiprocessing on Python 3.9 on Mac OS ### Enhancements - Dialogs: print the reason field for question in the answerfile (#762) - Added possibility to specify the report format version (#686) ## stdlib ### Enhancements - Introduced `stdlib.path` library `get_common_*_path` functions for the scanning repositories, actors, etc. paths outside of the actor execution (#742)

fernflower added the wip label Feb 9, 2021

fernflower changed the title ~~Control leapp-report.json format~~ Control leapp-report format Feb 9, 2021

fernflower force-pushed the reportbackwardscompatibility branch from d4677cf to 171437b Compare February 10, 2021 13:32

drehak requested changes Feb 11, 2021

View reviewed changes

leapp/cli/upgrade/__init__.py Outdated Show resolved Hide resolved

leapp/cli/upgrade/__init__.py Outdated Show resolved Hide resolved

drehak previously approved these changes Feb 11, 2021

View reviewed changes

fernflower dismissed drehak’s stale review via 341e9fa February 12, 2021 10:28

fernflower force-pushed the reportbackwardscompatibility branch from 8113013 to 341e9fa Compare February 12, 2021 10:28

vinzenz reviewed Feb 12, 2021

View reviewed changes

leapp/cli/upgrade/__init__.py Outdated Show resolved Hide resolved

fernflower force-pushed the reportbackwardscompatibility branch 2 times, most recently from 62e2c7f to 0cb7b73 Compare February 12, 2021 14:50

drehak reviewed Feb 12, 2021

View reviewed changes

tests/scripts/test_reporting.py Outdated Show resolved Hide resolved

fernflower force-pushed the reportbackwardscompatibility branch from 0cb7b73 to 66d6b86 Compare February 12, 2021 17:01

drehak previously approved these changes Feb 12, 2021

View reviewed changes

fernflower dismissed drehak’s stale review via da84c5b February 15, 2021 10:42

fernflower force-pushed the reportbackwardscompatibility branch from da84c5b to 9a31c48 Compare February 15, 2021 10:48

pirat89 reviewed Feb 15, 2021

View reviewed changes

leapp/utils/report.py Outdated Show resolved Hide resolved

pirat89 previously approved these changes Feb 15, 2021

View reviewed changes

man/leapp.1 Outdated Show resolved Hide resolved

leapp/cli/upgrade/__init__.py Outdated Show resolved Hide resolved

pirat89 added this to the 8.4.1 milestone Apr 17, 2021

fernflower dismissed pirat89’s stale review via 80c8a72 May 18, 2021 19:35

fernflower force-pushed the reportbackwardscompatibility branch 3 times, most recently from 3e45c6a to d102f06 Compare October 5, 2021 12:49

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Dec 17, 2021

Control leapp report format

4817bf2

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower force-pushed the reportbackwardscompatibility branch 2 times, most recently from 9dff129 to e6837cb Compare December 17, 2021 11:33

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Dec 20, 2021

Control leapp report format

42c6c11

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Jan 6, 2022

Control leapp report format

b11d2fd

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower force-pushed the reportbackwardscompatibility branch 2 times, most recently from 7f184ae to 524181f Compare January 7, 2022 10:57

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Jan 7, 2022

Control leapp report format

26e44d8

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Jan 7, 2022

Control leapp report format

0ba5a6c

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower added a commit to fernflower/leapp-repository that referenced this pull request Jan 14, 2022

Control leapp report format

f814c6f

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

fernflower and others added 2 commits January 14, 2022 12:34

Document --report-schema in manpage

7041759

fernflower force-pushed the reportbackwardscompatibility branch from 524181f to 7041759 Compare January 14, 2022 11:35

pirat89 approved these changes Jan 17, 2022

View reviewed changes

pirat89 merged commit 0fc2ab3 into oamg:master Jan 17, 2022

pirat89 pushed a commit to oamg/leapp-repository that referenced this pull request Jan 17, 2022

Control leapp report format

e050c0b

Leapp-repository part of PR686 which contains appropriate changes for the leapp preupgrade and upgrade commands. Depends-On: oamg/leapp#686

Rezney mentioned this pull request Mar 12, 2022

Release 0.14.0 #766

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Control leapp-report format #686

Control leapp-report format #686

fernflower commented Feb 9, 2021

centos-ci commented Feb 9, 2021

leapp-bot commented Feb 9, 2021

pirat89 commented Feb 10, 2021

fernflower commented Feb 11, 2021 •

edited

Loading

fernflower commented Feb 11, 2021

fernflower commented Feb 11, 2021

pirat89 commented Feb 11, 2021

pirat89 commented Feb 11, 2021 •

edited

Loading

drehak commented Feb 11, 2021

drehak left a comment

fernflower commented Feb 15, 2021

pirat89 left a comment

pirat89 commented Apr 17, 2021

fernflower commented Dec 17, 2021

github-actions bot commented Dec 17, 2021

github-actions bot commented Dec 17, 2021

fernflower commented Jan 7, 2022

github-actions bot commented Jan 7, 2022

github-actions bot commented Jan 7, 2022

pirat89 left a comment

Control leapp-report format #686

Control leapp-report format #686

Conversation

fernflower commented Feb 9, 2021

centos-ci commented Feb 9, 2021

leapp-bot commented Feb 9, 2021

Thank you for contributing to the Leapp project!

pirat89 commented Feb 10, 2021

fernflower commented Feb 11, 2021 • edited Loading

fernflower commented Feb 11, 2021

fernflower commented Feb 11, 2021

pirat89 commented Feb 11, 2021

pirat89 commented Feb 11, 2021 • edited Loading

drehak commented Feb 11, 2021

drehak left a comment

Choose a reason for hiding this comment

fernflower commented Feb 15, 2021

pirat89 left a comment

Choose a reason for hiding this comment

pirat89 commented Apr 17, 2021

fernflower commented Dec 17, 2021

github-actions bot commented Dec 17, 2021

github-actions bot commented Dec 17, 2021

fernflower commented Jan 7, 2022

github-actions bot commented Jan 7, 2022

github-actions bot commented Jan 7, 2022

pirat89 left a comment

Choose a reason for hiding this comment

fernflower commented Feb 11, 2021 •

edited

Loading

pirat89 commented Feb 11, 2021 •

edited

Loading