OpenFeign/feign

feign-mock is too strict with request headers when matching requests

Open

#1.552 geöffnet am 20. Dez. 2021

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (9.070 Stars) (1.911 Forks)batch import
help wantedproposal

Beschreibung

I am using https://github.com/OpenFeign/feign/tree/master/mock to write unit tests. When one would want to match/verify request headers, the current implementation seems too strict as it checks for exact equality. Ideally, it should be matching a subset of the headers as there can be headers the tester doesn't care about or generated headers like Content-Length.

I know the workaround for this is to write a RequestInterceptor and do assertions there, but that is not ideal as it adds a lot of boilerplate code in tests. For each test, one needs to write a test-specific RequestInterceptor.

I would like to propose making the header matching in RequestKey.java#L171 match a subset of the headers instead of exact equality.

Bonus Request: match with RegEx

Contributor Guide

Tech Stack
java
Domain
testingbackend
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaFeign mock moduleHTTP headers
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60
Research-Richtung
Examine the header matching logic in mock/src/main/java/feign/mock/RequestKey.java (line 171). The current implementation checks for exact equality. Propose a change to match a subset of headers, potentially with regex support. Consider backward compatibility, e.g., by adding a new method or configuration flag. Review test files to understand expected behavior and ensure existing tests are not broken.