Merge pull request #42 from algorandfoundation/refactor/fixture

refactor: use algorandFixture for more reliable test execution

Author: boblat

package-lock.json

@@ -25,7 +25,7 @@
     "build-examples": "rollup --config examples/rollup.config.ts --configPlugin typescript"
   },
   "devDependencies": {
-    "@algorandfoundation/algokit-utils": "^8.0.3",
+    "@algorandfoundation/algokit-utils": "^8.1.0",
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
     "@eslint/eslintrc": "3.1.0",
@@ -64,8 +64,8 @@
     "tslib": "^2.6.2"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.11",
-    "@algorandfoundation/puya-ts": "^1.0.0-beta.13",
+    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.13",
+    "@algorandfoundation/puya-ts": "^1.0.0-beta.15",
     "elliptic": "^6.5.7",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",

package.json

@@ -1,5 +1,6 @@
 import { internal } from '@algorandfoundation/algorand-typescript'
 
+export { addEqualityTesters } from './set-up'
 export { TestExecutionContext } from './test-execution-context'
 export const encodingUtil = {
   ...internal.encodingUtil,

src/index.ts

@@ -11,7 +11,7 @@ interface ExpectObj {
   addEqualityTesters: (testers: Array<Tester>) => void
 }
 
-function addEqualityTesters(expectObj: ExpectObj) {
+function doAddEqualityTesters(expectObj: ExpectObj) {
   expectObj.addEqualityTesters([
     function IsSamePrimitiveTypeAndValue(this: TesterContext, subject, test, customTesters): boolean | undefined {
       const subjectIsPrimitive = subject instanceof internal.primitives.AlgoTsPrimitiveCls
@@ -44,7 +44,8 @@ function addEqualityTesters(expectObj: ExpectObj) {
     },
     function BytesPrimitiveIsArray(this: TesterContext, subject, test, customTesters): boolean | undefined {
       if (subject instanceof internal.primitives.BytesCls) {
-        const testValue = Array.isArray(test) && test.every((i) => typeof i === 'number') ? new Uint8Array(test) : undefined
+        const testValue =
+          Array.isArray(test) && test.every((i) => typeof i === 'number' && i >= 0 && i < 256) ? new Uint8Array(test) : undefined
         if (testValue !== undefined) return this.equals(subject.asUint8Array(), testValue, customTesters)
         return undefined
       }
@@ -108,6 +109,6 @@ function addEqualityTesters(expectObj: ExpectObj) {
   ])
 }
 
-export function setUpTests({ expect }: { expect: ExpectObj }) {
-  addEqualityTesters(expect)
+export function addEqualityTesters({ expect }: { expect: ExpectObj }) {
+  doAddEqualityTesters(expect)
 }

src/set-up.ts

@@ -3,18 +3,7 @@ import { internal } from '@algorandfoundation/algorand-typescript'
 import { captureMethodConfig } from './abi-metadata'
 import { DEFAULT_TEMPLATE_VAR_PREFIX } from './constants'
 import type { DecodedLogs, LogDecoding } from './decode-logs'
-import { ApplicationTxn, AssetConfigTxn, AssetFreezeTxn, AssetTransferTxn, KeyRegistrationTxn, PaymentTxn, Transaction } from './impl/gtxn'
-import {
-  applicationCall as itxnApplicationCall,
-  assetConfig as itxnAssetConfig,
-  assetFreeze as itxnAssetFreeze,
-  assetTransfer as itxnAssetTransfer,
-  keyRegistration as itxnKeyRegistration,
-  payment as itxnPayment,
-  submitGroup as itxnSubmitGroup,
-} from './impl/inner-transactions'
-import { Account } from './impl/reference'
-import { Box, BoxMap, BoxRef, GlobalState, LocalState } from './impl/state'
+import { Account, AccountCls } from './impl/reference'
 import { ContractContext } from './subcontexts/contract-context'
 import { LedgerContext } from './subcontexts/ledger-context'
 import { TransactionContext } from './subcontexts/transaction-context'
@@ -67,47 +56,14 @@ export class TestExecutionContext implements internal.ExecutionContext {
     return this.#defaultSender
   }
 
-  /* @internal */
-  get abiMetadata() {
-    return {
-      captureMethodConfig,
-    }
+  set defaultSender(val: bytes | AccountType) {
+    this.#defaultSender = val instanceof AccountCls ? val : Account(val as bytes)
   }
 
   /* @internal */
-  get gtxn() {
-    return {
-      Transaction,
-      PaymentTxn,
-      KeyRegistrationTxn,
-      AssetConfigTxn,
-      AssetTransferTxn,
-      AssetFreezeTxn,
-      ApplicationTxn,
-    }
-  }
-
-  /* @internal */
-  get itxn() {
-    return {
-      submitGroup: itxnSubmitGroup,
-      payment: itxnPayment,
-      keyRegistration: itxnKeyRegistration,
-      assetConfig: itxnAssetConfig,
-      assetTransfer: itxnAssetTransfer,
-      assetFreeze: itxnAssetFreeze,
-      applicationCall: itxnApplicationCall,
-    }
-  }
-
-  /* @internal */
-  get state() {
+  get abiMetadata() {
     return {
-      GlobalState,
-      LocalState,
-      Box,
-      BoxMap,
-      BoxRef,
+      captureMethodConfig,
     }
   }
 

src/test-execution-context.ts

@@ -1,49 +1,66 @@
-import type { AppSpec } from '@algorandfoundation/algokit-utils/types/app-spec'
 import { Bytes } from '@algorandfoundation/algorand-typescript'
 import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
 import { Bool, interpretAsArc4 } from '@algorandfoundation/algorand-typescript/arc4'
-import { afterEach, describe, expect, test } from 'vitest'
+import { afterEach, beforeAll, describe, expect } from 'vitest'
 import { ABI_RETURN_VALUE_LOG_PREFIX } from '../../src/constants'
 import { asUint8Array } from '../../src/util'
-import appSpecJson from '../artifacts/arc4-primitive-ops/data/Arc4PrimitiveOpsContract.arc32.json'
-import { getAlgorandAppClient, getAvmResult } from '../avm-invoker'
+import { getAvmResult } from '../avm-invoker'
+import { createArc4TestFixture } from '../test-fixture'
 
 describe('arc4.Bool', async () => {
-  const appClient = await getAlgorandAppClient(appSpecJson as AppSpec)
+  const [test, localnetFixture] = createArc4TestFixture('tests/artifacts/arc4-primitive-ops/data/Arc4PrimitiveOpsContract.arc56.json', {
+    Arc4PrimitiveOpsContract: { deployParams: { createParams: { extraProgramPages: undefined } } },
+  })
   const ctx = new TestExecutionContext()
 
+  beforeAll(async () => {
+    await localnetFixture.newScope()
+  })
+
   afterEach(() => {
     ctx.reset()
   })
 
-  test.each([true, false])('should be able to get bytes representation of %s', async (value) => {
-    const avmResult = await getAvmResult({ appClient }, 'verify_bool_bytes', value)
-    const result = new Bool(value)
-    expect(result.bytes).toEqual(avmResult)
-  })
+  test.for([true, false])(
+    'should be able to get bytes representation of %s',
+    async (value, { appClientArc4PrimitiveOpsContract: appClient }) => {
+      const avmResult = await getAvmResult({ appClient }, 'verify_bool_bytes', value)
+      const result = new Bool(value)
+      expect(result.bytes).toEqual(avmResult)
+    },
+  )
 
-  test.each([asUint8Array(Bytes.fromHex('00')), asUint8Array(Bytes.fromHex('80'))])('create Bool from bytes', async (value) => {
-    const avmResult = await getAvmResult({ appClient }, 'verify_bool_from_bytes', value)
-    const result = interpretAsArc4<Bool>(Bytes(value))
-    expect(result.native).toEqual(avmResult)
-  })
+  test.for([asUint8Array(Bytes.fromHex('00')), asUint8Array(Bytes.fromHex('80'))])(
+    'create Bool from bytes',
+    async (value, { appClientArc4PrimitiveOpsContract: appClient }) => {
+      const avmResult = await getAvmResult({ appClient }, 'verify_bool_from_bytes', value)
+      const result = interpretAsArc4<Bool>(Bytes(value))
+      expect(result.native).toEqual(avmResult)
+    },
+  )
 
-  test.each([asUint8Array(Bytes.fromHex('00')), asUint8Array(Bytes.fromHex('80'))])('create Bool from log', async (value) => {
-    const paddedValue = new Uint8Array([...asUint8Array(ABI_RETURN_VALUE_LOG_PREFIX), ...value])
-    const avmResult = await getAvmResult({ appClient }, 'verify_bool_from_log', paddedValue)
-    const result = interpretAsArc4<Bool>(Bytes(paddedValue), 'log')
-    expect(result.native).toEqual(avmResult)
-  })
+  test.for([asUint8Array(Bytes.fromHex('00')), asUint8Array(Bytes.fromHex('80'))])(
+    'create Bool from log',
+    async (value, { appClientArc4PrimitiveOpsContract: appClient }) => {
+      const paddedValue = new Uint8Array([...asUint8Array(ABI_RETURN_VALUE_LOG_PREFIX), ...value])
+      const avmResult = await getAvmResult({ appClient }, 'verify_bool_from_log', paddedValue)
+      const result = interpretAsArc4<Bool>(Bytes(paddedValue), 'log')
+      expect(result.native).toEqual(avmResult)
+    },
+  )
 
-  test.each([
+  test.for([
     [asUint8Array(Bytes.fromHex('00')), asUint8Array('')],
     [asUint8Array(Bytes.fromHex('80')), asUint8Array(Bytes.fromHex('ff000102'))],
     [asUint8Array(Bytes.fromHex('00')), asUint8Array(ABI_RETURN_VALUE_LOG_PREFIX.slice(0, 3))],
-  ])('should throw error when log prefix is invalid for Bool', async (value, prefix) => {
-    const paddedValue = new Uint8Array([...prefix, ...value])
-    await expect(() => getAvmResult({ appClient }, 'verify_bool_from_log', paddedValue)).rejects.toThrowError(
-      new RegExp('(assert failed)|(extraction start \\d+ is beyond length)'),
-    )
-    expect(() => interpretAsArc4<Bool>(Bytes(paddedValue), 'log')).toThrowError('ABI return prefix not found')
-  })
+  ])(
+    'should throw error when log prefix is invalid for Bool',
+    async ([value, prefix], { appClientArc4PrimitiveOpsContract: appClient }) => {
+      const paddedValue = new Uint8Array([...prefix, ...value])
+      await expect(() => getAvmResult({ appClient }, 'verify_bool_from_log', paddedValue)).rejects.toThrowError(
+        new RegExp('(has valid prefix)|(extraction start \\d+ is beyond length)'),
+      )
+      expect(() => interpretAsArc4<Bool>(Bytes(paddedValue), 'log')).toThrowError('ABI return prefix not found')
+    },
+  )
 })