[git] hook을 이용하여 코드 스타일 검사 - pep8 검증

pep을 사용해서 매번 검사를 하는건 꽤나 귀찮은 일입니다. 이러한 검사 과정을 특정 행위를 하기 이전에 먼저 수행함으로써 귀찮음을 해결 할 수 있습니다. git hook의 pre-commit을 이용하여 커밋이 되기 이전에 pep 검사를 수행 후 결과에 따라 커밋 결정 유무를 판단을 해보도록 하는 hook을 만들어 보갰습니다.

$ git status

On branch master

Your branch is ahead of 'origin/master' by 1 commit.

  (use "git push" to publish your local commits)

Changes to be committed:

  (use "git reset HEAD ..." to unstage)
 new file:   .app.py.swp
    new file:   app.py
    new file:   app2.py

커밋 대상의 파일을 보실 수 있습니다.
status를 통해 app.py, app2.py가 add되어 cache되었음을 알 수 있습니다.

어떤 코드가 cache되었는지 확인을 하기 위해서는 diff의 명령어를 사용하면 됩니다.

$ git diff --stahed 또는 git diff --cached # 같은 결과입니다.

diff --git a/.app.py.swp b/.app.py.swp
new file mode 100644
index 0000000..6cf6386
Binary files /dev/null and b/.app.py.swp differ
diff --git a/app.py b/app.py
new file mode 100644
index 0000000..aa07c85
--- /dev/null
+++ b/app.py
@@ -0,0 +1,41 @@
+'''
+2017.03.04
+'''
+import requests
+
+class a_test:
+    '''
+    해당 클래스는 어쩌구 저쩌구
+    '''
+
+    def __init__(self):
+        self.aTest = 'asd'
+
+    def test(self):
+        '''
+        self.a_test를 어쩌구 저쩌구
+        '''
+        print(self.aTest)
+
+    def _test1(self):
+        ''''
+        해당 메소드는 해당 클래스 외부로 노출이 되지 않는 메소드 입니다
+        '''
+        return self.a_test
+
+    def test2(self):
+        '''
+        something
+        '''
+        return self.a_test
+
+
+def test():
+    '''
+    test function 입니다
+    '''
+    print('test')
+
+
+if __name__ == "__main__":
+    test()
diff --git a/app2.py b/app2.py
new file mode 100644
index 0000000..5bc8d31

--- /dev/null
+++ b/app2.py
@@ -0,0 +1,3 @@
+adslkfjadfkj
+
+adsfasdf

cache된 내용을 확인 할 수 있습니다.

하지만 우리는 결과가 아닌 pep검증된 결과 입니다. 캐시 된 내용을 검증해보면 됩니다.
우리는 파이프라고 하는 |을 통해 추가적으로 작업을 연결을 시켜줄 수 있습니다.

$ git diff --staged | pep8 diff
./app.py:6:1 E302 expected 2 blank lines, found1

| pep8 diff을 통해 pep검사 결과를 출력 해 줍니다.

이제 해당 명령어를 pre-commit에 추가를 해주면 됩니다.

$ git commit -m 'asd'
./app.py:6:1: E302 expected 2 blank lines, found 1
[master d714ba1] asd
 Committer: 박정태 
Your name and email address were configured automatically based
on your username and hostname. Please check that they are accurate.
You can suppress this message by setting them explicitly. Run the
following command and follow the instructions in your editor to edit
your configuration file:

    git config --global --edit

After doing this, you may fix the identity used for this commit with:

    git commit --amend --reset-author

 3 files changed, 44 insertions(+)
 create mode 100644 .app.py.swp
 create mode 100644 app.py
 create mode 100644 app2.py

commit을 하였습니다.

가장 첫번째 줄에 pep검사 결과가 출력이 되었습니다.
우리는 pep검사 결과에서 아무것도 뜨지 않아야 커밋을 진행을 해야 합니다.
훅을 조금 더 수정을 해보도록 하겠습니다.

$ vim .git/hooks/pre-commit

#!/bin/sh
#

...중략
FILES=$(git diff --cached | pep8 --diff)
if [ -n "$FILES" ]; then
    echo $FILES
    exit 1
fi
...중략

훅은 .sh, python, ruby, perl로 작성이 가능 합니다. 저는 그나마 py, sh가 친숙하여 sh로 작성을 하였습니다.

git diff --cached | pep8 --diff)의 결과를 비교하여 exit의 결정 유무를 판단해주면 됩니다.
0이외의 값을 반환을 해주면 해당 커밋은 일어나지 않습니다.

$ git commit -m "hooks test'
./app.py:6:1 #302 expected 2 blank lines, found 1

정상적으로 커밋이 진행되지 않았음을 확인 할 수 있습니다.