[Git Hook] pre commit 으로 장애 예방하기(ft. husky, osascript)

d최신 운영 중인 앱에서 특정 메서드를 호출하다 장애가 났었다.

 

일부 서비스에서 사용이 불가능한 메서드가 있었는데, 환경이 분산되고 복잡하다보니 개발자가 테스트를 놓친 케이스였었다.

 

이 부분을 개선하고 비슷한 장애를 예방하기 위해서 pre commit rule을 추가해서 특정 키워드가 소스에 추가되면 안내를 위한 팝업을 띄우게 했다. 

🤖 환경

개발팀의 환경은 Mac을 사용하고 있고 Husky plugin이 설치되어 있었다.

 

git은 개발자가 commit을 수행하면, commit 이 수행되기 전에 스크립트를 실행되게끔하는 pre-commit 기능을 제공한다.

방법은 프로젝트의 .git/ 하위에  "pre-commit"스크립트를 작성하면 된다.

하지만, git에서 제공하는 pre-commit의 경우, 개인 로컬에만 적용되고 remote 환경을 이용해서 개발자들이 바로 적용하게할 수는 없었다.

 

https://www.npmjs.com/package/husky

husky

husky를 이용하면, pre-commit을 작성하고 배포할 수 있다는 장점이 있어서 이용하기로 이를 활용하기로 했다.

 

🍎 Mac 팝업 띄위기(osascript)

mac os의 경우, 애플에서 제공하는 osascript를 이용해서 알람이나 팝업을 띄울 수 있다.

$ osascript -e 'display dialog  "팝업 창 메세제"'

팝업 창 띄우기

결과

$ osascript -e 'display dialog  "팝업 창 메세제" buttons{"커스텀 버튼"}'

이렇게 버튼을 커스텀할 수도 있다.

버튼 커스텀 결과

$ osascript -e 'set keyword to "키워드"' -e 'display dialog keyword & "를 사용" buttons{"커스텀 버튼"}'

set 예약어를 사용해서 변수를 지정할 수도 있다

위 소스는 keyword 라는 변수에 "키워드"라는 문자열을 할당한 후, display dialog 예약어로 팝업 창을 띄웠다.

변수 사용 결과

🔍 Git diff로 수정한 소스의 키워드 추가 확인하기

git 프로젝트에 git diff를 사용하면 소스의 변화를 확인할 수 있다.

이때, 추가된 line은 +가 삭제된 line은 -가 맨 앞에 붙어있다.

이를 활용하면, 특정 키워드가 소스에 추가되었는지 확인이 가능하다.

$ git diff --cached | grep -q "^\+.*${KEYWORD}"

--cached 옵션은 스태이징 상태(add 후)를 확인하고 grep의 -q 옵션은 존재하는지 true / false 결과만 return하게 해준다.

-q 옵션을 제외하면, 해당 line을 터미널에 출력 해준다.

 

이를 활용하면 commit 시 특정 키워드를 확인해서 동작하는 pre-commit을 만들 수 있다.

#!/usr/bin/env sh

KEYWORD="eval"

if git diff --cached | grep -q "^\+.*${KEYWORD}"; then
        response=$(osascript -e 'set KW to "$KEYWORD"' -e 'display dialog KW & "를 추가하셨습니다." buttons{"확인"}')
fi

exit 0

 

이로써, 자칫 개발자들이 놓칠 수 있는 부분을 한번 더 챙겨서 장애 예방에 도움이될 수 있지 않을까 싶다.

 

참고로 husky를 활용해서 수정한 소스를 remote 환경에 올려두면, 개발자들이 pull해갈 수 있지만, .git/pre-commit을 작성해야한다면, 소스를 개발자들에게 전파해서 직접 로컬 환경에 적용시키게 하거나 한 사람이 pre-commit 파일을 remote에 올리고 해당 파일을 직접 적용시켜주는 스크립트 등을 만들어서 개발자들은 소스를 pull 받고 스크립트만 실행하면 적용될 수 있게 해줘야할 것 같다.

 

내 경우는 일부 repo의 경우 husky가 존재하지 않아서 후자의 방법으로 pre-commit을 적용시킬 수 있는 스크립트를 만들어서 제공했다.