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.

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

Prevent exception while running BorgVersionJob with unexpected lines on stderr #1934

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ntninja
Copy link

@ntninja ntninja commented Feb 12, 2024

Description

The borg job logic expects the profile_name key to be unconditionally present in the params if any data is received on stderr. This causes the BorgVersionJob (which didn’t set this param) to fail if any unexpected output – such as LD_PRELOAD warnings – in generated while running borg --version. This in turn causes Vorta to silently (other than an unrelated looking exception in the console output) fall back to assuming borg 1.1.0 as the borg version.

Related Issue

Please don’t make me create an issue for this…

Motivation and Context

Borg version detection currently silently fails in environments that have LD_PRELOAD set in a way to causes warnings to be emitted.

How Has This Been Tested?

The change is pretty trivial, so I just tested with and without.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have read the CONTRIBUTING guide.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

I provide my contribution under the terms of the license of this repository and I affirm the Developer Certificate of Origin.

Copy link
Collaborator

@real-yfprojects real-yfprojects left a comment

Choose a reason for hiding this comment

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

Thank you for taking the time to create this PR. You can find my commentary below.

src/vorta/borg/version.py Show resolved Hide resolved
@m3nu
Copy link
Contributor

m3nu commented Feb 13, 2024

Was also looking at this. Currently wondering about the test timeouts on Linux. A Github glitch?

@real-yfprojects
Copy link
Collaborator

real-yfprojects commented Feb 14, 2024

A Github glitch?

Not sure what it is, but the line collecting ... collected 166 items was already produced 13min 4min in. So either it was idling for 7 minutes or there is a step in pytest that took this long and doesn't produce any output.

…on stderr

The borg job logic expects the `profile_name` key to be unconditionally present in the params if any data is received on stderr. This causes the BorgVersionJob (which didn’t set this param) to fail if any unexpected output – such as LD_PRELOAD warnings – in generated while running `borg --version`. This in turn causes Vorta to silently (other than an unrelated looking exception in the console output) fall back to assuming borg 1.1.0 as the borg version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants