時間がない人へのまとめ

この記事では、Actionsで行ったテスト結果をPRにレポートとしてコメントしてくれるoctocovを自分の管理するGoのプロジェクトのリポジトリに導入してみます。

coverage:
  paths:
    - coverage.out
codeToTestRatio:
  code:
    - '**/*.go'
    - '!**/*_test.go'
  test:
    - '**/*_test.go'
testExecutionTime:
  if: true
comment:
  if: is_pull_request
report:
  if: is_default_branch
  datastores:
    - artifact://${GITHUB_REPOSITORY}
diff:
  datastores:
    - artifact://${GITHUB_REPOSITORY}

今回は、Goで書いているので、codeToTestRatio>code/testにはgo関連のファイルを指定しています。

ほかに設定できるオプションもあるので、気になる方は下記を確認してください。

GitHub - k1LoW/octocov: octocov is a toolkit for collecting code metrics (code coverage, code to test ratio and test execution time).

https://github.com/k1LoW/octocov#configuration

workflowの準備

octocovの設定はかけたので、octocovがレポートをコメントしてくれるようにActionsのWorkflowの設定を書いていきましょう。テストをWorkflowで走らせている、.github/workflow/test.ymlの中身を以下のようにします。今回重要なのは、１でgoのユニットテストでレポートを吐かせていることと、２でoctocovを使用していることです。

name: Test
on:
  push:
      branches:
        - main
  pull_request:
jobs:
  golang-test:
    strategy:
      matrix:
        go-version: [1.17.x]
        os: [ubuntu-latest]
    name: lint
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v2
      - name: golangci-lint
        uses: golangci/golangci-lint-action@v2
        with:
          version: latest
      - name: testing
        run: go test ./... -coverprofile=coverage.out --１
      - name: create report
        uses: k1LoW/octocov-action@v0 --２

これで、準備は完了です。

確認

PRを作成して準備したものをPushしてみましょう。そうすると下記のように、レポートをコメントしてくれるはずです。

おわりに

今回コードをより健全に保つ補助をしてくれるoctocovの導入を行いました。コードカバレッジ、コード/テスト比、テスト実行時間をPRにコメントしてくれるだけで、「あ、カバレッジ下がってるからテスト足りないかも」など思いテストを整備するきっかけになりそうですね。導入自体も簡単にできるので気軽に導入してみてもいいかもしれません。是非皆さんも導入してみてください。