code-agent: implement issue 6
Approval-Correlation: e5da4592756fb704256d8737d31662e5
Plan-SHA256: 0fbe8b996656fb908c513b31e30706f7521cf76eeac60778a1c28f46bfc19b46
Bundle-SHA256: 29ce1ef1917864f79938459725201e6e74d67e21b1f817ac53d7b294eca8f1a2
Base-SHA: cabd354d71
This commit is contained in:
code-agent
+32
-24
@@ -1,39 +1,47 @@
|
|||||||
|
<!-- gitea-agent:documentation-template/data-model/v1 -->
|
||||||
# 데이터 모델
|
# 데이터 모델
|
||||||
|
|
||||||
## 대화 상태
|
## 목적과 범위
|
||||||
|
|
||||||
`ChatApp`은 세션 동안 다음 목록을 메모리에 유지한다.
|
이 문서는 대화 세션에서 사용자 메시지와 에이전트 응답의 작성자 의미를 명시적으로 관리하는 데이터 모델을 정의한다. 메시지의 역할과 본문을 정본 데이터로 삼고, 화면 라벨과 구조적 스타일은 역할에서 파생한다. 외부 API 연동, 인증, 사용자별 기록 관리 및 영속 저장은 범위에 포함하지 않는다.
|
||||||
|
|
||||||
- `submitted_inputs`: `trim`된 유효 사용자 메시지 목록
|
## 정본 엔터티
|
||||||
- `selected_responses`: 각 사용자 메시지에 대응하는 선택 응답 목록
|
|
||||||
|
|
||||||
두 목록은 같은 인덱스를 사용하며, 유효한 제출 하나마다 항목 하나씩 추가된다. 공백 입력은 어느 목록도 변경하지 않는다.
|
정본 메시지 엔터티는 작성자 역할과 본문을 함께 보유한다. 작성자 역할은 사용자 또는 에이전트 중 하나이며, 역할별 화면 라벨은 각각 사용자와 에이전트로 정해진다. 본문은 사용자 입력의 앞뒤 공백을 제거한 문자열 또는 고정 응답 목록에서 선택된 문자열이다.
|
||||||
|
|
||||||
## 고정 응답 목록
|
### `message-author-semantics`
|
||||||
|
|
||||||
`src/chat_tui/app.py`의 `RESPONSE_MESSAGES` 상수는 다음 다섯 문자열을 순서대로 보유한다.
|
메시지의 작성자 의미는 화면 표현이 아니라 정본 데이터 모델에서 관리한다. 각 메시지는 작성자 역할과 본문을 필수 값으로 가지며, 역할은 사용자와 에이전트 중 하나로 제한한다.
|
||||||
|
|
||||||
1. `안녕하세요! 무엇을 도와드릴까요?`
|
- 사용자 메시지는 `user` 역할과 정규화된 사용자 입력을 가진다.
|
||||||
2. `그것은 제가 처리하기 불가능합니다.`
|
- 에이전트 응답은 `agent` 역할과 선택된 응답 본문을 가진다.
|
||||||
3. `맡겨만 주세요.`
|
- 역할별 표시 라벨은 사용자 역할에서 `사용자`, 에이전트 역할에서 `에이전트`로 파생한다.
|
||||||
4. `지금 처리 중입니다.`
|
- 화면의 `user-message`, `response-message`, `user-role`, `agent-role` 클래스와 좌우 정렬 및 테두리는 역할에서 파생되는 표현이며 역할의 정본이 아니다.
|
||||||
5. `작업을 완료하였습니다.`
|
- 메시지 본문은 역할과 분리된 문자열 값이며, 사용자 입력은 앞뒤 공백을 제거한 뒤 보존한다.
|
||||||
|
- 메시지 목록은 유효한 제출마다 사용자 메시지를 먼저, 에이전트 응답을 다음에 보유한다.
|
||||||
|
- 빈 문자열 또는 공백만 포함한 입력에는 메시지 엔터티와 응답을 생성하지 않는다.
|
||||||
|
|
||||||
응답은 `random.choice(RESPONSE_MESSAGES)`로 선택한다. 난수 선택 자체는 테스트에서 `chat_tui.app.random.choice`를 대체할 수 있는 경계로 취급한다.
|
역할과 본문은 하나의 불변 메시지 값으로 취급한다. 메시지가 생성된 뒤 역할을 화면 스타일에 맞추어 변경하거나 본문과 분리하여 관리하지 않는다. 에이전트 응답은 외부 시스템 결과가 아니라 고정된 응답 집합에서 선택된 세션 값이며, 작성자 역할은 선택 결과와 무관하게 항상 에이전트로 유지한다.
|
||||||
|
|
||||||
## 대화 항목
|
이 모델은 현재 세션 메모리에서만 사용된다. 저장 위치, 직렬화 형식, 식별자 생성 규칙 및 데이터베이스 스키마는 정의하지 않는다. 따라서 기존 저장 데이터에 대한 마이그레이션이나 저장 실패에 대한 롤백은 없다. 향후 영속화를 도입할 경우 역할 값과 본문을 함께 원자적으로 저장하고 사용자 메시지와 에이전트 응답의 순서를 보존해야 한다.
|
||||||
|
|
||||||
유효한 입력이 제출되면 대화 영역에 다음 두 `Label`을 순서대로 추가한다.
|
검증은 다음 조건을 확인한다.
|
||||||
|
|
||||||
1. `user-message` 클래스의 사용자 메시지
|
- 유효한 입력의 앞뒤 공백이 제거되고 사용자 역할로 기록되는지 확인한다.
|
||||||
2. `response-message` 클래스의 선택 응답
|
- 같은 제출에서 선택된 응답이 에이전트 역할로 기록되는지 확인한다.
|
||||||
|
- 여러 제출의 메시지가 사용자와 에이전트 순서로 반복되는지 확인한다.
|
||||||
|
- 역할 라벨과 구조적 스타일이 해당 역할에서 일관되게 파생되는지 확인한다.
|
||||||
|
- 빈 입력과 공백 입력에서 응답 선택, 메시지 목록 변경 및 화면 항목 추가가 발생하지 않는지 확인한다.
|
||||||
|
- 역할을 CSS 클래스나 표시 위치에서 추론하지 않고 정본 메시지 값에서 직접 검증하는지 확인한다.
|
||||||
|
|
||||||
사용자 메시지는 입력값을 `strip()`한 결과이며, 선택 응답은 고정 응답 목록의 문자열이다.
|
## 관계와 불변조건
|
||||||
|
|
||||||
## 불변 조건
|
각 유효한 사용자 입력은 사용자 역할의 메시지 하나와 그에 대응하는 에이전트 역할의 메시지 하나를 순서대로 만든다. 역할은 CSS 클래스나 화면 위치에서 추론하지 않으며 메시지 데이터에 직접 보존한다. 빈 입력과 공백 입력은 메시지와 응답을 만들지 않는다.
|
||||||
|
|
||||||
- 공백 제거 결과가 빈 문자열이면 상태와 화면을 변경하지 않는다.
|
## 저장과 마이그레이션
|
||||||
- 유효한 입력마다 사용자 메시지가 응답보다 먼저 추가된다.
|
|
||||||
- `submitted_inputs`와 `selected_responses`의 길이는 항상 같다.
|
메시지는 애플리케이션 세션 메모리에만 보관하며 직렬화 형식이나 영속 저장소는 정의하지 않는다. 따라서 기존 데이터 마이그레이션과 롤백 절차는 필요하지 않다. 이후 저장 기능이 추가되더라도 역할과 본문을 함께 저장하고 기존 순서를 보존해야 한다.
|
||||||
- 응답은 고정 목록에 포함된 값이어야 한다.
|
|
||||||
- 대화 기록은 애플리케이션 세션 안에서만 유지한다.
|
## 검증
|
||||||
|
|
||||||
|
정상 입력에서는 역할, 본문, 생성 순서가 일치하는지 검증한다. 경계 입력에서는 빈 문자열과 공백 문자열이 상태를 변경하지 않는지 확인한다. 렌더링 검증에서는 역할에서 파생된 라벨과 구조적 스타일이 일치하는지 확인하며, 영속 저장 후 재조회와 마이그레이션 검증은 해당 없음으로 판정한다.
|
||||||
|
|||||||
+48
-24
@@ -1,38 +1,62 @@
|
|||||||
|
<!-- gitea-agent:documentation-template/interface-contract/v1 -->
|
||||||
# 인터페이스 계약
|
# 인터페이스 계약
|
||||||
|
|
||||||
## 메시지 제출 이벤트
|
## 목적과 범위
|
||||||
|
|
||||||
Textual의 `Input.Submitted` 이벤트가 `#user-input`에서 발생하면 `ChatApp.on_input_submitted`가 처리한다.
|
이 문서는 대화형 Textual 화면에서 사용자 메시지와 에이전트 응답을 작성자 역할, 라벨, 구조적 스타일 및 표시 순서로 구분하는 인터페이스를 정의한다. 메시지 역할과 본문은 표시 결과의 정본이며, 외부 API 연동이나 영속 저장은 범위에 포함하지 않는다.
|
||||||
|
|
||||||
### 입력 정규화
|
## 계약
|
||||||
|
|
||||||
1. 이벤트의 `value`에 `strip()`을 적용한다.
|
- 각 메시지는 작성자 역할과 본문을 함께 가져야 한다.
|
||||||
2. 입력 위젯의 값을 빈 문자열로 초기화한다.
|
- 사용자 역할은 `user`, 에이전트 역할은 `agent`로 표현한다.
|
||||||
3. 정규화 결과가 빈 문자열이면 추가 처리를 중단한다.
|
- 사용자 역할의 화면 라벨은 `사용자`, 에이전트 역할의 화면 라벨은 `에이전트`다.
|
||||||
|
- 사용자 메시지는 `사용자: 본문` 형식으로, 에이전트 응답은 `에이전트: 본문` 형식으로 표시한다.
|
||||||
|
- 사용자 메시지는 `chat-message user-message user-role` 클래스를 사용하고, 에이전트 응답은 `chat-message response-message agent-role` 클래스를 사용한다.
|
||||||
|
- 사용자 메시지와 에이전트 응답은 각각 왼쪽과 오른쪽 정렬 및 서로 다른 측면 테두리로 구분한다.
|
||||||
|
- 유효한 입력 하나는 사용자 메시지 다음에 에이전트 응답을 추가한다.
|
||||||
|
|
||||||
공백만 포함한 입력은 사용자 메시지, 응답 선택, 대화 항목을 생성하지 않는다.
|
### `conversation-message-rendering`
|
||||||
|
|
||||||
### 유효한 입력 처리
|
메시지 렌더링 인터페이스는 명시적인 역할을 가진 메시지 값을 화면 항목으로 변환한다.
|
||||||
|
|
||||||
정규화 결과가 비어 있지 않으면 다음 순서로 처리한다.
|
- 입력: 작성자 역할과 문자열 본문을 가진 메시지
|
||||||
|
- 출력: 작성자 라벨과 본문을 결합한 라벨 위젯
|
||||||
|
- 사용자 역할: `user` 값, `사용자` 라벨, `user-message` 및 `user-role` 클래스
|
||||||
|
- 에이전트 역할: `agent` 값, `에이전트` 라벨, `response-message` 및 `agent-role` 클래스
|
||||||
|
- 표시 형식: 역할 라벨, 콜론, 공백, 본문 순서
|
||||||
|
- 구조적 표현: 사용자 항목은 왼쪽 정렬과 왼쪽 테두리, 에이전트 항목은 오른쪽 정렬과 오른쪽 테두리
|
||||||
|
- 순서: 유효한 제출마다 사용자 메시지를 먼저 표시하고 대응하는 에이전트 응답을 바로 뒤에 표시
|
||||||
|
|
||||||
1. 정규화된 사용자 메시지를 `submitted_inputs`에 추가한다.
|
역할과 본문은 하나의 메시지 의미로 취급하며, 라벨과 스타일은 역할에서 파생한다. 화면의 위치나 스타일만으로 작성자를 판정해서는 안 된다. 메시지 본문은 사용자 입력의 앞뒤 공백을 제거한 값 또는 고정 응답 목록에서 선택된 값이어야 한다.
|
||||||
2. `random.choice(RESPONSE_MESSAGES)`로 응답을 선택한다.
|
|
||||||
3. 선택 응답을 `selected_responses`에 추가한다.
|
|
||||||
4. 대화 영역에 사용자 메시지 `Label`을 추가한다.
|
|
||||||
5. 바로 이어서 응답 `Label`을 추가한다.
|
|
||||||
6. 대화 영역을 마지막 항목까지 스크롤한다.
|
|
||||||
|
|
||||||
사용자 메시지와 응답은 별도 대화 항목이며, 화면 표시 순서는 항상 사용자 메시지 다음 응답이다.
|
빈 입력이나 공백만 포함한 입력은 정상적인 렌더링 요청으로 간주하지 않는다. 이 경우 응답을 선택하지 않고 메시지 목록과 대화 영역을 변경하지 않으며, 입력창만 비운다.
|
||||||
|
|
||||||
## 화면 위젯 계약
|
호환성을 위해 기존 대화 영역과 입력창의 위젯 식별자, 사용자 및 응답 항목의 클래스, Enter 제출, 고정 응답 선택, Escape와 Ctrl+Q 종료 동작을 유지한다. 작성자 라벨과 역할 클래스는 기존 표시 항목에 추가되는 계약이며, 대화 영역 전체 레이아웃을 재설계하지 않는다.
|
||||||
|
|
||||||
- 대화 영역은 `#conversation` 식별자의 `VerticalScroll`이다.
|
검증에서는 정상 입력 두 건을 제출하여 역할, 본문, 라벨, 클래스 및 표시 순서를 함께 비교한다. 역할별 정렬과 테두리 규칙이 색상과 독립적으로 존재하는지 확인하고, 빈 입력과 공백 입력에서 응답 선택과 새 화면 항목이 발생하지 않는지 확인한다. 또한 표준 응답 선택 호출과 종료 동작이 기존 방식대로 유지되는지 확인한다.
|
||||||
- 입력창은 `#user-input` 식별자의 `Input`이다.
|
|
||||||
- 사용자 메시지는 `user-message` 클래스를 사용한다.
|
|
||||||
- 응답은 `response-message` 클래스를 사용한다.
|
|
||||||
- 애플리케이션 마운트 시 입력창에 포커스를 둔다.
|
|
||||||
|
|
||||||
## 종료 계약
|
## 호환성
|
||||||
|
|
||||||
`Escape`와 `Ctrl+Q`는 기존 `quit` 바인딩을 통해 애플리케이션 종료를 요청한다.
|
- Enter로 제출하는 기존 입력 방식을 유지한다.
|
||||||
|
- 입력은 앞뒤 공백을 제거한 뒤 처리하며, 빈 입력이나 공백만 있는 입력은 응답 선택과 화면 변경 없이 무시한다.
|
||||||
|
- 응답은 기존 고정 응답 목록에서 표준 무작위 선택 방식으로 생성한다.
|
||||||
|
- 기존 대화 영역과 입력창의 위젯 식별자 및 메시지 표시 순서를 유지한다.
|
||||||
|
- Escape와 Ctrl+Q 종료 동작을 유지한다.
|
||||||
|
- 역할 의미는 화면 위치나 CSS 클래스만으로 추론하지 않고 메시지 데이터에서 직접 제공한다.
|
||||||
|
|
||||||
|
## 예시
|
||||||
|
|
||||||
|
- 입력값이 ` 첫 번째 입력 `이면 `사용자: 첫 번째 입력`으로 표시한다.
|
||||||
|
- 선택된 응답이 `맡겨만 주세요.`이면 `에이전트: 맡겨만 주세요.`로 표시한다.
|
||||||
|
- 여러 제출은 각 제출마다 사용자 메시지와 에이전트 응답의 쌍을 만들며, 전체 순서는 제출 순서와 일치한다.
|
||||||
|
- 사용자 항목에는 왼쪽 정렬과 왼쪽 테두리를 적용하고, 에이전트 항목에는 오른쪽 정렬과 오른쪽 테두리를 적용한다.
|
||||||
|
- 빈 문자열 또는 공백 문자열을 제출하면 새 라벨과 응답이 생성되지 않는다.
|
||||||
|
|
||||||
|
## 검증
|
||||||
|
|
||||||
|
- 역할 값과 본문이 올바르게 결합되어 메모리의 메시지 목록에 보존되는지 확인한다.
|
||||||
|
- 렌더링된 라벨이 역할별 접두사와 본문을 정확히 포함하는지 확인한다.
|
||||||
|
- 역할별 CSS 클래스, 정렬 규칙 및 양쪽 테두리가 구현에 존재하는지 확인한다.
|
||||||
|
- 여러 입력에서 사용자 메시지 뒤에 에이전트 응답이 표시되는지 확인한다.
|
||||||
|
- 빈 입력과 공백 입력에서 응답 선택, 메시지 기록 및 라벨 추가가 발생하지 않는지 확인한다.
|
||||||
|
- 기존 무작위 응답 선택과 종료 동작이 변경되지 않았는지 회귀 검증한다.
|
||||||
|
|||||||
@@ -1,44 +1,304 @@
|
|||||||
# 프로젝트 스캐폴드 요구사항
|
---
|
||||||
|
{
|
||||||
|
"schema": "proofline.requirement/v1",
|
||||||
|
"id": "REQ-001",
|
||||||
|
"title": "프로젝트 스캐폴드의 메시지 작성자 구분",
|
||||||
|
"revision": "0.1",
|
||||||
|
"status": "approved",
|
||||||
|
"depends_on": [],
|
||||||
|
"applies_to": ["chat-tui-message-rendering"],
|
||||||
|
"language": "ko"
|
||||||
|
}
|
||||||
|
---
|
||||||
|
|
||||||
## 범위
|
# REQ-001 — 프로젝트 스캐폴드의 메시지 작성자 구분
|
||||||
|
|
||||||
Python 3.11 이상과 표준 `pyproject.toml`을 사용하는 Textual 기반 TUI 초기 스캐폴드를 제공한다.
|
## 1. 목적
|
||||||
|
|
||||||
## 기능 요구사항
|
대화형 Textual TUI에서 사용자가 입력한 메시지와 에이전트의 응답을 작성자 라벨과 구조적 스타일로 명확하게 구분한다. 각 메시지의 작성자 의미를 명시적인 데이터 역할로 관리하여 화면 표시, 실행 흐름 및 자동 테스트에서 일관되게 검증할 수 있게 한다.
|
||||||
|
|
||||||
1. `chat-tui` 콘솔 명령과 `python -m chat_tui` 실행을 지원한다.
|
## 2. 배경
|
||||||
2. Textual 화면에 사용자 입력창과 대화 영역을 표시한다.
|
|
||||||
3. 사용자가 입력을 제출하면 입력값을 `trim`한 뒤 비어 있지 않은 사용자 메시지를 제출 순서대로 대화 영역에 누적한다.
|
|
||||||
4. 유효한 사용자 메시지 제출 후 고정된 다섯 개 응답 목록에서 표준 난수 선택으로 하나의 응답을 결정한다.
|
|
||||||
5. 선택한 응답을 해당 사용자 메시지 바로 뒤에 별도의 대화 항목으로 표시한다.
|
|
||||||
6. 유효한 입력 처리 뒤 입력창을 비운다.
|
|
||||||
7. 빈 입력 또는 공백만 포함한 입력은 사용자 메시지와 응답을 대화 기록에 추가하지 않는다.
|
|
||||||
8. `Escape` 또는 `Ctrl+Q`로 애플리케이션 종료를 요청할 수 있다.
|
|
||||||
9. 입력 누적, 응답 선택과 표시, 공백 입력 무시, 입력창 초기화 및 종료 동작을 자동 테스트로 검증한다.
|
|
||||||
|
|
||||||
## 고정 응답 목록
|
현재 애플리케이션은 사용자 메시지와 에이전트 응답을 서로 다른 CSS 클래스를 가진 Label로 표시하지만 화면에 작성자 라벨이 없고 작성자 의미가 데이터 개념으로 표현되지 않는다. 따라서 메시지의 작성자를 화면에서 구분하기 어렵고, 테스트도 표시 순서와 내용만 검증할 뿐 작성자 역할과 구조적 구분을 검증하지 못한다.
|
||||||
|
|
||||||
응답은 다음 다섯 문구 중 하나를 사용한다.
|
이번 요구사항은 외부 API나 LLM 연동 없이 현재 Textual 기반 대화 흐름을 유지하면서 작성자 의미를 명시적으로 모델링하고, 색상에만 의존하지 않는 라벨·테두리·정렬 기반의 구분을 제공하기 위한 것이다.
|
||||||
|
|
||||||
- 안녕하세요! 무엇을 도와드릴까요?
|
## 3. 범위
|
||||||
- 그것은 제가 처리하기 불가능합니다.
|
|
||||||
- 맡겨만 주세요.
|
|
||||||
- 지금 처리 중입니다.
|
|
||||||
- 작업을 완료하였습니다.
|
|
||||||
|
|
||||||
응답 선택에는 표준 라이브러리의 난수 선택 기능을 사용하며, 외부 서비스나 LLM은 호출하지 않는다.
|
### 포함
|
||||||
|
|
||||||
## 제외 범위
|
- 사용자 메시지와 에이전트 응답을 각각 별도의 Label 대화 항목으로 표시한다.
|
||||||
|
- 각 메시지에 사용자 또는 에이전트라는 명시적인 작성자 역할을 부여한다.
|
||||||
|
- 화면에 사용자와 에이전트 작성자 라벨을 표시한다.
|
||||||
|
- `user-message`와 `response-message` 식별자를 유지하고, 테두리 또는 정렬 차이 같은 구조적 스타일을 적용한다.
|
||||||
|
- 유효한 입력의 정규화, 응답 선택, 메시지 표시 순서 및 공백 입력 무시 동작을 유지한다.
|
||||||
|
- 작성자 역할, 라벨, 구조적 스타일 및 기존 동작을 자동 테스트로 검증한다.
|
||||||
|
- 관련 요구사항, 데이터 모델, 인터페이스 계약 및 실행 흐름 문서와의 추적성을 유지한다.
|
||||||
|
|
||||||
LLM 연동, 외부 API 호출, 인증, 영구 대화 기록 저장, 사용자별 응답 기록, 응답 목록 편집, 사용자 입력에 따른 맞춤형 응답 생성은 구현하지 않는다.
|
### 제외
|
||||||
|
|
||||||
## 수용 기준
|
- LLM 연동 또는 외부 API 호출
|
||||||
|
- 대화 저장, 사용자 인증 또는 사용자별 기록 관리
|
||||||
|
- 고정 응답 목록과 응답 생성 방식의 변경
|
||||||
|
- 대화 영역 전체 레이아웃의 재설계
|
||||||
|
- 색상만으로 작성자를 구분하는 방식
|
||||||
|
- 별도 영속성 백엔드나 데이터베이스 도입
|
||||||
|
|
||||||
- Python 3.11 이상 환경에서 의존성을 설치할 수 있다.
|
## 4. 용어와 기준
|
||||||
- TUI가 실행되고 입력창에 포커스가 배치된다.
|
|
||||||
- 두 번 이상 제출한 입력이 `trim`된 값으로 제출 순서대로 표시된다.
|
- **사용자 메시지**: 입력창에 사용자가 제출한 공백 제거 후의 유효한 문자열이다.
|
||||||
- 각 유효한 사용자 메시지 바로 뒤에 고정 목록에서 선택된 응답이 표시된다.
|
- **에이전트 응답**: 유효한 사용자 입력마다 고정된 응답 목록에서 표준 난수 선택으로 생성되는 문자열이다.
|
||||||
- 자동 테스트에서 난수 선택 결과를 제어하고 선택 호출 및 표시 순서를 검증할 수 있다.
|
- **메시지 역할**: 메시지를 작성한 주체를 나타내는 명시적인 값이며 `user` 또는 `agent` 중 하나다.
|
||||||
- 빈 입력과 공백만 포함한 입력은 사용자 메시지, 응답 및 응답 선택 결과를 남기지 않는다.
|
- **작성자 라벨**: 사용자 역할을 `사용자`, 에이전트 역할을 `에이전트`로 화면에 표시하는 문자열이다.
|
||||||
- 유효한 입력 제출 뒤 입력창이 비워진다.
|
- **구조적 스타일**: 색상에만 의존하지 않고 CSS 클래스, 테두리 또는 정렬 차이로 작성자를 구분하는 표현이다.
|
||||||
- `Escape` 및 `Ctrl+Q`가 애플리케이션 종료를 요청한다.
|
- **정본 기준**: `ChatMessage.role`과 `ChatMessage.content`의 조합을 메시지 의미의 단일 기준으로 삼고, 라벨과 CSS 클래스는 이 역할에서 파생한다.
|
||||||
|
|
||||||
|
## 5. 요구사항
|
||||||
|
|
||||||
|
`REQ-001`은 대화 메시지의 작성자 의미를 명시적으로 관리하고 화면 및 검증 절차에서 일관되게 구분하기 위한 요구사항 묶음의 식별자다.
|
||||||
|
|
||||||
|
### REQ-001.01 — 명시적인 메시지 역할 관리
|
||||||
|
|
||||||
|
시스템은 유효한 사용자 입력과 그에 대응하는 에이전트 응답을 각각 명시적인 작성자 역할을 가진 메시지로 관리해야 한다. 사용자 메시지의 역할은 `user`, 에이전트 응답의 역할은 `agent`여야 하며, 역할과 본문은 하나의 대화 메시지 단위로 보존되어야 한다.
|
||||||
|
|
||||||
|
**영향 범위**
|
||||||
|
|
||||||
|
- 인터페이스: `ChatMessage`, `MessageRole`, 대화 영역의 Label 렌더링
|
||||||
|
- 영속성: 없음. 메시지는 애플리케이션 세션 메모리에만 유지한다.
|
||||||
|
- 후속 사용 주체: UI 렌더러와 자동 테스트
|
||||||
|
- 마이그레이션: 필요 없음. 기존 저장 데이터가 없다.
|
||||||
|
- 호환성: 유효한 입력의 정규화, 응답 선택, 입력·응답 배열 및 표시 순서를 유지한다.
|
||||||
|
- 배포 전제 조건: Python 3.11 이상과 현재 Textual 의존성을 유지한다.
|
||||||
|
|
||||||
|
### REQ-001.02 — 작성자 라벨과 구조적 표시
|
||||||
|
|
||||||
|
시스템은 각 메시지의 명시적인 역할을 작성자 라벨과 구조적 스타일로 변환하여 표시해야 한다. 사용자 메시지는 `사용자` 라벨과 `user-message` 식별자를 사용하고, 에이전트 응답은 `에이전트` 라벨과 `response-message` 식별자를 사용해야 한다. 구조적 스타일은 색상만으로 작성자를 구분하지 않아야 하며, 역할별 테두리 또는 정렬 차이를 포함해야 한다.
|
||||||
|
|
||||||
|
**영향 범위**
|
||||||
|
|
||||||
|
- 인터페이스: `#conversation` 내부 Label의 표시 문자열과 CSS 클래스
|
||||||
|
- 영속성: 없음. 화면 위젯과 세션 메모리만 변경한다.
|
||||||
|
- 후속 사용 주체: 사용자, UI 검수자 및 자동 회귀 테스트
|
||||||
|
- 마이그레이션: 필요 없음
|
||||||
|
- 호환성: 기존 `user-message` 및 `response-message` 식별자와 사용자·응답의 표시 순서를 유지한다.
|
||||||
|
- 배포 전제 조건: Textual의 Label, VerticalScroll 및 CSS 스타일 기능을 사용할 수 있어야 한다.
|
||||||
|
|
||||||
|
## 6. 제약과 불변조건
|
||||||
|
|
||||||
|
- Python 3.11 이상과 현재 Textual 기반 TUI 구조를 유지한다.
|
||||||
|
- 유효한 입력은 앞뒤 공백을 제거한 뒤 사용자 메시지로 한 번만 기록한다.
|
||||||
|
- 공백만 있거나 빈 입력은 응답을 선택하지 않고 메시지 목록과 화면을 변경하지 않는다.
|
||||||
|
- 유효한 입력 하나마다 사용자 메시지가 먼저, 그 뒤에 에이전트 응답이 표시되어야 한다.
|
||||||
|
- 에이전트 응답은 기존 `RESPONSE_MESSAGES`에서 `random.choice(RESPONSE_MESSAGES)`로 선택한다.
|
||||||
|
- 모든 메시지는 `MessageRole`을 통해 작성자 의미를 가져야 하며 CSS 클래스만으로 역할을 판정하지 않는다.
|
||||||
|
- 사용자와 에이전트는 화면의 텍스트 라벨로 구분되어야 한다.
|
||||||
|
- 역할 구분은 색상에만 의존하지 않고 역할별 CSS 식별자와 테두리 또는 정렬 차이를 포함해야 한다.
|
||||||
|
- 메시지 표시와 테스트에서 사용자 및 에이전트 역할의 순서와 의미가 일치해야 한다.
|
||||||
|
- 외부 API, 인증, 영속 저장소 및 민감정보 처리는 추가하지 않는다.
|
||||||
|
|
||||||
|
## 7. 인수 기준
|
||||||
|
|
||||||
|
인수 기준은 소속 요구사항을 포함한 `REQ-001.01-AC01` 형식으로 식별한다.
|
||||||
|
|
||||||
|
### REQ-001.01-AC01 — 메시지 역할이 순서대로 보존됨
|
||||||
|
|
||||||
|
**판정 기준**
|
||||||
|
|
||||||
|
- 유효한 사용자 입력이 제출되면 입력 문자열의 앞뒤 공백이 제거된 사용자 메시지가 `user` 역할로 기록된다.
|
||||||
|
- 같은 제출에서 선택된 응답이 `agent` 역할로 기록된다.
|
||||||
|
- 여러 입력을 제출할 때 메시지 목록은 각 입력에 대해 사용자 메시지 다음 에이전트 응답 순서를 유지한다.
|
||||||
|
- 메시지 역할과 본문이 함께 비교 가능해야 하며, 역할을 CSS 클래스에서 추론하지 않아야 한다.
|
||||||
|
|
||||||
|
**검증**
|
||||||
|
|
||||||
|
- Textual 테스트 앱에서 두 개의 유효한 입력을 제출한다.
|
||||||
|
- `submitted_inputs`, `selected_responses`, `messages`의 값과 순서를 비교한다.
|
||||||
|
- `messages`가 사용자와 에이전트 역할을 번갈아 포함하는지 확인한다.
|
||||||
|
- 응답 선택을 고정해 입력 정규화와 메시지 역할 보존을 결정적으로 검증한다.
|
||||||
|
|
||||||
|
**검증 분류**
|
||||||
|
|
||||||
|
- 수준: `integration`
|
||||||
|
- 백엔드: 없음
|
||||||
|
- 케이스: `positive`
|
||||||
|
|
||||||
|
**상태 불변조건**
|
||||||
|
|
||||||
|
- 성공 시 입력과 응답이 각각 올바른 역할의 메시지로 세션 목록에 추가되어야 한다.
|
||||||
|
- 성공하더라도 기존 입력·응답의 순서와 내용은 변경되면 안 된다.
|
||||||
|
- 실패 또는 공백 입력 시 응답 선택과 메시지 목록 추가가 발생하지 않아야 한다.
|
||||||
|
|
||||||
|
### REQ-001.01-AC02 — 공백 입력이 역할 없는 메시지를 만들지 않음
|
||||||
|
|
||||||
|
**판정 기준**
|
||||||
|
|
||||||
|
- 빈 문자열 또는 공백·탭·개행만 포함한 입력을 제출해도 사용자 메시지와 에이전트 응답이 추가되지 않아야 한다.
|
||||||
|
- 공백 입력에서는 응답 선택 함수가 호출되지 않아야 한다.
|
||||||
|
- 입력창은 기존 동작과 같이 제출 후 비워져야 한다.
|
||||||
|
|
||||||
|
**검증**
|
||||||
|
|
||||||
|
- 공백만 포함한 입력과 빈 입력을 각각 Textual 테스트 앱에 제출한다.
|
||||||
|
- 메시지 목록과 대화 영역 Label 개수가 0인지 확인한다.
|
||||||
|
- `random.choice`가 호출되지 않았는지 확인한다.
|
||||||
|
- 입력창 값이 비워지는지 확인한다.
|
||||||
|
|
||||||
|
**검증 분류**
|
||||||
|
|
||||||
|
- 수준: `integration`
|
||||||
|
- 백엔드: 없음
|
||||||
|
- 케이스: `boundary`
|
||||||
|
|
||||||
|
**상태 불변조건**
|
||||||
|
|
||||||
|
- 성공적인 무시 처리에서 메시지 목록, 제출 입력 기록 및 응답 기록은 변경되지 않아야 한다.
|
||||||
|
- 대화 영역에 작성자 라벨을 포함한 새 Label이 추가되면 안 된다.
|
||||||
|
- 실패 시 부분적인 사용자 메시지 또는 응답이 남아서는 안 된다.
|
||||||
|
|
||||||
|
### REQ-001.02-AC01 — 작성자 라벨과 구조적 스타일이 역할과 일치함
|
||||||
|
|
||||||
|
**판정 기준**
|
||||||
|
|
||||||
|
- 사용자 메시지는 `사용자: 본문` 형식으로 표시되어야 한다.
|
||||||
|
- 에이전트 응답은 `에이전트: 본문` 형식으로 표시되어야 한다.
|
||||||
|
- 사용자 Label에는 `chat-message user-message user-role` 클래스가 포함되어야 한다.
|
||||||
|
- 에이전트 Label에는 `chat-message response-message agent-role` 클래스가 포함되어야 한다.
|
||||||
|
- CSS에는 사용자와 에이전트의 구조적 차이를 나타내는 `border-left`, `border-right`, `align: left middle`, `align: right middle` 규칙이 있어야 한다.
|
||||||
|
|
||||||
|
**검증**
|
||||||
|
|
||||||
|
- 유효한 입력 하나를 제출하고 대화 영역의 Label 두 개를 조회한다.
|
||||||
|
- Label의 렌더링 문자열과 클래스가 각각 사용자 및 에이전트 역할과 일치하는지 확인한다.
|
||||||
|
- 애플리케이션 CSS에 양쪽 테두리와 역할별 정렬 규칙이 포함되는지 확인한다.
|
||||||
|
|
||||||
|
**검증 분류**
|
||||||
|
|
||||||
|
- 수준: `integration`
|
||||||
|
- 백엔드: 없음
|
||||||
|
- 케이스: `positive`
|
||||||
|
|
||||||
|
**상태 불변조건**
|
||||||
|
|
||||||
|
- 성공 시 각 메시지의 라벨과 구조적 클래스가 해당 역할과 일치해야 한다.
|
||||||
|
- 성공하더라도 메시지 본문, 표시 순서 및 기존 식별자는 변경되면 안 된다.
|
||||||
|
- 렌더링 실패 시 역할이 다른 라벨이나 일부만 표시된 메시지가 남아서는 안 된다.
|
||||||
|
|
||||||
|
### REQ-001.02-AC02 — 기존 응답 선택과 종료 동작을 보존함
|
||||||
|
|
||||||
|
**판정 기준**
|
||||||
|
|
||||||
|
- 유효한 입력 제출 시 기존 응답 목록을 인자로 하여 표준 `random.choice`가 한 번 호출되어야 한다.
|
||||||
|
- `Escape` 키 입력은 기존처럼 애플리케이션 종료를 요청해야 한다.
|
||||||
|
- 작성자 구분 기능을 추가해도 기존 입력·응답 회귀 테스트가 통과해야 한다.
|
||||||
|
|
||||||
|
**검증**
|
||||||
|
|
||||||
|
- `random.choice`를 모의 처리하여 `RESPONSE_MESSAGES`가 전달되는지 확인한다.
|
||||||
|
- Textual 테스트 앱에서 `Escape`를 입력하고 `exit()` 호출을 확인한다.
|
||||||
|
- 유효 입력 두 건의 정규화, 응답 내용, 표시 순서 및 입력창 초기화를 함께 확인한다.
|
||||||
|
|
||||||
|
**검증 분류**
|
||||||
|
|
||||||
|
- 수준: `integration`
|
||||||
|
- 백엔드: 없음
|
||||||
|
- 케이스: `unchanged-state`
|
||||||
|
|
||||||
|
**상태 불변조건**
|
||||||
|
|
||||||
|
- 유효 입력 성공 시 기존 응답 선택과 종료 바인딩이 계속 동작해야 한다.
|
||||||
|
- 작성자 라벨 추가로 응답 목록, 난수 선택 방식 또는 종료 정책이 변경되면 안 된다.
|
||||||
|
- 실패 시 부분적인 응답 선택 기록이나 대화 항목이 남아서는 안 된다.
|
||||||
|
|
||||||
|
## 8. 오류 및 충돌 계약
|
||||||
|
|
||||||
|
- 입력 오류: 빈 입력과 공백 입력은 오류를 표시하지 않고 무시하며, 응답 선택과 메시지 추가를 수행하지 않는다.
|
||||||
|
- 상태 충돌: 단일 Textual 이벤트 루프에서 제출 이벤트 순서를 처리하며, 동일 입력을 자동으로 중복 제출하지 않는다.
|
||||||
|
- 저장 실패: 영속 저장소가 없으므로 저장 실패와 롤백 대상이 없다. 렌더링 실패가 발생하더라도 별도의 부분 영속 기록을 만들지 않는다.
|
||||||
|
- 역할 오류: 사용자 또는 에이전트로 정의되지 않은 역할은 정상 메시지로 렌더링하지 않으며, 역할 값과 표시 라벨의 매핑은 한 곳의 명시적 기준을 따른다.
|
||||||
|
|
||||||
|
## 9. 데이터 및 인터페이스 계약
|
||||||
|
|
||||||
|
- `MessageRole`: 문자열 기반 열거형이며 `USER`의 값은 `user`, `AGENT`의 값은 `agent`다.
|
||||||
|
- `ChatMessage.role`: 필수 `MessageRole` 값으로 메시지 작성자를 나타낸다.
|
||||||
|
- `ChatMessage.content`: 필수 문자열로 공백 제거가 완료된 사용자 입력 또는 선택된 응답 본문을 담는다.
|
||||||
|
- `MessageRole.label`: `user`를 `사용자`, `agent`를 `에이전트`로 변환한다.
|
||||||
|
- `ChatApp.messages`: 제출 순서대로 `ChatMessage`를 보유하며 유효 입력마다 사용자 메시지와 에이전트 응답을 차례로 추가한다.
|
||||||
|
- 사용자 Label 표시값은 `사용자: 본문` 형식이고 에이전트 Label 표시값은 `에이전트: 본문` 형식이다.
|
||||||
|
- 사용자 Label은 `user-message`와 `user-role`을 포함하고 에이전트 Label은 `response-message`와 `agent-role`을 포함한다.
|
||||||
|
- `submitted_inputs`, `selected_responses` 및 기존 `RESPONSE_MESSAGES` 계약은 유지한다.
|
||||||
|
- 식별자는 세션 내 메모리 객체와 CSS 클래스에 한정되며 시간대·단위·정밀도 계약은 없다.
|
||||||
|
|
||||||
|
## 10. 하위 호환성
|
||||||
|
|
||||||
|
- Python 3.11 이상에서 실행되는 기존 패키지와 콘솔 진입점 `chat_tui.app:main`을 유지한다.
|
||||||
|
- `#conversation`, `#user-input`, `user-message`, `response-message` 식별자를 유지한다.
|
||||||
|
- Enter 제출, 앞뒤 공백 제거, 공백 입력 무시, 고정 응답 목록 선택, `Escape` 및 `Ctrl+Q` 종료 동작을 유지한다.
|
||||||
|
- 기존의 사용자·응답 Label 두 항목 표시 구조를 유지하되 표시 문자열에 작성자 라벨과 역할 클래스를 추가한다.
|
||||||
|
- 기존 영속 데이터가 없으므로 데이터 마이그레이션은 필요하지 않다.
|
||||||
|
- 작성자 라벨과 구조적 스타일은 추가되지만 대화 영역 전체 레이아웃을 재설계하지 않는다.
|
||||||
|
|
||||||
|
## 11. 검증 계획
|
||||||
|
|
||||||
|
- `tests/test_app.py`의 Textual 비동기 테스트로 정상 입력, 다중 메시지 순서, 역할 객체, 라벨 및 CSS 클래스를 검증한다.
|
||||||
|
- 공백 입력과 빈 입력 테스트로 응답 선택 미호출, 메시지 미추가 및 화면 미변경을 검증한다.
|
||||||
|
- `random.choice` 모의 테스트로 기존 응답 선택 계약을 검증한다.
|
||||||
|
- `Escape` 종료 테스트로 기존 종료 바인딩을 회귀 검증한다.
|
||||||
|
- 별도 영속성 백엔드와 마이그레이션이 없으므로 저장 후 재조회 검증은 해당 없음으로 판정한다.
|
||||||
|
- 요구사항, `docs/data-model.md`, `docs/interface-contract.md`, `docs/runtime-flow.md`의 역할·라벨·스타일·순서 설명이 구현 및 테스트와 일치하는지 문서 검토로 확인한다.
|
||||||
|
|
||||||
|
### 테스트 추적성 계약
|
||||||
|
|
||||||
|
- 요구사항 문서에는 검증 의도와 판정 조건만 기록한다.
|
||||||
|
- 실행 가능한 테스트 정의는 별도 테스트 카탈로그 산출물에서 관리한다.
|
||||||
|
- 각 테스트 케이스는 안정적인 식별자를 사용하고 `verifies`로 인수 기준을 참조한다.
|
||||||
|
- 하나의 테스트가 여러 인수 기준을 검증할 수 있으며, 각 연결을 빠짐없이 기록한다.
|
||||||
|
- 실행 결과는 요구사항 또는 테스트 정의에 덮어쓰지 않고 별도 증거 산출물에 기록한다.
|
||||||
|
- 증거는 요구사항 개정 번호, 검증한 커밋, 환경과 실행 시각에 결합한다.
|
||||||
|
- 테스트 정의의 존재, 자동화 여부, 특정 커밋에서의 실행 여부와 PASS 결과를 서로 다른 상태로 취급한다.
|
||||||
|
|
||||||
|
테스트 정의 예시:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Test ID: TC-001-001
|
||||||
|
Verifies:
|
||||||
|
- REQ-001.01-AC01
|
||||||
|
- REQ-001.02-AC01
|
||||||
|
Test reference: tests/test_app.py::ChatAppTest::test_submitted_input_and_response_are_displayed_in_order
|
||||||
|
Automated: true
|
||||||
|
```
|
||||||
|
|
||||||
|
실행 증거 예시:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Test ID: TC-001-001
|
||||||
|
Requirement revision: REQ-001@0.1
|
||||||
|
Commit: 검증 실행 시점의 커밋 SHA
|
||||||
|
Environment: Python 3.11 이상, Textual 테스트 앱, 영속 백엔드 없음
|
||||||
|
Result: PASS | FAIL | BLOCKED
|
||||||
|
Executed at: 실행 시각
|
||||||
|
```
|
||||||
|
|
||||||
|
## 12. 추적성
|
||||||
|
|
||||||
|
- 근거 이슈: Gitea 이슈 #6, 제목 `메세지 표시창에서 메세지 작성자 구분`
|
||||||
|
- 구현 PR: 없음
|
||||||
|
- 관련 설계 문서: `docs/data-model.md`, `docs/interface-contract.md`, `docs/runtime-flow.md`, `docs/project-structure.md`
|
||||||
|
- 관련 요구사항: 없음
|
||||||
|
|
||||||
|
## 13. 확정된 결정
|
||||||
|
|
||||||
|
- 사용자 메시지와 에이전트 응답은 작성자 라벨과 구조적 스타일로 구분한다.
|
||||||
|
- 작성자 구분은 색상에만 의존하지 않고 테두리 또는 정렬 차이를 포함한다.
|
||||||
|
- 작성자 의미는 CSS 클래스에만 두지 않고 명시적인 메시지 역할로 관리한다.
|
||||||
|
- 기존 사용자·응답 표시 순서, 입력 정규화, 고정 응답 선택 및 종료 동작은 유지한다.
|
||||||
|
- 외부 API, LLM, 인증 및 영속 저장은 이번 범위에 포함하지 않는다.
|
||||||
|
|
||||||
|
## 14. 미결 사항
|
||||||
|
|
||||||
|
없음
|
||||||
|
|
||||||
|
## 15. 승인 기록
|
||||||
|
|
||||||
|
- 상태: `approved`
|
||||||
|
- 승인 주체: `spec-agent`
|
||||||
|
- 승인 근거: 승인 댓글 923 및 디스커버리 승인 결과
|
||||||
|
|||||||
+42
-28
@@ -1,39 +1,53 @@
|
|||||||
|
<!-- gitea-agent:documentation-template/runtime-flow/v1 -->
|
||||||
# 런타임 흐름
|
# 런타임 흐름
|
||||||
|
|
||||||
## 정상 입력 시나리오
|
## 목적과 범위
|
||||||
|
|
||||||
1. 애플리케이션이 `#user-input`에 포커스를 둔다.
|
이 문서는 사용자가 입력을 제출한 시점부터 사용자 메시지와 에이전트 응답을 역할별로 생성하고 화면에 렌더링하는 실행 범위를 정의한다. 입력은 앞뒤 공백을 제거한 뒤 처리하며, 유효한 입력마다 고정 응답 목록에서 하나의 응답을 선택한다. 외부 API, LLM, 인증, 영속 저장 및 대화 기록 관리는 범위에 포함하지 않는다.
|
||||||
2. 사용자가 입력하고 Enter를 누른다.
|
|
||||||
3. `Input.Submitted` 이벤트에서 입력값을 `strip()`한다.
|
|
||||||
4. 입력창 값을 즉시 빈 문자열로 초기화한다.
|
|
||||||
5. `trim` 결과가 유효하면 사용자 메시지를 세션 상태에 기록한다.
|
|
||||||
6. `random.choice(RESPONSE_MESSAGES)`가 고정 응답 하나를 선택한다.
|
|
||||||
7. 선택 응답을 세션 상태에 기록한다.
|
|
||||||
8. 대화 영역에 사용자 메시지 `Label`을 추가한다.
|
|
||||||
9. 사용자 메시지 바로 뒤에 응답 `Label`을 추가한다.
|
|
||||||
10. 대화 영역을 마지막 항목으로 스크롤한다.
|
|
||||||
|
|
||||||
여러 번 제출하면 각 사용자 메시지와 응답 쌍이 제출 순서대로 누적된다.
|
## 흐름
|
||||||
|
|
||||||
## 공백 입력 시나리오
|
1. 입력창에서 제출 이벤트가 발생하면 입력값의 앞뒤 공백을 제거하고 입력창을 즉시 비운다.
|
||||||
|
2. 정규화된 값이 비어 있으면 후속 처리를 중단한다.
|
||||||
|
3. 값이 유효하면 고정된 응답 목록에서 표준 무작위 선택으로 에이전트 응답을 결정한다.
|
||||||
|
4. 정규화된 입력을 사용자 역할의 메시지로 만들고, 선택된 응답을 에이전트 역할의 메시지로 만든다.
|
||||||
|
5. 두 메시지를 제출 순서대로 메모리 목록에 추가한다. 한 번의 제출에서는 사용자 메시지가 먼저이고 에이전트 응답이 바로 뒤따른다.
|
||||||
|
6. 각 메시지의 역할에서 화면 라벨과 구조적 스타일 클래스를 파생한다. 사용자 메시지는 사용자 라벨과 왼쪽 정렬·왼쪽 테두리를 사용하고, 에이전트 응답은 에이전트 라벨과 오른쪽 정렬·오른쪽 테두리를 사용한다.
|
||||||
|
7. 대화 영역에 두 항목을 순서대로 마운트하고 마지막 항목이 보이도록 스크롤한다.
|
||||||
|
8. 종료 키 입력은 기존 종료 동작을 요청하며, 메시지 제출 흐름과 독립적으로 처리한다.
|
||||||
|
|
||||||
1. 사용자가 공백만 포함한 값을 제출한다.
|
### `message-submission-and-rendering`
|
||||||
2. 입력값을 `strip()`한다.
|
|
||||||
3. 결과가 빈 문자열임을 확인한다.
|
|
||||||
4. 입력창은 비우되 상태, 난수 선택 결과 및 대화 영역은 변경하지 않는다.
|
|
||||||
|
|
||||||
## 종료 시나리오
|
입력창의 제출 이벤트는 실행 흐름의 시작점이다. 이벤트 값을 앞뒤 공백 제거로 정규화하고 입력창을 비운 다음, 정규화된 결과가 비어 있는지 판정한다. 빈 결과는 정상적으로 무시하며 응답 선택이나 상태 변경을 수행하지 않는다.
|
||||||
|
|
||||||
- `Escape`를 누르면 기존 종료 바인딩이 실행된다.
|
유효한 입력이면 고정된 응답 목록을 표준 무작위 선택 함수에 전달하여 에이전트 응답을 하나 결정한다. 이후 정규화된 입력과 선택된 응답을 각각 사용자 역할과 에이전트 역할의 불변 메시지로 만든다. 제출 입력과 선택 응답의 기존 세션 기록도 함께 갱신하되, 응답 선택은 유효한 입력마다 한 번만 수행한다.
|
||||||
- `Ctrl+Q`를 누르면 기존 종료 바인딩이 실행된다.
|
|
||||||
- 두 동작 모두 `quit` 액션을 통해 애플리케이션 종료를 요청한다.
|
|
||||||
|
|
||||||
## 검증 시나리오
|
생성된 메시지는 사용자 메시지, 에이전트 응답 순서로 메시지 목록에 연속 추가한다. 여러 번 제출한 경우에도 각 제출의 두 항목이 제출 순서에 따라 누적되며, 이전 항목의 내용과 역할은 변경하지 않는다. 메시지의 역할과 본문은 화면 표현보다 우선하는 정본 값이다.
|
||||||
|
|
||||||
자동 테스트는 결정 가능한 `random.choice` 결과를 사용해 다음을 확인한다.
|
렌더링 단계에서는 역할에서 표시 라벨과 구조적 스타일을 파생한다. 사용자 메시지는 `사용자: 본문` 형식과 사용자용 메시지 클래스를 사용하고, 에이전트 응답은 `에이전트: 본문` 형식과 응답용 메시지 클래스를 사용한다. 사용자 항목은 왼쪽 정렬과 왼쪽 테두리, 에이전트 항목은 오른쪽 정렬과 오른쪽 테두리를 적용하여 색상에만 의존하지 않고 구분한다.
|
||||||
|
|
||||||
- 입력 `trim` 결과가 사용자 메시지로 저장되고 표시되는지
|
각 항목은 대화 영역에 생성 순서대로 추가하고, 두 항목을 모두 추가한 뒤 대화 영역의 끝으로 스크롤한다. 따라서 유효한 제출 하나의 화면 결과는 사용자 메시지가 먼저이고 대응하는 에이전트 응답이 바로 뒤따르는 형태가 된다. 종료 키 처리는 이 흐름과 별도로 애플리케이션 종료를 요청하며, 입력·응답 상태를 새로 만들지 않는다.
|
||||||
- 사용자 메시지 다음에 응답이 표시되는지
|
|
||||||
- 공백 입력에서 `random.choice`가 호출되지 않는지
|
검증은 정규화된 입력과 응답 기록, 역할과 본문을 포함한 메시지 목록, 화면 라벨, 역할별 구조적 스타일 및 표시 순서를 함께 비교하여 수행한다. 빈 입력과 공백 입력에서는 응답 선택과 모든 메시지·화면 변경이 발생하지 않는지 확인하고, 여러 입력에서는 기존 항목을 보존한 채 사용자와 에이전트 쌍이 올바른 순서로 누적되는지 확인한다.
|
||||||
- 입력창이 제출 후 비워지는지
|
|
||||||
- 기존 종료 동작이 유지되는지
|
## 실패와 복구
|
||||||
|
|
||||||
|
- 빈 문자열이나 공백·탭·개행만 포함한 입력은 입력창을 비운 뒤 무시한다.
|
||||||
|
- 무시된 입력에서는 응답 선택, 제출 기록 추가, 메시지 생성 및 화면 항목 추가가 발생하지 않는다.
|
||||||
|
- 응답 선택이나 메시지 기록 전에 입력 유효성을 확인하므로 부분적인 사용자 메시지 또는 에이전트 응답이 남지 않는다.
|
||||||
|
- 단일 이벤트 루프에서 제출 이벤트 순서를 처리하며, 처리된 제출의 표시 순서를 자동으로 재배열하지 않는다.
|
||||||
|
- 렌더링 실패가 영속 데이터나 외부 시스템 상태를 변경하지 않도록 별도 저장·보상 절차를 두지 않는다.
|
||||||
|
- 역할 값은 명시적인 역할 모델에서 관리하며 화면 위치나 스타일 클래스만으로 작성자를 추론하지 않는다.
|
||||||
|
|
||||||
|
## 관찰 가능성
|
||||||
|
|
||||||
|
실행 중 확인할 수 있는 상태는 정규화된 제출 입력 목록, 선택된 응답 목록, 역할과 본문을 함께 가진 메시지 목록 및 대화 영역의 표시 항목이다. 각 유효한 제출에 대해 입력과 응답이 같은 순서로 기록되며, 메시지 목록에는 역할이 명시된다. 화면 텍스트에는 사용자 또는 에이전트 라벨이 포함되고, 구조적 스타일은 역할별 정렬과 테두리로 확인할 수 있다. 민감정보, 외부 호출 식별자 및 영속 저장 상태는 생성하지 않는다.
|
||||||
|
|
||||||
|
## 검증
|
||||||
|
|
||||||
|
- 정상 입력 하나와 여러 개를 제출하여 입력 정규화, 응답 선택, 역할 부여, 라벨 표시 및 전체 순서를 확인한다.
|
||||||
|
- 응답 선택을 고정하여 동일한 입력 흐름을 결정적으로 검증하고, 표준 응답 선택 호출이 기존 목록을 대상으로 한 번 수행되는지 확인한다.
|
||||||
|
- 빈 입력과 공백 입력을 제출하여 선택 함수가 호출되지 않고 메시지 목록과 화면 항목이 변경되지 않는지 확인한다.
|
||||||
|
- 사용자와 에이전트 항목의 라벨, 역할 클래스, 좌우 정렬 및 양쪽 테두리 규칙을 확인한다.
|
||||||
|
- 종료 키 입력이 애플리케이션 종료 요청으로 연결되는지 회귀 검증한다.
|
||||||
|
- 입력창이 모든 제출 뒤 비워지고, 유효한 제출의 사용자 메시지 뒤에 해당 에이전트 응답이 즉시 표시되는지 확인한다.
|
||||||
|
|||||||
+62
-3
@@ -1,5 +1,7 @@
|
|||||||
"""사용자 입력과 고정 무작위 응답을 표시하는 Textual 애플리케이션."""
|
"""사용자 입력과 고정 무작위 응답을 작성자 역할과 함께 표시하는 Textual 애플리케이션."""
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from enum import Enum
|
||||||
import random
|
import random
|
||||||
|
|
||||||
from textual.app import App, ComposeResult
|
from textual.app import App, ComposeResult
|
||||||
@@ -16,6 +18,29 @@ RESPONSE_MESSAGES = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class MessageRole(str, Enum):
|
||||||
|
"""대화 메시지를 작성한 주체의 명시적인 역할."""
|
||||||
|
|
||||||
|
USER = "user"
|
||||||
|
AGENT = "agent"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def label(self) -> str:
|
||||||
|
"""화면에 표시할 작성자 라벨을 반환한다."""
|
||||||
|
return {
|
||||||
|
MessageRole.USER: "사용자",
|
||||||
|
MessageRole.AGENT: "에이전트",
|
||||||
|
}[self]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class ChatMessage:
|
||||||
|
"""작성자 역할과 본문을 함께 보유하는 대화 메시지."""
|
||||||
|
|
||||||
|
role: MessageRole
|
||||||
|
content: str
|
||||||
|
|
||||||
|
|
||||||
class ChatApp(App[None]):
|
class ChatApp(App[None]):
|
||||||
"""사용자 메시지 뒤에 고정 목록에서 선택한 응답을 표시하는 TUI."""
|
"""사용자 메시지 뒤에 고정 목록에서 선택한 응답을 표시하는 TUI."""
|
||||||
|
|
||||||
@@ -30,6 +55,23 @@ class ChatApp(App[None]):
|
|||||||
padding: 1;
|
padding: 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#conversation .chat-message {
|
||||||
|
width: 80%;
|
||||||
|
margin: 1 0;
|
||||||
|
padding: 1 2;
|
||||||
|
border: round $surface;
|
||||||
|
}
|
||||||
|
|
||||||
|
#conversation .user-message {
|
||||||
|
align: left middle;
|
||||||
|
border-left: thick $success;
|
||||||
|
}
|
||||||
|
|
||||||
|
#conversation .response-message {
|
||||||
|
align: right middle;
|
||||||
|
border-right: thick $warning;
|
||||||
|
}
|
||||||
|
|
||||||
#user-input {
|
#user-input {
|
||||||
margin: 1 0;
|
margin: 1 0;
|
||||||
}
|
}
|
||||||
@@ -44,6 +86,7 @@ class ChatApp(App[None]):
|
|||||||
super().__init__()
|
super().__init__()
|
||||||
self.submitted_inputs: list[str] = []
|
self.submitted_inputs: list[str] = []
|
||||||
self.selected_responses: list[str] = []
|
self.selected_responses: list[str] = []
|
||||||
|
self.messages: list[ChatMessage] = []
|
||||||
|
|
||||||
def compose(self) -> ComposeResult:
|
def compose(self) -> ComposeResult:
|
||||||
yield Header(show_clock=False)
|
yield Header(show_clock=False)
|
||||||
@@ -68,11 +111,27 @@ class ChatApp(App[None]):
|
|||||||
self.submitted_inputs.append(value)
|
self.submitted_inputs.append(value)
|
||||||
self.selected_responses.append(response)
|
self.selected_responses.append(response)
|
||||||
|
|
||||||
|
user_message = ChatMessage(MessageRole.USER, value)
|
||||||
|
agent_message = ChatMessage(MessageRole.AGENT, response)
|
||||||
|
self.messages.extend((user_message, agent_message))
|
||||||
|
|
||||||
conversation = self.query_one("#conversation", VerticalScroll)
|
conversation = self.query_one("#conversation", VerticalScroll)
|
||||||
conversation.mount(Label(value, classes="user-message"))
|
self._mount_message(conversation, user_message, "user-message")
|
||||||
conversation.mount(Label(response, classes="response-message"))
|
self._mount_message(conversation, agent_message, "response-message")
|
||||||
conversation.scroll_end(animate=False)
|
conversation.scroll_end(animate=False)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _mount_message(
|
||||||
|
conversation: VerticalScroll,
|
||||||
|
message: ChatMessage,
|
||||||
|
style_class: str,
|
||||||
|
) -> None:
|
||||||
|
"""메시지 역할을 라벨과 호환 가능한 구조적 스타일로 변환한다."""
|
||||||
|
text = f"{message.role.label}: {message.content}"
|
||||||
|
conversation.mount(
|
||||||
|
Label(text, classes=f"chat-message {style_class} {message.role.value}-role")
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
"""콘솔 스크립트의 실행 진입점."""
|
"""콘솔 스크립트의 실행 진입점."""
|
||||||
|
|||||||
+50
-6
@@ -3,7 +3,12 @@ from unittest.mock import patch
|
|||||||
|
|
||||||
from textual.widgets import Input, Label
|
from textual.widgets import Input, Label
|
||||||
|
|
||||||
from chat_tui.app import RESPONSE_MESSAGES, ChatApp
|
from chat_tui.app import (
|
||||||
|
RESPONSE_MESSAGES,
|
||||||
|
ChatApp,
|
||||||
|
ChatMessage,
|
||||||
|
MessageRole,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class ChatAppTest(unittest.IsolatedAsyncioTestCase):
|
class ChatAppTest(unittest.IsolatedAsyncioTestCase):
|
||||||
@@ -28,21 +33,58 @@ class ChatAppTest(unittest.IsolatedAsyncioTestCase):
|
|||||||
app.selected_responses,
|
app.selected_responses,
|
||||||
[RESPONSE_MESSAGES[2], RESPONSE_MESSAGES[2]],
|
[RESPONSE_MESSAGES[2], RESPONSE_MESSAGES[2]],
|
||||||
)
|
)
|
||||||
|
self.assertEqual(
|
||||||
|
app.messages,
|
||||||
|
[
|
||||||
|
ChatMessage(MessageRole.USER, "첫 번째 입력"),
|
||||||
|
ChatMessage(MessageRole.AGENT, RESPONSE_MESSAGES[2]),
|
||||||
|
ChatMessage(MessageRole.USER, "두 번째 입력"),
|
||||||
|
ChatMessage(MessageRole.AGENT, RESPONSE_MESSAGES[2]),
|
||||||
|
],
|
||||||
|
)
|
||||||
displayed = [
|
displayed = [
|
||||||
label.renderable
|
str(label.renderable)
|
||||||
for label in app.query("#conversation Label")
|
for label in app.query("#conversation Label")
|
||||||
]
|
]
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
displayed,
|
displayed,
|
||||||
[
|
[
|
||||||
"첫 번째 입력",
|
"사용자: 첫 번째 입력",
|
||||||
RESPONSE_MESSAGES[2],
|
f"에이전트: {RESPONSE_MESSAGES[2]}",
|
||||||
"두 번째 입력",
|
"사용자: 두 번째 입력",
|
||||||
RESPONSE_MESSAGES[2],
|
f"에이전트: {RESPONSE_MESSAGES[2]}",
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
self.assertEqual(input_widget.value, "")
|
self.assertEqual(input_widget.value, "")
|
||||||
|
|
||||||
|
async def test_messages_have_explicit_roles_labels_and_structural_styles(
|
||||||
|
self,
|
||||||
|
) -> None:
|
||||||
|
app = ChatApp()
|
||||||
|
with patch("chat_tui.app.random.choice", return_value=RESPONSE_MESSAGES[0]):
|
||||||
|
async with app.run_test() as pilot:
|
||||||
|
input_widget = app.query_one("#user-input", Input)
|
||||||
|
input_widget.value = "역할 확인"
|
||||||
|
await pilot.press("enter")
|
||||||
|
await pilot.pause()
|
||||||
|
|
||||||
|
labels = list(app.query("#conversation Label"))
|
||||||
|
self.assertEqual(len(labels), 2)
|
||||||
|
self.assertEqual(
|
||||||
|
labels[0].classes,
|
||||||
|
frozenset({"chat-message", "user-message", "user-role"}),
|
||||||
|
)
|
||||||
|
self.assertEqual(
|
||||||
|
labels[1].classes,
|
||||||
|
frozenset({"chat-message", "response-message", "agent-role"}),
|
||||||
|
)
|
||||||
|
self.assertIn("사용자:", str(labels[0].renderable))
|
||||||
|
self.assertIn("에이전트:", str(labels[1].renderable))
|
||||||
|
self.assertIn("border-left", app.CSS)
|
||||||
|
self.assertIn("border-right", app.CSS)
|
||||||
|
self.assertIn("align: left middle", app.CSS)
|
||||||
|
self.assertIn("align: right middle", app.CSS)
|
||||||
|
|
||||||
async def test_response_selection_uses_standard_random_choice(self) -> None:
|
async def test_response_selection_uses_standard_random_choice(self) -> None:
|
||||||
app = ChatApp()
|
app = ChatApp()
|
||||||
with patch(
|
with patch(
|
||||||
@@ -68,6 +110,7 @@ class ChatAppTest(unittest.IsolatedAsyncioTestCase):
|
|||||||
|
|
||||||
self.assertEqual(app.submitted_inputs, [])
|
self.assertEqual(app.submitted_inputs, [])
|
||||||
self.assertEqual(app.selected_responses, [])
|
self.assertEqual(app.selected_responses, [])
|
||||||
|
self.assertEqual(app.messages, [])
|
||||||
self.assertEqual(len(app.query("#conversation Label")), 0)
|
self.assertEqual(len(app.query("#conversation Label")), 0)
|
||||||
choice_mock.assert_not_called()
|
choice_mock.assert_not_called()
|
||||||
|
|
||||||
@@ -79,6 +122,7 @@ class ChatAppTest(unittest.IsolatedAsyncioTestCase):
|
|||||||
|
|
||||||
self.assertEqual(app.submitted_inputs, [])
|
self.assertEqual(app.submitted_inputs, [])
|
||||||
self.assertEqual(app.selected_responses, [])
|
self.assertEqual(app.selected_responses, [])
|
||||||
|
self.assertEqual(app.messages, [])
|
||||||
self.assertEqual(len(app.query("#conversation Label")), 0)
|
self.assertEqual(len(app.query("#conversation Label")), 0)
|
||||||
|
|
||||||
async def test_escape_requests_application_exit(self) -> None:
|
async def test_escape_requests_application_exit(self) -> None:
|
||||||
|
|||||||
Reference in New Issue
Block a user