feat: add test stub generation

src/bindings/writeTests.ts

@@ -0,0 +1,185 @@
+import { Writer } from "@/utils/Writer";
+import type { ABIArgument, ContractABI, ABIReceiver } from "@ton/core";
+import type { WrappersConstantDescription } from "@/bindings/writeTypescript";
+import type { CompilerContext } from "@/context/context";
+import type { TypeDescription } from "@/types/types";
+
+function getReceiverFunctionName(receiver: ABIReceiver): string {
+    const receiverType = receiver.receiver; // 'internal' or 'external'
+    const messageKind = receiver.message.kind; // 'empty', 'typed', 'text', 'any'
+
+    let name = receiverType.charAt(0).toUpperCase() + receiverType.slice(1); // Internal or External
+
+    switch (messageKind) {
+        case "empty":
+            name += "Empty";
+            break;
+        case "typed":
+            name += "Message";
+            name += receiver.message.type ?? "Typed";
+            break;
+        case "text":
+            name += "Text";
+            if (receiver.message.text) {
+                const cleanText = receiver.message.text.replace(
+                    /[^a-zA-Z0-9]/g,
+                    "",
+                );
+                name += cleanText.charAt(0).toUpperCase() + cleanText.slice(1);
+            }
+            break;
+        case "any":
+            name += "Any";
+            break;
+        default:
+            name += "Unknown";
+    }
+
+    return name;
+}
+
+export function writeTests(
+    abi: ContractABI,
+    _ctx: CompilerContext,
+    _constants: readonly WrappersConstantDescription[],
+    _contract: undefined | TypeDescription,
+    generatedContractPath: string,
+    _init?: {
+        code: string;
+        system: string | null;
+        args: ABIArgument[];
+        prefix?:
+            | {
+                  value: number;
+                  bits: number;
+              }
+            | undefined;
+    },
+) {
+    const w = new Writer();
+    const contractName = abi.name ?? "Contract";
+
+    w.write(
+        `// !!THIS FILE IS GENERATED BY TACT. THIS FILE IS REGENERATED EVERY TIME, COPY IT TO YOUR PROJECT MANUALLY!!`,
+    );
+    w.write(`// https://docs.tact-lang.org/book/debug/`);
+    w.append();
+
+    w.write(`import { ${contractName} } from './${generatedContractPath}';`);
+
+    w.write(`import { Blockchain, createShardAccount } from "@ton/sandbox";`);
+    w.append();
+
+    const FromInit = `FromInit${contractName}`;
+    w.write(`export type ${FromInit} = typeof ${contractName}.fromInit;`);
+    w.append();
+    w.write(`export type TestCase = (fromInit: ${FromInit}) => void;`);
+    w.append();
+
+    w.write(`export const test${contractName} = (fromInit: ${FromInit}) => {`);
+    w.inIndent(() => {
+        w.write(`describe("${contractName} Contract", () => {`);
+        w.inIndent(() => {
+            w.write("// Test receivers");
+            if (abi.receivers && abi.receivers.length > 0) {
+                for (const receiver of abi.receivers) {
+                    const receiverName = getReceiverFunctionName(receiver);
+                    w.write(`test${receiverName}(fromInit);`);
+                }
+            }
+            w.write("// Test getters");
+            if (abi.getters && abi.getters.length > 0) {
+                for (const getter of abi.getters) {
+                    w.write(`getterTest${getter.name}(fromInit);`);
+                }
+            }
+        });
+        w.write(`});`);
+    });
+    w.write(`};`);
+
+    w.append();
+
+    w.write(`const globalSetup = async (fromInit: ${FromInit}) => {`);
+    w.inIndent(() => {
+        w.append("const blockchain = await Blockchain.create();");
+        w.append("// @ts-ignore");
+        w.append(`const contract = await blockchain.openContract(await fromInit(
+        // TODO: implement default values
+    ));
+        `);
+
+        w.append(
+            "// Universal method for deploy contract without sending message",
+        );
+        w.append(`await blockchain.setShardAccount(contract.address, createShardAccount({
+        address: contract.address,
+        code: contract.init!.code,
+        data: contract.init!.data,
+        balance: 0n,
+        workchain: 0
+    }));
+        `);
+
+        w.append(`const owner = await blockchain.treasury("owner");`);
+        w.append(`const notOwner = await blockchain.treasury("notOwner");`);
+        w.append();
+
+        w.append(`return { blockchain, contract, owner, notOwner };`);
+    });
+    w.write("};");
+    w.append();
+
+    const generateBody = (functionName: string, name: string) => {
+        w.write(`const ${functionName}: TestCase = (fromInit) => {`);
+        w.inIndent(() => {
+            w.write(`describe("${name}", () => {`);
+            w.inIndent(() => {
+                w.write(`const setup = async () => {`);
+                w.inIndent(() => {
+                    w.write(`return await globalSetup(fromInit);`);
+                });
+                w.write(`};`);
+                w.append();
+                w.write(
+                    `// !!THIS FILE IS GENERATED BY TACT. THIS FILE IS REGENERATED EVERY TIME, COPY IT TO YOUR PROJECT MANUALLY!!`,
+                );
+                w.write(`// TODO: You can write tests for ${name} here`);
+                w.append();
+                w.write(`it("should perform correctly", async () => {`);
+                w.inIndent(() => {
+                    w.write(
+                        `const { blockchain, contract, owner, notOwner } = await setup();`,
+                    );
+                });
+                w.write(`});`);
+            });
+            w.write(`});`);
+        });
+        w.write(`};`);
+        w.append();
+    };
+
+    // Generate tests for receivers
+    if (abi.receivers && abi.receivers.length > 0) {
+        for (const receiver of abi.receivers) {
+            const receiverName = getReceiverFunctionName(receiver);
+            generateBody("test" + receiverName, receiverName);
+        }
+    }
+
+    // Generate tests for getters
+    if (abi.getters && abi.getters.length > 0) {
+        for (const getter of abi.getters) {
+            generateBody("getterTest" + getter.name, getter.name);
+        }
+    }
+
+    w.write("// entry point");
+    w.write(
+        `test${contractName}(${contractName}.fromInit.bind(${contractName}));`,
+    );
+    w.append();
+
+    return w.end();
+}

src/pipeline/build.ts

@@ -14,6 +14,7 @@ import type { TypeDescription } from "@/types/types";
 import { doPackaging } from "@/pipeline/packaging";
 import { doBindings } from "@/pipeline/bindings";
 import { doReports } from "@/pipeline/reports";
+import { doTests } from "@/pipeline/tests";
 import { createVirtualFileSystem } from "@/vfs/createVirtualFileSystem";
 import * as Stdlib from "@/stdlib/stdlib";
 
@@ -144,6 +145,11 @@ export async function build(args: {
         return BuildFail(bCtx.errorMessages);
     }
 
+    const testsRes = doTests(bCtx, packages);
+    if (!testsRes) {
+        return BuildFail(bCtx.errorMessages);
+    }
+
     const reportsRes = doReports(bCtx, packages);
     if (!reportsRes) {
         return BuildFail(bCtx.errorMessages);

src/pipeline/tests.ts

@@ -0,0 +1,49 @@
+import { writeTests } from "@/bindings/writeTests";
+import type { BuildContext } from "@/pipeline/build";
+import type { Packages } from "@/pipeline/packaging";
+
+export function doTests(bCtx: BuildContext, packages: Packages): boolean {
+    const { project, config, logger } = bCtx;
+
+    logger.info("   > Tests");
+
+    for (const pkg of packages) {
+        logger.info(`   > ${pkg.name}`);
+
+        if (pkg.init.deployment.kind !== "system-cell") {
+            const message = `   > ${pkg.name}: unsupported deployment kind ${pkg.init.deployment.kind}`;
+            logger.error(message);
+            bCtx.errorMessages.push(new Error(message));
+            return false;
+        }
+
+        try {
+            const testsCode = writeTests(
+                JSON.parse(pkg.abi),
+                bCtx.ctx,
+                bCtx.built[pkg.name]?.constants ?? [],
+                bCtx.built[pkg.name]?.contract,
+                config.name + "_" + pkg.name,
+                {
+                    code: pkg.code,
+                    prefix: pkg.init.prefix,
+                    system: pkg.init.deployment.system,
+                    args: pkg.init.args,
+                },
+            );
+            const testsPath = project.resolve(
+                config.output,
+                config.name + "_" + pkg.name + ".stub.tests.ts",
+            );
+            project.writeFile(testsPath, testsCode);
+        } catch (e) {
+            const error = e as Error;
+            error.message = `Tests generator crashed: ${error.message}`;
+            logger.error(error);
+            bCtx.errorMessages.push(error);
+            return false;
+        }
+    }
+
+    return true;
+}