Chào mọi người, hôm rồi mình có hướng dẫn dùng ktlint và detekt để check code style, lint cho android. Hôm nay, tiếp tục seri cải thiện code, mình chia sẻ tiếp về cách chạy các tool trên tự động mỗi khi commit code.
OK, bắt đầu thôi !
Git Hooks
Trước đây, mình vẫn luôn mong muốn tìm một công cụ để giúp loại bỏ những lỗi cơ bản về git và coding convention trước khi gởi PR, như commit message theo chuẩn công ty, code phải được format chung, unit test phải đc chạy pass ở local hay lỗi lint phải được xử lý hết… tìm hoài không thấy nên phải thường nhắc nhở anh em, đôi khi nhắc hoài nó lại dỡ. Bởi lẽ code mọi người đều quản lý trên máy cá nhân, ai làm gì thì sao can thiệp, cứ ngỡ rồi mình sẽ mãi bị ghét vì suốt ngày lãi nhãi, nhắc đi nhắc lại mấy chuyện kiểu “Ừ biết rồi, khổ lắm, nói mãi”. Và rồi…
Như vô tình nhặt được bí kíp, mình tình cờ tìm kiếm cách check từ khoá commit message rule git và git hooks hiện ra như cứu cánh. Với git hooks, mọi vấn đề của mình đã gần như hoàn toàn được giải quyết.
Git hooks là gì?
Giống như các hệ thống quản lý version khác, Git cũng cung cấp cho chúng ta một cách để can thiệp vào một số quá trình đặc biệt của nó bằng những custom script, đó là
hook.
Git hooks trở thành vị cứu tinh như thế nào?
Mình chọn ngay 2 client hook phù hợp cho việc kiểm tra commit message rule, và chạy các tool/task tự động code style, lint, unit test trước khi commit.
pre-commit: Hook này được gọi đầu tiên, thực thi trước khi bạn nhập nội dung cho commit message. Hook này được sử dụng để kiểm tra nội dung các tập tin được commit. Bạn có thể viết script để kiểm tra code convention, run test hoặc chạy static analysis trước khi commit. Nếu script trả về kết quả lớn hơn 0, quá trình commit sẽ bị hủy bỏ.commit-msg: Nó được gọi sau khi chúng ta đã nhập nội dung message cho commit. Thích hợp trong việc chuẩn hóa commit message. Chỉ có một tham số được nhận trong hook này, đó là tên file chứa commit message. Tương tự, nếu script này trả về kết quả lớn hơn 0 thì quá trình commit sẽ bị hủy.
Cài đặt
Tạo một folder team-props có cấu trúc như sau:
Lưu ý: nếu các bạn thay đổi tên hoặc cấu trúc thư mục, các bước bên dưới các bạn phải tự tìm kiếm và sửa đường dẫn đến các file theo đúng thư mục của bạn.
Tạo script checking commit message (commit-msg.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | <span class="token comment">#!/usr/bin/env bash</span> <span class="token keyword">echo</span> <span class="token string">"Checking your commit message"</span> <span class="token operator"><<</span><span class="token string">comment Bạn có thể comment theo cú pháp này. Bạn có thể thay đổi message regex theo mong muốn. Lưu ý có sự khác nhau regex trên Mac vs Linux. comment</span> commit_regex<span class="token operator">=</span><span class="token string">'^[b(add|modify|fix|revert|hotfix)b]s.+$'</span> error_msg<span class="token operator">=</span><span class="token string">"Aborting commit. Your commit message does not follow the commit message rule"</span> <span class="token keyword">if</span> <span class="token operator">!</span> <span class="token function">grep</span> -iqE <span class="token string">"<span class="token variable">$commit_regex</span>"</span> <span class="token string">"<span class="token variable">$1</span>"</span><span class="token punctuation">;</span> <span class="token keyword">then</span> <span class="token keyword">echo</span> <span class="token string">"<span class="token variable">$error_msg</span>"</span> <span class="token operator">></span><span class="token operator">&</span>2 <span class="token keyword">exit</span> 1 <span class="token keyword">fi</span> |
For Linux:
1 2 | commit_regex<span class="token operator">=</span><span class="token string">'^[b(add|modify|fix|revert|hotfix)b]s.+$'</span> |
For Mac:
1 2 | commit_regex<span class="token operator">=</span><span class="token string">'^[b(?i)(add|modify|fix|revert|hotfix)b]s.+$'</span> |
Bạn có thể thay thế regex theo đúng mong muốn, hiện tại mình đang follow theo rule của project.
Ví dụ, những commit sau sẽ là hợp lệ:
1 2 3 4 5 6 7 | [Add] Feature A [Modify] Feature B [Fix] Correct layout C [Revert] Feature B [Hotfix] Sometime popup is not dismissed in main page production. ... |
Tạo script chạy tự động các gradle task và Unit test (pre-commit.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | <span class="token comment">#!/usr/bin/env bash</span> <span class="token keyword">echo</span> <span class="token string">"Running static analysis..."</span> <span class="token keyword">echo</span> <span class="token string">"Start running ktlint"</span> ./gradlew ktlintFormat ktlintCheck --daemon status0<span class="token operator">=</span><span class="token variable">$?</span> <span class="token keyword">if</span> <span class="token punctuation">[</span><span class="token punctuation">[</span> <span class="token string">"<span class="token variable">$status0</span>"</span> <span class="token operator">=</span> 0 <span class="token punctuation">]</span><span class="token punctuation">]</span> <span class="token punctuation">;</span> <span class="token keyword">then</span> <span class="token keyword">echo</span> <span class="token string">"ktlint found no problems."</span> <span class="token keyword">else</span> <span class="token keyword">echo</span> 1<span class="token operator">></span><span class="token operator">&</span>2 <span class="token string">"ktlint found violations, it could not fix. Please check ktlint report at "build/reports/ktlint/ktlint.html" "</span> <span class="token keyword">exit</span> 1 <span class="token keyword">fi</span> <span class="token keyword">echo</span> <span class="token string">"Start running detektCheck"</span> ./gradlew detekt --daemon status1<span class="token operator">=</span><span class="token variable">$?</span> <span class="token keyword">if</span> <span class="token punctuation">[</span><span class="token punctuation">[</span> <span class="token string">"<span class="token variable">$status1</span>"</span> <span class="token operator">=</span> 0 <span class="token punctuation">]</span><span class="token punctuation">]</span> <span class="token punctuation">;</span> <span class="token keyword">then</span> <span class="token keyword">echo</span> <span class="token string">"detekt found no problems."</span> <span class="token keyword">else</span> <span class="token keyword">echo</span> 1<span class="token operator">></span><span class="token operator">&</span>2 <span class="token string">"ktlint found violations. Please check ktlint report at "build/reports/detekt/detekt-report.html" "</span> <span class="token keyword">exit</span> 1 <span class="token keyword">fi</span> <span class="token keyword">echo</span> <span class="token string">"Start running unit test"</span> ./gradlew testDevelopDebug --daemon status2<span class="token operator">=</span><span class="token variable">$?</span> <span class="token keyword">if</span> <span class="token punctuation">[</span><span class="token punctuation">[</span> <span class="token string">"<span class="token variable">$status2</span>"</span> <span class="token operator">=</span> 0 <span class="token punctuation">]</span><span class="token punctuation">]</span> <span class="token punctuation">;</span> <span class="token keyword">then</span> <span class="token keyword">echo</span> <span class="token string">"run unit test success."</span> <span class="token function">git</span> add <span class="token keyword">.</span> <span class="token keyword">else</span> <span class="token keyword">echo</span> 1<span class="token operator">></span><span class="token operator">&</span>2 <span class="token string">"run unit test failure, please re-check"</span> <span class="token keyword">exit</span> 1 <span class="token keyword">fi</span> |
Trong đoạn code trên mình kết hợp sử dụng lại các gradle task trong bài dùng ktlint và detekt để kiểm tra code convention và code smell .
Lỗi ở điểm nào thì mình dừng ngay tại thời điểm đó luôn. Commit chỉ thành công khi tất cả các bước trên thành công.
Lưu ý: cú pháp run unit test có dạng như bên dưới, bạn có thể tuỳ chỉnh theo cách của project đang hoạt động.
1 2 | <span class="token punctuation">.</span><span class="token operator">/</span>gradlew test<span class="token punctuation">[</span>Flavor<span class="token punctuation">]</span><span class="token punctuation">[</span>BuildType<span class="token punctuation">]</span> |
Copy Hooks to git hooks folder
Bây giờ mình cùng tạo 1 gradle task để copy hooks vào đúng thư mục dự án .git/hooks nào.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 | <span class="token keyword">fun</span> <span class="token function">isLinuxOrMacOs</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">:</span> Boolean <span class="token punctuation">{</span> <span class="token keyword">return</span> <span class="token function">isMac</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">||</span> <span class="token function">isLinux</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> <span class="token keyword">fun</span> <span class="token function">isLinux</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">:</span> Boolean <span class="token punctuation">{</span> <span class="token keyword">return</span> System<span class="token punctuation">.</span><span class="token function">getProperty</span><span class="token punctuation">(</span><span class="token string">"os.name"</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">toLowerCase</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">contains</span><span class="token punctuation">(</span><span class="token string">"linux"</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> <span class="token keyword">fun</span> <span class="token function">isMac</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">:</span> Boolean <span class="token punctuation">{</span> <span class="token keyword">val</span> osName <span class="token operator">=</span> System<span class="token punctuation">.</span><span class="token function">getProperty</span><span class="token punctuation">(</span><span class="token string">"os.name"</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">toLowerCase</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">return</span> osName<span class="token punctuation">.</span><span class="token function">contains</span><span class="token punctuation">(</span><span class="token string">"mac os"</span><span class="token punctuation">)</span> <span class="token operator">||</span> osName<span class="token punctuation">.</span><span class="token function">contains</span><span class="token punctuation">(</span><span class="token string">"macos"</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> tasks<span class="token punctuation">.</span><span class="token function">register</span><span class="token punctuation">(</span><span class="token string">"copyGitHooks"</span><span class="token punctuation">,</span> Copy<span class="token operator">::</span><span class="token keyword">class</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> description <span class="token operator">=</span> <span class="token string">"Copies the git hooks from team-props/git-hooks to the .git folder."</span> <span class="token keyword">val</span> path <span class="token operator">=</span> <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token function">isLinux</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token string">"<span class="token interpolation variable">$rootDir</span>/team-props/git-hooks/linux"</span> <span class="token keyword">else</span> <span class="token string">"<span class="token interpolation variable">$rootDir</span>/team-props/git-hooks/mac"</span> <span class="token comment">// diff paths from Linux & Mac environment</span> <span class="token function">from</span><span class="token punctuation">(</span>path<span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token function">include</span><span class="token punctuation">(</span><span class="token string">"**/*.sh"</span><span class="token punctuation">)</span> <span class="token function">rename</span><span class="token punctuation">(</span><span class="token string">"(.*).sh"</span><span class="token punctuation">,</span> <span class="token string">"<span class="token interpolation variable">$1</span>"</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> <span class="token function">into</span><span class="token punctuation">(</span><span class="token string">"<span class="token interpolation variable">$rootDir</span>/.git/hooks"</span><span class="token punctuation">)</span> onlyIf <span class="token punctuation">{</span> <span class="token function">isLinuxOrMacOs</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> tasks<span class="token punctuation">.</span><span class="token function">register</span><span class="token punctuation">(</span><span class="token string">"installGitHooks"</span><span class="token punctuation">,</span> Exec<span class="token operator">::</span><span class="token keyword">class</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> description <span class="token operator">=</span> <span class="token string">"Installs the pre-commit git hooks from team-props/git-hooks."</span> group <span class="token operator">=</span> <span class="token string">"git hooks"</span> workingDir <span class="token operator">=</span> rootDir <span class="token function">setCommandLine</span><span class="token punctuation">(</span><span class="token string">"chmod"</span><span class="token punctuation">,</span> <span class="token string">"-R"</span><span class="token punctuation">,</span> <span class="token string">"+x"</span><span class="token punctuation">,</span> <span class="token string">".git/hooks/"</span><span class="token punctuation">)</span> <span class="token function">dependsOn</span><span class="token punctuation">(</span><span class="token string">"copyGitHooks"</span><span class="token punctuation">)</span> onlyIf <span class="token punctuation">{</span> <span class="token function">isLinuxOrMacOs</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> doLast <span class="token punctuation">{</span> logger<span class="token punctuation">.</span><span class="token function">info</span><span class="token punctuation">(</span><span class="token string">"Git hook installed successfully!"</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> afterEvaluate <span class="token punctuation">{</span> tasks<span class="token punctuation">[</span><span class="token string">"clean"</span><span class="token punctuation">]</span><span class="token punctuation">.</span><span class="token function">dependsOn</span><span class="token punctuation">(</span><span class="token string">"installGitHooks"</span><span class="token punctuation">)</span> <span class="token punctuation">}</span> |
Trong đoạn code trên, sẽ có 2 task là copyGitHooks và installGitHooks, 2 task sẽ tự động chạy mỗi khi bạn clean code. Do vậy, chỉ khi bạn chạy clean project ít nhất 1 lần thì các (thay đổi) git hooks mới được copy và chạy đúng mong muốn.
Sau khi hoàn thành tạo task này, bạn hãy thêm vào build.gradle level project:
1 2 3 4 5 6 7 8 9 10 11 12 | buildscript <span class="token punctuation">{</span> <span class="token function">apply</span><span class="token punctuation">(</span>from <span class="token operator">=</span> <span class="token string">"<span class="token interpolation variable">$rootDir</span>/team-props/git-hooks.gradle.kts"</span><span class="token punctuation">)</span> repositories <span class="token punctuation">{</span> <span class="token comment">//...</span> <span class="token punctuation">}</span> dependencies <span class="token punctuation">{</span> <span class="token comment">//...</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
Test kết quả
Bây giờ hay clean project 1 lần, sau đó thử edit và tạo 1 commit. Hãy ăn mừng nếu gradle task được chạy thành công ! (beer)(beer)(beer).
Conclusion
Ok, như vậy là mình đã hướng dẫn các bạn tự tạo một local CI nhỏ, giúp check qua code của anh em trong team về code style, lint, unit test trước khi tạo Pull Request. Hy vọng bài viết mang lại lợi ích cho mọi người.
Tham khảo: Mình sẽ share code chi tiết sớm khi có thời gian.
HAPPY CODING !