JUnit5を使ってテストコードを書こう!(Mac版)


開発環境
PC:Mac
OS:BigSur
IDE:Eclispe(java-2019-12)

※もしwidowsを使用している場合は環境構築の方法やコマンドが違うため
適宜調べながら準備をしてください。

目次

  • テストコードとは?
  • JUNITとは?
  • 開発環境の準備(ECLIPSE)
  • プロジェクトの作成
  • JUnit5の追加
  • JUnitを使ったコードの書き方を学ぼう
  • テストコードを書いてみよう
  • テストコードを実行しよう。

テストコードとは?

  • 自分の書いたコードが、想定通りに動いているか確認するためのもの です。

JUnit(JUnit5)とは?

  • Javaのテスト用のフレームワーク
  • JUnit5は大きく3つのフレームワーク(junit-jupiter、junit-platform、junit.vintage)から構成されている

1.junit-jupiter

  • JUnit5のフレームワークです。

2.junit-platform

  • テストのランチャーです。凝った起動をするのでなければ必要ないかもしれません。

3.junit.vintage

  • JUnit4、JUnit3の記述で書かれたテストコードをJUnit5環境で実行する際に使用します。JUnit5で記述した場合には必要ありません。

開発環境の準備(ECLIPSE)

自分のホームディレクトリにprojectsフォルダを作りましょう
ここからは作っていただいたprojectディレクトリを使用します。

  • projectディレクトリを作成して移動する
$ cd
$ mkdir projects
$ cd projects

✅以下のディレクトリに移動している

$ pwd
/Users/#{username}/projects
  • eclipseを開く
  • Launchからnewを押す(画像)
  • 今作ったprojectsを選択して画像に赤枠の矢印ボタンを押す(画像)

✅下の画面が確認できたら成功です。

・プロジェクトを作成
・プロジェクト名を入力(JUNIT_PROJECT)
・javaのバージョンを選択(世間一般的に使われているjava8)
画像の番号を参考に1〜3までを実行しましょう。

Finishを選択

✅作成したプロジェクトが画像通りなら成功です。
お疲れ様でした。これで準備は完了です。

プロジェクトの作成

  • JUnitを追加

  • Add Libraryを選択

✅libraries配下にJUNIT5が追加されている(画像)

以上でJUnit5の追加は完了しました。

JUnitを使ったコードの書き方を学ぼう。

  • 「src>New>package」の順番で選択

  • co.hogeと入力
  • Finishを選択

✅src以下にco.hogeパッケージが追加された。

  • 「co.hoge>new>class」を選択

✅ファイルを開いて画像と同じ画面が確認できること

テストコードを書いてみよう

  • 今から簡単なテストコードを実行してテストの流れを理解しましょう。 サンプルのテストコードを書いたのでそのままファイルにコピペしてください。
  • このコードは変数strに代入した文字列が等しいかを確認するテストです。
package co.hoge;

//assertEqualsを静的インポートとして定義します
import static org.junit.Assert.assertEquals;

import org.junit.Test;

public class JunitClass {
    @Test
    public void setup() {
        String str = "初めてのJunitを使ったプログラム";
        assertEquals("初めてのJunitを使ったプログラム", str);
    }

}

何をしてるかわからないと思うので
ざっくりとしたコードを書いた手順を書きました。
コードの後にある番号の順に書いています。
まだ意味はわからなくていいので流れだけ把握しておきましょう。

  1. @Testアノテーションを書く 
  2. setipメソッドを追加
  3. String型の変数strに 文字列"初めてのJunitを使ったプログラム" を代入する
  4. assertEqualsメソッドの引数に 初めてのJunitを使ったプログラムとstrを渡す
  5. 必要なインポート文を追記する

package co.hoge;
//assertEqualsを静的インポートとして定義します
import static org.junit.Assert.assertEquals;//⑤
import org.junit.Test;//⑤
public class JunitClass {
    @Test //①
    public void setup() {//②
        String str = "初めてのJunitを使ったプログラム";//③
        assertEquals("初めてのJunitを使ったプログラム", str);//④
    }
}

テストコードを実行しよう。

  • 「JunitClass.java> Run As > Junit Test」を選択
  • ナビゲーションバーにある緑の矢印ボタン(赤枠)を選択

✅「Errors: 0」と表示されてテストが通っていることを確認する
無事テストが通りましたね。簡単でしたがこれで一通りのテストの流れが学べました。

次のページ

JUnit5を使ってテストコードを書こう!②(Mac版)

参考にした記事(いつもありがとうございます)