Sözleşme Testleri — Karşı Servis Değişince Kim Kırılır?

Bir elektrikli cihaz üretiyorsun ve fişin iki pimi var. Priz üreten firma bir gün yeni bir delik ekliyor; sorun yok. Ama bir ertesi gün pimlerden birinin yerini değiştiriyor ve senin cihazın hiçbir prize oturmuyor.

Mock neyi göremez?

Havale servisi hesap servisinden bakiyeyi okur; testlerde de hesap servisini elle yazılmış bir mock ile taklit ederiz. Bu testler hızlıdır ve kendi kodumuzu sınar.

Ama mock, karşı servisin dün ne gönderdiğini taklit eder. Hesap servisi bir alanın adını değiştirirse, mock’lu testler geçmeye devam eder ve kırılma ancak canlıda görünür.

Sözleşmeyi kim yazar, kim doğrular?

Sözleşme testi?Terimin tanımını açsözleşme testiİki servisin birbirinden ne beklediğini otomatik olarak kontrol eden test. Karşı servisin değişikliği seni kırıyorsa, canlıya çıkmadan söyler.Sözlükte gör →, iki servisin birbirinden ne beklediğini otomatik olarak kontrol eder. Tüketici odaklı sözleşmede?Terimin tanımını açtüketici odaklı sözleşmeSözleşmeyi karşı servisi kullanan tarafın yazdığı yaklaşım: yalnızca okuduğu alanlar. Sağlayıcı her build'inde onu doğrular.Sözlükte gör → sözleşmeyi tüketici yazar: “bu istekte bana şu alanlar, şu tiplerle gelsin.”

Sağlayıcı bu sözleşmeyi her build’inde kendi gerçek koduna karşı çalıştırır. Tüketicinin okuduğu bir alanı bozan değişiklik birleştirilmeden durur; kimsenin okumadığı alanlara dokunmak serbesttir.

Kendin gör

1. Varsayılanla oynat. Elle yazılmış mock’lar: iki kırıcı değişiklik de canlıya çıktı.
2. “Uçtan uca testler” seç. Kırılmalar yakalandı, ama değişiklikler birleştirilip ortama çıktıktan sonra.
3. “Bütün şemanın anlık görüntüsü” seç. Kırıcılar erken durdu, ama iki güvenli değişiklik de gereksiz yere durdu.
4. “Tüketici odaklı sözleşme testleri” seç. Kırıcılar sağlayıcının build’inde durdu, güvenliler geçti.

Tuzaklar

Sözleşmeye her alanı yazmak: tüketici okumadığı alanları da sözleşmeye koyarsa, sağlayıcı yine gereksiz yere kırılır. Sözleşmede yalnızca gerçekten kullandığın alanlar olsun.

Doğrulamayı sağlayıcının build’ine bağlamamak. Sözleşme yazılıp hiçbir pipeline’da çalışmazsa hiçbir şeyi korumaz. Sağlayıcı her build’inde tüketicilerin sözleşmelerini doğrulamalı.

Uçtan uca testleri tamamen bırakmak. Sözleşme iki servisin konuşmasını sınar, bütün akışı değil. Az sayıda kritik akış için uçtan uca test yine değerlidir.

1
@ExtendWith(PactConsumerTestExt.class)
2
@PactTestFor(providerName = "accounts-service")
3
class AccountsClientPactTest {
4

5
    @Pact(consumer = "transfer-service")
6
    RequestResponsePact balanceOfTr01(PactDslWithProvider builder) {
7
        return builder
8
                .given("account TR01 exists")
9
                .uponReceiving("a balance request")
10
                .path("/accounts/TR01/balance").method("GET")
11
                .willRespondWith().status(200)
12
                .body(new PactDslJsonBody()
13
                        .decimalType("balance", 1500.00)     // only what the transfer service reads
14
                        .stringType("currency", "TRY"))
15
                .toPact();
16
    }
17

18
    @Test
19
    void readsTheBalance(MockServer server) {
20
        var client = new AccountsClient(RestClient.create(server.getUrl()));
21
        assertThat(client.balanceOf("TR01")).isEqualTo(new Balance(new BigDecimal("1500.00"), "TRY"));
22
    }
23
}

1
@Provider("accounts-service")
2
@PactBroker
3
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
4
class ConsumerContractsTest {
5

6
    @LocalServerPort
7
    int port;
8

9
    @Autowired
10
    AccountRepository accounts;
11

12
    @BeforeEach
13
    void target(PactVerificationContext context) {
14
        context.setTarget(new HttpTestTarget("localhost", port));
15
    }
16

17
    @TestTemplate
18
    @ExtendWith(PactVerificationInvocationContextProvider.class)
19
    void honoursEveryConsumer(PactVerificationContext context) {
20
        context.verifyInteraction();   // fails this build if a consumer's fields change
21
    }
22

23
    @State("account TR01 exists")
24
    void tr01() {
25
        accounts.save(new Account("TR01", new BigDecimal("1500.00"), "TRY"));
26
    }
27
}

1
      - name: Verify consumer contracts
2
        run: ./mvnw -B verify -Dpact.verifier.publishResults=true
3
      - name: Can this version be deployed?
4
        run: pact-broker can-i-deploy --pacticipant accounts-service --version ${{ github.sha }} --to-environment production

Kendini sına