tests: add units for shortcut (only)

Author: StrayDragon

.cursorignore

@@ -0,0 +1,3 @@
+# Add directories or file patterns to ignore during indexing (e.g. foo/ or *.csv)
+# NOTE: 不对旧飞书sdk进行索引
+src/lark_oapi_compact/remaintain

README.md

@@ -4,7 +4,9 @@
 [![image](https://img.shields.io/pypi/pyversions/lark-oapi-compact.svg)](https://pypi.python.org/pypi/lark-oapi-compact)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![codecov](https://codecov.io/gh/StrayDragon/oapi-sdk-python-compact/branch/main/graph/badge.svg)](https://codecov.io/gh/StrayDragon/oapi-sdk-python-compact)
 
 
 - 上游 https://github.com/larksuite/oapi-sdk-python 的默认分支 [v2_main](https://github.com/larksuite/oapi-sdk-python/tree/v2_main) 提供的API不全, 但是老分支 [main](https://github.com/larksuite/oapi-sdk-python/tree/main) 有一部分可以利用, 这个包将老分支的代码进行合并并兼容处理
 - 增加一些方便使用的快捷函数, 见 [src/lark_oapi_compact/shortcut](./src/lark_oapi_compact/shortcut/README.md)
+- 归档并弃用 https://github.com/StrayDragon/oapi-sdk-python

pyproject.toml

@@ -46,6 +46,14 @@ build-backend = "hatchling.build"
 dev-dependencies = [
     "ipython>=7.34.0",
     "pre-commit>=2.21.0",
+    "pytest-cov>=4.1.0",
     "pytest>=7.4.4",
     "ruff>=0.6.8",
 ]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = [
+    "tests",
+]

tests/conftest.py

@@ -0,0 +1,35 @@
+import os
+
+import pytest
+from lark_oapi_compact.shortcut.compact import FeishuOpenAPICompactSettings
+from lark_oapi_compact.shortcut.driver import FeishuDriverShortcut
+from lark_oapi_compact.shortcut.sheets import FeishuSheetsShortcut
+
+
+@pytest.fixture(scope="session")
+def feishu_settings():
+    app_id = os.environ.get("FEISHU_APP_ID", "")
+    app_secret = os.environ.get("FEISHU_APP_SECRET", "")
+    if not app_id or not app_secret:
+        raise ValueError("FEISHU_APP_ID and FEISHU_APP_SECRET must be set")
+    return FeishuOpenAPICompactSettings(
+        app_id=app_id,
+        app_secret=app_secret,
+        name="Test Feishu OAPI App",
+    )
+
+
+@pytest.fixture(scope="session")
+def driver_shortcut(feishu_settings):
+    return FeishuDriverShortcut(feishu_settings)
+
+
+@pytest.fixture(scope="session")
+def sheets_shortcut(feishu_settings):
+    return FeishuSheetsShortcut(feishu_settings)
+
+
+@pytest.fixture
+def testing_folder_token(driver_shortcut):
+    folder_meta = driver_shortcut.get_self_root_folder_meta()
+    return folder_meta.token

tests/test_driver.py

@@ -0,0 +1,9 @@
+def test_get_self_root_folder_meta(driver_shortcut):
+    result = driver_shortcut.get_self_root_folder_meta()
+    assert result is not None
+
+
+def test_get_folder_meta(driver_shortcut):
+    folder_token = driver_shortcut.get_self_root_folder_meta().token
+    result = driver_shortcut.get_folder_meta(folder_token)
+    assert result is not None

tests/test_group_robot.py

@@ -0,0 +1,22 @@
+import os
+
+import pytest
+from lark_oapi_compact.shortcut.group_robot import FeishuGroupRobotShortCut
+
+
+@pytest.fixture
+def group_robot_shortcut():
+    web_hook_url = os.environ.get("FEISHU_GROUP_ROBOT_WEBHOOK_URL", "")
+    sign_secret = os.environ.get("FEISHU_GROUP_ROBOT_SIGN_SECRET", "")
+    if not all([web_hook_url, sign_secret]):
+        raise ValueError("FEISHU_GROUP_ROBOT_WEBHOOK_URL and FEISHU_GROUP_ROBOT_SIGN_SECRET must be set")
+    return FeishuGroupRobotShortCut(
+        web_hook_url=web_hook_url,
+        sign_secret=sign_secret,
+    )
+
+
+def test_send_message(group_robot_shortcut):
+    message_data = {"msg_type": "text", "content": {"text": "This is a test message"}}
+    group_robot_shortcut.send_message(message_data)
+    assert True

tests/test_message.py

@@ -0,0 +1,14 @@
+import pytest
+from lark_oapi_compact.shortcut.message import FeishuMessageShortcut
+
+
+@pytest.fixture
+def message_shortcut(feishu_settings):
+    return FeishuMessageShortcut(feishu_settings)
+
+
+@pytest.mark.skip(reason="TODO: Not total implemented!")
+def test_send_group_robot_message(message_shortcut):
+    body = {"msg_type": "text", "content": {"text": "This is a test message"}}
+    result = message_shortcut.send_group_robot_message(body)
+    assert result is not None

tests/test_sheets.py

@@ -0,0 +1,175 @@
+import time
+
+import pytest
+from lark_oapi_compact.shortcut.sheets.models import CellPos, CellsRange, SheetRange
+
+SPREADSHEET_TITLE = "Test Spreadsheet"
+SHEET_TITLE = f"Testing Sheet {time.time()}"
+
+
+@pytest.fixture
+def testing_spreadsheet(sheets_shortcut, testing_folder_token):
+    spreadsheet = sheets_shortcut.create_spreadsheet(testing_folder_token, SPREADSHEET_TITLE)
+    yield spreadsheet
+
+
+@pytest.fixture
+def testing_sheet_id(sheets_shortcut, testing_spreadsheet):
+    sheet_id = sheets_shortcut.create_sheet(
+        testing_spreadsheet.spreadsheet_token,
+        title=SHEET_TITLE,
+    ).get(SHEET_TITLE, "")
+    assert sheet_id, f"Failed to create sheet {SHEET_TITLE}"
+    yield sheet_id
+    sheets_shortcut.remove_sheet(testing_spreadsheet.spreadsheet_token, sheet_id)
+
+
+def test_create_spreadsheet(testing_spreadsheet):
+    assert testing_spreadsheet is not None
+    assert testing_spreadsheet.title == SPREADSHEET_TITLE
+
+
+def test_change_spreadsheet_permission(sheets_shortcut, testing_spreadsheet):
+    sheets_shortcut.change_spreadsheet_permission(testing_spreadsheet.spreadsheet_token, "tenant_editable")
+
+
+def test_get_spreadsheet_sheets(sheets_shortcut, testing_spreadsheet):
+    sheets = sheets_shortcut.get_spreadsheet_sheets(testing_spreadsheet.spreadsheet_token)
+    assert isinstance(sheets, list)
+    assert len(sheets) > 0
+
+
+def test_find_cell_locations_in_sheet(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    sheets_shortcut.batch_update_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [(CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="A", y=1)), [["test_value"]])],
+    )
+    result = sheets_shortcut.find_cell_locations_in_sheet(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, "test_value"
+    )
+    assert result is not None
+    assert len(result.matched_cells) > 0
+
+
+def test_recursive_find_cell_locations_in_sheet(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    sheets_shortcut.batch_update_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [
+            (
+                CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="A", y=3)),
+                [["value1"], ["value2"], ["value3"]],
+            )
+        ],
+    )
+    result = sheets_shortcut.recursive_find_cell_locations_in_sheet(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, ["value1", "value2", "value3"]
+    )
+    assert result is not None
+
+
+def test_batch_handle_sheets(sheets_shortcut, testing_spreadsheet):
+    new_sheet = sheets_shortcut.create_sheet(testing_spreadsheet.spreadsheet_token, "New Sheet")
+    assert len(new_sheet) > 0
+    for sheet_id in new_sheet.values():
+        sheets_shortcut.remove_sheet(testing_spreadsheet.spreadsheet_token, sheet_id)
+    sheets = sheets_shortcut.get_spreadsheet_sheets(testing_spreadsheet.spreadsheet_token)
+    assert all(sheet.title != "New Sheet" for sheet in sheets)
+
+
+def test_merge_and_unmerge_cells(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    merge_range = CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="B", y=2))
+    sheets_shortcut.merge_cells(testing_spreadsheet.spreadsheet_token, testing_sheet_id, merge_range)
+
+    sheet_range = SheetRange(sheet_id=testing_sheet_id, start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="B", y=2))
+    sheets_shortcut.unmerge_cells(testing_spreadsheet.spreadsheet_token, sheet_range)
+
+
+def test_prepend_and_append_insert_values(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    values = [["prepend1"], ["prepend2"]]
+    sheets_shortcut.prepend_insert_values(testing_spreadsheet.spreadsheet_token, testing_sheet_id, values=values)
+
+    values = [["append1"], ["append2"]]
+    sheets_shortcut.append_insert_values(testing_spreadsheet.spreadsheet_token, testing_sheet_id, values=values)
+
+    result = sheets_shortcut.batch_read_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="A", y=4))],
+    )
+    assert list(result.values())[0] == [["prepend1"], ["prepend2"], ["append1"], ["append2"]]
+
+
+def test_batch_update_and_read_values(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    update_range = CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="B", y=2))
+    values = [["A1", "B1"], ["A2", "B2"]]
+    sheets_shortcut.batch_update_values(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, [(update_range, values)]
+    )
+
+    read_result = sheets_shortcut.batch_read_values(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, [update_range]
+    )
+    assert list(read_result.values())[0] == values
+
+
+def test_update_formula_value_cell(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    formula = "=SUM(A1:A2)"
+    result_cell = CellPos(x="B", y=3)
+    sheets_shortcut.update_formula_value_cell(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, formula, result_cell
+    )
+    read_result = sheets_shortcut.batch_read_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [CellsRange(start_pos=result_cell, end_pos=result_cell)],
+        value_render_option="Formula",
+    )
+    assert list(read_result.values())[0] == [[formula]]
+
+
+def test_update_formula_value_cell_using_sum_of_cell_range(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    target_range = CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="A", y=2))
+    result_cell = CellPos(x="B", y=3)
+    sheets_shortcut.update_formula_value_cell_using_sum_of_cell_range(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, target_range, result_cell
+    )
+    read_result = sheets_shortcut.batch_read_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [CellsRange(start_pos=result_cell, end_pos=result_cell)],
+        value_render_option="Formula",
+    )
+    assert list(read_result.values())[0] == [["=SUM(A1:A2)"]]
+
+
+def test_insert_and_delete_dimension(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    sheets_shortcut.insert_dimension(testing_spreadsheet.spreadsheet_token, testing_sheet_id, "ROWS", 0, 1)
+    sheets_shortcut.delete_dimension(testing_spreadsheet.spreadsheet_token, testing_sheet_id, "ROWS", 1, 2)
+
+
+def test_truncate_and_replace_sheet(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    sheets_shortcut.truncate_sheet(testing_spreadsheet.spreadsheet_token, testing_sheet_id)
+
+    new_values = [["new1"], ["new2"]]
+    sheets_shortcut.replace_sheet_by_values(testing_spreadsheet.spreadsheet_token, testing_sheet_id, new_values)
+
+    read_result = sheets_shortcut.batch_read_values(
+        testing_spreadsheet.spreadsheet_token,
+        testing_sheet_id,
+        [CellsRange(start_pos=CellPos(x="A", y=1), end_pos=CellPos(x="A", y=2))],
+    )
+    assert list(read_result.values())[0] == new_values
+
+
+def test_insert_image_to_cell(sheets_shortcut, testing_spreadsheet, testing_sheet_id):
+    cell_pos = CellPos(x="A", y=1)
+    # 5x5的纯黑色图片
+    # fmt: off
+    image_byte_array = [137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0, 0, 5, 0, 0, 0, 5, 8, 2, 0, 0, 0, 2, 13, 177, 178, 0, 0, 0, 12, 73, 68, 65, 84, 120, 156, 99, 96, 160, 46, 0, 0, 0, 80, 0, 1, 243, 48, 247, 42, 0, 0, 0, 0, 73, 69, 78, 68, 174, 66, 96, 130]  # noqa: E501
+    # fmt: on
+    sheets_shortcut.insert_image_to_cell(
+        testing_spreadsheet.spreadsheet_token, testing_sheet_id, cell_pos, image_byte_array, "test_image.png"
+    )
+    assert True