前回の記事
<a href="/posts/p2570">リンク</a>
前回はSpockの基本的な書き方を見てきました。今回はSpringでの利用とスパイについて見ていきます。
spock-springを使うことでSpringでSpockを利用することができます。
<div class="remark-highlight"><pre class="language-js"><code class="language-js">testImplementation 'org.spockframework:spock-spring:2.1-groovy-3.0'
</code></pre></div>
今回のテスト対象は以下のクラスです
<div class="remark-highlight"><pre class="language-java"><code class="language-java">@Component
public class StockRepositoryImpl implements StockRepository {

 @Autowired
 private JpaStockDao&#x3C;StockEntity> jpaStockDao;

 @Override
 public Stock findStockByItemId(int itemId) {
 StockEntity stockEntity = this.jpaStockDao.findByItemId(itemId);
 Stock stock = new Stock(stockEntity.getId(),stockEntity.getItem_id(),stockEntity.getCount());
 return stock;
 }

 @Override
 public void save(Stock stock) {
 // データベース用のオブジェクトに変換します
 StockEntity stockEntity = new StockEntity();
 stockEntity.setId(stock.getId());
 stockEntity.setItem_id(stock.getItemId());
 stockEntity.setCount(stock.getCount());
 this.jpaStockDao.update(stockEntity);
 }
}
</code></pre></div>
このうちfindStockByItemIdメソッドのテストコードを書いていきます。※トランザクションの動きを見るために作ったコードなので不備があります。
<h2>テストコードの記載</h2>
JpaStockDaoクラスについては実装はあり、メソッドだけをいじりたいのでSpyを利用します。
<div class="remark-highlight"><pre class="language-java"><code class="language-java">//SpringBootのアノテーションが利用できる
@SpringBootTest
class StockRepositoryImplTest extends Specification {

 @Autowired
 StockRepositoryImpl stockRepository

 def "Stockクラスのオブジェクトが正しく取得できる"(){
 // 対象クラスの準備
 given: "Spyの設定とインジェクトする"
 // daoの戻り値を作成する
 def entity = new StockEntity()
 entity.id = 1
 entity.item_id = 1
 entity.count = 100
 // spyを利用する
 def jpaStockDao = Spy(JpaStockDao)
 // findByItemId(_)の戻り値をentityに設定する
 // any()は使わず_でその代用ができる
 jpaStockDao.findByItemId(_) >> entity
 // テスト対象のStockRepositoryImplのjpaStockDaoをspyしたオブジェクトに書き換える
 StockRepositoryImpl.metaClass.setAttribute(stockRepository,"jpaStockDao",jpaStockDao)

 when: "Stockの取得を行う"
 def result = stockRepository.findStockByItemId(1)

 then: "Stockクラスであること、値のマッピングを確認する"
 // Stockクラスであること。StockEntity→Stockへの変換ができていること
 result.class == Stock.class
 result.id == 1
 result.itemId == 1
 result.count == 100
 }
}
</code></pre></div>
<ul>
<li>@SpringBootTestも使えるため、コンポーネントスキャンなど実施されます
<ul>
<li>@Autowiredでテストに必要なクラス(テスト対象)をインジェクションできます</li>
</ul>
</li>
<li>Spy(JpaStockDao)
<ul>
<li>テスト対象で必要しているコンポーネントをSpyによって作成します</li>
</ul>
</li>
<li>jpaStockDao.findByItemId(_) >> entity
<ul>
<li>Spyによって作成したクラスのfindByItemIdメソッドは定義しているentityを返すようにします</li>
<li>任意の引数を表す時には_を利用します</li>
</ul>
</li>
<li>StockRepositoryImpl.metaClass.setAttribute(stockRepository,”jpaStockDao”,jpaStockDao)
<ul>
<li>テスト対象のクラスのprivateな変数をSpyにて作成したjpaStockDaoに書き換えます</li>
<li>mockitoの@InjectMockのようなことをしています</li>
</ul>
</li>
</ul>
依存コンポーネントのインジェクトの仕方がとても直感的ですね。悪く言えばリフレクションチックとでもいいましょうか。
SpringでSpockを利用できることが確認できました。またSpyについても簡単にできることが確認できました。
今回のソースコードは以下のブランチにあげております
https://github.com/jirentaicho/springboot-transaction-sample/tree/test-spring
関連記事
<a href="/posts/p1729">リンク</a>

SpringBoot | SpockでSpyしてSpringのテストを行う