Skip to content

feat: add ci cd #130

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

Merged
okxapi merged 5 commits into from
Dec 19, 2025
Merged

feat: add ci cd #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
11efc37
feat: add ci cd
Dec 19, 2025
81c269c
feat: add ci cd and remove wrong commit for gitlab
Dec 19, 2025
89e8e25
feat: add cicd
Dec 19, 2025
2d47171
fix: missing import
Dec 19, 2025
ee04e6b
fix: broken testing
Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# GitHub Actions CI/CD Configuration for python-okx
name: CI

on:
push:
branches:
- master
- 'release/*'
- 'releases/*'
pull_request:
branches:
- master
- 'release/*'
- 'releases/*'

jobs:
# ============================================
# LINT JOB
# ============================================
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install linting tools
run: |
python -m pip install --upgrade pip
pip install flake8

- name: Run flake8
run: |
flake8 okx/ --max-line-length=120 --ignore=E501,W503,E203 --count --show-source --statistics
continue-on-error: true # Set to false once codebase is cleaned up

# ============================================
# TEST JOB
# ============================================
test:
name: Test (Python ${{ matrix.python-version }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v4

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

- name: Cache pip dependencies
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
restore-keys: |
${{ runner.os }}-pip-${{ matrix.python-version }}-
${{ runner.os }}-pip-

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .
pip install pytest pytest-cov pytest-asyncio websockets certifi

- name: Run tests
run: |
python -m pytest test/unit/ -v --cov=okx --cov-report=term-missing --cov-report=xml

- name: Upload coverage to Codecov
if: matrix.python-version == '3.11'
uses: codecov/codecov-action@v4
with:
file: ./coverage.xml
fail_ci_if_error: false

# ============================================
# BUILD JOB
# ============================================
build:
name: Build Package
runs-on: ubuntu-latest
needs: [test]

steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Install build tools
run: |
python -m pip install --upgrade pip
pip install build twine

- name: Build package
run: python -m build

- name: Check package
run: twine check dist/*

- name: Upload build artifacts
uses: actions/upload-artifact@v4
with:
name: dist
path: dist/
retention-days: 7

4 changes: 3 additions & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
"loguru",
"requests",
"Twisted",
"pyOpenSSL"
"pyOpenSSL",
"websockets",
"certifi"
]
)
47 changes: 21 additions & 26 deletions test/unit/okx/websocket/test_ws_private_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@
import asyncio
from unittest.mock import patch, MagicMock, AsyncMock

# Import the module first so patch can resolve the path
import okx.websocket.WsPrivateAsync as ws_private_module
from okx.websocket.WsPrivateAsync import WsPrivateAsync


class TestWsPrivateAsyncInit(unittest.TestCase):
"""Unit tests for WsPrivateAsync initialization"""

def test_init_with_required_params(self):
"""Test initialization with required parameters"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory') as mock_factory:
from okx.websocket.WsPrivateAsync import WsPrivateAsync
with patch.object(ws_private_module, 'WebSocketFactory') as mock_factory:
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand All @@ -37,13 +40,12 @@ class TestWsPrivateAsyncSubscribe(unittest.TestCase):

def test_subscribe_sends_correct_payload(self):
"""Test subscribe sends correct payload after login"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory'), \
patch('okx.websocket.WsPrivateAsync.WsUtils.initLoginParams') as mock_init_login, \
patch('okx.websocket.WsPrivateAsync.asyncio.sleep', new_callable=AsyncMock):
with patch.object(ws_private_module, 'WebSocketFactory'), \
patch.object(ws_private_module, 'WsUtils') as mock_ws_utils, \
patch.object(ws_private_module.asyncio, 'sleep', new_callable=AsyncMock):

mock_init_login.return_value = '{"op":"login"}'
mock_ws_utils.initLoginParams.return_value = '{"op":"login"}'

from okx.websocket.WsPrivateAsync import WsPrivateAsync
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand All @@ -70,13 +72,12 @@ async def run_test():

def test_subscribe_with_id(self):
"""Test subscribe with id parameter"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory'), \
patch('okx.websocket.WsPrivateAsync.WsUtils.initLoginParams') as mock_init_login, \
patch('okx.websocket.WsPrivateAsync.asyncio.sleep', new_callable=AsyncMock):
with patch.object(ws_private_module, 'WebSocketFactory'), \
patch.object(ws_private_module, 'WsUtils') as mock_ws_utils, \
patch.object(ws_private_module.asyncio, 'sleep', new_callable=AsyncMock):

mock_init_login.return_value = '{"op":"login"}'
mock_ws_utils.initLoginParams.return_value = '{"op":"login"}'

from okx.websocket.WsPrivateAsync import WsPrivateAsync
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand Down Expand Up @@ -105,8 +106,7 @@ class TestWsPrivateAsyncUnsubscribe(unittest.TestCase):

def test_unsubscribe_sends_correct_payload(self):
"""Test unsubscribe sends correct payload"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory'):
from okx.websocket.WsPrivateAsync import WsPrivateAsync
with patch.object(ws_private_module, 'WebSocketFactory'):
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand All @@ -131,8 +131,7 @@ async def run_test():

def test_unsubscribe_with_id(self):
"""Test unsubscribe with id parameter"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory'):
from okx.websocket.WsPrivateAsync import WsPrivateAsync
with patch.object(ws_private_module, 'WebSocketFactory'):
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand Down Expand Up @@ -160,12 +159,11 @@ class TestWsPrivateAsyncLogin(unittest.TestCase):

def test_login_calls_init_login_params(self):
"""Test login calls WsUtils.initLoginParams with correct parameters"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory'), \
patch('okx.websocket.WsPrivateAsync.WsUtils.initLoginParams') as mock_init_login:
with patch.object(ws_private_module, 'WebSocketFactory'), \
patch.object(ws_private_module, 'WsUtils') as mock_ws_utils:

mock_init_login.return_value = '{"op":"login","args":[...]}'
mock_ws_utils.initLoginParams.return_value = '{"op":"login","args":[...]}'

from okx.websocket.WsPrivateAsync import WsPrivateAsync
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
Expand All @@ -179,7 +177,7 @@ def test_login_calls_init_login_params(self):
async def run_test():
result = await ws.login()
self.assertTrue(result)
mock_init_login.assert_called_once_with(
mock_ws_utils.initLoginParams.assert_called_once_with(
useServerTime=True,
apiKey="test_api_key",
passphrase="test_passphrase",
Expand All @@ -193,26 +191,23 @@ class TestWsPrivateAsyncStartStop(unittest.TestCase):
"""Unit tests for WsPrivateAsync start and stop methods"""

def test_stop(self):
"""Test stop method closes the factory and stops loop"""
with patch('okx.websocket.WsPrivateAsync.WebSocketFactory') as mock_factory_class:
"""Test stop method closes the factory"""
with patch.object(ws_private_module, 'WebSocketFactory') as mock_factory_class:
mock_factory_instance = MagicMock()
mock_factory_instance.close = AsyncMock()
mock_factory_class.return_value = mock_factory_instance

from okx.websocket.WsPrivateAsync import WsPrivateAsync
ws = WsPrivateAsync(
apiKey="test_api_key",
passphrase="test_passphrase",
secretKey="test_secret_key",
url="wss://test.example.com",
useServerTime=False
)
ws.loop = MagicMock()

async def run_test():
await ws.stop()
mock_factory_instance.close.assert_called_once()
ws.loop.stop.assert_called_once()

asyncio.get_event_loop().run_until_complete(run_test())

Expand Down
27 changes: 11 additions & 16 deletions test/unit/okx/websocket/test_ws_public_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@
import asyncio
from unittest.mock import patch, MagicMock, AsyncMock

# Import the module first so patch can resolve the path
import okx.websocket.WsPublicAsync as ws_public_module
from okx.websocket.WsPublicAsync import WsPublicAsync


class TestWsPublicAsyncInit(unittest.TestCase):
"""Unit tests for WsPublicAsync initialization"""

def test_init_with_url(self):
"""Test initialization with url parameter"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory') as mock_factory:
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory') as mock_factory:
ws = WsPublicAsync(url="wss://test.example.com")

self.assertEqual(ws.url, "wss://test.example.com")
Expand All @@ -29,8 +32,7 @@ class TestWsPublicAsyncSubscribe(unittest.TestCase):

def test_subscribe_sets_callback(self):
"""Test subscribe sets callback correctly"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory'):
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory'):
ws = WsPublicAsync(url="wss://test.example.com")
mock_websocket = AsyncMock()
ws.websocket = mock_websocket
Expand All @@ -53,8 +55,7 @@ async def run_test():

def test_subscribe_with_id(self):
"""Test subscribe with id parameter"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory'):
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory'):
ws = WsPublicAsync(url="wss://test.example.com")
mock_websocket = AsyncMock()
ws.websocket = mock_websocket
Expand All @@ -75,8 +76,7 @@ async def run_test():

def test_subscribe_with_multiple_channels(self):
"""Test subscribe with multiple channels"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory'):
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory'):
ws = WsPublicAsync(url="wss://test.example.com")
mock_websocket = AsyncMock()
ws.websocket = mock_websocket
Expand All @@ -101,8 +101,7 @@ class TestWsPublicAsyncUnsubscribe(unittest.TestCase):

def test_unsubscribe_without_id(self):
"""Test unsubscribe without id parameter"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory'):
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory'):
ws = WsPublicAsync(url="wss://test.example.com")
mock_websocket = AsyncMock()
ws.websocket = mock_websocket
Expand All @@ -121,8 +120,7 @@ async def run_test():

def test_unsubscribe_with_id(self):
"""Test unsubscribe with id parameter"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory'):
from okx.websocket.WsPublicAsync import WsPublicAsync
with patch.object(ws_public_module, 'WebSocketFactory'):
ws = WsPublicAsync(url="wss://test.example.com")
mock_websocket = AsyncMock()
ws.websocket = mock_websocket
Expand All @@ -144,19 +142,16 @@ class TestWsPublicAsyncStartStop(unittest.TestCase):

def test_stop(self):
"""Test stop method closes the factory"""
with patch('okx.websocket.WsPublicAsync.WebSocketFactory') as mock_factory_class:
with patch.object(ws_public_module, 'WebSocketFactory') as mock_factory_class:
mock_factory_instance = MagicMock()
mock_factory_instance.close = AsyncMock()
mock_factory_class.return_value = mock_factory_instance

from okx.websocket.WsPublicAsync import WsPublicAsync
ws = WsPublicAsync(url="wss://test.example.com")
ws.loop = MagicMock()

async def run_test():
await ws.stop()
mock_factory_instance.close.assert_called_once()
ws.loop.stop.assert_called_once()

asyncio.get_event_loop().run_until_complete(run_test())

Expand Down
Loading