PluginTest.php

<?php

declare(strict_types=1);

namespace Extism\Tests;

use Extism\CurrentPlugin;
use Extism\HostFunction;
use Extism\PluginOptions;
use PHPUnit\Framework\TestCase;
use Extism\Plugin;
use Extism\Manifest;
use Extism\Manifest\PathWasmSource;
use Extism\ExtismValType;

final class PluginTest extends TestCase
{
    public function testAlloc(): void
    {
        $plugin = self::loadPlugin("alloc.wasm", []);

        $response = $plugin->call("run_test", "");
        $this->assertEquals("", $response);
    }

    public function testFail(): void
    {
        $this->expectException(\Exception::class);

        $plugin = self::loadPlugin("fail.wasm", []);

        $plugin->call("run_test", "");
    }

    public function testExit(): void
    {
        $plugin = self::loadPlugin("exit.wasm", [], function ($manifest) {
            $manifest->config->code = "2";
        });

        try {
            $plugin->call("_start", "");
        } catch (\Exception $e) {
            $this->assertStringContainsString("2", $e->getMessage());
        }
    }

    public function testTimeout(): void
    {
        $plugin = self::loadPlugin("sleep.wasm", [], function ($manifest) {
            $manifest->timeout_ms = 50;
            $manifest->config->duration = "3"; // sleep for 3 seconds
        });

        try {
            $plugin->call("run_test", "");
        } catch (\Exception $e) {
            $this->assertStringContainsString("timeout", $e->getMessage());
        }
    }

    public function testFileSystem(): void
    {
        $plugin = self::loadPlugin("fs.wasm", [], function ($manifest) {
            $manifest->allowed_paths = ["tests/data" => "/mnt"];
        });

        $response = $plugin->call("_start", "");
        $this->assertEquals("hello world!", $response);
    }

    public function testFunctionExists(): void
    {
        $plugin = self::loadPlugin("alloc.wasm", []);

        $this->assertTrue($plugin->functionExists("run_test"));
        $this->assertFalse($plugin->functionExists("i_dont_exist"));
    }

    public function testHostFunctions(): void
    {
        $kvstore = [];

        $kvRead = new HostFunction("kv_read", [ExtismValType::I64], [ExtismValType::I64], function (CurrentPlugin $p, string $key) use (&$kvstore) {
            return $kvstore[$key] ?? "\0\0\0\0";
        });

        $kvWrite = new HostFunction("kv_write", [ExtismValType::I64, ExtismValType::I64], [], function (string $key, string $value) use (&$kvstore) {
            $kvstore[$key] = $value;
        });

        $plugin = self::loadPlugin("count_vowels_kvstore.wasm", [$kvRead, $kvWrite]);

        $response = $plugin->call("count_vowels", "Hello World!");
        $this->assertEquals('{"count":3,"total":3,"vowels":"aeiouAEIOU"}', $response);

        $response = $plugin->call("count_vowels", "Hello World!");
        $this->assertEquals('{"count":3,"total":6,"vowels":"aeiouAEIOU"}', $response);
    }

    public function testCallWithHostContext(): void
    {
        $multiUserKvStore = [[]];

        $kvRead = new HostFunction("kv_read", [ExtismValType::I64], [ExtismValType::I64], function (CurrentPlugin $p, string $key) use (&$multiUserKvStore) {
            $ctx = $p->getCallHostContext(); // get a copy of the host context data
            $userId = $ctx["userId"];
            $kvStore = $multiUserKvStore[$userId] ?? [];

            return $kvStore[$key] ?? "\0\0\0\0";
        });

        $kvWrite = new HostFunction("kv_write", [ExtismValType::I64, ExtismValType::I64], [], function (CurrentPlugin $p, string $key, string $value) use (&$multiUserKvStore) {
            $ctx = $p->getCallHostContext(); // get a copy of the host context data
            $userId = $ctx["userId"];
            $kvStore = $multiUserKvStore[$userId] ?? [];

            $kvStore[$key] = $value;
            $multiUserKvStore[$userId] = $kvStore;
        });

        $plugin = self::loadPlugin("count_vowels_kvstore.wasm", [$kvRead, $kvWrite]);

        $ctx = ["userId" => 1];

        $response = $plugin->callWithContext("count_vowels", "Hello World!", $ctx);
        $this->assertEquals('{"count":3,"total":3,"vowels":"aeiouAEIOU"}', $response);

        $response = $plugin->callWithContext("count_vowels", "Hello World!", $ctx);
        $this->assertEquals('{"count":3,"total":6,"vowels":"aeiouAEIOU"}', $response);
    }

    public function testHostFunctionManual(): void
    {
        $kvstore = [];

        $kvRead = new HostFunction("kv_read", [ExtismValType::I64], [ExtismValType::I64], function (CurrentPlugin $p, int $keyPtr) use (&$kvstore) {
            $key = $p->read_block($keyPtr);
            $value = $kvstore[$key] ?? "\0\0\0\0";
            return $p->write_block($value);
        });

        $kvWrite = new HostFunction("kv_write", [ExtismValType::I64, ExtismValType::I64], [], function (CurrentPlugin $p, int $keyPtr, int $valuePtr) use (&$kvstore) {
            $key = $p->read_block($keyPtr);
            $value = $p->read_block($valuePtr);

            $kvstore[$key] = $value;
        });

        $plugin = self::loadPlugin("count_vowels_kvstore.wasm", [$kvRead, $kvWrite]);

        $response = $plugin->call("count_vowels", "Hello World!");
        $this->assertEquals('{"count":3,"total":3,"vowels":"aeiouAEIOU"}', $response);

        $response = $plugin->call("count_vowels", "Hello World!");
        $this->assertEquals('{"count":3,"total":6,"vowels":"aeiouAEIOU"}', $response);
    }

    public function testHostFunctionNamespace(): void
    {
        $this->expectExceptionMessage("Extism: unable to load plugin: Unable to compile Extism plugin: unknown import: `extism:host/user::kv_read` has not been defined");

        $kvRead = new HostFunction("kv_read", [ExtismValType::I64], [ExtismValType::I64], function (string $key) {
            //
        });
        $kvRead->set_namespace("custom");

        $kvWrite = new HostFunction("kv_write", [ExtismValType::I64, ExtismValType::I64], [], function (string $key, string $value) {
            //
        });
        $kvWrite->set_namespace("custom");

        $plugin = self::loadPlugin("count_vowels_kvstore.wasm", [$kvRead, $kvWrite]);
    }

    public function testFuelLimit(): void
    {
        $plugin = self::loadPlugin("sleep.wasm", [], null, new PluginOptions(true, 10));

        try {
            $plugin->call("run_test", "");
        } catch (\Exception $e) {
            $this->assertStringContainsString("fuel", $e->getMessage());
        }
    }

    public static function loadPlugin(string $name, array $functions, ?callable $config = null, $withWasi = true)
    {
        $path = __DIR__ . '/../wasm/' . $name;
        $manifest = new Manifest(new PathWasmSource($path, 'main'));

        if ($config !== null) {
            $config($manifest);
        }

        return new Plugin($manifest, $withWasi, $functions);
    }
}