add button action tests

Author: mProjectsCode

bun.lockb

@@ -49,7 +49,8 @@
 		"svelte-check": "^3.6.4",
 		"svelte-preprocess": "^5.1.3",
 		"tslib": "2.6.2",
-		"typescript": "^5.3.3"
+		"typescript": "^5.3.3",
+		"yaml": "^2.4.1"
 	},
 	"dependencies": {
 		"@codemirror/legacy-modes": "^6.3.3",

package.json

@@ -223,6 +223,17 @@ export abstract class InternalAPI<Plugin extends IPlugin> {
 
 	abstract writeFilePath(filePath: string, content: string): Promise<void>;
 
+	/**
+	 * Create a file in the given folder with the given name and extension.
+	 * If the name is already taken, a number will be appended to the name.
+	 *
+	 * @param folderPath the path to the folder
+	 * @param fileName the name of the file
+	 * @param extension the extension of the file
+	 * @param open
+	 *
+	 * @returns the path to the created file
+	 */
 	abstract createFile(folderPath: string, fileName: string, extension: string, open?: boolean): Promise<string>;
 
 	abstract createContextMenu(items: ContextMenuItemDefinition[]): IContextMenu;

packages/core/src/api/InternalAPI.ts

@@ -154,7 +154,7 @@ export class ButtonActionRunner {
 	 * @param position the position of the button in the note
 	 */
 	async runAction(
-		config: ButtonConfig,
+		config: ButtonConfig | undefined,
 		action: ButtonAction,
 		filePath: string,
 		inline: boolean,
@@ -207,7 +207,7 @@ export class ButtonActionRunner {
 		this.plugin.internal.executeCommandById(action.command);
 	}
 
-	async runJSAction(config: ButtonConfig, action: JSButtonAction, filePath: string): Promise<void> {
+	async runJSAction(config: ButtonConfig | undefined, action: JSButtonAction, filePath: string): Promise<void> {
 		const configOverrides: Record<string, unknown> = {
 			buttonConfig: config,
 			args: action.args,

packages/core/src/fields/button/ButtonActionRunner.ts

@@ -0,0 +1,69 @@
+export class TestFileSystem {
+	files: Map<string, string>;
+
+	constructor() {
+		this.files = new Map();
+	}
+
+	readFile(path: string): string {
+		this.validateFilePath(path);
+
+		let fileContent = this.files.get(path);
+		if (fileContent === undefined) {
+			throw new Error(`File not found: ${path}`);
+		}
+		return fileContent;
+	}
+
+	writeFile(path: string, content: string): void {
+		this.validateFilePath(path);
+
+		this.files.set(path, content);
+	}
+
+	deleteFile(path: string): void {
+		this.validateFilePath(path);
+
+		if (!this.fileExists(path)) {
+			throw new Error(`File does not exist: ${path}`);
+		}
+
+		this.files.delete(path);
+	}
+
+	listFiles(): string[] {
+		return Array.from(this.files.keys());
+	}
+
+	fileExists(path: string): boolean {
+		this.validateFilePath(path);
+
+		return this.files.has(path);
+	}
+
+	listDirs(): string[] {
+		const dirs = new Set<string>();
+
+		for (const path of this.files.keys()) {
+			const parts = path.split('/');
+			parts.pop();
+			dirs.add(parts.join('/'));
+		}
+
+		return Array.from(dirs);
+	}
+
+	validateFilePath(path: string): void {
+		if (path === '') {
+			throw new Error('Invalid file path');
+		}
+
+		const parts = path.split('/');
+
+		for (const part of parts) {
+			if (part === '' || part === '.' || part === '..') {
+				throw new Error('Invalid file path');
+			}
+		}
+	}
+}

tests/__mocks__/TestFileSystem.ts

@@ -12,9 +12,18 @@ import { ModalContent } from 'packages/core/src/modals/ModalContent';
 import { IModal } from 'packages/core/src/modals/IModal';
 import { SelectModalContent } from 'packages/core/src/modals/SelectModalContent';
 import { ContextMenuItemDefinition, IContextMenu } from 'packages/core/src/utils/IContextMenu';
-import { undefined } from 'zod';
+import { TestFileSystem } from 'tests/__mocks__/TestFileSystem';
+import YAML from 'yaml';
 
 export class TestInternalAPI extends InternalAPI<TestPlugin> {
+	fileSystem: TestFileSystem;
+
+	constructor(plugin: TestPlugin) {
+		super(plugin);
+
+		this.fileSystem = new TestFileSystem();
+	}
+
 	public async renderMarkdown(markdown: string, element: HTMLElement, _filePath: string): Promise<() => void> {
 		element.innerText += markdown;
 		return () => {};
@@ -53,12 +62,12 @@ export class TestInternalAPI extends InternalAPI<TestPlugin> {
 
 	public showNotice(_: string): void {}
 
-	public parseYaml(_yaml: string): unknown {
-		return {};
+	public parseYaml(yaml: string): unknown {
+		return YAML.parse(yaml) as unknown;
 	}
 
-	public stringifyYaml(_yaml: unknown): string {
-		return '';
+	public stringifyYaml(yaml: unknown): string {
+		return YAML.stringify(yaml);
 	}
 
 	public setIcon(_element: HTMLElement, _icon: string): void {}
@@ -84,11 +93,11 @@ export class TestInternalAPI extends InternalAPI<TestPlugin> {
 	}
 
 	public getAllFiles(): string[] {
-		return [];
+		return this.fileSystem.listFiles();
 	}
 
 	public getAllFolders(): string[] {
-		return [];
+		return this.fileSystem.listDirs();
 	}
 
 	public getImageSuggesterOptions(_inputField: ImageSuggesterIPF): SuggesterOption<string>[] {
@@ -99,16 +108,18 @@ export class TestInternalAPI extends InternalAPI<TestPlugin> {
 		return [];
 	}
 
-	public readFilePath(_filePath: string): Promise<string> {
-		return Promise.resolve('');
+	public async readFilePath(filePath: string): Promise<string> {
+		return this.fileSystem.readFile(filePath);
 	}
 
-	public writeFilePath(_filePath: string, _content: string): Promise<void> {
-		return Promise.resolve();
+	public async writeFilePath(filePath: string, content: string): Promise<void> {
+		this.fileSystem.writeFile(filePath, content);
 	}
 
-	public createFile(_folderPath: string, _fileName: string, _extension: string, _open?: boolean): Promise<string> {
-		return Promise.resolve('');
+	public async createFile(folderPath: string, fileName: string, extension: string, _open?: boolean): Promise<string> {
+		const filePath = `${folderPath}/${fileName}.${extension}`;
+		this.fileSystem.writeFile(filePath, '');
+		return filePath;
 	}
 
 	public createContextMenu(_items: ContextMenuItemDefinition[]): IContextMenu {