php-sdk/tests/Unit/Schema/Elicitation/MultiSelectEnumSchemaDefinitionTest.php
Christopher Hertel cf2c4d4ead
[Schema] Stop rejecting elicitation schemas the specification allows (#437)
* [Schema] Stop rejecting elicitation schemas the specification allows

The specification makes `title` optional on every elicitation schema
definition. AbstractSchemaDefinition required it, so a client reading a
conformant server's elicitation/create refused the request - and a server
building one could not omit it either.

`title` is now nullable on all seven definitions, omitted from the
serialized form when absent, and rejected only when present and not a
string.

* Fix stale title docblocks; allow omitting title where safe

* Give Number's title param a default too

* Apply suggestions from code review

Co-authored-by: Christopher Hertel <mail@christopher-hertel.de>
2026-08-18 19:49:15 +02:00

231 lines
7.6 KiB
PHP

<?php
/*
* This file is part of the official PHP MCP SDK.
*
* A collaboration between Symfony and the PHP Foundation.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Mcp\Tests\Unit\Schema\Elicitation;
use Mcp\Exception\InvalidArgumentException;
use Mcp\Schema\Elicitation\MultiSelectEnumSchemaDefinition;
use PHPUnit\Framework\TestCase;
final class MultiSelectEnumSchemaDefinitionTest extends TestCase
{
public function testConstructorWithMinimalParams(): void
{
$schema = new MultiSelectEnumSchemaDefinition('Tags', ['php', 'js', 'go']);
$this->assertSame('Tags', $schema->title);
$this->assertSame(['php', 'js', 'go'], $schema->enum);
$this->assertNull($schema->description);
$this->assertNull($schema->default);
$this->assertNull($schema->minItems);
$this->assertNull($schema->maxItems);
}
public function testConstructorWithAllParams(): void
{
$schema = new MultiSelectEnumSchemaDefinition(
title: 'Tags',
enum: ['php', 'js', 'go'],
description: 'Select languages',
default: ['php'],
minItems: 1,
maxItems: 3,
);
$this->assertSame('Tags', $schema->title);
$this->assertSame(['php', 'js', 'go'], $schema->enum);
$this->assertSame('Select languages', $schema->description);
$this->assertSame(['php'], $schema->default);
$this->assertSame(1, $schema->minItems);
$this->assertSame(3, $schema->maxItems);
}
public function testConstructorWithEmptyEnum(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('enum array must not be empty');
new MultiSelectEnumSchemaDefinition('Test', []);
}
public function testConstructorWithNonStringEnumValue(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('All enum values must be strings');
/* @phpstan-ignore argument.type */
new MultiSelectEnumSchemaDefinition('Test', ['a', 1, 'b']);
}
public function testConstructorWithNegativeMinItems(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('minItems must be non-negative');
new MultiSelectEnumSchemaDefinition('Test', ['a'], minItems: -1);
}
public function testConstructorWithNegativeMaxItems(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('maxItems must be non-negative');
new MultiSelectEnumSchemaDefinition('Test', ['a'], maxItems: -1);
}
public function testConstructorWithMinItemsGreaterThanMaxItems(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('minItems cannot be greater than maxItems');
new MultiSelectEnumSchemaDefinition('Test', ['a', 'b'], minItems: 3, maxItems: 1);
}
public function testConstructorWithInvalidDefault(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Default value "invalid" is not in the enum array');
new MultiSelectEnumSchemaDefinition('Test', ['a', 'b'], default: ['invalid']);
}
public function testFromArrayWithMinimalParams(): void
{
$schema = MultiSelectEnumSchemaDefinition::fromArray([
'title' => 'Tags',
'items' => [
'type' => 'string',
'enum' => ['php', 'js', 'go'],
],
]);
$this->assertSame('Tags', $schema->title);
$this->assertSame(['php', 'js', 'go'], $schema->enum);
$this->assertNull($schema->description);
$this->assertNull($schema->default);
$this->assertNull($schema->minItems);
$this->assertNull($schema->maxItems);
}
public function testFromArrayWithAllParams(): void
{
$schema = MultiSelectEnumSchemaDefinition::fromArray([
'title' => 'Tags',
'description' => 'Select languages',
'default' => ['php'],
'minItems' => 1,
'maxItems' => 3,
'items' => [
'type' => 'string',
'enum' => ['php', 'js', 'go'],
],
]);
$this->assertSame('Tags', $schema->title);
$this->assertSame(['php', 'js', 'go'], $schema->enum);
$this->assertSame('Select languages', $schema->description);
$this->assertSame(['php'], $schema->default);
$this->assertSame(1, $schema->minItems);
$this->assertSame(3, $schema->maxItems);
}
public function testFromArrayWithoutTitleIsAccepted(): void
{
// `title` is optional in the specification, so a server that omits it
// must still be readable.
$schema = MultiSelectEnumSchemaDefinition::fromArray([
'items' => ['type' => 'string', 'enum' => ['a']],
]);
$this->assertNull($schema->title);
$this->assertArrayNotHasKey('title', $schema->jsonSerialize());
}
public function testFromArrayRejectsNonStringTitle(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid "title" for multi-select enum schema definition.');
/* @phpstan-ignore argument.type */
MultiSelectEnumSchemaDefinition::fromArray([
'title' => 42,
'items' => ['type' => 'string', 'enum' => ['a']],
]);
}
public function testFromArrayWithMissingItemsEnum(): void
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Missing or invalid "items.enum"');
/* @phpstan-ignore argument.type */
MultiSelectEnumSchemaDefinition::fromArray([
'title' => 'Test',
'items' => ['type' => 'string'],
]);
}
public function testJsonSerializeWithMinimalParams(): void
{
$schema = new MultiSelectEnumSchemaDefinition('Tags', ['php', 'js', 'go']);
$this->assertSame([
'type' => 'array',
'title' => 'Tags',
'items' => [
'type' => 'string',
'enum' => ['php', 'js', 'go'],
],
], $schema->jsonSerialize());
}
public function testJsonSerializeWithAllParams(): void
{
$schema = new MultiSelectEnumSchemaDefinition(
title: 'Tags',
enum: ['php', 'js', 'go'],
description: 'Select languages',
default: ['php'],
minItems: 1,
maxItems: 3,
);
$this->assertSame([
'type' => 'array',
'title' => 'Tags',
'description' => 'Select languages',
'items' => [
'type' => 'string',
'enum' => ['php', 'js', 'go'],
],
'default' => ['php'],
'minItems' => 1,
'maxItems' => 3,
], $schema->jsonSerialize());
}
public function testFromArrayJsonSerializeRoundTrip(): void
{
$original = new MultiSelectEnumSchemaDefinition(
title: 'Tags',
enum: ['php', 'js', 'go'],
description: 'Select languages',
default: ['php', 'go'],
minItems: 1,
maxItems: 3,
);
$serialized = $original->jsonSerialize();
$restored = MultiSelectEnumSchemaDefinition::fromArray($serialized);
$this->assertSame($serialized, $restored->jsonSerialize());
}
}