Written by chuotfx on September 10, 2019

Auto review code & report lên Github với SwiftLint và LinterBot

Contents

Để đảm bảo chất lượng của 1 dự án thì mã nguồn phải được kiểm tra thường xuyên. Nhưng với một team dự án lớn, nhiều người thì lượng task sẽ tăng theo, cũng như áp lực deadline. Thì việc đảm bảo review code là điều rất khó khăn. Bên cạnh đó chúng ta có thể hạn chế các lỗi typo, lỗi ngớ ngẫn, cũng nhưng tất cả phải tuân theo conventions … bằng cách sử dụng các tools tự động.

Hôm nay, mình xin giới thiệu cho các bạn 1 tool (có lẽ không mới cho lắm) để auto review code và report lên GitHub. Tất nhiên, nó phải kết hợp được với CI thì mới phát huy được hiệu quả tốt nhất.

Nếu bạn chưa đọc bài cấu hình Travis CI thì có thể kích vào đây để đọc trước, rồi mới tiếp tục sang bài này. Còn trước khi bắt đầu thì mình hãy đọc sơ qua vài khái niệm sau:

1. Coding Coventions

Nôm na thì Coding conventions là tập hợp những nguyên tắc chung khi lập trình nhằm làm cho code dễ đọc, dễ hiểu, từ đó dễ quản lý, bảo trì project hơn.

Là một tập quy tắt ứng xử cộng đồng. Trong trường hợp này là team dev của bạn. Với mỗi loại ngôn ngữ lập trình thì chúng ta có một loại Coding conventions. Và chúng không phải cố định mà nó tùy thuộc vào mỗi team dự án đặt ra và quy định cho các thành viên tuân theo.

Với Swift thì bạn có thể tham khảo tại đây: https://github.com/raywenderlich/swift-style-guide

2. SwiftLint

2.1 Khái niệm

Là một tool dùng để kiểm tra code (hay gọi là review code) theo conventions của Swift
Có thể bắt gặp nhiều Lint khác cho nhiều loại ngôn ngữ khác
Về conventions thì mình có thể sử dụng các rule mặc định hoặc có thể tự custom theo conventions của team hay của dự án
Link: https://github.com/realm/SwiftLint

2.2 Cài đặt

Có rất nhiều cách cài đặt khác nhau, tùy thuộc vào cấu hình iOS Project của bạn. Với bài viết này mình sẽ hướng dẫn sử dụng với CocoaPod.

Mở Podfile và thêm vào:

pod 'SwiftLint'

Install, tùy thuộc vào cái bạn đang dùng là gì (CocoaPod hay Bundle).
Thêm script vào Xcode để chạy swiftlint
- Vào Build Phase > New Run Script Phase
- Chép đoạn script sau:

"${PODS_ROOT}/SwiftLint/swiftlint"

Build project và sẽ thấy Swiftlint thông báo các warning và error

2.3 Test SwiftLint

Thử kiểm tra hoạt động của SwiftLint thì bạn có thể thử như sau, thêm 1 đoạn code nào đó vào 1 file nào đó.

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        
        // test comment
        var namesOfIntegers: [Int: String] = [Int: String]()
        
        return true
    }

Kết quả
- Có 2 warning cho 2 dòng trống
- Convention sai cho việc khởi tạo array

3. Tích hợp SwiftLint với CI

Để sử dụng được SwiftLint với CI hay ở đây là Travis CI thì:
- Tạo 1 yaml file và đặt ở thư mục gốc. CI sẽ tự động quét và chạy
- Đặt tên sau .swiftlint.yml
Nội dung file tham khảo:

disabled_rules: # rule identifiers to exclude from running
  - colon
  - comma
  - control_statement
opt_in_rules: # some rules are only opt-in
  - empty_count
  # Find all the available rules by running:
  # swiftlint rules
excluded: # paths to ignore during linting. Takes precedence over `included`.
  - Carthage
  - Pods
  - vendor
analyzer_rules: # Rules run by `swiftlint analyze` (experimental)
  - explicit_self

# configurable rules can be customized from this configuration file
# binary rules can set their severity level
force_cast: warning # implicitly
force_try:
  severity: warning # explicitly
# rules that have both warning and error levels, can set just the warning level
# implicitly
line_length: 110
# they can set both implicitly with an array
type_body_length:
  - 300 # warning
  - 400 # error
# or they can set both explicitly
file_length:
  warning: 500
  error: 1200
# naming rules can set warnings/errors for min_length and max_length
# additionally they can set excluded names
type_name:
  min_length: 4 # only warning
  max_length: # warning and error
    warning: 40
    error: 50
  excluded: iPhone # excluded via string
identifier_name:
  min_length: # only min_length
    error: 3 # only error
  excluded: # excluded via string array
    - id
    - URL
    - GlobalAPIKey
reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, junit, html, emoji, sonarqube, markdown)

Ý nghĩa các từ khoá và lệnh trong file trên thì các bạn từ tìm hiểu và nói chung thì cũng không khó mấy, nên vọc vọc tí là ra
Chú ý:
- Rule & Custom Rule : các luật (rule) mặc định và tùy biến theo team dự án cho conventions của Project. Ví dụ:

custom_rules:

  id_suffix_naming:
    name: "Wrong name"
    regex: "(ID)"
    match_kinds:
      - comment
      - identifier
    message: "Use 'Id' instead 'ID'"
    severity: error

  uiwebview_disabled:
    included: ".*.swift"
    name: "UIWebView Usage Disabled"
    regex: 'UIWebView'
    message: "Do not use UIWebView. Use WKWebView Instead. https://developer.apple.com/reference/uikit/uiwebview"
    severity: error

- Thư mục và đường dẫn : nếu bạn có sử dụng thì hãy check, vì ghi thư mục trong file nhưng nó ko có trong repo thì không pass đc CI
Các trường hợp chạy SwiftLint oke thì bản build sẽ được kiểm tra, nếu bản build failed thì sẽ báo như sau:

Testing failed:
	Identifier Name Violation: Variable name should be between 4 and 40 characters long: 'key' (identifier_name)
	Testing cancelled because the build failed.
** TEST FAILED **

Build chạy đúng thì âm thầm không show ra gì, nên cứ bình tĩnh mà tiến tới tiếp bước sau. 😎

4. Report & Comment lên GitHub với LinterBot

Để có thể post/comment các kết quả của SwiftLint lên GitHub thì chúng ta sử dụng LinterBot

4.1 Khái niệm

Linterbot
- Là 1 con BOT , nhiệm vụ của nó là đọc out put của SwiftLint và comment vào pull request trên GitHub
- Cần có được access_token từ account của dev mới có thể post comment vào
Link tham khảo: https://github.com/guidomb/linterbot

4.2 Cài đặt

Thêm vào GemFile

gem 'linterbot'

Install

gem install linterbot

4.3 Sử dụng ở Local

swiftlint lint --reporter json | linterbot REPOSITORY PULL_REQUEST_NUMBER

4.4 Sử dụng với Travis CI

Create bash script (bash là gì thì tự tìm hiểu nha)
- Tạo thư mục scripts (trong thư mục gốc) > tạo 1 file (ko có đuôi) và edit như sau:

#!/bin/bash

if [ "$TRAVIS_PULL_REQUEST" != "false" ]
then
  ./Pods/SwiftLint/swiftlint --reporter json > swiftlint-report.json || false
  linterbot $TRAVIS_REPO_SLUG $TRAVIS_PULL_REQUEST < swiftlint-report.json
fi

- Chú ý đường dẫn sau ./Pods/SwiftLint/swiftlint Vì đó là nơi mà mình pod swiftlint về nên trỏ vào đúng nó mới chạy được. Lỗi ngu ngu này mất cả tiếng đồng hồ nếu copy dán không suy nghĩ.
- Saved file lại với tên là linter
- Edit quyền để tránh các lỗi về Permission denied như sau (khi chạy trên CI)

0.01s$ ./bin/linter
/Users/travis/.travis/functions: line 104: ./bin/linter: Permission denied
The command “./bin/linter” exited with 126.

- Lệnh set lại quyền truy cập như sau (dành cho các thanh niên không biết)

 chmod +x ./scripts/linter

Edit .travis.yml
- Thêm các lệnh cài đặt linterbot

before_install:
  - bundle install
  - gem install linterbot
  - bundle exec pod install --repo-update

- Thêm lệnh thực hiện script linter

script:
  - ./scripts/linter

File .travis.yml đẹp như sau:

language: objective-c
osx_image: xcode10.1
cache:
  - bundler
  - cocoapods
xcode_workspace: TheLastProject.xcworkspace
xcode_scheme: TheLastProject_Development
xcode_destination: platform=iOS Simulator,OS=12.1,name=iPhone X
before_install:
  - bundle install
  - gem install linterbot
  - bundle exec pod install --repo-update
install:
  - set -o pipefail
  - sudo systemsetup -settimezone Asia/Ho_Chi_Minh
  - bundle install --path=vendor/bundle --jobs 4 --retry 3
before_script:
  - chmod a+x ./scripts/linter
script:
  - ./scripts/linter

4.4 Access Key

Để có thể post/comment lên được GitHub thì cần có quyền truy cập từ GitHub
Tham khảo cách tạo access_key : https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
Để đảm bảo tính bảo mật thì các key sẽ được lưu trữ trên trang Travis CI. Vào setting > tạo 1 GITHUB_ACCESS_TOKEN

Mặc định thì LinterBot sẽ tự đồng tìm biến môi trường là GITHUB_ACCESS_TOKEN . Ngoài ra bạn có thể cấu hình riêng cho nó
- Tạo file .linterbot.yml
- Edit

github_access_token: 'YOUR_GITHUB_ACCESS_TOKEN'
linter_report_file: 'PATH/TO/SWIFTLINT/JSON/OUTPUT/FILE'
project_base_path: 'BASE/PROJECT/PATH'

- Tham khảo: https://github.com/guidomb/linterbot#configuration-file

5. Kết quả

Tiến hành commit và gởi pull request để CI chạy và kiểm tra. Nếu đầy đủ các kết quả sau trên pull request thì chúc mừng bạn đã pass qua bước này.

Pass được CI
Xuất hiện comments của SwiftLint thông qua linterbot

Nếu pull request không có bất cứ lỗi chi thì sẽ như thế này

6. Tổng kết

Với bài viết này thì bạn có thể làm được những việc sau:

- Đảm bảo conventions của project
- Auto review code
- Tiết kiệm thời gian
- Tự động report và comment lên GitHub

Tham khảo:

Facebook Tweet Pin Yummly LinkedIn Print EmailShares24

Written by chuotfx

Hãy ngồi xuống, uống miếng bánh và ăn miếng trà. Chúng ta cùng nhau đàm đạo về đời, về code nhóe!

Auto review code & report lên Github với SwiftLint và LinterBot

1. Coding Coventions

2. SwiftLint

2.1 Khái niệm

2.2 Cài đặt

2.3 Test SwiftLint

3. Tích hợp SwiftLint với CI

4. Report & Comment lên GitHub với LinterBot

4.1 Khái niệm

4.2 Cài đặt

4.3 Sử dụng ở Local

4.4 Sử dụng với Travis CI

4.4 Access Key

5. Kết quả

6. Tổng kết

Related Posts:

Written by chuotfx

Leave a Reply Cancel reply

Donate – Buy me a coffee!

Fan page

Recent Posts

You may also like:

Archives

About me

Auto review code & report lên Github với SwiftLint và LinterBot

1. Coding Coventions

2. SwiftLint

2.1 Khái niệm

2.2 Cài đặt

2.3 Test SwiftLint

3. Tích hợp SwiftLint với CI

4. Report & Comment lên GitHub với LinterBot

4.1 Khái niệm

4.2 Cài đặt

4.3 Sử dụng ở Local

4.4 Sử dụng với Travis CI

4.4 Access Key

5. Kết quả

6. Tổng kết

Related Posts:

Written by chuotfx

Leave a Reply Cancel reply

Donate – Buy me a coffee!

Fan page

Tags

Recent Posts

You may also like:

Archives