The ARDoCo Tool Landscape: REST API, TraceView, and TraceViz for Architecture Traceability

기술 요약: ARDoCo 도구 생태계

문제 배경
소프트웨어 개발은 자연어 형태의 소프트웨어 아키텍처 문서(SAD), 형식적 소프트웨어 아키텍처 모델(SAM), 그리고 소스 코드를 포함하여 다양한 추상화 수준에 걸쳐 상호 연관된 산출물을 생성합니다. 이러한 산출물 간의 일관성과 추적성을 유지하는 것은 유지보수, 변경 영향 분석 및 진화에 있어 매우 중요합니다. 그러나 수동으로 추적 링크(trace links)를 유지하는 것은 번거롭고 오류가 발생하기 쉽습니다. 자동화된 추적성 링크 복구(Traceability Link Recovery, TLR)가 필수적임에도 불구하고, 기존의 ARDoCo 접근 방식들(SWATTR, ArCoTL, TransArC, LiSSA)은 역사적으로 Java 라이브러리나 커맨드 라인 도구 형태로만 제공되어 왔습니다. 이러한 기술적 장벽은 도구를 구성하고 실행할 전문 지식이 부족한 아키텍트와 개발자들이 최첨단 TLR을 실제로 도입하는 것을 방해하여, 실질적인 배포를 제한해 왔습니다.

방법론 및 도구 생태계
알고리즘 연구와 실제 응용 사이의 간극을 메우기 위해, 저자들은 ARDoCo TLR 제품군을 노출하는 세 가지 상호 보완적인 인터페이스로 구성된 공개 배포 도구 생태계를 제시합니다.

1. ARDoCo REST API: Spring Boot 기반의 백엔드로, HTTP 엔드포인트를 통해 네 가지 TLR 파이프라인에 대한 프로그래밍 방식의 접근을 제공합니다. 이는 비동기 실행과 결과 캐싱(Redis 활용)을 지원하여 성능을 최적화합니다. 노출된 파이프라인은 다음과 같습니다:

   • SAD-SAM: SWATTR(NLP 및 휴리스틱)을 활용하며, 모델에서 누락된 텍스트 엔티티(TEAM) 및 텍text에서 누락된 모델 엔티티(MEAT) 불일치를 탐지합니다.
   • SAM-Code: ArCoTL(중간 표현 및 텍스트 유사도)을 활용합니다.
   • SAD-Code (직접): ArDoCode(SAM 없이 SWATTR 휴리스틱을 코드에 직접 적용)를 활용합니다.
   • 전이적 SAD-SAM-Code: TransArC(SWATTR과 ArCoTL을 전이적으로 결합)를 활용합니다.
     API는 구조화된 JSON을 반환하며, 탐색을 위한 통합 Swagger UI를 포함합니다.

2. TraceView: Next.js와 React로 구축된 브라우저 기반의 무설치 프런트엔드로, 아키텍트와 비개발자에게 최적화되어 있습니다. 산출물(SAD, SAM, 코드)을 업로드하고 TLR 파이프라인을 구성할 수 있는 가이드형 위저드 기능을 갖추고 있습니다. 핵심 인터페이스는 사용자가 SAD, SAM, 소스 코드를 나란히 시각화하여 볼 수 있는 다중 패널 대화형 뷰를 제공합니다. 요소를 선택하면 모든 패널에서 연결된 상대 요소와 탐지된 불일치 사항이 강조 표시되어, 산출물 간의 교차 탐색을 용이하게 합니다.

3. TraceViz: 개발자를 위해 최적화된, 특히 SAD-Code TLR에 특화된 Visual Studio Code 확장 프로그램입니다. 이 도구는 색상이 있는 거터 마커(gutter markers)를 통해 IDE에 추적 링크를 직접 오버레이합니다. 주요 기능은 다음과 같습니다:

   • 탐색: Quick Pick 메뉴 또는 CodeLens를 통해 문서 문장에서 연결된 코드 파일로(또는 그 반대로) 한 번의 클릭으로 이동할 수 있습니다.
   • 소스 불가지론(Source Agnosticism): REST API(ArDoCode/TransArC)로부터의 링크, 외부 도구로부터의 CSV 임포트, 그리고 LiSSA(검색 증강 생성 접근 방식)의 로컬 실행을 모두 지원합니다.
   • 시각적 최적화: 적절한 경우 파일별 마커를 디렉토리 수준의 점으로 집계하여 노이즈를 줄이며, 최대 두 개의 추적 링크 세트를 나란히 비교할 수 있도록 허용합니다.

주요 기여

• 접근성: 이 생태계는 복잡한 라이브러리 기반의 TLR 알고리즘을 설치가 거의 필요 없는 접근 가능한 도구로 변모시켜, 다양한 사용자 페르소나(통합자, 아키텍트, 개발자)를 충족합니다.
• 통합 백엔드: REST API는 공유 계산 엔진 역할을 하여 브라우저와 IDE 인터페이스 간의 일관성을 보장하는 동시에 제3자 통합을 가능하게 합니다.
• IDE 내 시각화: TraceViz는 외부 보고서를 넘어 개발자의 편집 컨텍스트 내에서 추적성을 시각화하는 새로운 접근 방식을 도입합니다.

결과 및 평가

• 알고리즘 성능: 기반이 되는 TLR 알고리즘들은 5개의 오픈 소스 Java 프로젝트(MediaStore, TeaStore, TEAMMATES, BigBlueButton, JabRef) 벤치마크를 통해 평가되었습니다. 결과에 따르면 SWATTR은 SAD-SAM에서 0.81의 F1 점수를, ArCoTL은 SAM-Code에서 0.98의 F1 점수를, TransArC는 SAD-Code에서 0.82의 F1 점수를 달성하여, ArDoCode 베이스라인(F1 = 0.37)을 크게 상회했습니다. 불일치 탐지(MEAT)는 0.89의 F1 점수를 기록했습니다.
• 사용자 연구 (TraceViz): 박사 과정생, 석사 졸업생, 산업체 개발자로 구성된 7명의 참가자를 대상으로 한 예비 사고 구술(think-aloud) 연구를 통해 TraceViz의 유용성을 평가했습니다. 참가자들은 시각화 도구가 있는 경우와 없는 경우로 나누어 TEAMMATES 프로젝트에 대한 소프트웨어 이해 과업을 수행했습니다.
  • 7명 중 6명의 참가자가 시각화가 과업 완수에 도움이 된다고 답했습니다.
  • 7명 전원이 이것이 자신의 이해 과정을 지원한다고 동의했습니다.
  • 질적 피드백에 따르면, 시각화가 없을 때 사용자들은 반복적인 수동 트리 탐색에 의존했으나, TraceViz는 관련 파일로 직접 점프할 수 있게 해주었습니다.
  • 3명의 참가자는 실제 환경에서 도구 사용 의사를 밝혔으며, 다른 이들은 온보딩 및 대규모 코드베이스 탐색에 대한 잠재력을 언급했습니다.

의의
본 논문은 이 도구 생태계가 알고리즘의 기술적 복잡성으로 인해 배제되었던 아키텍트, 개발자 및 도구 통합자라는 더 넓은 관객에게 최첨단 TLR을 접근 가능하게 만든다고 주장합니다. 브라우저 기반의 탐색 도구(TraceView)와 IDE 통합 시각화 도구(TraceViz)를 제공함으로써, 저자들은 자동화된 추적성이 실제 현장에서 효과적으로 배치될 수 있음을 입증합니다. 예비 사용자 연구는 이러한 링크를 IDE 내에 직접 시각화하는 것이 소프트웨어 이해 과업 중 개발자의 이해도와 효율성을 향상시킨다는 것을 시사합니다. 향히 연구는 LLM 기반 접근 방식(LiSSA, ExArch)을 생태계에 통합하고 더 큰 규모의 통제된 연구를 수행하는 것을 목표로 합니다.