概要

Spring Boot で書籍の貸出状況確認・貸出申請する Web アプリケーションを作る ( その２８ )( 貸出状況取得タスクの作成２ ) の続きです。

今回の手順で確認できるのは以下の内容です。
- 貸出状況取得タスクの作成
  - テストの作成

参照したサイト・書籍

com.google.common.io - Class Files
http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/io/Files.html
- Mail001Helper クラスのテストを書く際に、比較対象のメール本文を記述したファイルを読み込んで String 型の変数にセットするために Files クラスの toString メソッドを利用しました。
Read file line by line in java 8: Streams of Lines Example
http://howtodoinjava.com/2014/05/04/read-file-line-by-line-in-java-8-streams-of-lines-example/
- Guava の Files.toString メソッドではなく java.nio.File パッケージの Files.lines メソッドあたりが使えないかと思い、調査した時に参照しました。
- Files.lines をそのまま単に Stream API で処理するのではなく、一旦 try-with-resources 構文で囲っているのが印象に残ったのでメモとして残しておきます。リソースのクローズ忘れに注意しないといけないとは知りませんでした。。。

テスト作成対象のクラスを決める
calilapi のレスポンス展開用のクラスを reponse パッケージの下に移動する
EmailService.java のテストクラスを ksbysample-webapp-email から持ってくる
Mail001Helper クラスのテストの作成
InquiringStatusOfBookQueueListener クラスのテストの作成
LendingUserDetailsHelper クラスのテストの作成
UploadBooklistFormValidator クラスのテストの作成
全てのテストが成功するか確認する
commit、Push、Pull Request、マージ
次回は。。。
メモ書き

手順

テスト作成対象のクラスを決める

Gradle projects View から printClassWhatNotMakeTest タスクを実行します。
出力されたクラスに対して以下の対応を行います。
- src/main/java/ksbysample/webapp/lending/service/calilapi の下に作成したレスポンス展開用のクラスは reponse パッケージを作成してその下に移動し、src/main/java/ksbysample/webapp/lending/service/calilapi/response を printClassWhatNotMakeTest タスクのチェック対象外にします。
- src/main/java/ksbysample/webapp/lending/service/EmailService.java はテストクラスも ksbysample-webapp-email から持ってきます。
- 以下のクラスはテストを作成します。
  - src/main/java/ksbysample/webapp/lending/helper/mail/Mail001Helper.java
  - src/main/java/ksbysample/webapp/lending/listener/rabbitmq/InquiringStatusOfBookQueueListener.java
  - src/main/java/ksbysample/webapp/lending/security/LendingUserDetailsHelper.java
  - src/main/java/ksbysample/webapp/lending/web/booklist/UploadBooklistFormValidator.java

calilapi のレスポンス展開用のクラスを reponse パッケージの下に移動する

src/main/java/ksbysample/webapp/lending/service/calilapi の下に response パッケージを作成します。
src/main/java/ksbysample/webapp/lending/service/calilapi の下の以下のクラスを reponse パッケージの下へ移動します。
- Book.java
- CheckApiResponse.java
- Libkey.java
- Libraries.java
- LibrariesForJackson2Xml.java
- Library.java
- LibraryForJackson2Xml.java
- SystemData.java
src/main/java/ksbysample/webapp/lending/service/calilapi/response を printClassWhatNotMakeTest タスクのチェック対象外にします。build.gradle をリンク先の内容に変更します。

EmailService.java のテストクラスを ksbysample-webapp-email から持ってくる

https://github.com/ksby/ksbysample-webapp-email/tree/1.0.x/src/test/java/ksbysample/webapp/email/service の下にある EmailServiceTest.java を持ってきて、src/test/java/ksbysample/webapp/lending/service の下に配置します。配置後 public static class MailServerResourceを利用してメール送信する場合{ ... } 以外のネストクラスを削除し、リンク先の内容に変更します。
テストを実行します。EmailServiceTest クラスのクラス名にカーソルを移動し、コンテキストメニューを表示後「Run 'EmailServiceTest' with Coverage」を選択します。

テストが成功することが確認できます。

Mail001Helper クラスのテストの作成

src/main/java/ksbysample/webapp/lending/helper/mail の下の Mail001Helper.java で「Create Test」ダイアログを表示し、テストクラスを作成します。

src/test/java/ksbysample/webapp/lending/helper/mail の下に Mail001HelperTest.java が作成されます。
src/test/resources/ksbysample/webapp/lending の下に helper/mail/assertdata/001 ディレクトリを作成します。
src/test/resources/ksbysample/webapp/lending/helper/mail/assertdata/001 の下に message.txt を作成します。作成後、リンク先の内容に変更します。
src/test/java/ksbysample/webapp/lending/helper/mail の下の Mail001HelperTest.java をリンク先の内容に変更します。
テストを実行します。Mail001HelperTest クラスのクラス名にカーソルを移動し、コンテキストメニューを表示後「Run 'Mail001HelperTest' with Coverage」を選択します。

テストが成功することが確認できます。

InquiringStatusOfBookQueueListener クラスのテストの作成

src/main/java/ksbysample/webapp/lending/listener/rabbitmq の下の InquiringStatusOfBookQueueListener.java で「Create Test」ダイアログを表示し、テストクラスを作成します。

src/test/java/ksbysample/webapp/lending/listener/rabbitmq の下に InquiringStatusOfBookQueueListenerTest.java が作成されます。
DB にセットするテストデータを定義します。src/test/resources/ksbysample/webapp/lending の下に listener/rabbitmq/testdata/001 ディレクトリを作成します。
src/test/resources/ksbysample/webapp/lending/helper/mail/testdata/001 の下に table-ordering.txt, lending_app.csv, lending_book.csv を作成します。作成後、リンク先の内容に変更します。
検証用データを定義します。src/test/resources/ksbysample/webapp/lending/listener/rabbitmq の下に assertdata/001 ディレクトリを作成します。
src/test/resources/ksbysample/webapp/lending/listener/rabbitmq/assertdata/001 の下に table-ordering.txt, lending_app.csv, lending_book.csv を作成します。作成後、リンク先の内容に変更します。
テストでは receiveMessage メソッド内の calilApiService.check をモックに入れ替えてカーリルの蔵書検索 WebAPI を呼び出さないようにします。モックで Book クラス及び関連クラス ( SystemData クラス、Libkey クラス ) のインスタンスを生成しやすくするために、この３つのクラスに lombok の @AllArgsConstructor アノテーションを付加します ( @NoArgsConstructor もないと実行時にエラーが出るため一緒に付加します )。src/main/java/ksbysample/webapp/lending/listener/rabbitmq/response の下の Book.java, SystemData.java, Libkey.java をリンク先の内容に変更します。
src/test/java/ksbysample/webapp/lending/listener/rabbitmq の下の InquiringStatusOfBookQueueListenerTest.java をリンク先の内容に変更します。
テストを実行します。InquiringStatusOfBookQueueListenerTest クラスのクラス名にカーソルを移動し、コンテキストメニューを表示後「Run 'InquiringStatusOfBookQueueList...' with Coverage」を選択します。

テストが成功することが確認できます。

LendingUserDetailsHelper クラスのテストの作成

src/main/java/ksbysample/webapp/lending/security の下の LendingUserDetailsHelper.java で「Create Test」ダイアログを表示し、テストクラスを作成します。

src/test/java/ksbysample/webapp/lending/security の下に LendingUserDetailsHelperTest.java が作成されます。
src/test/java/ksbysample/webapp/lending/security の下の LendingUserDetailsHelperTest.java をリンク先の内容に変更します。
テストを実行します。LendingUserDetailsHelperTest クラスのクラス名にカーソルを移動し、コンテキストメニューを表示後「Run 'LendingUserDetailsHe...' with Coverage」を選択します。

テストが成功することが確認できます。

UploadBooklistFormValidator クラスのテストの作成

src/main/java/ksbysample/webapp/lending/web/booklist の下の UploadBooklistFormValidator.java で「Create Test」ダイアログを表示し、テストクラスを作成します。

src/test/java/ksbysample/webapp/lending/web/booklist の下に UploadBooklistFormValidatorTest.java が作成されます。
src/test/java/ksbysample/webapp/web/booklist の下の UploadBooklistFormValidatorTest.java をリンク先の内容に変更します。
テストを実行します。UploadBooklistFormValidatorTest クラスのクラス名にカーソルを移動し、コンテキストメニューを表示後「Run 'UploadBooklistFormVa...' with Coverage」を選択します。

テストが成功することが確認できます。

全てのテストが成功するか確認する

最後に全てのテストが成功するか確認します。Project View のルートでコンテキストメニューを表示して「Run 'Tests in 'ksbysample...' with Coverage」を選択します。

テストが実行され、全て成功することが確認できます。
clean タスクの実行→「Rebuild Project」メニューの実行→build タスクの実行を行い、"BUILD SUCCESSFUL" のメッセージが出力されることも確認します。

commit、Push、Pull Request、マージ

ここまでの変更内容を commit します。
コマンドラインから以下のコマンドを実行して commit を１つにまとめます。

> git rebase -i HEAD~3
> git commit --amend -m "#37 貸出状況取得タスクを作成しました。"
GitHub へ Push、feature/37-issue -> 1.0.x へ Pull Request、1.0.x でマージ、feature/37-issue ブランチを削除、をします。

次回は。。。

番外編としてテストクラス内で @Autowired で DI したクラスの中の @Autowired で DI しているフィールドを一部だけ JMockit でモック化する方法をまとめます ( 今回これをやろうとしてかなり試行錯誤しました。。。 )。

その後で IntelliJ IDEA Ultimate Edition を 15.0 へバージョンアップしてから、次の貸出申請画面の作成に進みます。

メモ書き

IntelliJ IDEA Ulitimate Edition の Database tools で出力する CSV ファイルには NULL は "NULL" と出力されることに今回テストデータを作成していて気付きました。TestDataResource や TestDataLoaderResource で NULL に変換する文字列を "[null]" にしていますが、"NULL" にした方がよさそうです。ただし ksbysample-webapp-lending ではこのまま進めます。
InquiringStatusOfBookQueueListenerTest のテストを作成している時に気付きました。自作したテスト検証用クラス TableDataAssert の assertEquals メソッドの２番目の引数には検証対象外のカラムを列挙するよう実装しているのですが、今回のテストのように１カラムだけ検証したい場合には検証対象外のカラムを列挙するのはちょっと手間で、検証したいカラムだけ指定できるようにできないかと思って再度見直したところ DefaultColumnFilter クラスに excludedColumnsTable メソッド以外に includedColumnsTable メソッドも存在していました。近いうちに TableDataAssert クラスを修正して、検証対象のカラムだけ指定できるメソッドも用意したいと思います。
テストデータの作成・配置方法や、テストで使用する共通クラスの作成方法のルールを決めておきたいと思いました。テストデータを作成する必要があるけどどこに作ろうかとか、あるテストを書いていると別のテストで作成したメソッドを利用したいとか、今回特に強く思いました。こちらも近いうちに１度考えてみたいと思います。

ソースコード

build.gradle

task printClassWhatNotMakeTest << {
    def srcDir = new File("src/main/java");
    def excludePaths = [
            "src/main/java/ksbysample/webapp/lending/Application.java"
            , "src/main/java/ksbysample/webapp/lending/config"
            , "src/main/java/ksbysample/webapp/lending/dao"
            , "src/main/java/ksbysample/webapp/lending/entity"
            , "src/main/java/ksbysample/webapp/lending/exception"
            , "src/main/java/ksbysample/webapp/lending/helper/page/PagenationHelper.java"
            , "src/main/java/ksbysample/webapp/lending/security/LendingUser.java"
            , "src/main/java/ksbysample/webapp/lending/security/RoleAwareAuthenticationSuccessHandler.java"
            , "src/main/java/ksbysample/webapp/lending/service/calilapi/response"
            , "src/main/java/ksbysample/webapp/lending/service/file/BooklistCSVRecord.java"
            , "src/main/java/ksbysample/webapp/lending/service/openweathermapapi"
            , "src/main/java/ksbysample/webapp/lending/service/queue/InquiringStatusOfBookQueueMessage.java"
            , "src/main/java/ksbysample/webapp/lending/util/doma"
            , "src/main/java/ksbysample/webapp/lending/util/velocity/VelocityUtils.java"
            , "src/main/java/ksbysample/webapp/lending/webapi/common/CommonWebApiResponse.java"
            , "src/main/java/ksbysample/webapp/lending/webapi/weather"
    ];
    def excludeFileNamePatterns = [
            ".*EventListener.java"
            , ".*Form.java"
            , ".*Values.java"
    ];

    compareSrcAndTestDir(srcDir, excludePaths, excludeFileNamePatterns);
}

, "src/main/java/ksbysample/webapp/lending/service/calilapi/Librar" → , "src/main/java/ksbysample/webapp/lending/service/calilapi/response" へ変更します。

EmailServiceTest.java

package ksbysample.webapp.lending.service;

import ksbysample.common.test.MailServerResource;
import ksbysample.webapp.lending.Application;
import org.junit.Rule;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;
import org.springframework.mail.javamail.MimeMessageHelper;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;

import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertThat;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
public class EmailServiceTest {

    @Rule
    @Autowired
    public MailServerResource mailServer;

    @Autowired
    private JavaMailSender mailSender;
    
    @Autowired
    private EmailService emailService;

    @Test
    public void testSendSimpleMail() throws Exception {
        SimpleMailMessage message = new SimpleMailMessage();
        message.setFrom("test@sample.com");
        message.setTo("xxx@yyy.zzz");
        message.setSubject("テスト");
        message.setText("これはテストです");
        emailService.sendSimpleMail(message);

        assertThat(mailServer.getMessagesCount(), is(1));
        MimeMessage receiveMessage = mailServer.getFirstMessage();
        assertThat(receiveMessage.getFrom()[0], is(new InternetAddress("test@sample.com")));
        assertThat(receiveMessage.getAllRecipients()[0], is(new InternetAddress("xxx@yyy.zzz")));
        assertThat(receiveMessage.getSubject(), is("テスト"));
        assertThat(receiveMessage.getContent(), is("これはテストです"));
    }

    @Test
    public void testSendMail() throws Exception {
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper message = new MimeMessageHelper(mimeMessage);
        message.setFrom("test@sample.com");
        message.setTo("xxx@yyy.zzz");
        message.setSubject("テスト");
        message.setText("これはテストです");
        emailService.sendMail(message.getMimeMessage());
        
        assertThat(mailServer.getMessagesCount(), is(1));
        MimeMessage receiveMessage = mailServer.getFirstMessage();
        assertThat(receiveMessage.getFrom()[0], is(new InternetAddress("test@sample.com")));
        assertThat(receiveMessage.getAllRecipients()[0], is(new InternetAddress("xxx@yyy.zzz")));
        assertThat(receiveMessage.getSubject(), is("テスト"));
        assertThat(receiveMessage.getContent(), is("これはテストです"));
    }

}

lending/helper/mail/assertdata/001/message.txt

貸出状況を確認しました。以下のURLから借りたい書籍を申請してください。

http://localhost:8080/lendingapp?lendingAppId=1

Mail001HelperTest.java

package ksbysample.webapp.lending.helper.mail;

import com.google.common.base.Charsets;
import ksbysample.webapp.lending.Application;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.SpringApplicationConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.test.context.web.WebAppConfiguration;

import javax.mail.Message;
import javax.mail.internet.MimeMessage;
import java.io.File;

import static org.assertj.core.api.Assertions.assertThat;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
public class Mail001HelperTest {

    @Autowired
    private Mail001Helper mail001Helper;

    @Test
    public void testCreateMessage() throws Exception {
        MimeMessage message = mail001Helper.createMessage("test@sample.com", 1L);
        assertThat(message.getRecipients(Message.RecipientType.TO))
                .extracting(Object::toString)
                .containsOnly("test@sample.com");
        assertThat(message.getContent())
                .isEqualTo(com.google.common.io.Files.toString(
                        new File("src/test/resources/ksbysample/webapp/lending/helper/mail/assertdata/001/message.txt")
                        , Charsets.UTF_8));
    }
}

To アドレスのチェックにおいて message.getRecipients(Message.RecipientType.TO) は Address[] のデータを返すので、AssertJ の extracting メソッドを使用して String へ変換してからチェックしています。
本文のチェックはテストデータを別ファイルに用意しておいて Guava の Files.toString を使用して String のデータを取得してチェックしています。

listener/rabbitmq/testdata/001/table-ordering.txt, lending_app.csv, lending_book.csv

■table-ordering.txt

lending_app
lending_book

■lending_app.csv

lending_app_id,status,lending_user_id,approval_user_id
1,1,1,[null]

■lending_book.csv

lending_book_id,lending_app_id,isbn,book_name,lending_state,lending_app_flg,lending_app_reason,approval_result,approval_reason
1,1,978-4-7741-6366-6,GitHub実践入門,[null],[null],[null],[null],[null]
2,1,978-4-7741-5377-3,JUnit実践入門,[null],[null],[null],[null],[null]
3,1,978-4-7973-8014-9,Java最強リファレンス,[null],[null],[null],[null],[null]
4,1,978-4-7973-4778-4,アジャイルソフトウェア開発の奥義,[null],[null],[null],[null],[null]
5,1,978-4-87311-704-1,Javaによる関数型プログラミング,[null],[null],[null],[null],[null]

listener/rabbitmq/assertdata/001/table-ordering.txt, lending_app.csv, lending_book.csv