OpenFeign/feign

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

Open

Aperta il 20 dic 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Java (9070 star) (1911 fork)batch import
help wantedproposal

Descrizione

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

Guida contributor

Tech stack
java
Dominio
testingbackend
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
JavaFeign mock moduleHTTP headers
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
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.