mirror of
https://github.com/openai/codex.git
synced 2026-05-14 00:02:33 +00:00
96d2ea9058
## Summary Adds an app-server `plugin/skill/read` method for remote plugin skill markdown. The new method calls the plugin-service skill detail endpoint and returns `skill_md_contents`, so clients can preview skills for remote plugins before the bundle is installed locally. ## Why Uninstalled remote plugin skills do not have local `SKILL.md` files. Without an on-demand remote read, the desktop plugin details UI cannot render the skill details modal for those skills. ## Validation - `just write-app-server-schema` - `just fmt` - `cargo test -p codex-app-server-protocol` - `cargo test -p codex-app-server --test all -- suite::v2::plugin_read::plugin_skill_read_reads_remote_skill_contents_when_remote_plugin_enabled --exact` - `just fix -p codex-app-server-protocol -p codex-core-plugins -p codex-app-server`
274 lines
7.9 KiB
Python
274 lines
7.9 KiB
Python
from __future__ import annotations
|
|
|
|
import importlib.resources as resources
|
|
import inspect
|
|
import tomllib
|
|
from pathlib import Path
|
|
from typing import Any
|
|
|
|
import codex_app_server
|
|
from codex_app_server import AppServerConfig, RunResult
|
|
from codex_app_server.models import InitializeResponse
|
|
from codex_app_server.api import AsyncCodex, AsyncThread, Codex, Thread
|
|
|
|
|
|
def _keyword_only_names(fn: object) -> list[str]:
|
|
signature = inspect.signature(fn)
|
|
return [
|
|
param.name
|
|
for param in signature.parameters.values()
|
|
if param.kind == inspect.Parameter.KEYWORD_ONLY
|
|
]
|
|
|
|
|
|
def _assert_no_any_annotations(fn: object) -> None:
|
|
signature = inspect.signature(fn)
|
|
for param in signature.parameters.values():
|
|
if param.annotation is Any:
|
|
raise AssertionError(
|
|
f"{fn} has public parameter typed as Any: {param.name}"
|
|
)
|
|
if signature.return_annotation is Any:
|
|
raise AssertionError(f"{fn} has public return annotation typed as Any")
|
|
|
|
|
|
def test_root_exports_app_server_config() -> None:
|
|
assert AppServerConfig.__name__ == "AppServerConfig"
|
|
|
|
|
|
def test_root_exports_run_result() -> None:
|
|
assert RunResult.__name__ == "RunResult"
|
|
|
|
|
|
def test_package_and_default_client_versions_follow_project_version() -> None:
|
|
pyproject_path = Path(__file__).resolve().parents[1] / "pyproject.toml"
|
|
pyproject = tomllib.loads(pyproject_path.read_text())
|
|
|
|
assert codex_app_server.__version__ == pyproject["project"]["version"]
|
|
assert AppServerConfig().client_version == codex_app_server.__version__
|
|
|
|
|
|
def test_package_includes_py_typed_marker() -> None:
|
|
marker = resources.files("codex_app_server").joinpath("py.typed")
|
|
assert marker.is_file()
|
|
|
|
|
|
def test_generated_public_signatures_are_snake_case_and_typed() -> None:
|
|
expected = {
|
|
Codex.thread_start: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"ephemeral",
|
|
"model",
|
|
"model_provider",
|
|
"personality",
|
|
"sandbox",
|
|
"service_name",
|
|
"service_tier",
|
|
"session_start_source",
|
|
],
|
|
Codex.thread_list: [
|
|
"archived",
|
|
"cursor",
|
|
"cwd",
|
|
"limit",
|
|
"model_providers",
|
|
"search_term",
|
|
"sort_direction",
|
|
"sort_key",
|
|
"source_kinds",
|
|
"use_state_db_only",
|
|
],
|
|
Codex.thread_resume: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"model",
|
|
"model_provider",
|
|
"personality",
|
|
"sandbox",
|
|
"service_tier",
|
|
],
|
|
Codex.thread_fork: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"ephemeral",
|
|
"model",
|
|
"model_provider",
|
|
"sandbox",
|
|
"service_tier",
|
|
],
|
|
Thread.turn: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"cwd",
|
|
"effort",
|
|
"model",
|
|
"output_schema",
|
|
"personality",
|
|
"sandbox_policy",
|
|
"service_tier",
|
|
"summary",
|
|
],
|
|
Thread.run: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"cwd",
|
|
"effort",
|
|
"model",
|
|
"output_schema",
|
|
"personality",
|
|
"sandbox_policy",
|
|
"service_tier",
|
|
"summary",
|
|
],
|
|
AsyncCodex.thread_start: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"ephemeral",
|
|
"model",
|
|
"model_provider",
|
|
"personality",
|
|
"sandbox",
|
|
"service_name",
|
|
"service_tier",
|
|
"session_start_source",
|
|
],
|
|
AsyncCodex.thread_list: [
|
|
"archived",
|
|
"cursor",
|
|
"cwd",
|
|
"limit",
|
|
"model_providers",
|
|
"search_term",
|
|
"sort_direction",
|
|
"sort_key",
|
|
"source_kinds",
|
|
"use_state_db_only",
|
|
],
|
|
AsyncCodex.thread_resume: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"model",
|
|
"model_provider",
|
|
"personality",
|
|
"sandbox",
|
|
"service_tier",
|
|
],
|
|
AsyncCodex.thread_fork: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"base_instructions",
|
|
"config",
|
|
"cwd",
|
|
"developer_instructions",
|
|
"ephemeral",
|
|
"model",
|
|
"model_provider",
|
|
"sandbox",
|
|
"service_tier",
|
|
],
|
|
AsyncThread.turn: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"cwd",
|
|
"effort",
|
|
"model",
|
|
"output_schema",
|
|
"personality",
|
|
"sandbox_policy",
|
|
"service_tier",
|
|
"summary",
|
|
],
|
|
AsyncThread.run: [
|
|
"approval_policy",
|
|
"approvals_reviewer",
|
|
"cwd",
|
|
"effort",
|
|
"model",
|
|
"output_schema",
|
|
"personality",
|
|
"sandbox_policy",
|
|
"service_tier",
|
|
"summary",
|
|
],
|
|
}
|
|
|
|
for fn, expected_kwargs in expected.items():
|
|
actual = _keyword_only_names(fn)
|
|
assert actual == expected_kwargs, f"unexpected kwargs for {fn}: {actual}"
|
|
assert all(name == name.lower() for name in actual), (
|
|
f"non snake_case kwargs in {fn}: {actual}"
|
|
)
|
|
_assert_no_any_annotations(fn)
|
|
|
|
|
|
def test_lifecycle_methods_are_codex_scoped() -> None:
|
|
assert hasattr(Codex, "thread_resume")
|
|
assert hasattr(Codex, "thread_fork")
|
|
assert hasattr(Codex, "thread_archive")
|
|
assert hasattr(Codex, "thread_unarchive")
|
|
assert hasattr(AsyncCodex, "thread_resume")
|
|
assert hasattr(AsyncCodex, "thread_fork")
|
|
assert hasattr(AsyncCodex, "thread_archive")
|
|
assert hasattr(AsyncCodex, "thread_unarchive")
|
|
assert not hasattr(Codex, "thread")
|
|
assert not hasattr(AsyncCodex, "thread")
|
|
|
|
assert not hasattr(Thread, "resume")
|
|
assert not hasattr(Thread, "fork")
|
|
assert not hasattr(Thread, "archive")
|
|
assert not hasattr(Thread, "unarchive")
|
|
assert not hasattr(AsyncThread, "resume")
|
|
assert not hasattr(AsyncThread, "fork")
|
|
assert not hasattr(AsyncThread, "archive")
|
|
assert not hasattr(AsyncThread, "unarchive")
|
|
|
|
for fn in (
|
|
Codex.thread_archive,
|
|
Codex.thread_unarchive,
|
|
AsyncCodex.thread_archive,
|
|
AsyncCodex.thread_unarchive,
|
|
):
|
|
_assert_no_any_annotations(fn)
|
|
|
|
|
|
def test_initialize_metadata_parses_user_agent_shape() -> None:
|
|
payload = InitializeResponse.model_validate({"userAgent": "codex-cli/1.2.3"})
|
|
parsed = Codex._validate_initialize(payload)
|
|
assert parsed is payload
|
|
assert parsed.userAgent == "codex-cli/1.2.3"
|
|
assert parsed.serverInfo is not None
|
|
assert parsed.serverInfo.name == "codex-cli"
|
|
assert parsed.serverInfo.version == "1.2.3"
|
|
|
|
|
|
def test_initialize_metadata_requires_non_empty_information() -> None:
|
|
try:
|
|
Codex._validate_initialize(InitializeResponse.model_validate({}))
|
|
except RuntimeError as exc:
|
|
assert "missing required metadata" in str(exc)
|
|
else:
|
|
raise AssertionError(
|
|
"expected RuntimeError when initialize metadata is missing"
|
|
)
|