본문으로 건너뛰기
개발 머꼬
개발 노트GitHub Actions
hohyeon.dev114

테스트가 실패했는데 step이 초록색으로 통과한 이유

  • #CI/CD
  • #Engineering Note
  • #GitHub Actions

문제 발생

테스트 출력을 파일로도 남겨 두고 싶어서 tee를 붙여 뒀습니다.

- name: Test
  run: pnpm test | tee test.log

그런데 며칠 뒤에 보니 테스트가 깨진 PR에 초록색 체크가 붙어 있었습니다. 로그를 열어 보면 실패한 테스트가 그대로 찍혀 있는데도 step은 멀쩡히 성공으로 끝나 있었습니다.

원인 분석

파이프라인의 종료 상태는 마지막 명령이 정합니다. Bash 매뉴얼에 그대로 나와 있습니다 — pipefail 옵션이 켜져 있지 않으면 파이프라인의 종료 상태는 마지막 명령의 종료 상태라고요. 그러니 pnpm test가 실패로 끝나도 tee가 0으로 끝나면 전체는 0이 됩니다.

그리고 shell을 적지 않은 step에는 pipefail이 없었습니다. GitHub 문서의 셸 표를 보면 두 줄이 따로 있습니다.

  • shell을 적지 않았을 때(Linux/macOS): bash -e {0}
  • shell: bash를 적었을 때: bash --noprofile --norc -eo pipefail {0}

같은 bash인데 실제로 실행되는 명령이 다릅니다. 문서도 미지정 쪽에 "bash를 명시했을 때와 다른 명령을 실행한다"고 굳이 적어 두었습니다. -e는 양쪽에 다 있지만 -o pipefail은 shell: bash를 적었을 때만 붙습니다.

-e가 실패를 잡아 줄 거라고 믿고 있었는데, 정작 -e가 본 건 tee의 0이었던 겁니다.

해결 방안

  1. 워크플로 맨 위에 기본 셸을 적어 둡니다. defaults.run은 워크플로의 모든 run step에 적용됩니다.
defaults:
  run:
    shell: bash

job 하나에만 적용하고 싶다면 jobs.<job_id>.defaults.run에 적으면 됩니다. 둘 다 있으면 더 구체적인 쪽이 쓰입니다.

  1. 켜고 나면 다른 파이프가 깨질 수 있습니다. pipefail이 켜지면 파이프라인의 반환 값은 0이 아닌 상태로 끝난 가장 오른쪽 명령의 값이 됩니다. 그동안 앞쪽 명령의 실패를 조용히 삼키던 줄이 있었다면 이제는 step이 실패합니다. 실패해도 괜찮은 명령이라면 || true를 붙여서 의도를 남겨 둡니다.

  2. shell: bash {0}은 뜻이 다릅니다. 문서에 따르면 템플릿 문자열을 주면 셸 파라미터를 전부 직접 정하게 됩니다. -e까지 빠지기 때문에, 이렇게 쓸 거라면 스크립트 첫 줄에 set -eo pipefail을 직접 적어야 합니다.

  3. Windows 러너는 따로 봐야 합니다. 기본 셸이 pwsh라서 같은 표의 다른 줄이 적용됩니다.

  4. 일부러 실패시켜서 확인해 봅니다. 아래 step은 shell을 적지 않으면 통과하고, shell: bash에서는 실패해야 정상입니다.

- run: false | cat

공식 문서

마지막 수정

좋아요북마크

댓글0

아직 댓글이 없어요. 첫 의견을 편하게 남겨 보세요.