test: Add test fixture for running Algorand TypeScript code on chain

examples/voting/contract.algo.ts

@@ -33,7 +33,6 @@ const BOX_BYTE_MIN_BALANCE: uint64 = 400
 // The min balance increase for each asset opted into
 const ASSET_MIN_BALANCE: uint64 = 100000
 
-// TODO: ObjectPType should hopefully respect this ordering of properties
 type VotingPreconditions = {
   is_voting_open: uint64
   is_allowed_to_vote: uint64

package.json

@@ -14,7 +14,7 @@
     "dev:calculator": "tsx src/cli.ts build examples/calculator/contract.algo.ts",
     "dev:approvals": "tsx src/cli.ts build tests/approvals --output-awst --output-awst-json --no-output-teal --output-ssa-ir --out-dir out/[name]",
     "dev:expected-output": "tsx src/cli.ts build tests/expected-output --dry-run",
-    "dev:testing": "tsx src/cli.ts build tests/approvals/destructuring-iterators.algo.ts --output-awst --output-awst-json --log-level=info --log-level debug",
+    "dev:testing": "tsx src/cli.ts build tests/expected-output/cant-create.algo.ts --output-awst --output-awst-json --log-level=info --log-level debug",
     "audit": "better-npm-audit audit",
     "format": "prettier --write .",
     "lint": "eslint \"src/**/*.ts\"",
@@ -45,6 +45,7 @@
   "author": "Algorand foundation",
   "license": "MIT",
   "devDependencies": {
+    "@algorandfoundation/algokit-utils": "^7.0.0-beta.7",
     "@algorandfoundation/algorand-typescript": "file:packages/algo-ts/dist",
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",

src/util/generate-temp-file.ts

@@ -1,8 +1,10 @@
 import { randomUUID } from 'crypto'
 import fs from 'fs'
+import { globIterateSync } from 'glob'
 import type { WriteFileOptions } from 'node:fs'
-import path from 'node:path'
 import os from 'os'
+import upath from 'upath'
+import { mkDirIfNotExists } from './index'
 
 export type TempFile = {
   writeFileSync(data: NodeJS.ArrayBufferView, options?: WriteFileOptions): void
@@ -11,14 +13,14 @@ export type TempFile = {
 } & Disposable
 
 function ensureTempDir(): string {
-  const tempDir = path.join(os.tmpdir(), 'puya-ts')
-  if (!fs.existsSync(tempDir)) fs.mkdirSync(tempDir)
+  const tempDir = upath.join(os.tmpdir(), 'puya-ts')
+  mkDirIfNotExists(tempDir)
   return tempDir
 }
 
 export function generateTempFile(options?: { ext?: string }): TempFile {
   const { ext = 'tmp' } = options ?? {}
-  const filePath = path.join(ensureTempDir(), `${randomUUID()}.${ext}`)
+  const filePath = upath.join(ensureTempDir(), `${randomUUID()}.${ext}`)
 
   return {
     get filePath() {
@@ -32,3 +34,28 @@ export function generateTempFile(options?: { ext?: string }): TempFile {
     },
   }
 }
+export type TempDir = {
+  readonly dirPath: string
+  files(): IterableIterator<string>
+} & Disposable
+
+export function generateTempDir(): TempDir {
+  const dirPath = upath.join(ensureTempDir(), `${randomUUID()}`)
+  mkDirIfNotExists(dirPath)
+
+  return {
+    get dirPath() {
+      return dirPath
+    },
+    *files(): IterableIterator<string> {
+      for (const p of globIterateSync(upath.join(dirPath, '**'), {
+        nodir: true,
+      })) {
+        yield p
+      }
+    },
+    [Symbol.dispose]() {
+      fs.rmSync(dirPath, { recursive: true, force: true })
+    },
+  }
+}

tests/onchain/abi-decorators.spec.ts

@@ -0,0 +1,15 @@
+import { describe } from 'vitest'
+import { createTestFixture } from './util/test-fixture'
+
+describe('abi-decorators', () => {
+  const test = createTestFixture('tests/approvals/abi-decorators.algo.ts', { createParams: { method: 'createMethod' } })
+  test('can be created', async ({ appFactory }) => {
+    await appFactory.send.create({ method: 'createMethod' })
+  })
+  test('methods can be called', async ({ appClient, expect }) => {
+    await appClient.send.call({ method: 'justNoop' })
+    await appClient.send.call({ method: 'allActions', onComplete: 1 })
+    const { return: returnValue } = await appClient.send.call({ method: 'overrideReadonlyName' })
+    expect(returnValue).toBe(5n)
+  })
+})