Luigit
repositories / pi-ext

pi-ext

bugabingas pi extensions

owned by admin

extensions/devdocs/__tests__/symbols.test.ts

Raw
import { expect, it } from "vitest";
import { symbolIndex } from "../src/symbols.ts";

it("reads Javadoc type, member, and package discovery metadata without executing script text", () => {
	const input = `window.memberSearchIndex = [
		{"p":"java.lang","c":"String","l":"charAt(int)","u":"java.base/java/lang/String.html#charAt(int)","m":"java.base"},
		{"p":"java.lang","l":"String","u":"java.base/java/lang/String.html","m":"java.base"},
		{"l":"java.lang","u":"java.base/java/lang/package-summary.html","m":"java.base"}
	]; globalThis.executed = true;`;

	expect(
		symbolIndex(input, "javadoc", "java.base/java.lang.String.charAt(int)"),
	).toEqual([
		{
			locator: "java.base/java/lang/String.html#charAt(int)",
			heading: "java.base/java.lang.String.charAt(int)",
			body: "Javadoc symbol index entry.",
		},
	]);
	expect(symbolIndex(input, "javadoc", "java.base/java.lang")[0]).toEqual({
		locator: "java.base/java/lang/package-summary.html",
		heading: "java.base/java.lang",
		body: "Javadoc symbol index entry.",
	});
});

it("rejects malformed Javadoc assignments and unsafe locators", () => {
	const unsafe = `typeSearchIndex = [
		{"p":"example","l":"Safe","u":"../outside.html"},
		{"p":"example","l":"Remote","u":"https://example.test/Remote.html"},
		{"p":"example","l":"Good","u":"example/Good.html"}
	]; alert("not run");`;
	expect(symbolIndex(unsafe, "javadoc", "example")).toEqual([
		{
			locator: "example/Good.html",
			heading: "example.Good",
			body: "Javadoc symbol index entry.",
		},
	]);
	expect(
		symbolIndex(
			'typeSearchIndex = [{"l":"broken"}; run()]',
			"javadoc",
			"broken",
		),
	).toEqual([]);
});

it("reads Doxygen tag and index XML with qualified signatures and safe refids", () => {
	const tag = `<?xml version="1.0"?>
	<tagfile><compound kind="class"><name>acme::Widget</name><filename>classacme_1_1Widget.html</filename>
	<member kind="function"><name>draw</name><arglist>(const Paint&amp; paint)</arglist><anchorfile>classacme_1_1Widget.html</anchorfile><anchor>a123</anchor></member>
	</compound></tagfile>`;
	expect(
		symbolIndex(tag, "doxygen", "acme::Widget::draw(const Paint& paint)"),
	).toEqual([
		{
			locator: "classacme_1_1Widget.html#a123",
			heading: "acme::Widget::draw(const Paint& paint)",
			body: "Doxygen symbol index entry.",
		},
	]);

	const index = `<doxygenindex><compound refid="namespaceacme" kind="namespace"><name>acme</name><member refid="namespaceacme_1aabc" kind="function"><name>start</name></member></compound></doxygenindex>`;
	expect(symbolIndex(index, "doxygen", "acme::start")).toEqual([
		{
			locator: "namespaceacme.html#aabc",
			heading: "acme::start",
			body: "Doxygen symbol index entry.",
		},
	]);
});

it("rejects Doxygen declarations and traversal paths", () => {
	const input = `<!DOCTYPE tagfile [<!ENTITY xxe SYSTEM "file:///etc/passwd">]><tagfile><compound><name>x</name><filename>../x.html</filename></compound></tagfile>`;
	expect(symbolIndex(input, "doxygen", "x")).toEqual([]);
});