プログラミング

CircleCIとCoverallsでCI/CD設定

最終更新： 19/03/2025
1 分の読み

CircleCIとCoverallsを使った継続的インテグレーション（CI）と継続的デリバリー（CD）の設定は、ソフトウェア開発プロジェクトの品質と効率を向上させるために非常に重要です。この記事では、これらのツールを使用して、コードの品質を維持しながら自動化されたビルドとテストを行う方法を完全かつ包括的に説明します。

1. CircleCIとは？

CircleCIは、ソフトウェア開発のワークフローを自動化するためのクラウドベースのCI/CDツールです。CircleCIを使うことで、コードの変更がリポジトリにプッシュされるたびに自動的にビルドとテストを実行し、コードの品質をチェックできます。これにより、開発者は手動でビルドやテストを行う手間を省くことができ、迅速かつエラーの少ないデプロイを実現します。

関連記事

2. Coverallsとは？

Coverallsは、テストカバレッジのレポートを提供するサービスです。テストカバレッジとは、テストでカバーされたコードの割合を示す指標で、ソフトウェアの品質を保つために非常に重要です。Coverallsは、コードの変更に伴い、どの部分がテストされているか、どの部分がテストされていないかを可視化することができます。

3. CircleCIとCoverallsを使ったCI/CDのセットアップ方法

ステップ1: CircleCIのアカウント作成

まず、CircleCIにサインアップします。GitHubやBitbucketアカウントを使って簡単にサインインできます。CircleCIにサインイン後、プロジェクトを追加します。GitHubリポジトリを選択し、そのリポジトリをCircleCIに接続します。

ステップ2: .circleci/config.ymlファイルの作成

CircleCIでは、プロジェクトのルートディレクトリに.circleci/config.ymlという設定ファイルを作成する必要があります。このファイルは、CircleCIにビルド、テスト、デプロイのプロセスをどのように実行するかを指示します。

以下は、基本的な設定例です。

yaml
version: 2.1

jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Install dependencies
          command: |
            pip install -r requirements.txt
      - run:
          name: Run tests
          command: |
            pytest --maxfail=1 --disable-warnings -q
      - run:
          name: Check code coverage
          command: |
            coverage report
            coverage html
      - store_artifacts:
          path: coverage.html
          destination: coverage_report

workflows:
  version: 2
  build:
    jobs:
      - build

この設定ファイルでは、Python環境を使用して依存関係をインストールし、テストを実行し、コードカバレッジを確認するジョブを設定しています。coverage reportを使用して、テストカバレッジのレポートを生成し、coverage.htmlというファイルに保存します。

ステップ3: Coverallsとの統合

次に、Coverallsを使ってテストカバレッジをアップロードします。これを実現するためには、CoverallsのAPIと連携する必要があります。以下の手順で設定します。

  1. Coverallsのアカウント作成

    Coverallsのウェブサイトでアカウントを作成し、リポジトリを追加します。リポジトリをCoverallsにリンクさせると、リポジトリ専用のAPIトークンが発行されます。

  2. coverallsパッケージのインストール

    次に、Python環境でcoverallsパッケージをインストールします。これにより、カバレッジデータをCoverallsに送信できるようになります。

    bash
    pip install coveralls

  3. CircleCI設定ファイルにCoveralls統合を追加

    .circleci/config.ymlに、テスト実行後にCoverallsにデータを送信するステップを追加します。以下のように設定します。

yaml
jobs:
  build:
    docker:
      - image: circleci/python:3.8
    steps:
      - checkout
      - run:
          name: Install dependencies
          command: |
            pip install -r requirements.txt
      - run:
          name: Run tests
          command: |
            pytest --maxfail=1 --disable-warnings -q
      - run:
          name: Upload coverage to Coveralls
          command: |
            coveralls

このステップでは、coverallsコマンドを使用して、カバレッジデータをCoverallsにアップロードしています。

ステップ4: CoverallsのAPIトークンの設定

CircleCIで環境変数を設定する必要があります。CoverallsのAPIトークンをCircleCIのプロジェクトに設定して、カバレッジデータが正しくアップロードされるようにします。

  1. CircleCIのダッシュボードに移動し、設定するプロジェクトを選択します。
  2. 左側のメニューから「Project Settings」 > 「Environment Variables」を選択します。
  3. COVERALLS_REPO_TOKENという名前で、CoverallsのAPIトークンを追加します。

ステップ5: CircleCIの設定を実行

設定が完了したら、GitHubリポジトリに変更を加え、その変更をプッシュします。CircleCIは変更を検出し、自動的にビルドとテストを実行します。テストが終了すると、CircleCIはCoverallsにテストカバレッジをアップロードし、結果をウェブインターフェースで確認できるようになります。

4. 結果の確認

CircleCIでのビルドが完了した後、Coverallsのダッシュボードでテストカバレッジのレポートを確認できます。Coverallsは、テストされていないコードの行をハイライト表示するため、どこに改善の余地があるのかを簡単に把握できます。

5. まとめ

CircleCIとCoverallsを統合することで、ソフトウェア開発の効率が大幅に向上します。CircleCIを使って自動化されたビルドとテストを実行し、Coverallsでテストカバレッジを追跡することができます。これにより、手動でのエラーを減らし、品質を保ちながら迅速にデプロイすることができます。 CI/CDの導入は、開発者がより高い生産性を発揮できるようサポートし、プロジェクトの成功を助ける重要な要素です。

最終更新： 19/03/2025
1 分の読み
Back to top button