コードカバレッジ

こんにちは、友人、同僚、そして...ペンギン! 今日はコードカバレッジ コードカバレッジ - 1

について説明します。コードカバレッジとは何か、コードカバレッジが必要な理由、そしてコードカバレッジの統計を提供することでオープンソースプロジェクトをアップグレードする方法を理解します。この記事は、継続的インテグレーションに関する前回の記事の簡潔な続きです。ここでは、CI と... の組み合わせのもう 1 つの強力な利点を学びます。それが何であるかはすぐにわかります。ここでは、プログラムのテストを正しく作成する方法や、可能な限り有効なカバレッジを達成する方法については説明しないことだけを強調しておきますが、この罪はすべてあなたの肩に残るだけです。じゃ、行こう！

コードカバレッジとは何ですか?

コードカバレッジは、テスト中に完了したソースコードの割合を示す特定の値です。 さて、ここですべてが明らかになったようです。コードカバレッジパーセンテージの範囲は 0 ～ 100 ですが、「最大 CC パーセンテージを目指すべきか?」という疑問が生じるかもしれません。私の答えは「はい」であり、「いいえ」です。何故ですか？他のプロジェクトで使用されるプロジェクトを作成するとします。このプロジェクトには機能が豊富で、中でも恐ろしいのがゲッターとセッターであり、その数はかなりの数です。機能をカバーするときに、すべてのゲッターがカバーされているわけではありませんが、カバーされていないものはプロジェクトで呼び出されないことは確かですが、ゲッターは必ずしも「それ自体のために」書かれているわけではないため、「クライアント"。何をするか？各ゲッターを個別にカバーしますか? これでは効果的なテストにはなりません。しかし、それらをカバーしなければ、最大の CC パーセンテージを達成することはできません。ここで両刃の剣が生じます。

なぜコードカバレッジが必要なのでしょうか?

この質問に対する答えは非常に簡単だと思います。リファクタリングや機能の追加/変更の際に「目に見えない」バグが発生せず、追跡できるようにするために、コードにはテストが必要です。ブレークポイントやデバッガーを備えたフレームワークを実行して、この悪質なバグを捕捉することはありません。人生は短すぎる。例それで、最も興味深いことです。タスクは次のとおりです。 前の記事で書いたオープンソースプロジェクトに、CC に関する情報を収集し、どこかで処理するテクノロジーを導入します。これにより、この情報を GitHub の形式で配置できるようになります。たとえばバッジ。すべてのソースコードは私のGitHub に投稿されます。

コードカバレッジ情報を 1 つの山に収集するプラグインを選択することから始めましょう。私は個人的に、コードカバレッジに関する情報を収集するJaCoCoを選択しました。しかし、代替手段もあります。

Сайт JaCoCo предлагает нам скачать плагин, но качать мы нечего не будем, ведь мы используем Build System Maven. Заходим в Maven Repository и ищем JaCoCo Plugin. Берем последнюю версию, и вставляем в наш pom.xml зависимость.

Но через dependencies я делать не рекомендую, ведь есть более хороший, более функциональный альтернативный вариант, и даже не один.
1. Заходим CodeCov Setup выбираем язык Java и выбираем Using JaCoCo плагин, и ставим по инструкции.
2. По той же ссылке выбираем Using Maven. Этот вариант будет даже лучше. Cobertura будет извлекать информацию из CI тестов, но увы и тут есть подвох. Все что выше JDK 7 (А на данный момент уже 10 есть) не подойдет. Поэтому мы остановимся на 1 варианте.
В результате в нашем pom.xml должно было появиться что то вроде того:
```

<plugin>
    <groupId>org.jacoco</groupId>
    <artifactId>jacoco-maven-plugin</artifactId>
    <version>0.8.1</version>
    <executions>
        <execution>
            <goals>
                <goal>prepare-agent</goal>
            </goals>
        </execution>
        <execution>
            <id>report</id>
            <phase>test</phase>
            <goals>
                <goal>report</goal>
            </goals>
        </execution>
    </executions>
</plugin>
```
И в Maven Projects в списке плагинов появится JaCoCo Plugin:
Плагин стоит. Все вроде бы замечательно. Но если вы внимательно читали инструкцию по установке JaCoCo plugin, там было указание, добавить в .travis.yml строчку, отвечающую за отправку отчёта plugin на сайт Codecov.

Итак, исходя из Using JaCoCo, нам нужно вписать в наш файл:
```
after_success:
  - bash <(curl -s https://codecov.io/bash)
```
Вписали. Отлично.
Все вроде готово, и остались финальные штрихи. Во-первых давайте скомпorруем наш code, и запустим все тесты, причем сделаем это через Lifecycle Maven:

Так How у нас в плагине JaCoCo стоит фаза выполнения test, то должен был появится отчет после выполнения цикла тестов Maven в папке target:
Подходим к завершению. Мы видим что все работает прекрасно, осталось лишь убедится что это "все прекрасно" также будет работать на внешних источниках. Настала пора собрать все в кучу. Собираем проект и делаем push на GitHub, перед этим открыв Travis CI и Codecov для мониторинга происходящего.

После push мы видим что сборка успешная:

И результат JaCoCo plugin о покрытии codeа:
Помните нашу задачу? Да, да, мы забыл про бейджик. Я хотел вынести тему "Украшение" open-source project'ов в отдельную статью, но маленькую часть все же оставлю здесь.

Итак, пошаговая инструкция что бы не заблудится:
1. Переходим на сайт Codecov;
2. Выбираем проект, который вам нужно;
3. Выбираем Setting:
4. Выбираем Badge и видим ссылки на ваш бейджик в несколько различных формах представления:
  
  Первые это стандартные бейджики, их можно вставить, например, в ваш README.md:
  
  Их особенность в том что при кликании на них вас будет перенаправлять на page с отчетом о CC;
  
  Вторые это графы, таблицы и тому подобные штуки:

Полезные ссылки

Мой тестовый проект, который вы можете скачать, посмотреть, оценить. Все по этой статье находится в branch: JaCoCo;
Java コードカバレッジツール;
JaCoCoの代替品;
ジャココ図書館;
JaCoCo Maven プラグインの依存関係;
Codecovセットアップチュートリアル;
実際にJaCoCo自体をセットアップします。
Coberturaのセットアップ;

本文中に誤字・脱字があるかもしれません。ご清聴ありがとうございました！

TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION