宣告：

Author：趙志乾

Date：2017-8-5

Declaration：All Right Reserved！！！

    1、本系列教程主要是介紹JMockit庫中一些註解和API的使用，這些註解和API能夠簡化測試用例的編寫。首先是能夠使被測物件自動例項化和初始化的註解；之後是模擬依賴的ExpectationsAPI；最後是仿造應用的mockupAPI（簡化外部元件的模擬）。

     注：該教程只是對JMockit庫中一些常用的註解、API、類進行簡單例項，詳細內容請參考API文件手冊。

    2、開發人員通常需要自己藉助一些測試框架（如JUnit）來寫一些驗證自己程式碼邏輯的測試用例。而自動化測試由可分為兩類：一類是對從系統中分割出來的類或者元件進行測試的單元測試，另一類是對系統操作進行測試的整體測試（一次涉及多個單元）。

    整體測試會涉及到多個元件或單元的互動，而通常在測試過程中我們感興趣的並不是所有的單元、元件或子系統，此時就需要對那些不感興趣的元件進行模擬或仿製，從而從系統中分離出我們感興趣的程式碼進行測試。因此，能夠“將程式碼從系統中進行分離”這種特性非常有用，但是，在實際使用中，我們要儘量保證測試環境的真實性，也就是說在理想情況下，應該使模擬或者仿製的部分壓縮到最小。

    3、通常而言，一個mock出來的物件是在單一測試或多個相關測試過程中對某個類的特定實現，它會在測試過程取代依賴物件，並且表現出預期的行為。但是這並不是mock物件唯一的能力，因為mock物件本身也可進行一些斷言。JMockit優於傳統mock物件的方面是：其支援在非模擬類上直接mock方法和建構函式，避免了測試過程中對mock物件進行例項化的需求。並且在測試過程，真實類上被模擬的方法和建構函式何時被呼叫，其都會表現出我們預定義的行為。而當一個類被模擬的時候，測試期間，模擬程式碼會取代原有程式碼。這些模擬方式不僅適用於例項方法，也適用於靜態方法、final方法和建構函式。

    注：mcok不僅適用於單元測試，也適用於整體測試。

   4、示例演示：

    假定我們有一個業務服務類，其遵循以下步驟來完成業務操作：

        取出某個持久化的實體；

        將實體的新狀態進行持久化；

        向某個需要感知該操作的元件傳送郵件進行告知；

    前兩個步驟需要訪問應用的資料庫，這通常會使用持久化子系統的簡化API來做，這裡使用的JPA。而最後一步需要使用第三方的API來發送郵件（示例中使用的是Apache的）。可以看出，這個服務類有兩個依賴，一個用於資料持久化、另一個用於傳送郵件。為了測試業務操作，我們會使用JMockit的JPA來處理持久化操作，而傳送郵件則使用模擬的API來完成。被測類的原始碼如下：

package tutorial.domain;

import java.math.*;
import java.util.*;
import org.apache.commons.mail.*;
import static tutorial.persistence.Database.*;

public final class MyBusinessService
{
   private final EntityX data;

   public MyBusinessService(EntityX data) { this.data = data; }

   public void doBusinessOperationXyz() throws EmailException
   {
      List<EntityX> items =
(1)      find("select item from EntityX item where item.someProperty = ?1", data.getSomeProperty());

      // Compute or obtain from another service a total value for the new persistent entity:
      BigDecimal total = ...
      data.setTotal(total);

(2)   persist(data);

      sendNotificationEmail(items);
   }

   private void sendNotificationEmail(List<EntityX> items) throws EmailException
   {
      Email email = new SimpleEmail();
      email.setSubject("Notification about processing of ...");
(3)   email.addTo(data.getCustomerEmail());

      // Other e-mail parameters, such as the host name of the mail server, have defaults defined
      // through external configuration.

      String message = buildNotificationMessage(items);
      email.setMsg(message);

(4)   email.send();
   }

   private String buildNotificationMessage(List<EntityX> items) { ... }
}

    資料庫類只包含一些靜態方法和一個私有的建構函式，而find和persist方法的意義很明確，此處將不再進行說明。那麼接下來我們要考慮如何在不修改原有程式碼的情況下來測試doBusinessOperationXyz這個方法？下面是JUnit的測試類，其中測試將會驗證持久化操作執行情況以及傳送郵件API的呼叫情況。這些驗證點位於上面示例程式碼中的數字標識位置。

package tutorial.domain;

import org.apache.commons.mail.*;
import static tutorial.persistence.Database.*;

import org.junit.*;
import org.junit.rules.*;
import static org.junit.Assert.*;
import mockit.*;

public final class MyBusinessServiceTest
{
   @Rule public final ExpectedException thrown = ExpectedException.none();

   @Tested final EntityX data = new EntityX(1, "abc", "[email protected]");
   @Tested(fullyInitialized = true) MyBusinessService businessService;
   @Mocked SimpleEmail anyEmail;

   @Test
   public void doBusinessOperationXyz() throws Exception
   {
      EntityX existingItem = new EntityX(1, "AX5", "[email protected]");
(1)   persist(existingItem);

      businessService.doBusinessOperationXyz();

(2)   assertNotEquals(0, data.getId()); // implies "data" was persisted
(4)   new Verifications() {{ anyEmail.send(); times = 1; }};
   }

   @Test
   public void doBusinessOperationXyzWithInvalidEmailAddress() throws Exception
   {
      final String email = "invalid address";
      data.setCustomerEmail(email);
(3)   new Expectations() {{ anyEmail.addTo(email); result = new EmailException(); }};
      thrown.expect(EmailException.class);

      businessService.doBusinessOperationXyz();
   }
}

    上面的示例中使用了JMockit的一些註解：其中@Tested註解會正確的初始化被測物件，@Mocked註解則用於模擬一個給定的型別。

    在測試類示例中，expectations的錄製（位於new Expectations() {{ ... }}中）和驗證（位於new Verifications() {{ ... }}中）在模擬型別或者例項上的對應方法被呼叫時會起作用。其中，對於返回值或異常丟擲都是通過欄位result進行指定，而呼叫次數則通過欄位times進行指定。

注：本部落格中的例項程式碼均來自於JMockit官方教程。