Convert examples to Jest instead of using ESM loader (#144)

Author: jribbink

.changeset/selfish-turtles-do.md

@@ -0,0 +1,5 @@
+---
+"@onflow/flow-js-testing": patch
+---
+
+Convert examples to run in Jest environment instead of ESM loader

.github/workflows/ci.yml

@@ -13,7 +13,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+
+      # gallium is the v16 lts
+      - name: Setup Node.js lts/gallium
+        uses: actions/setup-node@v2
+        with:
+          node-version: lts/gallium
+
       - name: Cache Node.js modules
         uses: actions/cache@v2
         with:
@@ -23,6 +29,7 @@ jobs:
           restore-keys: |
             ${{ runner.OS }}-node-
             ${{ runner.OS }}-
+
       - name: Install Flow CLI
         run: brew install flow-cli
       - name: Install dependencies

examples/01-get-account-address.js examples/01-get-account-address.test.jsexamples/01-get-account-address.js renamed to examples/01-get-account-address.test.js

@@ -1,14 +1,20 @@
 import path from "path"
 import {init, emulator, getAccountAddress} from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("get account address", async () => {
   const Alice = await getAccountAddress("Alice")
-  console.log({Alice})
 
+  // Expect Alice to be address of Alice's account
+  expect(Alice).toMatch(/^0x[0-9a-f]{16}$/)
+})
+
+afterEach(async () => {
   await emulator.stop()
-})()
+})

examples/02-deploy-contract-by-name.js …mples/02-deploy-contract-by-name.test.jsexamples/02-deploy-contract-by-name.js renamed to examples/02-deploy-contract-by-name.test.js examples/02-deploy-contract-by-name.js renamed to examples/02-deploy-contract-by-name.test.js

@@ -1,14 +1,16 @@
 import path from "path"
 import {init, emulator, deployContractByName, executeScript} from "../src"
 
-;(async () => {
+beforeEach(async () => {
   // Init framework
   const basePath = path.resolve(__dirname, "./cadence")
   await init(basePath)
 
   // Start Emulator
   await emulator.start()
+})
 
+test("deploy contract by name", async () => {
   // Deploy contract Greeting with single argument
   await deployContractByName({
     name: "Greeting",
@@ -25,7 +27,7 @@ import {init, emulator, deployContractByName, executeScript} from "../src"
       } 
   `,
   })
-  console.log({greetingMessage})
+  expect(greetingMessage).toBe("Hello from Emulator")
 
   // Deploy contract Hello with no arguments
   await deployContractByName({name: "Hello"})
@@ -38,8 +40,10 @@ import {init, emulator, deployContractByName, executeScript} from "../src"
       }
     `,
   })
-  console.log({helloMessage})
+  expect(helloMessage).toBe("Hi!")
+})
 
+afterEach(async () => {
   // Stop Emulator
   await emulator.stop()
-})()
+})

examples/03-deploy-contract.js examples/03-deploy-contract.test.jsexamples/03-deploy-contract.js renamed to examples/03-deploy-contract.test.js

@@ -7,12 +7,14 @@ import {
   executeScript,
 } from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "../cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("deploy contract", async () => {
   // We can specify, which account will hold the contract
   const to = await getAccountAddress("Alice")
 
@@ -37,7 +39,9 @@ import {
       }
     `,
   })
-  console.log({balance})
+  expect(balance).toBe(1337)
+})
 
+afterEach(async () => {
   await emulator.stop()
-})()
+})

examples/04-get-contract-address.js examples/04-get-contract-address.test.jsexamples/04-get-contract-address.js renamed to examples/04-get-contract-address.test.js

@@ -1,18 +1,24 @@
 import path from "path"
 import {init, emulator, deployContractByName, getContractAddress} from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("get contract address", async () => {
   // if we omit "to" it will be deployed to Service Account
   // but let's pretend we don't know where it will be deployed :)
   await deployContractByName({name: "Hello"})
 
   const contractAddress = await getContractAddress("Hello")
-  console.log({contractAddress})
 
+  // Expect contractAddress to be address
+  expect(contractAddress).toMatch(/^0x[0-9a-f]{16}$/)
+})
+
+afterEach(async () => {
   await emulator.stop()
-})()
+})

examples/05-emulator-management.js examples/05-emulator-management.test.jsexamples/05-emulator-management.js renamed to examples/05-emulator-management.test.js

@@ -1,20 +1,11 @@
 import path from "path"
+import {clearInterval} from "timers"
 import {emulator, init, executeScript} from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
-  await init(basePath)
 
-  // Let's define simple method to log message to emulator console
-  const logMessage = async message => {
-    return executeScript({
-      code: `
-        pub fun main(){
-          log("------------> ${message}")
-        }
-      `,
-    })
-  }
+  await init(basePath)
 
   // Let's enable logging initially
   const logging = true
@@ -26,7 +17,20 @@ import {emulator, init, executeScript} from "../src"
 
   // Start emulator instance on available ports
   await emulator.start({logging})
+})
 
+// eslint-disable-next-line jest/expect-expect
+test("emulator management", async () => {
+  // Let's define simple method to log message to emulator console
+  const logMessage = async message => {
+    return executeScript({
+      code: `
+        pub fun main(){
+          log("------------> ${message}")
+        }
+      `,
+    })
+  }
   // This line will be visible in emulator output
   emulator.setLogging(true)
   await logMessage("Now you see me...")
@@ -46,6 +50,9 @@ import {emulator, init, executeScript} from "../src"
 
   // Then silently turn it off
   emulator.setLogging(false)
+})
+
+afterEach(async () => {
   // Stop running emulator
   await emulator.stop()
-})()
+})

examples/06-flow-management.js examples/06-flow-management.test.jsexamples/06-flow-management.js renamed to examples/06-flow-management.test.js

@@ -7,25 +7,28 @@ import {
   mintFlow,
 } from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("flow management", async () => {
   // Get address for account with alias "Alice"
   const Alice = await getAccountAddress("Alice")
 
   // Get initial balance
   const [initialBalance] = await getFlowBalance(Alice)
-  console.log({initialBalance})
+  expect(initialBalance).toBe("0.00100000")
 
   // Add 1.0 FLOW tokens to Alice account
   await mintFlow(Alice, "1.0")
 
   // Check updated balance
   const [updatedBalance] = await getFlowBalance(Alice)
-  console.log({updatedBalance})
+  const expectedBalance = parseFloat(initialBalance) + 1.0
+  expect(parseFloat(updatedBalance)).toBe(expectedBalance)
 
   await emulator.stop()
-})()
+})

examples/07-block-offset.js examples/07-block-offset.test.jsexamples/07-block-offset.js renamed to examples/07-block-offset.test.js

@@ -8,14 +8,16 @@ import {
   executeScript,
 } from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("block offset", async () => {
   const [initialBlockOffset] = await getBlockOffset()
-  console.log({initialBlockOffset})
+  expect(initialBlockOffset).toBe(0)
 
   // "getCurrentBlock().height" in your Cadence code will be replaced by Manager to a mocked value
   const code = `
@@ -26,20 +28,22 @@ import {
 
   // We can check that non-transformed code still works just fine
   const [normalResult] = await executeScript({code})
-  console.log({normalResult})
+  expect(normalResult).toBe(1)
 
   // Offset current block height by 42
   await setBlockOffset(42)
   // Let's check that offset value on Manager is actually changed to 42
   const [blockOffset] = await getBlockOffset()
-  console.log({blockOffset})
+  expect(blockOffset).toBe(42)
 
   // "transformers" field expects array of functions to operate update the code.
   // We will pass single operator "builtInMethods" provided by the framework to alter how getCurrentBlock().height is calculated
   const transformers = [builtInMethods]
   const [transformedResult] = await executeScript({code, transformers})
-  console.log({transformedResult})
+  expect(transformedResult).toBe(44)
+})
 
+afterEach(async () => {
   // Stop the emulator
   await emulator.stop()
-})()
+})

examples/08-execute-script.js examples/08-execute-script.test.jsexamples/08-execute-script.js renamed to examples/08-execute-script.test.js

@@ -1,12 +1,14 @@
 import path from "path"
 import {init, emulator, executeScript} from "../src"
 
-;(async () => {
+beforeEach(async () => {
   const basePath = path.resolve(__dirname, "./cadence")
 
   await init(basePath)
   await emulator.start()
+})
 
+test("execute script", async () => {
   // We have created a file called "log-args.cdc" under "./cadence/scripts" folder.
   // It's available for use since we configured framework to use "./cadence" folder as root
   const code = `
@@ -39,13 +41,15 @@ import {init, emulator, executeScript} from "../src"
 
   const [fromCode] = await executeScript({code, args})
   const [fromFile] = await executeScript({name, args})
-  console.log({fromCode})
-  console.log({fromFile})
+  expect(fromCode).toBe(fromFile)
+  expect(fromCode).toBe(42)
 
   // "executeScript" also supports short form, accepting name of the file in "scripts folder
   // and array of arguments
   const [shortForm] = await executeScript("hello")
-  console.log({shortForm})
+  expect(shortForm).toBe("Hello from Cadence")
+})
 
+afterEach(async () => {
   await emulator.stop()
-})()
+})