SpringBootアプリのビルド・テスト時に、テスト用application.propertiesが読み込まれない

Question

#問題と実現したいこと
ビルドサーバーを立て、Jenkinsで./gradlew buildでビルドした際、全てのテストが失敗します。

こちらの記事によれば、test時にはtest/resorces/配下のpropertiesファイルが優先されるとのことです。しかし、下記エラーメッセージにあるように、どうもtest用のtest.propertiesが読み込まれていないようです。

Caused by: java.io.FileNotFoundException: class path resource [test.properties] cannot be opened because it does not exist

ビルド時、どのようにしてテスト用のtest.propertiesを読み込ませ、JUnitによるテストを実施すれば良いでしょうか？？

#エラーメッセージ
各テストには下記のようなエラーメッセージがでます。

Java.lang.IllegalStateException: Failed to load ApplicationContext

Caused by: java.io.FileNotFoundException: class path resource [test.properties] cannot be opened because it does not exist
	at org.springframework.core.io.ClassPathResource.getInputStream(ClassPathResource.java:180)
	at org.springframework.core.io.support.EncodedResource.getInputStream(EncodedResource.java:159)
	at org.springframework.core.io.support.PropertiesLoaderUtils.fillProperties(PropertiesLoaderUtils.java:99)
	at org.springframework.core.io.support.PropertiesLoaderUtils.fillProperties(PropertiesLoaderUtils.java:73)
	at org.springframework.core.io.support.PropertiesLoaderUtils.loadProperties(PropertiesLoaderUtils.java:59)
	at org.springframework.core.io.support.ResourcePropertySource.<init>(ResourcePropertySource.java:86)
	at org.springframework.test.context.support.TestPropertySourceUtils.addPropertiesFilesToEnvironment(TestPropertySourceUtils.java:192)
	... 71 more

#試したこと、確認したこと

• こちらの記事を参考に、各テストクラスに@SpringBootTestおよび@TestPropertySource(locations = "/test.properties")を記載しました。
• ｓMySQLがビルドサーバーにもインストール済みか/該当のデータベースが存在するかを確認しました。

#設定ファイル（test.properties）

###  データベース関連
spring.datasource.url=jdbc:mysql://localhost:3306/DBname?serverTimezone=JST
spring.datasource.username=root
spring.datasource.password=TestTest100!
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.open-in-view=true
# （1）初期化を行うかの指定。
spring.datasource.initialization-mode=always
# （2）初期化を行う際のモード。この場合は検証のみ。
spring.jpa.hibernate.ddl-auto=validate

###  メッセージ
spring.messages.basename=messages
spring.messages.encoding=UTF-8

#環境

• AmazonLinux2
• Jenkins
• SpringBoot 2.2.4
• gradle6.0
• MySQL 8.0

ディレクトリ構成はだいたい↓の感じです（上記サイトを引用させてもらいました）。

/my/good/project
 ├── README.md
 ├── pon.xml
 └── src
     ├── main
     │   ├── com
     │   │    └── ...
     │   └── resources
     │       └── application.properties
     └── test
         ├── com
         │    └── ...
         └── resources
             └── test.properties
             └── schema.sql（テスト用データ）
             └── testdata.sql（テスト用データ）

また、build.gradleも記載いたします。

plugins {
	id 'org.springframework.boot' version '2.2.4.RELEASE'
	id 'io.spring.dependency-management' version '1.0.9.RELEASE'
	id 'java'
	id 'war'
}
war {
    enabled = true
    archiveName = 'sample.war'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
	developmentOnly
	runtimeClasspath {
		extendsFrom developmentOnly
	}
	compileOnly {
		extendsFrom annotationProcessor
	}
}

~中略~

dependencies {
~中略~
	runtimeOnly 'mysql:mysql-connector-java'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

//画面テストは除外
test {
	useJUnitPlatform()
	exclude 'com/example/demo/ViewTest.class'
}

#作成したテストクラスの例
以下のようなテストクラスを作成しています。

@RunWith(SpringRunner.class)
@SpringBootTest
@TestPropertySource(locations = "/test.properties")
@AutoConfigureMockMvc
public class BusinessDateServiceImplTest {

	//依存しているDaoをモック化
	@MockBean
	BusinessDateDao mockDao;

	@Autowired
	BusinessDateService businessDateService;


	@Test
	public void 一件登録が機能する()throws Exception{
		//テスト用の空のEntityクラス用意
		BusinessDate businessDate = new BusinessDate();

		//Daoのvoidメソッドが実行されることを設定（void）
		doNothing().when(mockDao).insertDate(businessDate);

//~以下略~

Answer 1

SpringBootスタータープロジェクトから作成した直後は、src/test/resources がビルドパスに含まれていませんので追加します。

Javaのビルドパスから src/test/resourcesを追加し、その後に以下の2つの操作をします。

• 出力フォルダーを targer/test-classes に変更
• テスト・ソースを含む を はい に変更

Comments

[daphnia99]

ご回答ありがとうございました。
ご指摘の通りやってみました。今度は違うエラーメッセージが出てしまいました。。。正直検討がつきませんでした。

```
org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'com.example.demo.BusinessDateDaoImplTest': Unsatisfied dependency expressed through field 'dao'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.example.demo.repository.BusinessDateDao' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
```

ちなみにご指摘の操作はEclipse上の設定の話かと思いますが、質問文のエラーはAmazonLinux上でも起こります。

やはり、テスト時のプロパティファイルのパスが`src/main/resources`のままになっているようで、どこかで`src/test/resources`に設定するのだと思うのですが。。。gradleのtestタスクに何か設定する。。。？？

もし他に考えられる原因があれば教えていただけますと幸いです。

[A-pZ]

デフォルトのgradle設定であれば、src/test/resourcesの内容でテストが実施されますので、今記載されているgradleタスクのtestで過不足はありませんが、configurationsの記載で「中略」とされているところで何らかの問題があると思われます。（質問内に書かれているのは、mockDao です )

また、↑の内容で記載されたエラー内容は、「dao」 フィールドの依存関係が解決できない内容ですので、質問に記載していただいている テストクラスとは別の問題です。

[daphnia99]

再度のご回答、誠にありがとうございます。gradleは依存関係のところを主に省略しておりました。下記がフルのgradleになります。申し訳ありませんが、皆目見当がつかず。。。

```
plugins {
id 'org.springframework.boot' version '2.2.4.RELEASE'
id 'io.spring.dependency-management' version '1.0.9.RELEASE'
id 'java'
id 'war'
}

war {
enabled = true
archiveName = 'sample.war'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'

configurations {
developmentOnly
runtimeClasspath {
extendsFrom developmentOnly
}
compileOnly {
extendsFrom annotationProcessor
}
}

repositories {
mavenCentral()
}

dependencies {
implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
//implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
implementation 'org.springframework.boot:spring-boot-starter-web'
implementation 'org.webjars:jquery:3.3.1'
implementation 'org.webjars:bootstrap:4.3.1'
implementation 'org.webjars:font-awesome:5.13.0'
implementation 'org.springframework.boot:spring-boot-starter-aop'
compileOnly 'org.projectlombok:lombok'
developmentOnly 'org.springframework.boot:spring-boot-devtools'
runtimeOnly 'mysql:mysql-connector-java'
annotationProcessor 'org.projectlombok:lombok'
testImplementation('org.springframework.boot:spring-boot-starter-test')
testImplementation('com.h2database:h2')
testCompile 'com.codeborne:selenide:5.11.1'
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
}

test {
useJUnitPlatform()
exclude 'com/example/demo/ViewTest.class'
}

```

[A-pZ]

詳細にありがとうございます。あと他の原因を探りたいのですが、Autowiredしている BusinessDateService には、mockBeanでモック化しているBusinessDateDao以外に必要なBeanはないでしょうか？特に dao でインスタンス化が求められているものがありそうです。

[daphnia99]

ご回答引き続きありがとうございます。

実はエラーメッセージが続いていたのを見落としておりました。。。
`SQLException:Access denied for user 'root'@'localhost' (using password: YES)`

src/test/resorces/test.propertiesでMySQLのパスワードが間違っておりました。。。

その結果、一番最初のご回答のとおり改めて実施したところ、test.propertiesを読み込むことができました。誠にありがとうございました。

[daphnia99]

このsrc/test/resorcesをビルドパスに加えるという作業は実際なにをやっているのでしょうか？
ビルド（テストを経てwarを作成する一連の流れ）で使用するディレクトリとして、/test/resourcesも含めるようEclipseに設定した、という理解で合っていますでしょうか？？

[A-pZ]

はい、その通りです。テスト用につかう設定ファイルなどを明示的に設定しています。gradleプロジェクトでしたらデフォルトで用意されますが、Eclipseでプロジェクトを作成した場合にtest/resourcesが用意されないケースがありますので記載しています。

[daphnia99]

ご回答ありがとうございます。理解できました。そして何度も申し訳ありません。

EC2(AmazonLinux2)のJenkinsによるビルドでは引き続きtest.propertiesが見つからない、と言われてしまうのですが、何が原因は考えられますでしょうか。。。

[A-pZ]

Jenkinsビルドした際のテストタスクで、何か別途ビルド設定を変えたりしていますでしょうか。

[daphnia99]

いえ、特段なにもしておりません。そもそもJenkins抜きにして、gitからcloneして./gradlew buildで失敗してしまいます。gradleのバージョンを6.0から6.6にしたりしてみましたがだめでした。。。下記が私のリポジトリです。
https://github.com/fftcysstkm/datemanager

下記参照に、gradleでsrcSetなるものを設定してみたところ色々ディレクトリ構成がごちゃごちゃになってしまいやめました。。。
https://stackoverflow.com/questions/38369060/gradle-custom-test-sourceset

[A-pZ]

確認しますね（少し時間がかかるかもしれません）

[daphnia99]

見ず知らずの自分の問題に貴重なお時間割いて頂いてしまい、大変恐縮です。。。また誠にありがとうございます。。。

[A-pZ]

build.gradleの中を拝見したところ、テスト用にh2databaseをインポートする定義がありますが、test.propertiesで接続しているデータベースはMySQLになっています。こちらは想定どおりでしょうか。

[A-pZ]

僭越ながらリポジトリの方へプルリクエストを出しましたのでご確認ください。

https://github.com/fftcysstkm/datemanager/pull/6

[daphnia99]

ご確認ありがとうございます。
テストもビルドサーバーにインストールしたMySQLに接続するようにしておりました。ですので、dependenciesのh2は余計でした。
しかし、接続するDBはtest.propertiesで決まると認識していましたので、残したままにしておりました。

[A-pZ]

DBの接続情報はあってますかね。

[daphnia99]

お返事が大変遅くなり申し訳ございません。諸事情によりプログラミングから離れておりまして。。。
数々のアドバイス誠にありがとうございました。