Groovy & Gradle: JVM Automation and Build Engineering · レッスン

コードカバレッジと静的解析

JaCoCoなどのコードカバレッジツールや、Checkstyle／PMDなどの静的解析ツールをGradleビルドに統合します。

「コードカバレッジと静的解析」はCoddyKit上の無料Groovy & Gradle: JVM Automation and Build Engineeringレッスンです。これはレッスン3/4です。下記で完全なレッスンを無料で読むことができます。その後、ブラウザ内の組み込みコードエディタと24時間対応のAIチューターでハンズオン演習できます。これはGroovy & Gradle: JVM Automation and Build Engineering学習パスの一部であり、ウェブとCoddyKitアプリ全体で進捗が同期されます。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。

このレッスンの一部はまだ翻訳されておらず、英語で表示されています。

Welcome to Code Quality

Ensuring high-quality code is crucial for reliable software. In this lesson, we'll explore two key practices:

Code Coverage: How much of your code is tested?
Static Analysis: Does your code follow best practices and style guidelines?

These tools help you write better, more maintainable code by identifying issues early.

Understanding Code Coverage

Code coverage measures the percentage of your source code that is executed by your tests. It's a metric that tells you how thoroughly your tests are exercising your application's logic.

While high coverage doesn't guarantee bug-free code, it indicates a good foundation of testing and helps pinpoint untested areas.

Meet JaCoCo for Coverage

JaCoCo (Java Code Coverage) is a popular and free code coverage library for Java projects, which works seamlessly with Groovy. It integrates exceptionally well with build tools like Gradle.

JaCoCo generates detailed reports showing which parts of your code are covered by tests and which are not, helping you identify gaps.

JaCoCo Plugin & Basic Config

To integrate JaCoCo, apply its plugin in your build.gradle. This automatically adds tasks and allows you to configure report generation, specifying formats like HTML and XML.

We'll also include basic Java/JUnit setup for context.

plugins {
  id 'java'
  id 'jacoco'
}

repositories {
  mavenCentral()
}

dependencies {
  testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
  testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.10.0'
}

test {
  useJUnitPlatform()
}

jacoco {
  toolVersion = "0.8.11" // Use a recent version
}

jacocoTestReport {
  reports {
    xml.required = true
    html.required = true
    csv.required = false // Optional: disable CSV
  }
}

Executing JaCoCo Tasks

Once configured in build.gradle, you can run the JaCoCo test report task from your terminal. This command will execute your tests and then generate the coverage report.

The interactive HTML report can be found in build/reports/jacoco/test/html/index.html.

// In your terminal:
// gradlew clean test jacocoTestReport

Understanding Static Analysis

Static analysis is the examination of your code without actually executing it. It's like a linter or a spell checker for your code, identifying potential issues before runtime.

It helps identify problems such as:

Coding standard violations
Potential bugs (e.g., null pointer dereferences)
Security vulnerabilities

Meet Checkstyle for Style

Checkstyle is a development tool that helps programmers write Java (and often Groovy) code that adheres to a coding standard. It automates the process of checking code against a predefined set of rules.

By catching style and common error violations early, it improves code consistency and readability.

Checkstyle Plugin & Basic Config

To integrate Checkstyle, apply its plugin in your build.gradle. You'll typically point it to a ruleset file, often located within your project's config/checkstyle directory, or use a default.

This configuration also ensures reports are generated in useful formats like HTML and XML.

// build.gradle
plugins {
  id 'java'
  id 'jacoco'
  id 'checkstyle' // Add this line
}

// ... other existing configurations like repositories, dependencies, test block ...

checkstyle {
  toolVersion = "10.12.7" // Use a recent version
  // Point to your custom ruleset file (e.g., a Google style guide)
  configFile = file("${project.rootDir}/config/checkstyle/checkstyle.xml")
}

tasks.withType(Checkstyle) {
  reports {
    xml.required = true
    html.required = true
  }
}

Executing Checkstyle Tasks

After configuration, you can run Checkstyle from your terminal. It will analyze your source code and generate reports without compiling or running tests.

You can find the HTML report in build/reports/checkstyle/main.html for your main source code.

// In your terminal:
// gradlew checkstyleMain

Quick Check on Quality Tools

You've learned about two powerful tools for code quality. Let's test your understanding.

Recap: Quality Assurance

In this lesson, you learned how to integrate essential quality assurance tools into your Gradle build:

JaCoCo: For measuring code coverage, showing how much of your code is exercised by tests.
Checkstyle: For static analysis, enforcing coding standards and identifying potential issues without running the code.

These tools are vital for maintaining high-quality, readable, and maintainable software.

よくある質問

「コードカバレッジと静的解析」レッスンは無料ですか？

はい。「コードカバレッジと静的解析」の完全なテキストはこのウェブで無料で読めます。インタラクティブに演習し（組み込みコードエディタと24時間対応のAIチューター）、Groovy & Gradle: JVM Automation and Build Engineeringコースの残りをアンロックするには、CoddyKit PROにアップグレードしてください。 Groovy & Gradle: JVM Automation and Build Engineeringコースには全4レッスンが含まれています。

「コードカバレッジと静的解析」で何を学びますか？

JaCoCoなどのコードカバレッジツールや、Checkstyle／PMDなどの静的解析ツールをGradleビルドに統合します。ブラウザで直接実行するハンズオンコードでGroovy & Gradle: JVM Automation and Build Engineeringを演習し、24時間対応のAIチューターがレッスンを進める中での質問に答えます。

Groovy & Gradle: JVM Automation and Build Engineeringを始めるのに経験は必要ですか？

事前経験は必要ありません。CoddyKitのGroovy & Gradle: JVM Automation and Build Engineeringは初級者から上級者向けに構成されているため、ここから始めるか最初から始めて、自分のペースで進むことができます。これはレッスン3/4です。

「コードカバレッジと静的解析」レッスンにはどのくらい時間がかかりますか？

ほとんどのCoddyKitレッスンは約5～10分かかります。各レッスンはコンパクトでインタラクティブなので、着実に進歩し、ウェブとアプリ全体で正確に前回の場所から再開できます。

このGroovy & Gradle: JVM Automation and Build Engineeringレッスンでコードを書いて実行できますか？

はい。すべてのGroovy & Gradle: JVM Automation and Build Engineeringレッスンに組み込みコードエディタが含まれているため、ブラウザでリアルコードを書いて実行し、即座のAIフィードバックを取得できます。ローカル設定は不要です。

このコースのすべてのレッスン

← Groovy & Gradle: JVM Automation and Build Engineeringに戻る