어느 팀은 코드 리뷰가 빠르게 끝나는 이유

DeadWhale·2023년 4월 17일

GithubAction ci

CICD

목록 보기

2/3

소나코드 서버의 최소 요구사항이 상당히 높아 프리티어로는 구축이 힘들수 있습니다 😭😭😭

개요

제가 이전 글에서 병합을 하기전./gradlew build 를 통해 빌드를 테스트 하는 것 가지는 생각했습니다.

하지만 이 때 불현듯 예전에 봤던 아티클이 생각 났습니다.(효과적인 코드 리뷰를 위해)

본문의 내용중 일부 발췌

지금 제가 F-Lab에서 진행중인 프로젝트는 저와 다른 멘티 한명 , 멘토님 총 3명이 진행중인 프로젝트입니다.
제가 코드를 작성했을 때 리뷰를 해줄수 있는 분들은 2명 뿐입니다.

모두 바쁘지만 좋은 퀄리티의 코드를 유지하기 위해서는 코드 리뷰에 많은 시간을 소모할 수 밖에 없습니다.

이럴 때 CI 과정을 통해 줄일 수 있는건 줄이고 수치화 할 수 있는건 수치화해
코드 리뷰의 효율성을 높이고 리뷰의 시간을 조절 할 수 있습니다.

뭐가 있을까.

일단 ./gradlew build 를 통해 프로그램의 동작은 확인한 상태입니다.
다시 한번 말하면 동작만 확인한 상태입니다.

코드가 컨벤션을 맞쳤는지는 확인할 수 없다.
코드가 효율적인 코드인지 모른다
코드가 안전한지는 모른다
테스트 코드가 잘 테스트 됬는지 모른다.

이런 모든걸 다른 리뷰어가 체크하기 시간적으로도 체력적으로 지치는데
CI를 통해 정보의 제공량을 높여 시간을 조금이나마 효율적으로 사용 할 수 있었습니다.

중복 / 테스트 커버리지 / 버그 / 보안 취약성/ 컨벤션 등 여러 정보를 제공 가능

테스트 코드 커버리지

테스트 코드 커버리지는 3가지의 구조로 이루어져 있습니다.

구문(Statement)

라인 커버리지 라고 표현합니다.
코드 한 줄이 한번 이상 실행 되면 충족됩니다.

조건(Condition)

모든 조건 식의 내부 조건이 T / F 를 가지게 되면 충족한다.

말이 살짝 헷갈리는데 쉽게 이해하자면
코드 상에 존재하는 모든 논리 조건의 경우의 수를 측정하는 지표입니다.

public boolean isAdult(int age, boolean isStudent) {
    if (age >= 18 && !isStudent) {
        return true;
    } else {
        return false;
    }
}

age >= 18 이고, isStudent 가 거짓인 경우 (참, 거짓)
age >= 18 이고, isStudent 가 참인 경우 (참, 참)
age < 18 이고, isStudent 가 거짓인 경우 (거짓, 거짓)
age < 18 이고, isStudent 가 참인 경우 (거짓, 참)

이럴 때 4가지 조건을 모두 맞쳐야지 조건 커버리지가 100%가 됩니다.

결정(Decision)

모든 조건식 T/F 를 가지게 되면 충족된다.

public String calculateAgeCategory(int age) {
    if (age < 18) {
        return "Child";
    } else if (age < 60) {
        return "Adult";
    } else {
        return "Senior";
    }
}

위 코드는 들어온 나이에 따라 나이 대를 전달하는 코드입니다.

age < 18 인 경우
18 <= age < 60 인 경우
age >= 60 인 경우

이런 3가지 조건을 모두 검사 해야지 분기 커버리지가 100%가 된니다.

이러한 테스트 커버리지는 테스트 코드의 정확성을 수치화 한거라 할 수 있습니다.
커버리지의 수치에 따라 개발자가 누락한 부분과 취약한 부분을 파악할 수 있습니다.

이러한 자바 테스트 코드 커버리지 툴은 몇가지 있습니다.

그 중 jacoco를 기준으로 애기해보려 합니다.

jacoco는 코드 커버리지를 측정 후 html , xml , csv와 같은 리포트를 생성할 수 있습니다.
설정한 커버리지 목표를 만족했는지 확인할 수 있습니다.
사용방법이 간단한 편입니다.

이런식으로 jacoco를 통해 커버리지의 측정 지표를 통해
테스트 코드가 얼마나 잘 짜여졌는지 확인 할 수 있습니다.

하지만 커버리지가 높은게 항상 좋은 테스트코드를 의미한 다는 것을 의미하는 것은 아닙니다.

코드 자체의 품질이 좋지 않을 경우
불필요한 테스트가 있을 경우

등등 코드 커버리지는 테스트 코드의 품질을 보장해주는 것이 아니라
어느 정도까지 검증되고 있는지를 보여주는데 도움을 줍니다.

글의 길이가 과도하게 길어 질 수 있기 때문에

yml의 설정 파일

- name: Run tests with JaCoCo
	run: ./gradlew test jacocoTestReport
# Gradle과 JaCoCo 플러그인을 사용하여 테스트를 실행하고 코드 커버리지 보고서를 생성합니다.

- name: Upload code coverage report
	uses: actions/upload-artifact@v3
	with:
	name: code-coverage-report
	path: build/reports/jacoco/test/html
# 생성된 코드 커버리지 보고서를 GitHub Actions 아티팩트로 업로드합니다.