Contract TestツールPactの紹介

openapi: 3.0.0
// Openapi Specに従ったAPIの定義
paths:
  '/greet':
    get:
      operationId: getGreet
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/greetMessage'
// 通信で使用するデータの構造定義
components:
  schemas:
    greetMessage:
      type: object
      properties:
        id:
          type: number
        content:
          type: string

@Service
public class GreetService {
    // Openapi Generatorが生成したRestTemplateのClientを使用したバックエンド呼び出し処理
    private final GreetApi greetApi;
    public GreetService(ApiClient apiClient) {
        GreetApi greetApi = new GreetApi(apiClient);
        this.greetApi = greetApi;
    }

    public GreetMessage greet() {
        try {
            return greetApi.getGreet();
        } catch (HttpClientErrorException e){
            throw e;
        }
    }
}

// Openapi Generatorが生成したAPI定義(interface)を実装するRestController
@RestController
public class GreetController implements GreetApi {
	@Override
	public ResponseEntity<GreetMessage> getGreet() {
		// 固定の挨拶文を返却
		GreetMessage target = new GreetMessage();
		target.setId(BigDecimal.ONE);
		target.setContent("Hello Microservice");
		return ResponseEntity.ok(target);
	}
}

@ExtendWith(PactConsumerTestExt.class)  // JUnit5のテストでPactを利用するための拡張
@PactTestFor(providerName = "GreetProvider")
public class GreetServiceTest {
    // 応答データをPactツールが提供する DSLを利用して定義
    @Pact(provider="GreetProvider", consumer="Greet_Front")
    public RequestResponsePact defaultGreet(PactDslWithProvider builder) {
        PactDslJsonBody body = new PactDslJsonBody()
            .numberValue("id", 1)
            .stringValue("content", "Hello Microservice");
        
        return builder
            .given("test state")
            .uponReceiving("GreeterPactTest get greet")
                .path("/greet")
                .method("GET")
            .willRespondWith()
                .status(200)
                .body(body)
            .toPact();
    }    

    @Test
    @PactTestFor(pactMethod = "defaultGreet") // モックに応答させる内容を定義したPactから指定
    void defaltGreetTest(MockServer mockServer) throws IOException {
        // テストで使用するapiClientのアクセス先をPactツールのモックサーバに設定
        var apiClient = new com.example.iwaki.greet.ApiClient();
        apiClient.setBasePath(mockServer.getUrl());

        GreetMessage message = new GreetService(apiClient).greet();
        assertEquals("Hello Microservice", message.getContent());
    }
}

{
  "consumer": {
    "name": "Greet_Front"
  },
  "interactions": [
    {
      "description": "GreeterPactTest get greet",
      "providerStates": [
        {
          "name": "test state"
        }
      ],
      "request": {
        "method": "GET",
        "path": "/greet"
      },
      "response": {
        "body": {
          "content": "Hello Microservice",
          "id": 1
        },
        (略)
       "status": 200
      }
    }
  ],
  (略)
  "provider": {
    "name": "GreetProvider"
  }
}

@WebMvcTest // SpringのMockMVCを利用するための拡張
@Provider("GreetProvider")  // Pact(Contract)で検証対象となるProvider名を指定
@PactFile("../front/target/pacts") // 検証するPactファイルを含むフォルダを指定
public class GreetContractTest {
     
    @Autowired
    private MockMvc mockMvc;

    @TestTemplate // JUnit5のTestTemplateを利用してPactの内容に応じたコンテキスト毎のテストを設定
    @ExtendWith(PactVerificationSpringProvider.class) // Pactツールからのコンテキスト提供を設定
    void pactVerificationTestTemplate(PactVerificationContext context) {
      context.verifyInteraction();
    }
    
    // コンテキスト毎の初期処理でテスト対象をmockmvcに設定
    @BeforeEach
    void before(PactVerificationContext context) {
        context.setTarget(new MockMvcTestTarget(mockMvc));
    }

    // Pactの条件(providerStates)毎に異なる処理が必要であれば記載
    @State("test state")
    void testState() {}
}

services:
  postgres:
    image: postgres
    healthcheck:
      test: psql postgres --command "select 1" -U postgres
    volumes:
      - postgres-volume:/var/lib/postgresql/data
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: password
      POSTGRES_DB: postgres

  pact-broker:
    image: pactfoundation/pact-broker:2.105.0.1
    ports:
      - "9292:9292"
    depends_on:
      - postgres
    environment:
      PACT_BROKER_PORT: '9292'
      PACT_BROKER_DATABASE_URL: "postgres://postgres:password@postgres/postgres"
      PACT_BROKER_LOG_LEVEL: INFO
      PACT_BROKER_SQL_LOG_LEVEL: DEBUG
      PACT_BROKER_DATABASE_CONNECT_MAX_RETRIES: "5"
      PACT_BROKER_BASE_URL: 'http://localhost:9292 http://pact-broker:9292'

volumes:
  postgres-volume:

<plugin>
    <groupId>au.com.dius.pact.provider</groupId>
	<artifactId>maven</artifactId>
    <version>4.1.11</version>
    <configuration>
	    <pactDirectory>${project.build.directory}/pacts</pactDirectory> <!-- 登録するPactファイルが存在するパス -->
		<pactBrokerUrl>http://localhost:9292</pactBrokerUrl>
        <projectVersion>${project.version}</projectVersion> <!-- PactのバージョンにはMavenプロジェクトのバージョンを使用 -->
		<trimSnapshot>true</trimSnapshot> <!-- MavenプロジェクトのバージョンがSNAPSHOTの場合に除外 -->
        <tags> <!-- Pactに付加する情報 -->
            <tag>test</tag>
        </tags>
    </configuration>
</plugin>

@WebMvcTest
@Provider("GreetProvider") 
@PactBroker(host = "localhost", port = "9292") // Pact参照先をファイルからBrokerに変更
public class GreetContractTest {
  ・・・
}