FilesExpand file tree

main

/

IntegrationTestCase.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

109 lines (96 loc) · 3.57 KB

main

/

IntegrationTestCase.php

Copy path

Top

File metadata and controls

• Code
• Blame

109 lines (96 loc) · 3.57 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

<?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\Integration;

use Mcp\Client;

use Mcp\Client\Builder as ClientBuilder;

use Mcp\Client\Transport\StdioTransport;

use Mcp\Exception\ConnectionException;

use Mcp\Schema\Enum\ProtocolVersion;

use PHPUnit\Framework\TestCase;

/**

* Base for tests that run a real client against a real server process.

*

* Every other test in the suite mocks one side of the conversation. These run

* both, wired the way `examples/client` wires them, so what they cover is the

* agreement between the two halves. The servers live in {@see Fixture}, one

* script per scenario.

*

* @author Christopher Hertel <mail@christopher-hertel.de>

*/

abstract class IntegrationTestCase extends TestCase

{

/**

* Both sides answer immediately, so anything reaching this is a deadlock.

* Far below the SDK's two-minute default, to fail rather than hang.

*/

private const TIMEOUT = 5;

private ?Client $client = null;

protected function clientBuilder(): ClientBuilder

{

return Client::builder()

->setClientInfo('integration-client', '1.0.0')

->setInitTimeout(self::TIMEOUT)

->setRequestTimeout(self::TIMEOUT);

}

/**

* @return iterable<string, array{ProtocolVersion}>

*/

public static function provideEras(): iterable

{

yield 'the handshake era' => [ProtocolVersion::V2025_11_25];

yield 'the modern era' => [ProtocolVersion::V2026_07_28];

}

/**

* Spawn a fixture server and connect a client to it.

*

* The returned client has completed the handshake.

*

* @param string $fixture basename of a script in {@see Fixture}

* @param array<string, string> $env added to the server process environment

*/

protected function connect(string $fixture, ?ClientBuilder $client = null, array $env = []): Client

{

$this->client = ($client ?? $this->clientBuilder())->build();

try {

$this->client->connect($this->transport($fixture, $env));

} catch (ConnectionException $e) {

// A fixture dying on startup arrives here with its exit code and the

// end of its stderr, usually enough to see why.

$this->fail(\sprintf('Could not connect to fixture server "%s": %s. Run `%s %s` to see why.', $fixture, $e->getMessage(), \PHP_BINARY, self::script($fixture)));

}

return $this->client;

}

/**

* A transport that will spawn a fixture server, without connecting it.

*

* Tests that assert on a failing connection need the transport by itself,

* since {@see self::connect()} turns that failure into a test failure.

*

* @param array<string, string> $env added to the server process environment

*/

protected function transport(string $fixture, array $env = []): StdioTransport

{

return new StdioTransport(

command: \PHP_BINARY,

args: [self::script($fixture)],

// proc_open() replaces the environment rather than adding to it.

env: [] === $env ? null : array_merge(getenv(), $env),

);

}

private static function script(string $fixture): string

{

return __DIR__.'/Fixture/'.$fixture.'.php';

}

protected function tearDown(): void

{

$this->client?->disconnect();

$this->client = null;

}

}