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

PR: tests/unit/test_utils: Parametrize and increase test coverage #1768

Merged
merged 6 commits into from
Aug 17, 2023

Conversation

bigtedde
Copy link
Collaborator

@bigtedde bigtedde commented Aug 6, 2023

Description

It is possible to reduce code duplication in the utils unit tests by using parametrization. Additionally, there are a some utils functions that still needed testing. In this PR, I aim to solve both of these issues.

Related Issue

#1754

Motivation and Context

One of my Google Summer of Code projects involves cleaning up the Vorta tests, reducing duplicated code, and increasing code coverage.

How Has This Been Tested?

Tests work locally by running pytest, and they pass the GitHub CI checks.

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.

@bigtedde bigtedde changed the title Utils unit tests: Parametrized and added tests utils unit tests: parametrize and increase test coverage Aug 7, 2023
@bigtedde bigtedde changed the title utils unit tests: parametrize and increase test coverage PR: tests/unit/test_utils: Parametrize and increase test coverage Aug 9, 2023
@bigtedde bigtedde marked this pull request as ready for review August 10, 2023 19:02


def test_normalize_path():
# Test that path is normalized for macOS, but does nothing for other platforms.
Copy link
Contributor

Choose a reason for hiding this comment

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

How about using normal docstrings to document the function (not lines within a function). That's what's used for other newer Vorta code. E.g.

def blah_func():
  """
  Lorem ipsum...
  """

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done 👍

@m3nu m3nu merged commit fb42614 into borgbase:master Aug 17, 2023
39 checks passed
@bigtedde bigtedde deleted the test_utils branch August 17, 2023 17:13
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.

2 participants