feat: implement browser testing

.changeset/rare-snails-shave.md

@@ -0,0 +1,5 @@
+---
+"docs": patch
+---
+
+Migrate from Jest to Vitest

.github/actions/test-setup/action.yaml

@@ -31,4 +31,4 @@ runs:
 
     - name: Build
       run: pnpm build
-      shell: bash
+      shell: bash

.github/workflows/test.yaml

@@ -18,6 +18,11 @@ jobs:
 
   test:
     runs-on: ubuntu-latest
+    name: ${{ matrix.env }}
+    strategy:
+      fail-fast: false
+      matrix:
+        env: [node]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -38,40 +43,84 @@ jobs:
       - name: Lint
         run: pnpm lint
 
+      - name: Validate Tests
+        run: pnpm test:validate
+
+      - name: Run Tests - ${{ matrix.env }}
+        run: pnpm ci:test --${{ matrix.env }}
+
+      - name: Upload Coverage - ${{ matrix.env }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ matrix.env }}
+          path: coverage/environments/${{ matrix.env }}
+
+  report:
+    runs-on: ubuntu-latest
+    needs: [test]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: CI Setup
+        uses: ./.github/actions/test-setup
+
+      - name: Generate Coverage Directory
+        run: mkdir -p coverage/environments
+
+      - name: Download Coverage Artifact for Node Tests
+        uses: actions/download-artifact@v3
+        with:
+          name: node
+          path: coverage/environments
+
+      - name: Generate Coverage
+        run: pnpm test:coverage-merge
+
       - name: Find PR Number
         uses: jwalton/gh-find-current-pr@v1
         id: findPr
 
-      - name: Run tests and collect coverage
-        if: ${{ !steps.findPr.outputs.number }}
-        run: pnpm ci:test -- --json --coverage --testLocationInResults --outputFile=report.master.json
-
-      - name: Upload coverage to Github artifacts
+      - name: Upload Master Coverage Artifact
         uses: actions/upload-artifact@v3
         if: ${{ !steps.findPr.outputs.number }}
         with:
-          name: coverage-reports
-          path: report.master.json
+          name: coverage-master
+          path: coverage/report
 
-      - name: Download coverage artifact
+      - name: Download Master Coverage Artifact
         uses: dawidd6/action-download-artifact@v2
-        if: ${{ steps.findPr.outputs.number }}
+        # TODO: Remove PR != check once #1310 has been merged
+        if: ${{ (steps.findPr.outputs.number) && (steps.findPr.outputs.number != 1310)}}
         with:
           workflow: test.yaml
           branch: master
-          name: coverage-reports
-          path: coverage-reports
+          name: coverage-master
+          path: coverage-master
 
-      - name: Run tests and post reports to PR
-        uses: ArtiomTr/jest-coverage-report-action@v2
+      # TODO: Delete once #1310 has been merged
+      - name: Download Master Coverage Artifact (temporary)
+        uses: dawidd6/action-download-artifact@v2
+        if: ${{ (steps.findPr.outputs.number) && (steps.findPr.outputs.number == 1310)}}
+        with:
+          workflow: test.yaml
+          run_id: 6628340271
+          name: coverage-master
+          path: coverage-master
+
+      - name: Generate Coverage Diff
+        run: pnpm test:coverage-diff
+
+      - name: Report Coverage
+        uses: thollander/actions-comment-pull-request@v2
         if: ${{ steps.findPr.outputs.number }}
         with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          package-manager: pnpm
-          annotations: failed-tests
-          test-script: pnpm ci:test
-          prnumber: ${{ steps.findPr.outputs.number }}
-          base-coverage-file: coverage-reports/report.master.json
+          filePath: coverage/report/coverage-diff.txt
+          pr_number: ${{ (steps.findPr.outputs.number) }}
+          comment_tag: diff
+          mode: recreate
+          create_if_not_exists: true
+
   live-tests:
     name: Run Live Tests
     if: github.head_ref == 'changeset-release/master'

.nycrc

@@ -0,0 +1,4 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "reporter": ["json-summary"]
+}

.vscode/extensions.json

@@ -1,6 +1,6 @@
 {
   "recommendations": [
-    "orta.vscode-jest",
+    "ZixuanChen.vitest-explorer",
     "esbenp.prettier-vscode",
     "dbaeumer.vscode-eslint"
   ]

CONTRIBUTING.md

@@ -107,14 +107,17 @@ And then run the tests in another terminal tab:
 # run all tests
 pnpm test
 
-# run tests while passing other flags to sub-program
-pnpm test -- --coverage --my-other-flag
+# watch all tests
+pnpm test:watch
 
 # run tests for a specific package
-pnpm test packages/my-desired-package
+pnpm test:filter packages/my-desired-package
 
 # run tests for a specific file
-pnpm test packages/my-desired-package/src/my.test.ts
+pnpm test:filter packages/my-desired-package/src/my.test.ts
+
+# run tests while passing other flags to sub-program
+pnpm test -- --coverage --my-other-flag
 ```
 
 Or if you want to start a local Fuel-Core node and run all tests serially you can do:

apps/demo-fuels/src/index.test.ts

@@ -14,6 +14,10 @@ import { SampleAbi__factory } from './sway-programs-api';
 import bytecode from './sway-programs-api/contracts/SampleAbi.hex';
 
 let gasPrice: BN;
+
+/**
+ * @group node
+ */
 describe('ExampleContract', () => {
   beforeAll(async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);

apps/demo-fuels/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../tsdoc.base.json"]
+}

apps/demo-typegen/contract/src/main.sw

@@ -1,4 +1,4 @@
-// #region Testing-with-jest-rust
+// #region Testing-in-ts-rust
 contract;
 
 abi DemoContract {
@@ -10,4 +10,4 @@ impl DemoContract for Contract {
         input
     }
 }
-// #endregion Testing-with-jest-rust
+// #endregion Testing-in-ts-rust

apps/demo-typegen/src/demo.test.ts

@@ -1,4 +1,4 @@
-// #region Testing-with-jest-ts
+// #region Testing-in-ts-ts
 import { safeExec } from '@fuel-ts/errors/test-utils';
 import { generateTestWallet } from '@fuel-ts/wallet/test-utils';
 import type { BN } from 'fuels';
@@ -8,11 +8,16 @@ import { DemoContractAbi__factory } from './generated-types';
 import bytecode from './generated-types/DemoContractAbi.hex';
 
 let gasPrice: BN;
+
+/**
+ * @group node
+ */
 describe('ExampleContract', () => {
   beforeAll(async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);
     ({ minGasPrice: gasPrice } = provider.getGasConfig());
   });
+
   it('should return the input', async () => {
     const provider = await Provider.create(FUEL_NETWORK_URL);
     const wallet = await generateTestWallet(provider, [[500_000, BaseAssetId]]);
@@ -50,7 +55,7 @@ describe('ExampleContract', () => {
     expect(value.toHex()).toEqual(toHex(1337));
   });
 });
-// #endregion Testing-with-jest-ts
+// #endregion Testing-in-ts-ts
 
 it('should throw when simulating via contract factory with wallet with no resources', async () => {
   const provider = await Provider.create(FUEL_NETWORK_URL);

apps/demo-typegen/tsdoc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../tsdoc.base.json"]
+}

apps/docs-snippets/src/guide/contracts/call-parameters.test.ts

@@ -4,6 +4,9 @@ import { BN, BaseAssetId } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;

apps/docs-snippets/src/guide/contracts/calls-with-different-wallets.test.ts

@@ -4,6 +4,9 @@ import { FUEL_NETWORK_URL, Provider, WalletUnlocked } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let deployedContract: Contract;
 

apps/docs-snippets/src/guide/contracts/configurable-constants.test.ts

@@ -4,6 +4,9 @@ import { ContractFactory } from 'fuels';
 import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let wallet: WalletUnlocked;
 

apps/docs-snippets/src/guide/contracts/contract-balance.test.ts

@@ -4,6 +4,9 @@ import { Wallet, BN, BaseAssetId, Provider, FUEL_NETWORK_URL } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;

apps/docs-snippets/src/guide/contracts/cost-estimation.test.ts

@@ -4,6 +4,9 @@ import { BaseAssetId } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;

apps/docs-snippets/src/guide/contracts/deploying-contracts.test.ts

@@ -5,6 +5,9 @@ import { join } from 'path';
 import { SnippetProjectEnum } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let PRIVATE_KEY: string;
   let projectsPath: string;

apps/docs-snippets/src/guide/contracts/index.test.ts

@@ -3,6 +3,9 @@ import type { Contract } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
 

apps/docs-snippets/src/guide/contracts/inter-contract-calls.test.ts

@@ -4,6 +4,9 @@ import { BN, ContractFactory } from 'fuels';
 import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let wallet: WalletUnlocked;
   let simpleToken: Contract;

apps/docs-snippets/src/guide/contracts/logs.test.ts

@@ -4,6 +4,9 @@ import { BN } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;

apps/docs-snippets/src/guide/contracts/managing-deployed-contracts.test.ts

@@ -4,6 +4,9 @@ import { ContractFactory, Contract } from 'fuels';
 import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let contractId: AbstractAddress;

apps/docs-snippets/src/guide/contracts/multicalls.test.ts

@@ -4,6 +4,9 @@ import { BaseAssetId, BN, ContractFactory } from 'fuels';
 import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let echoContract: Contract;
   let counterContract: Contract;

apps/docs-snippets/src/guide/contracts/simulate-transactions.test.ts

@@ -4,6 +4,9 @@ import { BaseAssetId, Wallet, BN, Contract } from 'fuels';
 import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   it('should successfully simulate contract call with forwarded amount', async () => {
     const contract = await createAndDeployContractFromProject(

apps/docs-snippets/src/guide/contracts/transaction-parameters.test.ts

@@ -4,6 +4,9 @@ import { BN } from 'fuels';
 import { SnippetProjectEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;

apps/docs-snippets/src/guide/predicates/index.test.ts

@@ -2,6 +2,9 @@ import { FUEL_NETWORK_URL, Provider, Predicate } from 'fuels';
 
 import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
 
+/**
+ * @group node
+ */
 describe(__filename, () => {
   const { abiContents: jsonAbi, binHexlified: binary } = getSnippetProjectArtifacts(
     SnippetProjectEnum.RETURN_TRUE_PREDICATE