Use pytest to run project tests #121

weklund · 2025-06-29T19:23:10Z

Use pytest to run all tests
Add status badge with static value of 68% after running it locally
Add CLAUDE.md to help any developers that use Claude Code
Configure codecov to dynamically set status badge

Here was the output from local coverage:

❯ make test-cov
PYTHONPATH=.:test python3 -m pytest test/unit/ test/integration/ --cov=ibind --cov-report=term-missing --cov-report=html
=================================== test session starts ===================================
platform darwin -- Python 3.12.10, pytest-8.4.1, pluggy-1.6.0
rootdir: /Users/weseklund/Projects/forks/ibind
configfile: pytest.ini
plugins: cov-5.0.0
collected 73 items                                                                        

test/unit/support/test_py_utils_u.py ..............                                 [ 19%]
test/integration/base/test_rest_client_i.py ........                                [ 30%]
test/integration/base/test_websocket_client_i.py ........                           [ 41%]
test/integration/client/test_ibkr_client_i.py ................                      [ 63%]
test/integration/client/test_ibkr_utils_i.py ...........                            [ 78%]
test/integration/client/test_ibkr_ws_client_i.py ................                   [100%]

--------- coverage: platform darwin, python 3.12.10-final-0 ----------
Name                                                  Stmts   Miss  Cover   Missing
-----------------------------------------------------------------------------------
ibind/__init__.py                                        14      0   100%
ibind/base/__init__.py                                    0      0   100%
ibind/base/queue_controller.py                           18      0   100%
ibind/base/rest_client.py                               133     26    80%   98, 105, 249-258, 263-265, 277-278, 287-289, 311-314, 317-323, 332
ibind/base/subscription_controller.py                   122     32    74%   64, 66-68, 73-74, 85, 88, 91, 99-100, 153, 172-190, 210, 282, 285, 288-291, 325, 333
ibind/base/ws_client.py                                 216     38    82%   62, 87, 92, 115-117, 121-126, 148, 152-153, 165-166, 187, 193-195, 199-201, 235, 244, 251-253, 313-318, 359, 435-436, 453, 466
ibind/client/__init__.py                                  0      0   100%
ibind/client/ibkr_client.py                              81     38    53%   81-85, 108-111, 124-127, 135-141, 155-157, 188-211, 227-229, 242-243, 246-248, 257-259
ibind/client/ibkr_client_mixins/__init__.py               0      0   100%
ibind/client/ibkr_client_mixins/accounts_mixin.py         4      0   100%
ibind/client/ibkr_client_mixins/contract_mixin.py        25      0   100%
ibind/client/ibkr_client_mixins/marketdata_mixin.py      55     23    58%   54-84, 225, 235, 297
ibind/client/ibkr_client_mixins/order_mixin.py           22     12    45%   110-118, 183-191
ibind/client/ibkr_client_mixins/portfolio_mixin.py        5      0   100%
ibind/client/ibkr_client_mixins/scanner_mixin.py          5      0   100%
ibind/client/ibkr_client_mixins/session_mixin.py         24      1    96%   90
ibind/client/ibkr_client_mixins/watchlist_mixin.py        4      0   100%
ibind/client/ibkr_definitions.py                          6      0   100%
ibind/client/ibkr_utils.py                              217     41    81%   222, 310-313, 316, 425-426, 585-588, 599-602, 621-624, 627-639, 648-654, 666-671
ibind/client/ibkr_ws_client.py                          223     53    76%   272, 275-279, 317, 322-324, 327, 346, 379, 384-385, 397-404, 410-411, 419-430, 435-448, 468, 472, 476, 489, 502, 520, 523, 536
ibind/oauth/__init__.py                                  26     26     0%   1-58
ibind/oauth/oauth1a.py                                  164    164     0%   1-466
ibind/support/__init__.py                                 0      0   100%
ibind/support/errors.py                                   4      0   100%
ibind/support/logs.py                                    63     40    37%   54-73, 98-109, 118-121, 124-125, 128, 131-136, 139-143
ibind/support/py_utils.py                                87     16    82%   307, 323-331, 337-350
ibind/var.py                                             78      2    97%   24-25
-----------------------------------------------------------------------------------
TOTAL                                                  1596    512    68%
Coverage HTML written to dir htmlcov

Voyz

Great to see this moving forward, thanks for the contribution 🙌 I've left a few small comments, but looks good in general

Voyz · 2025-07-03T17:03:14Z

CLAUDE.md

Hey, I understand this is useful to you, but I personally don't use Claude, so I'd think this should be in .gitignore. I'd have hoped for a standard AGENTS.md file to be propagated through the industry, but sadly that doesn't seem to be the case yet 🥲

As a helper to any contributor, it would be nice to have all the agent type things, but we can leave for another discussion.

I can add all types to gitignore

Can it maybe be added in some sub-directory? Like './AI/CLAUDE.MD` or alike? I'd think it would be awesome to start including these, but I'd rather not see the root dir polluted with settings that are individual to each dev - similar to .iml, .vscode, .venv, etc.

Or agents/CLAUDE.md ?

ahh that's awesome! yeah, let's go with that!

README.md

Voyz · 2025-07-03T17:10:31Z

pytest.ini

+[tool:pytest]
+testpaths = test
+pythonpath = . test
+addopts = -v --tb=short
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*


I've been trying to use pytest (and Pydantic!) in other projects to transition myself to your camp slowly, and I think these look like they're like this by default. Is there a need to specify any of them?

So there's a few in here that are redundant, but others aren't, I can remove the defaults.

Great, thanks! 👍

runs

weklund · 2025-07-07T20:52:41Z

This is exciting! Passing tests on some OS/versions and failing on others! This is exactly the benefit for doing all of this in CI.

Ok time to fix it now haha.

Voyz · 2025-07-10T07:29:13Z

Awesome, indeed! Kudos for introducing all that CI pipe 🙌

The test_utils import issue is probably related to pytest not finding that file. Any idea on how to fix it? Was it caused by removing any of these config lines from pytest.ini?

weklund · 2025-07-22T01:40:17Z

Looks like we're good! Do you mind one more pass if I've missed anything @Voyz ?

Voyz · 2025-07-22T16:52:11Z

Pretty much there, just need to remove that badge for now:

 <a href="https://github.com/Voyz/ibind">
        <img src="https://img.shields.io/badge/coverage-68%25-green.svg"/>
    </a>

weklund · 2025-07-23T01:56:39Z

@Voyz Ah yes! Here we go.

Voyz · 2025-07-23T15:21:24Z

Sweet! LGTM, thanks 🙌

feat: use pytest to run tests

c000163

weklund mentioned this pull request Jun 29, 2025

[Enhancement] Configure unit tests to run during CI action and set a goal for test coverage #96

Open

Voyz reviewed Jul 3, 2025

View reviewed changes

weklund added 2 commits July 7, 2025 16:27

Merge branch 'Voyz:master' into master

e82dbe5

fix: move claude file; feat: enable pytest

d9c30b3

runs

weklund added 3 commits July 21, 2025 21:17

fix: attempt to fix multi OS test running

69f8ee9

fix: Ensure windows based systems path works

56c98d1

fix: Try explicit windows command run

48969e9

weklund marked this pull request as ready for review July 22, 2025 01:40

fix: remove unneeded badge

cd5e361

Voyz merged commit 55c4215 into Voyz:master Jul 23, 2025
8 checks passed

Use pytest to run project tests #121

Use pytest to run project tests #121

Uh oh!

Conversation

weklund commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Voyz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weklund commented Jul 7, 2025

Uh oh!

Voyz commented Jul 10, 2025

Uh oh!

weklund commented Jul 22, 2025

Uh oh!

Voyz commented Jul 22, 2025

Uh oh!

weklund commented Jul 23, 2025

Uh oh!

Voyz commented Jul 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

weklund commented Jun 29, 2025 •

edited

Loading