ros-dds-manager 0.1.0__py3-none-any.whl

ros_dds_manager/__init__.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from ros_dds_manager.errors import (
+    EXIT_ERROR,
+    EXIT_INTERRUPT,
+    EXIT_NOT_FOUND,
+    EXIT_SUCCESS,
+    EXIT_USAGE,
+    ConfigurationError,
+    NonInteractiveError,
+    ProfileAlreadyExistsError,
+    ProfileNotFoundError,
+    RosDdsManagerError,
+    XMLValidationError,
+)
+from ros_dds_manager.generator import render_profile_xml, validate_xml
+from ros_dds_manager.models import DDSProfile, DDSVendor
+from ros_dds_manager.storage import (
+    activate_profile,
+    deactivate_profile,
+    delete_profile,
+    get_active_profile_name,
+    get_base_dir,
+    get_profiles_dir,
+    list_profiles,
+    load_profile,
+    save_profile,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "__version__",
+    # Models
+    "DDSProfile",
+    "DDSVendor",
+    # Generator
+    "render_profile_xml",
+    "validate_xml",
+    # Storage
+    "activate_profile",
+    "deactivate_profile",
+    "delete_profile",
+    "get_active_profile_name",
+    "get_base_dir",
+    "get_profiles_dir",
+    "list_profiles",
+    "load_profile",
+    "save_profile",
+    # Errors & Exit Codes
+    "EXIT_SUCCESS",
+    "EXIT_ERROR",
+    "EXIT_USAGE",
+    "EXIT_NOT_FOUND",
+    "EXIT_INTERRUPT",
+    "RosDdsManagerError",
+    "ProfileNotFoundError",
+    "ProfileAlreadyExistsError",
+    "XMLValidationError",
+    "NonInteractiveError",
+    "ConfigurationError",
+]

ros_dds_manager/commands/config_cmd.py

@@ -0,0 +1,131 @@
+from __future__ import annotations
+
+import json
+
+from wpycli import Command, CommandContext
+
+from ros_dds_manager.config_mgr import (
+    find_active_config_path,
+    format_toml,
+    get_config_path,
+    get_config_value,
+    init_config,
+    read_config,
+    set_config_value,
+)
+
+
+def build_config_command() -> Command:
+    config = Command(
+        use="config",
+        short="ros-dds-manager 설정을 관리한다.",
+        long="ros-dds-manager 의 전역 또는 로컬 설정(config.toml)을 초기화, 조회, 수정합니다.",
+        run=run_config_show,
+    )
+
+    init_cmd = Command(
+        use="init",
+        short="기본 config.toml 설정 파일을 생성한다.",
+        run=run_config_init,
+    )
+    init_cmd.add_bool_flag("local", help="현재 디렉토리에 config.toml 을 생성한다.", shorthand="l")
+    init_cmd.add_bool_flag("overwrite", help="이미 파일이 존재할 경우 덮어쓴다.", shorthand="f")
+
+    show_cmd = Command(
+        use="show",
+        short="현재 적용된 설정을 출력한다.",
+        run=run_config_show,
+    )
+    show_cmd.add_bool_flag("json", help="JSON 포맷으로 출력한다.", shorthand="j")
+
+    path_cmd = Command(
+        use="path",
+        short="설정 파일의 경로를 출력한다.",
+        run=run_config_path,
+    )
+    path_cmd.add_bool_flag("local", help="로컬 설정 파일 경로를 확인한다.", shorthand="l")
+
+    set_cmd = Command(
+        use="set <key> <value>",
+        short="설정 항목의 값을 변경한다. (예: app.default_vendor fastdds)",
+        run=run_config_set,
+    )
+    set_cmd.add_bool_flag("local", help="로컬 config.toml 에 저장한다.", shorthand="l")
+
+    get_cmd = Command(
+        use="get <key>",
+        short="특정 설정 항목의 값을 조회한다. (예: app.default_vendor)",
+        run=run_config_get,
+    )
+
+    config.add_command(init_cmd, show_cmd, path_cmd, set_cmd, get_cmd)
+    return config
+
+
+def run_config_init(ctx: CommandContext) -> int:
+    is_local = bool(ctx.flags.get("local"))
+    overwrite = bool(ctx.flags.get("overwrite"))
+
+    try:
+        path = init_config(is_local=is_local, overwrite=overwrite)
+        target_type = "로컬" if is_local else "전역"
+        print(ctx.terminal.message("success", f"{target_type} 설정 초기화 완료", f"파일 경로: {path}"))
+        return 0
+    except FileExistsError as e:
+        print(ctx.terminal.message("error", "설정 초기화 실패", f"{e}\n덮어쓰려면 --overwrite (-f) 옵션을 사용하세요."))
+        return 1
+
+
+def run_config_show(ctx: CommandContext) -> int:
+    active_path = find_active_config_path()
+    cfg = read_config(active_path)
+
+    as_json = bool(ctx.flags.get("json"))
+    if as_json:
+        print(ctx.terminal.pretty_json(json.dumps(cfg, indent=2)))
+    else:
+        path_str = str(active_path) if active_path else "(기본 내장값 사용 중)"
+        toml_content = format_toml(cfg)
+        print(ctx.terminal.panel(f"Configuration ({path_str})", toml_content))
+    return 0
+
+
+def run_config_path(ctx: CommandContext) -> int:
+    is_local = bool(ctx.flags.get("local"))
+    path = get_config_path(is_local=is_local)
+    exists_str = "존재함" if path.is_file() else "없음 (기본값 사용 중)"
+    print(f"경로: {path} [{exists_str}]")
+    return 0
+
+
+def run_config_set(ctx: CommandContext) -> int:
+    if len(ctx.args) < 2:
+        print(ctx.terminal.message("error", "인수 부족", "사용법: ros-dds-manager config set <key> <value>"))
+        return 1
+
+    key = ctx.args[0]
+    value = ctx.args[1]
+    is_local = bool(ctx.flags.get("local"))
+
+    try:
+        path, parsed = set_config_value(key, value, is_local=is_local)
+        print(ctx.terminal.message("success", "설정 변경 완료", f"[{path}]\n{key} = {parsed}"))
+        return 0
+    except Exception as e:
+        print(ctx.terminal.message("error", "설정 변경 실패", str(e)))
+        return 1
+
+
+def run_config_get(ctx: CommandContext) -> int:
+    if not ctx.args:
+        print(ctx.terminal.message("error", "인수 부족", "사용법: ros-dds-manager config get <key>"))
+        return 1
+
+    key = ctx.args[0]
+    try:
+        value = get_config_value(key)
+        print(value)
+        return 0
+    except KeyError as e:
+        print(ctx.terminal.message("error", "설정 조회 실패", str(e)))
+        return 1

ros_dds_manager/commands/doctor_cmd.py

@@ -0,0 +1,157 @@
+from __future__ import annotations
+
+import json
+import os
+from pathlib import Path
+
+from wpycli import Command, CommandContext
+
+from ros_dds_manager.errors import EXIT_SUCCESS
+from ros_dds_manager.generator import validate_xml
+from ros_dds_manager.network import get_network_interfaces
+from ros_dds_manager.storage import (
+    get_active_profile_name,
+    get_base_dir,
+    get_profile_dir,
+    load_profile,
+)
+
+
+def build_doctor_command() -> Command:
+    cmd = Command(
+        use="doctor",
+        short="현재 ROS 2 환경 및 DDS 설정을 진단한다.",
+        long="현재 쉘의 DDS 환경변수, 활성 프로파일 파일 상태, 네트워크 카드 상태를 점검합니다.",
+        run=run_doctor,
+    )
+    cmd.add_bool_flag("json", help="기계 판독 가능한 JSON 포맷으로 진단 결과를 출력한다.", shorthand="j")
+    return cmd
+
+
+def run_doctor(ctx: CommandContext) -> int:
+    issues: list[str] = []
+
+    # 1. ROS 2 Distro
+    ros_distro = os.environ.get("ROS_DISTRO")
+    if not ros_distro:
+        issues.append("ROS_DISTRO 환경변수가 설정되지 않았습니다. (ROS 2 환경 미로드)")
+
+    # 2. Active Profile
+    active_name = get_active_profile_name()
+    active_info: dict | None = None
+    if active_name:
+        try:
+            profile = load_profile(active_name)
+            prof_dir = get_profile_dir(active_name)
+            xml_path = prof_dir / "config.xml"
+            xml_ok = xml_path.is_file()
+            xml_valid = False
+            if xml_ok:
+                xml_valid, err = validate_xml(xml_path.read_text(encoding="utf-8"))
+                if not xml_valid:
+                    issues.append(f"프로파일 XML 구문 오류: {err}")
+            else:
+                issues.append("활성 프로파일의 config.xml 이 존재하지 않습니다.")
+
+            active_info = {
+                "name": profile.name,
+                "vendor": profile.vendor.value,
+                "dir": str(prof_dir),
+                "xml_path": str(xml_path) if xml_ok else None,
+                "xml_valid": xml_valid,
+            }
+        except Exception as e:
+            issues.append(f"활성 프로파일 로드 실패: {e}")
+
+    # 3. Shell Environment
+    current_rmw = os.environ.get("RMW_IMPLEMENTATION", "(default)")
+    current_cyclone_uri = os.environ.get("CYCLONEDDS_URI")
+    current_fastdds_file = os.environ.get("FASTRTPS_DEFAULT_PROFILES_FILE")
+    current_domain_id = os.environ.get("ROS_DOMAIN_ID", "0")
+    current_lh = os.environ.get("ROS_LOCALHOST_ONLY")
+    current_ds = os.environ.get("ROS_DISCOVERY_SERVER")
+
+    if current_cyclone_uri and current_cyclone_uri.startswith("file://"):
+        target_f = Path(current_cyclone_uri[7:])
+        if not target_f.is_file():
+            issues.append(f"CYCLONEDDS_URI 파일이 존재하지 않습니다: {target_f}")
+
+    if current_fastdds_file:
+        target_f = Path(current_fastdds_file)
+        if not target_f.is_file():
+            issues.append(f"FASTRTPS_DEFAULT_PROFILES_FILE 파일이 존재하지 않습니다: {target_f}")
+
+    env_info = {
+        "RMW_IMPLEMENTATION": current_rmw,
+        "CYCLONEDDS_URI": current_cyclone_uri,
+        "FASTRTPS_DEFAULT_PROFILES_FILE": current_fastdds_file,
+        "ROS_DOMAIN_ID": current_domain_id,
+        "ROS_LOCALHOST_ONLY": current_lh,
+        "ROS_DISCOVERY_SERVER": current_ds,
+    }
+
+    # 4. Network Interfaces
+    interfaces = get_network_interfaces()
+    ifaces_data = [
+        {
+            "name": iface.name,
+            "ipv4": iface.ipv4,
+            "state": iface.state,
+            "is_up": iface.is_up,
+            "is_loopback": iface.is_loopback,
+        }
+        for iface in interfaces
+    ]
+
+    # Handle JSON output
+    if ctx.flags.get("json"):
+        report = {
+            "ros_distro": ros_distro,
+            "active_profile": active_info,
+            "environment": env_info,
+            "interfaces": ifaces_data,
+            "issues": issues,
+            "status": "healthy" if not issues else "warning",
+        }
+        print(json.dumps(report, indent=2))
+        return EXIT_SUCCESS
+
+    # Text rendering
+    term = ctx.terminal
+    print(term.panel("ROS 2 DDS Diagnostic Report (Doctor)", "현재 쉘 환경, 활성 프로파일, 네트워크 상태를 점검합니다."))
+
+    print("\n[1] ROS 2 환경:")
+    if ros_distro:
+        print(f"  ✓ ROS_DISTRO: {ros_distro}")
+    else:
+        print("  ! ROS_DISTRO 환경변수가 설정되지 않았습니다. (ROS 2 언더레이 setup.bash 미로드)")
+
+    print("\n[2] 활성 프로파일 상태:")
+    if active_info:
+        print(f"  ✓ 활성 프로파일: {active_info['name']} (벤더: {active_info['vendor']})")
+        print(f"  ✓ 설정 디렉토리: {active_info['dir']}")
+        if active_info.get("xml_valid"):
+            print("  ✓ XML 유효성: 정상")
+        else:
+            print("  ✗ XML 구문 오류 또는 파일 부재")
+    else:
+        print("  - 현재 활성화된 프로파일이 없습니다. ('ros-dds-manager switch <name>' 으로 활성화 가능)")
+
+    print("\n[3] 현재 쉘 환경변수 (Environment Variables):")
+    for k, v in env_info.items():
+        val_str = v if v is not None else "(미설정)"
+        print(f"  - {k:<30} {val_str}")
+
+    print("\n[4] 감지된 네트워크 인터페이스 (Network Interfaces):")
+    for iface in interfaces:
+        status_symbol = "✓" if iface.is_up else "✗"
+        print(f"  {status_symbol} {iface.summary()}")
+
+    print("\n" + "=" * 50)
+    if issues:
+        print(term.message("warning", "진단 주의사항 발견", "\n".join(f"- {i}" for i in issues)))
+        return EXIT_SUCCESS
+    else:
+        current_sh = get_base_dir() / "current.sh"
+        print(term.message("success", "진단 결과 양호", f"모든 필수 항목이 정상입니다.\n(활성 프로파일 스크립트: {current_sh})"))
+        return EXIT_SUCCESS