feat: add tests

Author: wangyoucao577

.github/workflows/ci.yml

@@ -31,9 +31,16 @@ jobs:
           fetch-depth: "0"
           submodules: "true"
 
-      - name: Check ten dependencies
+      - name: Check dependencies
         run: |
-          tman install
+          task install
+
+      - name: Run tests
+        run: |
+          task test -- -s -v
+      - name: Run lint
+        run: |
+          task lint -- --errors-only
 
       - name: Release
         if: startsWith(github.ref, 'refs/tags/')

Taskfile.yml

@@ -0,0 +1,43 @@
+version: '3'
+
+tasks:
+  clean:
+    desc: clean up
+    cmds:
+      - find . -type d -name .pytest_cache -exec rm -rf {} \; || true
+      - find . -type d -name __pycache__ -exec rm -rf {} \; || true
+      - find . -type d -name .ten -exec rm -rf {} \; || true
+      - find . -name .coverage -exec rm -f {} \; || true
+
+  test:
+    desc: run tests
+    cmds:
+      - task: test-standalone
+      - task: test-template
+
+  test-standalone:
+    desc: run standalone testing
+    cmds:
+      - ./tests/bin/start {{ .CLI_ARGS }}
+
+  test-template:
+    desc: run testing with publish and create by template
+    cmds:
+      - tman -c tests/local-config.json --verbose publish
+      - rm -rf ./tmp && mkdir -p tmp/
+      - cd tmp && tman -c ../tests/local-config.json --verbose create extension hello_world --template default_async_llm_tool_extension_python --template-data class_name_prefix=HelloWorld
+      - cd tmp/hello_world && tman install --standalone
+      - cd tmp/hello_world && tests/bin/start {{ .CLI_ARGS }}
+
+  install:
+    desc: install dependencies
+    cmds:
+      - tman install --standalone
+      - pip install -r requirements.txt
+
+  lint:
+    desc: lint codes
+    env:
+      PYTHONPATH: "{{.USER_WORKING_DIR}}/.ten/app/ten_packages/system/ten_runtime_python/lib:{{.USER_WORKING_DIR}}/.ten/app/ten_packages/system/ten_runtime_python/interface:{{.USER_WORKING_DIR}}/.ten/app/ten_packages/system/ten_ai_base/interface"
+    cmds:
+      -  pylint ./*.py {{ .CLI_ARGS }}

tests/bin/start

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -e
+
+cd "$(dirname "${BASH_SOURCE[0]}")/../.."
+
+export PYTHONPATH=.ten/app:.ten/app/ten_packages/system/ten_runtime_python/lib:.ten/app/ten_packages/system/ten_runtime_python/interface:.ten/app/ten_packages/system/ten_ai_base/interface
+
+# If the Python app imports some modules that are compiled with a different
+# version of libstdc++ (ex: PyTorch), the Python app may encounter confusing
+# errors. To solve this problem, we can preload the correct version of
+# libstdc++.
+#
+# export LD_PRELOAD=/lib/x86_64-linux-gnu/libstdc++.so.6
+#
+# Another solution is to make sure the module 'ten_runtime_python' is imported
+# _after_ the module that requires another version of libstdc++ is imported.
+#
+# Refer to https://github.com/pytorch/pytorch/issues/102360?from_wecom=1#issuecomment-1708989096
+
+pytest tests/ "$@"

tests/conftest.py

@@ -0,0 +1,36 @@
+#
+# Copyright © 2025 Agora
+# This file is part of TEN Framework, an open source project.
+# Licensed under the Apache License, Version 2.0, with certain conditions.
+# Refer to the "LICENSE" file in the root directory for more information.
+#
+import pytest
+import sys
+import os
+from ten import (
+    unregister_all_addons_and_cleanup,
+)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def global_setup_and_teardown():
+    # Set the environment variable.
+    os.environ["TEN_DISABLE_ADDON_UNREGISTER_AFTER_APP_CLOSE"] = "true"
+
+    # Verify the environment variable is correctly set.
+    if (
+        "TEN_DISABLE_ADDON_UNREGISTER_AFTER_APP_CLOSE" not in os.environ
+        or os.environ["TEN_DISABLE_ADDON_UNREGISTER_AFTER_APP_CLOSE"] != "true"
+    ):
+        print(
+            "Failed to set TEN_DISABLE_ADDON_UNREGISTER_AFTER_APP_CLOSE",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+    # Yield control to the test; after the test execution is complete, continue
+    # with the teardown process.
+    yield
+
+    # Teardown part.
+    unregister_all_addons_and_cleanup()

tests/local-config.json

@@ -0,0 +1,7 @@
+{
+    "registry": {
+        "default": {
+            "index": "file:///tmp/ten/registry"
+        }
+    }
+}

tests/test_basic.py

@@ -0,0 +1,54 @@
+#
+# Copyright © 2025 Agora
+# This file is part of TEN Framework, an open source project.
+# Licensed under the Apache License, Version 2.0, with certain conditions.
+# Refer to the "LICENSE" file in the root directory for more information.
+#
+from typing import Optional
+from ten import (
+    ExtensionTester,
+    TenEnvTester,
+    Cmd,
+    CmdResult,
+    StatusCode,
+    TenError,
+)
+
+
+class ExtensionTesterBasic(ExtensionTester):
+    def check_hello(
+        self,
+        ten_env: TenEnvTester,
+        result: Optional[CmdResult],
+        error: Optional[TenError],
+    ):
+        if error is not None:
+            assert False, error.error_message()
+
+        assert result is not None
+
+        statusCode = result.get_status_code()
+        ten_env.log_debug(f"receive hello_world, status: {statusCode}")
+
+        if statusCode == StatusCode.OK:
+            ten_env.stop_test()
+
+    def on_start(self, ten_env: TenEnvTester) -> None:
+        new_cmd = Cmd.create("hello_world")
+
+        ten_env.log_debug("send hello_world")
+        ten_env.send_cmd(
+            new_cmd,
+            lambda ten_env, result, error: self.check_hello(
+                ten_env, result, error
+            ),
+        )
+
+        ten_env.log_debug("tester on_start_done")
+        ten_env.on_start_done()
+
+
+def test_basic():
+    tester = ExtensionTesterBasic()
+    tester.set_test_mode_single("default_async_llm_tool_extension_python")
+    tester.run()

tests/test_basic.py.tent

@@ -0,0 +1,54 @@
+#
+# Copyright © 2025 Agora
+# This file is part of TEN Framework, an open source project.
+# Licensed under the Apache License, Version 2.0, with certain conditions.
+# Refer to the "LICENSE" file in the root directory for more information.
+#
+from typing import Optional
+from ten import (
+    ExtensionTester,
+    TenEnvTester,
+    Cmd,
+    CmdResult,
+    StatusCode,
+    TenError,
+)
+
+
+class ExtensionTesterBasic(ExtensionTester):
+    def check_hello(
+        self,
+        ten_env: TenEnvTester,
+        result: Optional[CmdResult],
+        error: Optional[TenError],
+    ):
+        if error is not None:
+            assert False, error.error_message()
+
+        assert result is not None
+
+        statusCode = result.get_status_code()
+        ten_env.log_debug(f"receive hello_world, status: {statusCode}")
+
+        if statusCode == StatusCode.OK:
+            ten_env.stop_test()
+
+    def on_start(self, ten_env: TenEnvTester) -> None:
+        new_cmd = Cmd.create("hello_world")
+
+        ten_env.log_debug("send hello_world")
+        ten_env.send_cmd(
+            new_cmd,
+            lambda ten_env, result, error: self.check_hello(
+                ten_env, result, error
+            ),
+        )
+
+        ten_env.log_debug("tester on_start_done")
+        ten_env.on_start_done()
+
+
+def test_basic():
+    tester = ExtensionTesterBasic()
+    tester.set_test_mode_single("{{package_name}}")
+    tester.run()