Documentation

CustomFlowsTest extends AbstractFlowsTest
in package

Send requests using customizable flows. These don't use standard HTTP requests.

Instead, they may involve authentication by external/third-party agents.

The APIs authx_login() and Civi::pipe() should be focal points for customized flows. To test them, we run them in separate subprocesses (cv ev ...)

Tags
group

e2e

Table of Contents

Properties

$httpHistory  : array<string|int, mixed>
List of HTTP requests that have been made by this test.
$quirks  : array<string|int, mixed>
List of CMS-dependent quirks that should be ignored during testing.
$settingsBackup  : array<string|int, mixed>
Backup copy of the original settings.

Methods

assertAnonymousContact()  : void
Assert the AJAX request provided empty contact information
assertDashboardOk()  : void
assertDashboardUnauthorized()  : void
Assert that the $response indicates the user cannot view the dashboard.
assertMyContact()  : void
Assert the AJAX response provided the expected contact.
credApikey()  : mixed
credJwt()  : mixed
getCredTypes()  : mixed
getFlowTypes()  : mixed
getLebowskiCID()  : mixed
requestMyContact()  : Request
Make an AJAX request with info about the current contact.
requestMyContactDashboard()  : mixed
setUp()  : void
setUpBeforeClass()  : void
tearDown()  : void
testCliPipeTrustedLogin()  : mixed
testCliPipeUntrustedLogin()  : mixed
testCliServiceLogin()  : mixed
The internal API `authx_login()` should be used by background services to set the active user.
applyAuth()  : RequestInterface
Apply authentication options to a prepared HTTP request.
assertBodyRegexp()  : mixed
Assert that the response body matches a regular-expression.
assertContentType()  : $this
assertFailedDueToProhibition()  : void
assertHasCookies()  : mixed
assertNoCookies()  : mixed
assertNotAuthenticated()  : mixed
Assert that a request was not authenticated.
assertNotBodyRegexp()  : mixed
Assert that the response body DOES NOT match a regular-expression.
assertPageNotShown()  : void
Assert that the response did NOT produce a normal page-view.
assertStatusCode()  : $this
callApi4AjaxError()  : mixed
callApi4AjaxSuccess()  : mixed
createGuzzle()  : Client
Create an HTTP client suitable for simulating AJAX requests.
findQuirks()  : array<string|int, mixed>|array<string|int, string>
formatFailure()  : false|string
Given that an HTTP request has yielded a failed response, format a blurb to summarize the details of the request+response.
getDemoCID()  : int
getDemoUID()  : int
resolveResponse()  : ResponseInterface

Properties

$httpHistory

List of HTTP requests that have been made by this test.

protected array<string|int, mixed> $httpHistory = []

$quirks

List of CMS-dependent quirks that should be ignored during testing.

protected array<string|int, mixed> $quirks = []

$settingsBackup

Backup copy of the original settings.

protected array<string|int, mixed> $settingsBackup

Methods

assertAnonymousContact()

Assert the AJAX request provided empty contact information

public assertAnonymousContact(ResponseInterface $response[, string $additionalMessage = '' ]) : void
Parameters
$response : ResponseInterface
$additionalMessage : string = ''

assertDashboardOk()

public assertDashboardOk([mixed $response = NULL ]) : void
Parameters
$response : mixed = NULL

assertDashboardUnauthorized()

Assert that the $response indicates the user cannot view the dashboard.

public assertDashboardUnauthorized([ResponseInterface $response = NULL ]) : void
Parameters
$response : ResponseInterface = NULL

assertMyContact()

Assert the AJAX response provided the expected contact.

public assertMyContact(int $cid, int|null $uid, string $credType, string $flow, ResponseInterface $response) : void
Parameters
$cid : int

The expected contact ID

$uid : int|null

The expected user ID

$credType : string
$flow : string
$response : ResponseInterface

credApikey()

public credApikey(mixed $cid) : mixed
Parameters
$cid : mixed

credJwt()

public credJwt(mixed $cid[, mixed $expired = FALSE ]) : mixed
Parameters
$cid : mixed
$expired : mixed = FALSE

requestMyContact()

Make an AJAX request with info about the current contact.

public requestMyContact() : Request
Return values
Request

testCliPipeUntrustedLogin()

public testCliPipeUntrustedLogin() : mixed

testCliServiceLogin()

The internal API `authx_login()` should be used by background services to set the active user.

public testCliServiceLogin() : mixed

To test this, we call cv ev 'authx_login(...);' and check the resulting identity.

Tags
throws
CRM_Core_Exception

applyAuth()

Apply authentication options to a prepared HTTP request.

protected applyAuth(RequestInterface $request, string $credType, string $flowType, int $cid) : RequestInterface
Parameters
$request : RequestInterface

The original HTTP request (without any authentication options).

$credType : string

Ex: 'pass', 'jwt', 'api_key'

$flowType : string

Ex: 'param', 'header', 'xheader'

$cid : int

Authenticate as a specific contact (contact ID#).

Return values
RequestInterface —

The new HTTP request (with authentication options).

assertBodyRegexp()

Assert that the response body matches a regular-expression.

protected assertBodyRegexp(string $regexp[, ResponseInterface $response = NULL ][, string $message = NULL ]) : mixed
Parameters
$regexp : string
$response : ResponseInterface = NULL
$message : string = NULL

assertContentType()

protected assertContentType(mixed $expectType[, ResponseInterface|null $response = NULL ]) : $this
Parameters
$expectType : mixed
$response : ResponseInterface|null = NULL

If NULL, then it uses the last response.

Return values
$this

assertFailedDueToProhibition()

protected assertFailedDueToProhibition(ResponseInterface $response) : void
Parameters
$response : ResponseInterface

assertHasCookies()

protected assertHasCookies([ResponseInterface $response = NULL ]) : mixed
Parameters
$response : ResponseInterface = NULL

assertNoCookies()

protected assertNoCookies([ResponseInterface $response = NULL ]) : mixed
Parameters
$response : ResponseInterface = NULL

assertNotAuthenticated()

Assert that a request was not authenticated.

protected assertNotAuthenticated(string $mode, ResponseInterface $response) : mixed
Parameters
$mode : string

Expect that the 'prohibited' or 'anon'

$response : ResponseInterface

assertNotBodyRegexp()

Assert that the response body DOES NOT match a regular-expression.

protected assertNotBodyRegexp(string $regexp[, ResponseInterface $response = NULL ][, string $message = NULL ]) : mixed
Parameters
$regexp : string
$response : ResponseInterface = NULL
$message : string = NULL

assertPageNotShown()

Assert that the response did NOT produce a normal page-view.

protected assertPageNotShown([mixed $response = NULL ]) : void

This is basically assertStatusCode(404), except that the local configuration (CMS/setings/exts/yaddayadda) may change how the error manifests.

Parameters
$response : mixed = NULL

assertStatusCode()

protected assertStatusCode(mixed $expectCode[, ResponseInterface|null $response = NULL ]) : $this
Parameters
$expectCode : mixed
$response : ResponseInterface|null = NULL

If NULL, then it uses the last response.

Return values
$this

callApi4AjaxError()

protected callApi4AjaxError(string $entity, string $action[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$entity : string
$action : string
$params : array<string|int, mixed> = []

callApi4AjaxSuccess()

protected callApi4AjaxSuccess(string $entity, string $action[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$entity : string
$action : string
$params : array<string|int, mixed> = []

findQuirks()

protected findQuirks() : array<string|int, mixed>|array<string|int, string>
Return values
array<string|int, mixed>|array<string|int, string>

formatFailure()

Given that an HTTP request has yielded a failed response, format a blurb to summarize the details of the request+response.

protected formatFailure(ResponseInterface $response) : false|string
Parameters
$response : ResponseInterface
Return values
false|string

resolveResponse()

protected resolveResponse(ResponseInterface|null $response) : ResponseInterface
Parameters
$response : ResponseInterface|null
Return values
ResponseInterface 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results