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

use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Process\Process;

abstract class InspectorSnapshotTestCase extends TestCase
{
    private const INSPECTOR_VERSION = '0.16.8';

    /**
     * @param array<string, mixed> $toolArgs
     */
    #[DataProvider('provideMethods')]
    public function testMethodOutputMatchesSnapshot(
        string $method,
        ?string $toolName = null,
        array $toolArgs = [],
        ?string $uri = null,
    ): void {
        $inspector = \sprintf('@modelcontextprotocol/inspector@%s', self::INSPECTOR_VERSION);
        $args = [
            'npx', $inspector, '--cli', 'php', $this->getServerScript(), '--method', $method,
        ];

        // Options for tools/call
        if (null !== $toolName) {
            $args[] = '--tool-name';
            $args[] = $toolName;

            foreach ($toolArgs as $key => $value) {
                $args[] = '--tool-arg';
                $args[] = \sprintf('%s=%s', $key, $value);
            }
        }

        // Options for resources/read
        if (null !== $uri) {
            $args[] = '--uri';
            $args[] = $uri;
        }

        $output = (new Process($args))
            ->mustRun()
            ->getOutput();

        $snapshotFile = $this->getSnapshotFilePath($method);

        if (!file_exists($snapshotFile)) {
            file_put_contents($snapshotFile, $output.\PHP_EOL);
            $this->markTestIncomplete("Snapshot created at $snapshotFile, please re-run tests.");
        }

        $expected = file_get_contents($snapshotFile);

        $this->assertJsonStringEqualsJsonString($expected, $output);
    }

    /**
     * List of methods to test.
     *
     * @return array<string, array{method: string}>
     */
    abstract public static function provideMethods(): array;

    abstract protected function getServerScript(): string;

    /**
     * @return array<string, array{method: string}>
     */
    protected static function provideListMethods(): array
    {
        return [
            'Prompt Listing' => ['method' => 'prompts/list'],
            'Resource Listing' => ['method' => 'resources/list'],
            'Resource Template Listing' => ['method' => 'resources/templates/list'],
            'Tool Listing' => ['method' => 'tools/list'],
        ];
    }

    private function getSnapshotFilePath(string $method): string
    {
        $className = substr(static::class, strrpos(static::class, '\\') + 1);

        return __DIR__.'/snapshots/'.$className.'-'.str_replace('/', '_', $method).'.json';
    }
}