Skip to content

Switching some unit tests to doctest #5383

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

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from

Conversation

vvysokikh1
Copy link
Collaborator

@vvysokikh1 vvysokikh1 commented Apr 3, 2025

High Level Overview of Change

This PR is continuation of work done by @thejohnfreeman. We intend to move from our unit tests framework to doctest.

Context of Change

Type of Change

  • 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 not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Performance (increase or change in throughput and/or latency)
  • Tests (you added tests for code that already exists, or your new feature included in this PR)
  • Documentation update
  • Chore (no impact to binary, e.g. .gitignore, formatting, dropping support for older tooling)
  • Release

API Impact

  • Public API: New feature (new methods and/or new fields)
  • Public API: Breaking change (in general, breaking changes should only impact the next api_version)
  • libxrpl change (any change that may affect libxrpl or dependents of libxrpl)
  • Peer protocol change (must be backward compatible or bump the peer protocol version)

@thejohnfreeman
Copy link
Contributor

Happy to help with this as I can. Will take a look this evening. Please communicate with me here if there's something you'd like to ask.

Copy link

codecov bot commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.1%. Comparing base (c4308b2) to head (6319dec).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           develop   #5383     +/-   ##
=========================================
- Coverage     78.1%   78.1%   -0.0%     
=========================================
  Files          795     794      -1     
  Lines        68598   68498    -100     
  Branches      8278    8277      -1     
=========================================
- Hits         53593   53495     -98     
+ Misses       15005   15003      -2     

see 7 files with indirect coverage changes

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@thejohnfreeman thejohnfreeman left a comment

Choose a reason for hiding this comment

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

Tests build and pass on my machine. 👍

@@ -116,6 +117,7 @@ def requirements(self):
'external/*',
'include/*',
'src/*',
'tests/*',
Copy link
Contributor

Choose a reason for hiding this comment

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

This line is no longer needed if you're using src/tests instead of tests. I still recommend tests as a matter of convention.

@vvysokikh1 vvysokikh1 changed the title [WIP] Switched some unit tests to doctest Switching some unit tests to doctest Apr 24, 2025
@vvysokikh1 vvysokikh1 marked this pull request as ready for review April 24, 2025 15:21
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