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

add external links to the leapp-report.txt #842

Merged
merged 1 commit into from
Oct 10, 2023
Merged

add external links to the leapp-report.txt #842

merged 1 commit into from
Oct 10, 2023

Conversation

PeterMocary
Copy link
Member

@PeterMocary PeterMocary commented Sep 6, 2023 •
edited by pirat89
Loading

The external links were only included in the leapp-report.json and its .txt version was lacking this essential information. I didn't find any other problems regarding the information that is not included in one or the other format. Although the OAMG-9665 seems to be related to this. Do you think that it should be fixed in this PR as well?

Jira: OAMG-8553

@github-actions
Copy link

github-actions bot commented Sep 6, 2023

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 mergeable.
If you want to request a review or rebuild a package in copr, you can use following commands as a comment:

  • review please @oamg/developers to notify leapp developers of the review request
  • /packit copr-build to submit a public copr build using packit

To launch regression testing public members of oamg organization can leave the following comment:

  • /rerun to schedule basic regression tests using this pr build and leapp-repository*master* as artifacts
  • /rerun 42 to schedule basic regression tests using this pr build and leapp-repository*PR42* as artifacts
  • /rerun-sst to schedule sst tests using this pr build and leapp-repository*master* as artifacts
  • /rerun-sst 42 to schedule sst tests using this pr build and leapp-repository*PR42* as artifacts

Please open ticket in case you experience technical problem with the CI. (RH internal only)

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.

@PeterMocary PeterMocary marked this pull request as ready for review October 6, 2023 16:10
@pirat89
Copy link
Member

pirat89 commented Oct 9, 2023

/packit build

pirat89
pirat89 approved these changes Oct 10, 2023
View reviewed changes
Copy link
Member

@pirat89 pirat89 left a comment

Choose a reason for hiding this comment

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

Works as expected. tested on several scenarios, IPU 7 -> 8 & 8 -> 9, including multiple external links in a report:

Risk Factor: high (inhibitor)
Title: Cannot perform the VDO check of block devices
Summary: [snip]
Related links:
    - Importing existing VDO volumes to LVM: https://red.ht/import-existing-vdo-volumes-to-lvm
    - yahuoo: https://red.ht/import-existing-vdo-volumes-to-lvm
    - bungabungbainkaaa: https://red.ht/import-existing-vdo-volumes-to-lvmKey: 429a99e13b19a7eebadbb8cb35233d8119bcf255

Also tried behaviour with non-ascii characters, which in such a case it's broken on RHEL 7, but we do not have handled non-ascii characters correctly anyway in other fields (e.g. title). The only handled part of the report for non-ascii characters is now the remediation text. regarding that I am merging this anyway. As this is going to be the last RHEL 7 release, it is not worthy to spent time on that and the problem is not present on RHEL 8+.

@pirat89 pirat89 merged commit ea71f9b into oamg:master Oct 10, 2023
15 checks passed
@pirat89 pirat89 added the changelog-checked The merger/reviewer checked the changelog draft document and updated it when relevant label Oct 10, 2023
pirat89
pirat89 reviewed Oct 11, 2023
View reviewed changes
leapp/utils/report.py
if isinstance(remediation_text, six.binary_type):
# This will be true for py2 where repr returns an encoded string
remediation_text = remediation_text.decode('utf-8')
detail += remediation_text
Copy link
Member

Choose a reason for hiding this comment

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

@PeterMocary this is wrong. shame on me I missed that

Copy link
Member

Choose a reason for hiding this comment

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

Should be fixed by #844

pirat89 added a commit to pirat89/leapp that referenced this pull request Feb 13, 2024
@pirat89
Release 0.17.0
b61b6b7 
## Framework
### Enhancements
- Generated txt report file now contains also External links when part of a report (oamg#842, oamg#844)

## stdlib
### Fixes
- The `run` function is now compatible with Python 3.12 (oamg#845)
@pirat89 pirat89 mentioned this pull request Feb 13, 2024
Merged
pirat89 added a commit that referenced this pull request Feb 13, 2024
@pirat89
Release 0.17.0
1c9e2ee 
## Framework
### Enhancements
- Generated txt report file now contains also External links when part of a report (#842, #844)

## stdlib
### Fixes
- The `run` function is now compatible with Python 3.12 (#845)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pirat89 pirat89 pirat89 approved these changes

@dkubek dkubek Awaiting requested review from dkubek

Assignees
No one assigned
Labels
changelog-checked The merger/reviewer checked the changelog draft document and updated it when relevant enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@PeterMocary @pirat89