Robolectric의 컨벤션과 스타일 가이드에는 무엇이 있나요?

Q1: Robolectric의 코딩 컨벤션은 어떻게 되나요?
A1: Robolectric은 주로 Google Java Style Guide를 준수합니다. 이는 변수명, 메서드명, 클래스명 등의 명명 규칙과 들여쓰기, 공백 사용, 주석 작성 방식 등을 포함합니다. 예를 들어, 변수명은 camelCase, 클래스명은 PascalCase를 사용합니다.

Q2: Robolectric 테스트 작성 시 추천하는 네이밍 규칙이 있나요?
A2: 테스트 메서드는 테스트 대상 메서드명_상황_예상결과 형식으로 명명하는 것을 권장합니다. 예: `calculateSum_givenPositiveNumbers_returnsCorrectSum()`와 같이 구체적이고 명확한 이름을 사용합니다.

Q3: Robolectric 코드에서 주석 작성 시 어떤 방식을 따르나요?
A3: Javadoc 스타일 주석을 사용하며, 공개 API 및 복잡한 로직에는 상세 설명을 덧붙이는 것을 권장합니다. 코드 라인마다 불필요한 주석을 남기기보다 의미가 드러나지 않는 부분에 집중합니다.

Q4: 테스트 클래스 및 메서드 구조는 어떻게 구성해야 하나요?
A4: 각 테스트 클래스는 한 가지 컴포넌트나 기능에 집중합니다. 메서드는 Arrange-Act-Assert 패턴을 따르며, 각 테스트는 독립적으로 실행 가능해야 합니다. Setup 또는 초기화 코드는 @Before 어노테이션을 활용합니다.
Q5: Robolectric에서 권장하는 의존성 주입 방식이 있나요?
A5: Robolectric은 Android 컨텍스트를 모킹할 때 Dagger 또는 Hilt 같은 DI 프레임워크와 함께 사용하는 것을 권장합니다. 이렇게 하면 테스트가 명확해지고 재사용 가능하며 유지보수가 용이합니다.

Q6: 코드 스타일 검사 도구나 자동 포맷터 사용을 권장하나요?
A6: 예, Google Java Format 또는 ktlint 같은 자동 포맷터 사용을 권장하여 일관된 코드 스타일을 유지하도록 합니다. CI 파이프라인에서 코드 스타일 검사를 자동화하는 것이 좋습니다.

Q7: Robolectric 테스트 작성 시 피해야 할 나쁜 관행은 무엇인가요?
A7: 테스트 간 의존성 생성, 실제 안드로이드 자원에 직접 의존하는 테스트 작성, 긴 테스트 메서드 작성, 의미 없는 명명법 사용 등은 피해야 합니다. 명확하고 작은 단위 테스트로 유지하는 것이 목표입니다.

Q8: Robolectric 관련 문서에서 스타일 및 컨벤션 가이드를 어디서 확인할 수 있나요?
A8: Robolectric 공식 GitHub 저장소 및 Google Java Style Guide 웹사이트, Android 개발자 문서에서 권장하는 테스트 작성 가이드 등을 참고하면 됩니다. 또한, 프로젝트 내 README나 CONTRIBUTING.md 파일에 프로젝트 특화된 규칙이 명시되어 있을 수 있습니다.

Robolectric은 안드로이드 애플리케이션을 테스트하기 위한 오픈소스 프레임워크로, JVM 환경에서 빠르게 안드로이드 컴포넌트를 실행할 수 있게 해줍니다.

Robolectric 프로젝트 자체가 명확하게 문서화한 '컨벤션 및 스타일 가이드'를 공개해 놓은 경우는 드물지만, Robolectric 테스트 코드를 작성할 때 권장되는 관행과 스타일을 설명할 수 있습니다.

또한 Robolectric 프로젝트의 깃허브 리포지토리, 공식 문서, 그리고 커뮤니티에서 널리 수용된 관례를 토대로 일반적인 컨벤션을 정리하면 다음과 같습니다.

1. 테스트 클래스 및 메서드 네이밍 컨벤션 - 테스트 클래스 이름은 보통 테스트 대상 클래스명 뒤에 `Test`를 붙여 작성합니다.

예를 들어 `MainActivity`를 테스트한다면 `MainActivityTest`가 됩니다.

- 테스트 메서드 이름은 테스트하려는 행위와 기대 결과를 명확하게 표현하는 이름을 쓰는 것이 좋습니다.

예를 들어 `clickButton_shouldStartNewActivity()` 또는 `shouldReturnTrue_whenInputIsValid()` 등 동작과 결과를 구체적으로 나타냅니다.

- 테스트 메서드 이름에 공백 대신 언더스코어(`_`)를 사용하여 가독성을 높이는 스타일이 선호되는 편입니다.



2. 테스트 셋업과 라이프사이클 - `@Before` 및 `@After` 어노테이션을 활용해 테스트 전후 반복되는 초기화와 정리 작업을 수행합니다.

- Robolectric에서는 `@RunWith(RobolectricTestRunner.class)` 어노테이션으로 테스트 러너를 지정하는 것이 기본 관례입니다.

최신 버전에서는 `AndroidJUnit4`도 지원하지만 Robolectric 전용 러너를 쓰는 경우가 많습니다.

- 필요에 따라 `@Config` 어노테이션으로 SDK 버전, 매니페스트 사용 여부, shadows 클래스 지정 등 테스트 환경을 세밀하게 설정할 수 있으므로 이를 적절히 활용합니다.



3. 코드 스타일 및 구조 - 일반적인 Java/Kotlin 코딩 컨벤션을 따릅니다.

클래스, 메서드, 필드, 변수명은 명확하고 일관성 있게 작성합니다.

- 테스트 내에서는 Mockito 같은 mocking 라이브러리 사용이 일반적이므로 mock 초기화 코드는 분명하고 직관적으로 작성합니다.

- 테스트 코드는 읽기 쉽고 유지보수하기 쉽게 가능한 한 단순하게 유지하며, 한 테스트 메서드 내에서 여러 기능을 테스트하지 않는 ‘단일 책임 원칙’을 지키는 것이 좋습니다.



4. 테스트 실행과 의존성 관리 - Robolectric 테스트는 일반적으로 로컬 JVM에서 실행되므로, 외부 환경과 독립되도록 네트워크 호출이나 파일 I/O를 최소화합니다.

- Gradle 등 빌드 툴을 이용할 경우 Robolectric 버전, JUnit, Mockito 등의 테스트 관련 라이브러리를 명확히 관리하고, 테스트 실행 시 불필요한 의존성 주입 충돌을 방지합니다.

- 테스트 리소스나 매니페스트 파일의 위치 및 사용도 프로젝트 내 표준 위치에 두는 것이 권장됩니다.



5. Shadow 클래스 사용 가이드 - Robolectric은 안드로이드 프레임워크 클래스를 대체하는 Shadow 클래스를 활용합니다.

Shadow 클래스를 직접 작성해야 할 경우, 공식 문서를 참고해 네이밍, 기능 구현, Mockito와의 호환성 측면에서 권장되는 스타일을 따릅니다.

- Shadow 클래스는 최소한의 기능만 재정의하며, 원본 API 호출과 일관성을 유지하도록 설계하는 것이 바람직합니다.



6. 테스트 결과와 로그 관리 - 테스트 실패 시 쉽게 원인을 파악할 수 있도록 assert 메시지를 명확히 작성합니다.

- 불필요한 로그 출력은 줄이고, 필요한 경우만 로그를 남겨 디버깅에 도움이 되게 합니다.

Robolectric 테스트 코드 작성 시에는 일반적인 자바/안드로이드 테스트 코드 작성 스타일을 준수하되, Robolectric 특유의 테스트 환경 설정(@RunWith, @Config), Shadow 클래스 활용법, JVM 기반 실행 환경 차이를 고려해 컨벤션을 적용하는 것이 중요한 포인트입니다.

공식 문서와 오픈소스 예제 프로젝트를 참고하여 일관된 스타일을 유지하는 것이 좋은 관행입니다.