Documentación de Proyecto Sincro

ApiContratoTest extends ApiTestCase
in package

Contrato general de la API: forma de la respuesta, métodos HTTP admitidos y tratamiento de acciones inválidas.

No dependen de base de datos ni de sesión: son la primera línea de defensa y deben pasar en cualquier entorno.

Tags
see
api
requires

PHP 8.0 Uso de tipado estricto y funciones de strings

requires

PHPUnit.

Attributes
#[Group]
'general'
#[Group]
'contrato'

Table of Contents

Properties

$cookieJar  : CookieJar
$debug  : bool
$http  : Client

Methods

accionesMalformadasProvider()  : array<string|int, mixed>
metodosNoPermitidosProvider()  : array<string|int, mixed>
testAccionDesconocidaDevuelve400()  : void
Una acción inexistente debe devolver 400, nunca 500.
testAccionMalformadaNoRompeElServidor()  : void
Valores de 'action' malformados no deben provocar errores no controlados.
testContentTypeEsJson()  : void
La cabecera Content-Type debe declarar JSON.
testMetodosNoPermitidosDevuelven405()  : void
Solo se admite POST: el resto de métodos deben devolver 405.
testRespuestaEsJsonSinSalidaPrevia()  : void
El cuerpo debe ser JSON puro, sin ninguna salida previa.
testSinAccionDevuelve400()  : void
Una petición sin acción debe devolver 400.
assertNoFiltraDetallesInternos()  : void
Verifica que un mensaje de error no filtra detalles internos del servidor (SQL, rutas de archivo, clases o trazas de excepción).
assertRespuestaApi()  : void
Verifica que la respuesta cumple el contrato mínimo de la API: JSON válido con una clave booleana 'ok'.
credenciales()  : array{0: string, 1: string}
Devuelve las credenciales de test del entorno.
idSesion()  : string|null
Devuelve el identificador de sesión actual del cookieJar, si existe.
iniciarSesion()  : void
Inicia sesión con las credenciales del entorno.
nuevoCliente()  : Client
Crea un cliente HTTP que comparte el cookieJar del test.
post()  : array{0: int, 1: array}
Ejecuta un POST contra la API y devuelve [statusCode, bodyArray].
setUp()  : void
Carga el entorno de test, el cookieJar y el cliente HTTP.
trace()  : void
Imprime una traza de ejecución con contexto, dirección y payload.

Properties

Methods

accionesMalformadasProvider()

public static accionesMalformadasProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

metodosNoPermitidosProvider()

public static metodosNoPermitidosProvider() : array<string|int, mixed>
Return values
array<string|int, mixed>

testAccionDesconocidaDevuelve400()

Una acción inexistente debe devolver 400, nunca 500.

public testAccionDesconocidaDevuelve400() : void
Tags
throws
GuzzleException

testAccionMalformadaNoRompeElServidor()

Valores de 'action' malformados no deben provocar errores no controlados.

public testAccionMalformadaNoRompeElServidor(mixed $accion) : void
Parameters
$accion : mixed
Tags
throws
GuzzleException
Attributes
#[DataProvider]
'accionesMalformadasProvider'

testContentTypeEsJson()

La cabecera Content-Type debe declarar JSON.

public testContentTypeEsJson() : void
Tags
throws
GuzzleException

testMetodosNoPermitidosDevuelven405()

Solo se admite POST: el resto de métodos deben devolver 405.

public testMetodosNoPermitidosDevuelven405(string $metodo) : void
Parameters
$metodo : string
Tags
throws
GuzzleException
Attributes
#[DataProvider]
'metodosNoPermitidosProvider'

testRespuestaEsJsonSinSalidaPrevia()

El cuerpo debe ser JSON puro, sin ninguna salida previa.

public testRespuestaEsJsonSinSalidaPrevia() : void

Detecta echos sueltos, warnings de PHP o BOM antes del json_encode.

Tags
throws
GuzzleException

testSinAccionDevuelve400()

Una petición sin acción debe devolver 400.

public testSinAccionDevuelve400() : void
Tags
throws
GuzzleException

assertNoFiltraDetallesInternos()

Verifica que un mensaje de error no filtra detalles internos del servidor (SQL, rutas de archivo, clases o trazas de excepción).

protected assertNoFiltraDetallesInternos(array<string|int, mixed> $body[, string $contexto = '' ]) : void
Parameters
$body : array<string|int, mixed>

: Cuerpo decodificado

$contexto : string = ''

: Texto identificativo para el mensaje de fallo

assertRespuestaApi()

Verifica que la respuesta cumple el contrato mínimo de la API: JSON válido con una clave booleana 'ok'.

protected assertRespuestaApi(array<string|int, mixed> $body[, string $contexto = '' ]) : void
Parameters
$body : array<string|int, mixed>

: Cuerpo decodificado

$contexto : string = ''

: Texto identificativo para el mensaje de fallo

credenciales()

Devuelve las credenciales de test del entorno.

protected credenciales([bool $admin = false ]) : array{0: string, 1: string}
Parameters
$admin : bool = false

: true para las credenciales de administrador

Return values
array{0: string, 1: string}

idSesion()

Devuelve el identificador de sesión actual del cookieJar, si existe.

protected idSesion() : string|null

Se busca por coincidencia parcial para soportar session.name personalizado.

Return values
string|null

iniciarSesion()

Inicia sesión con las credenciales del entorno.

protected iniciarSesion([bool $admin = false ]) : void

Marca el test como skipped si no están configuradas.

Parameters
$admin : bool = false

: true para iniciar como administrador

Tags
throws
GuzzleException

nuevoCliente()

Crea un cliente HTTP que comparte el cookieJar del test.

protected nuevoCliente([array<string|int, mixed> $headers = [] ]) : Client

Permite sobreescribir cabeceras (útil para probar el binding de UA).

Parameters
$headers : array<string|int, mixed> = []

: Cabeceras adicionales o sobreescritas

Return values
Client

post()

Ejecuta un POST contra la API y devuelve [statusCode, bodyArray].

protected post(string $endpoint, array<string|int, mixed> $params) : array{0: int, 1: array}
Parameters
$endpoint : string

: Punto de entrada

$params : array<string|int, mixed>

: Parametros de la peticion

Tags
throws
GuzzleException
Return values
array{0: int, 1: array}

setUp()

Carga el entorno de test, el cookieJar y el cliente HTTP.

protected setUp() : void

El cookieJar se recrea en cada test para garantizar aislamiento.

trace()

Imprime una traza de ejecución con contexto, dirección y payload.

protected trace(string $contexto, string $mensaje[, mixed|null $payload = null ]) : void

Los valores sensibles se sustituyen por '***'.

Parameters
$contexto : string

: Contexto del mensaje

$mensaje : string

: Mensaje

$payload : mixed|null = null

: Carga del mensaje


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results