fix: add generator tests

Author: friedger

Clarinet.toml

@@ -6,6 +6,11 @@ telemetry = false
 cache_dir = './.cache'
 requirements = []
 
+[contracts.annotations_test]
+path = "tests/contracts/generator-tests/annotations_test.clar"
+clarity_version = 3
+epoch = "3.1"
+
 [repl.analysis]
 passes = ['check_checker']
 

deployments/default.simnet-plan.yaml

@@ -56,4 +56,12 @@ genesis:
     - cost-voting
     - bns
 plan:
-  batches: []
+  batches:
+    - id: 0
+      transactions:
+        - emulated-contract-publish:
+            contract-name: annotations_test
+            emulated-sender: ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM
+            path: tests/contracts/generator-tests/annotations_test.clar
+            clarity-version: 3
+      epoch: "3.1"

src/clarunit-generator.ts

@@ -1,15 +1,13 @@
 import { Simnet, tx } from "@hirosystems/clarinet-sdk";
 import { describe, it } from "vitest";
-import {
-  extractTestAnnotations,
-} from "./parser/clarity-parser";
+import { extractTestAnnotations } from "./parser/clarity-parser";
 import { expectOkTrue, isValidTestFunction } from "./parser/test-helpers";
 import { FunctionAnnotations } from "./parser/clarity-parser-flow-tests";
 
 /**
  * Returns true if the contract is a test contract
  * @param contractName name of the contract
- * @returns 
+ * @returns
  */
 function isTestContract(contractName: string) {
   return (
@@ -44,10 +42,11 @@ export function generateUnitTests(simnet: Simnet) {
           annotations[functionName] || {};
 
         const mineBlocksBefore =
-          parseInt(annotations["mine-blocks-before"] as string) || 0;
+          parseInt(functionAnnotations["mine-blocks-before"] as string) || 0;
 
-        const testDescription = `${functionCall.name}${functionAnnotations.name ? `: ${functionAnnotations.name}` : ""
-          }`;
+        const testDescription = `${functionCall.name}${
+          functionAnnotations.name ? `: ${functionAnnotations.name}` : ""
+        }`;
         it(testDescription, () => {
           // handle prepare function for this test
           if (hasDefaultPrepareFunction && !functionAnnotations.prepare)
@@ -56,11 +55,13 @@ export function generateUnitTests(simnet: Simnet) {
             delete functionAnnotations.prepare;
 
           // handle caller address for this test
-          const callerAddress = functionAnnotations.caller && typeof functionAnnotations.caller === "string"
-            ? functionAnnotations.caller[0] === "'"
-              ? `${(functionAnnotations.caller as string).substring(1)}`
-              : accounts.get(functionAnnotations.caller)!
-            : accounts.get("deployer")!;
+          const callerAddress =
+            functionAnnotations.caller &&
+            typeof functionAnnotations.caller === "string"
+              ? functionAnnotations.caller[0] === "'"
+                ? `${(functionAnnotations.caller as string).substring(1)}`
+                : accounts.get(functionAnnotations.caller)!
+              : accounts.get("deployer")!;
 
           if (functionAnnotations.prepare) {
             // mine block with prepare function call

tests/clarunit.test.ts

@@ -0,0 +1,3 @@
+import { clarunit } from "../src/index";
+
+clarunit(simnet);

tests/contracts/generator-tests/annotations_test.clar

@@ -0,0 +1,27 @@
+
+;; test block-height at launch
+;; One block is need to advance to epoch 2.5
+(define-public (test-block-height-at-launch)
+    (begin
+        (asserts! (is-eq u3 stacks-block-height) (err (concat "expected block height 3, found " (int-to-ascii stacks-block-height))))
+        (ok true)))
+
+;; @mine-blocks-before 10
+(define-public (test-mine-blocks-before)
+    (begin
+        (asserts! (is-eq u13 stacks-block-height) (err (concat "expected block height 13, found " (int-to-ascii stacks-block-height))))
+        (ok true)))
+
+;; @caller wallet_1
+(define-public (test-caller)
+    (begin
+        (asserts! (is-eq tx-sender 'ST1SJ3DTE5DN7X54YDH5D64R3BCB6A2AG2ZQ8YPD5) (err tx-sender))
+        (asserts! (is-eq contract-caller 'ST1SJ3DTE5DN7X54YDH5D64R3BCB6A2AG2ZQ8YPD5) (err contract-caller))
+        (ok true)))
+
+;; @caller 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE
+(define-public (test-caller-2)
+    (begin
+        (asserts! (is-eq tx-sender 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE) (err tx-sender))
+        (asserts! (is-eq contract-caller 'SP3FBR2AGK5H9QBDH3EEN6DF8EK8JY7RX8QJ5SVTE) (err contract-caller))
+        (ok true)))