HttpTestTrait - Allow one to easily authenticate subrequests #21261
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Update
HttpTestTrait
to make it is easier for E2E tests to send authenticated requests on behalf of different users/contacts.Step towards #21249
Before
The test writer must determine a specific credential (e.g. username+password or api_key or JWT) and send it as part of the request.
After
The test writer may pass the option
authx_user
orauthx_contact_id
to Guzzle. This will be converted to a JWT so that the HTTP call includes authentication credentials. A few examples:Full list of options:
authx_ttl
(int): Seconds of validity for JWT'sauthx_host
(string): Only send tokens for the given host. (Default perCIVICRM_UF_BASEURL
)authx_contact_id
(int): The CiviCRM contact to authenticate withauthx_user
(string): The CMS user to authenticate withauthx_flow
(string): How to format the auth token. One of: 'param', 'xheader', 'header'.