PHPackages ibexa/test-rest - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. ibexa/test-rest ActiveIbexa-bundle[Testing & Quality](/categories/testing) ibexa/test-rest =============== Internal Ibexa DXP REST testing framework 4.6.x-dev(5mo ago)0109.6k↓27.6%[1 PRs](https://github.com/ibexa/test-rest/pulls)2(GPL-2.0-only or proprietary)PHPPHP ^7.4 || ^8.0 Since Jul 17Pushed 2mo ago7 watchersCompare [ Source](https://github.com/ibexa/test-rest)[ Packagist](https://packagist.org/packages/ibexa/test-rest)[ RSS](/packages/ibexa-test-rest/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependencies (14)Versions (7)Used By (2) Warning ======= [](#warning) **This package is considered both internal and experimental, and may change without notice.** Ibexa REST Test package ======================= [](#ibexa-rest-test-package) This package is part of [Ibexa DXP](https://ibexa.co). To use this package, [install Ibexa DXP](https://doc.ibexa.co/en/latest/install/). Getting started --------------- [](#getting-started) The purpose of the package is to provide Ibexa REST testing framework, reducing boilerplate code. Installation ------------ [](#installation) To start using it, install it together with [ibexa/test-core](https://github.com/ibexa/test-core): ``` composer req --dev ibexa/test-rest:^0.1.x-dev ibexa/test-core:^0.1.x-dev ``` Prerequisites ------------- [](#prerequisites) It is assumed that you already have created an instance of `\Ibexa\Contracts\Core\Test\IbexaTestKernel` and configured it via `phpunit.integration.xml.dist` or similar PHPUnit configuration file, together with your `./tests/integration/bootstrap.php`. Configuration ------------- [](#configuration) ### Register Bundles [](#register-bundles) Your custom `IbexaTestKernel::registerBundles` method needs to yield your bundle instance, and at least: ``` yield from parent::registerBundles(); yield new \Hautelook\TemplatedUriBundle\HautelookTemplatedUriBundle(); yield new \Ibexa\Bundle\Rest\IbexaRestBundle(); yield new \Ibexa\Bundle\Test\Rest\IbexaTestRestBundle(); ``` ### Configure Container [](#configure-container) Next, create REST routing configuration file, in a similar way project configuration file is prepared via recipes, e.g.: `./tests/integration/Resources/REST/routing/rest.yaml`: ``` ibexa.acme.rest: resource: '@IbexaAcmeBundle/Resources/routing/rest.yaml' prefix: '%ibexa.rest.path_prefix%' ``` Then, in your custom `IbexaTestKernel::registerContainerConfiguration` method configure the following: ``` $loader->load(static function (ContainerBuilder $container): void { $container->loadFromExtension('framework', [ 'router' => [ 'resource' => __DIR__ . '/Resources/routing.yaml', // path to the file you've just created ], ]); $container->setParameter('form.type_extension.csrf.enabled', false); self::addSyntheticService($container, \Lexik\Bundle\JWTAuthenticationBundle\Services\JWTTokenManagerInterface::class); }); ``` Write your first test --------------------- [](#write-your-first-test) At this point you should be able to write your first test: ``` use Ibexa\Contracts\Test\Rest\BaseRestWebTestCase; use Ibexa\Contracts\Test\Rest\Request\Value\EndpointRequestDefinition; final class GetAcmeTest extends BaseRestWebTestCase { protected static function getEndpointsToTest(): iterable { $endpointRequestDefinition = new EndpointRequestDefinition( 'GET', '/api/ibexa/v2/acme', 'AcmeValue', // expected resource type self::generateMediaTypeString('AcmeValue', 'xml'), // accept header [], // custom HTTP headers to include in the request null, // InputPayload instance for POST/PATCH requests null, // custom request name for the data provider 'acme/acme01' // snapshot name ); yield $endpointRequestDefinition; yield $endpointRequestDefinition ->withAcceptHeader(self::generateMediaTypeString('AcmeValue', 'json')); } protected function getSchemaFileBasePath(string $resourceType, string $format): string { return dirname(__DIR__) . '/Resources/REST/Schemas/' . $resourceType; } protected static function getSnapshotDirectory(): ?string { return dirname(__DIR__) . '/Resources/REST/Snapshots'; } } ``` ### Base class [](#base-class) You need to override `\Ibexa\Contracts\Test\Rest\BaseRestWebTestCase` class. ### Define what to test [](#define-what-to-test) The Test case class needs to override `getEndpointsToTest` static method which should yield `EndpointRequestDefinition`describing what endpoints and how you want to test. Each `EndpointRequestDefinition` tests one endpoint, expecting one specific response format (XML or JSON). `EndpointRequestDefinition` takes the following constructor arguments, in that order: - HTTP method type (`'GET'`, `'POST'`, etc.) - Endpoint URI, including REST prefix. - Expected Resource Type the endpoint should return (e.g: `'Content'`, `'Product'`, or `null` for `NoContent`). - Accept HTTP header, e.g. `application/vnd.ibexa.api.Content+xml` (use `self::generateMediaTypeString(resourceType, format)` syntax sugar for that). - Extra HTTP headers if needed. - Input Payload (`null` for `GET` requests). See [Testing endpoints requiring input payload](#testing-endpoints-requiring-input-payload) for more details. - Endpoint request name used to generate PHPUnit data set name (`null` to use default name) - Snapshot name, see [Testing snapshots](#testing-snapshots) for more details. To test an endpoint in another format, you can use `withAcceptHeader` method which will clone the definition changing Accept header. ### Response contents validation against schema files [](#response-contents-validation-against-schema-files) REST Integration Test Framework, for each resource response, validates it against its schema (XSD or JSON). Decide where you want to keep schema files and create a directory for them, e.g.: `./tests/integration/Resources/REST/Schemas`. To configure it, your Test case class needs to define `getSchemaFileBasePath` method which returns schema file base path (including file name without an extension), e.g.: `./tests/integration/Resources/REST/Schemas/AcmeValue`, where in `Schemas` directory, there are two schema files: `AcmeValue.xsd` and `AcmeValue.json`. You can generate these schema files using IDE and/or some online tools. Typically, you'd want to create your own abstract base class defining this and make each Test case class extend it instead, e.g.: ``` abstract class BaseAcmeRestWebTestCase extends BaseRestWebTestCase { protected function getSchemaFileBasePath(string $resourceType, string $format): string { return dirname(__DIR__) . '/Resources/REST/Schemas/' . $resourceType; } } ``` File extension is not included because it depends on a validator (e.g. XSD for XML files). ### Testing snapshots [](#testing-snapshots) If you have a response snapshot to test against, your Test case class needs to override `getSnapshotDirectory` method and define snapshot base file path (without extension) when instantiating `EndpointRequestDefinition`. REST Test Framework looks for a snapshot file concatenating: ``` /. ``` If you want to generate a snapshot at runtime, set the following environment variable: ``` TEST_REST_GENERATE_SNAPSHOTS=1 ``` ### Testing endpoints requiring input payload [](#testing-endpoints-requiring-input-payload) To test mutation endpoints (`POST`, `PATCH`, `PUT`, etc.) you need to create input payload files and load them using `\Ibexa\Contracts\Test\Rest\Input\PayloadLoader` while creating `EndpointRequestDefinition`. Example: ``` public static function getEndpointsToTest(): iterable { $payloadLoader = new PayloadLoader(dirname(__DIR__) . '/Resources/REST/InputPayloads'); yield new EndpointRequestDefinition( 'POST', '/api/ibexa/v2/acme', 'AcmeValue', self::generateMediaTypeString('AcmeValue', 'xml'), [], $payloadLoader->loadPayload('AcmeValueCreate', 'xml', 'Acme/CustomPayloadFileName') ); yield new EndpointRequestDefinition( 'POST', '/api/ibexa/v2/acme', 'AcmeValue', self::generateMediaTypeString('AcmeValue', 'json'), [], $payloadLoader->loadPayload('AcmeValueCreate', 'json', 'Acme/CustomPayloadFileName') ); } ``` `PayloadLoader::loadPayload` expects 2 arguments: input Media Type, format. Optionally you can pass custom file base path (without extension) as the 3rd argument. If not given, the file base path will default to the given Media Type. COPYRIGHT --------- [](#copyright) Copyright (C) 1999-2025 Ibexa AS (formerly eZ Systems AS). All rights reserved. LICENSE ------- [](#license) This source code is available separately under the following licenses: A - Ibexa Business Use License Agreement (Ibexa BUL), version 2.4 or later versions (as license terms may be updated from time to time) Ibexa BUL is granted by having a valid Ibexa DXP (formerly eZ Platform Enterprise) subscription, as described at: For the full Ibexa BUL license text, please see: - LICENSE-bul file placed in the root of this source code, or - (latest version applies) AND B - Ibexa Trial and Test License Agreement (Ibexa TTL), version 2.2 or later versions (as license terms may be updated from time to time) Trial can be granted by Ibexa, reach out to Ibexa AS for evaluation access: For the full Ibexa TTL license text, please see: - LICENSE file placed in the root of this source code, or - (latest version applies) ### Health Score 44 — FairBetter than 92% of packages Maintenance80 Actively maintained with recent releases Popularity31 Limited adoption so far Community20 Small or concentrated contributor base Maturity39 Early-stage or recently created project Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~312 days Total 3 Last Release 164d ago Major Versions 0.1.x-dev → 4.5.x-dev2024-03-20 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/681611?v=4)[Ibexa Bot](/maintainers/ezrobot)[@ezrobot](https://github.com/ezrobot) ![](https://avatars.githubusercontent.com/u/130489?v=4)[Łukasz Serwatka](/maintainers/lserwatka)[@lserwatka](https://github.com/lserwatka) --- Top Contributors [![alongosz](https://avatars.githubusercontent.com/u/7099219?v=4)](https://github.com/alongosz "alongosz (19 commits)")[![Steveb-p](https://avatars.githubusercontent.com/u/3183926?v=4)](https://github.com/Steveb-p "Steveb-p (7 commits)")[![adamwojs](https://avatars.githubusercontent.com/u/211967?v=4)](https://github.com/adamwojs "adamwojs (6 commits)")[![ibexa-yuna](https://avatars.githubusercontent.com/u/67897517?v=4)](https://github.com/ibexa-yuna "ibexa-yuna (5 commits)")[![glye](https://avatars.githubusercontent.com/u/289744?v=4)](https://github.com/glye "glye (2 commits)") --- Tags ibexa-bundleibexa-productibexa-dxp ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/ibexa-test-rest/health.svg) ``` [![Health](https://phpackages.com/badges/ibexa-test-rest/health.svg)](https://phpackages.com/packages/ibexa-test-rest) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[silverstripe/framework The SilverStripe framework 7213.5M2.5k](/packages/silverstripe-framework)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 595.2M386](/packages/shopware-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)