feat: add testing to create-fuels

.changeset/shaggy-houses-remember.md

@@ -0,0 +1,5 @@
+---
+"create-fuels": patch
+---
+
+feat: add testing to `create-fuels`

apps/docs/src/guide/creating-a-fuel-dapp/index.md

@@ -199,6 +199,8 @@ Whenever you want to add a new feature to your dApp and quickly prototype things
 
 - If you want to deploy your dApp to the testnet, check out our [Deploying a dApp to Testnet](./deploying-a-dapp-to-testnet.md) guide.
 
+- If you want to further validate the functionality of your dApp and program types, check out the `test` directory in your `create fuels` project. Couple this with our [testing guide](https://docs.fuel.network/docs/fuels-ts/testing/) to get a better understanding of how to test your dApp.
+
 - If you have any questions or need help, feel free to reach out to us on the [Official Fuel Forum](https://forum.fuel.network/).
 
 - If you want to learn more about the Fuel Stack, check out the [Fuel Docs](https://docs.fuel.network/).

scripts/tests-find.sh

@@ -2,7 +2,7 @@
 
 ROOT=$(cd "$(dirname "$0")/.."; pwd)
 
-FILES=$(find $ROOT/{apps,packages,internal} -name '*.test.ts')
+FILES=$(find $ROOT/{apps,packages,internal,templates} -name '*.test.ts')
 
 if [[ $* == *--all* ]]; then
   grep -lE "@group\s+(node|browser|e2e)" $FILES

templates/nextjs/package.json

@@ -31,6 +31,7 @@
     "eslint-config-next": "14.2.4",
     "postcss": "^8",
     "tailwindcss": "^3.4.4",
-    "typescript": "^5"
+    "typescript": "^5",
+    "vitest": "^1.6.0"
   }
 }

templates/nextjs/test/contract.test.ts

@@ -0,0 +1,59 @@
+import { launchTestNode } from 'fuels/test-utils';
+
+import { describe, test, expect } from 'vitest';
+
+/**
+ * Imports for the contract factory and bytecode, so that we can use them in the test.
+ *
+ * Can't find these imports? Make sure you've run `fuels build` to generate these with typegen.
+ */
+import { TestContractAbi__factory } from '../src/sway-api';
+import bytecode from '../src/sway-api/contracts/TestContractAbi.hex';
+
+/**
+ * @group node
+ *
+ * Tests for the contract program type within the TS SDK. Here we will test the deployment of
+ * our contract, and the result of call it's functions.
+ */
+describe('Contract', () => {
+  test('Deploy and Call', async () => {
+    // First, we'll launch a test node, passing the contract factory and bytecode. This will deploy the contract
+    // to our test node so we can test against it.
+    using launched = await launchTestNode({
+      contractsConfigs: [
+        {
+          deployer: TestContractAbi__factory,
+          bytecode,
+        },
+      ],
+    });
+
+    // We can now destructure the contract, provider, and wallets from the launched object.
+    const {
+      contracts: [contract],
+    } = launched;
+
+    // Lets setup some values to use in the test.
+    const initialCount = 0;
+    const incrementedCount = 5;
+
+    // We can now call the contract functions and test the results. Lets assert the initial value of the counter.
+    const { waitForResult: initWaitForResult } = await contract.functions.get_count().call();
+    const { value: initValue } = await initWaitForResult();
+    expect(initValue.toNumber()).toBe(initialCount);
+
+    // Next, we'll increment the counter by 5 and assert the new value.
+    const { waitForResult: incrementWaitForResult } = await contract.functions
+      .increment_counter(incrementedCount)
+      .call();
+    const { value: incrementValue } = await incrementWaitForResult();
+    expect(incrementValue.toNumber()).toBe(incrementedCount);
+
+    // Finally, we'll test the get count function again to ensure parity.
+    const { waitForResult: finalWaitForResult } = await contract.functions.get_count().call();
+    const { value: finalValue } = await finalWaitForResult();
+    expect(finalValue.toNumber()).toBe(incrementedCount);
+    expect(initValue.toNumber()).toBeLessThan(finalValue.toNumber());
+  });
+});

templates/nextjs/test/predicate.test.ts

@@ -0,0 +1,63 @@
+import { launchTestNode } from 'fuels/test-utils';
+
+import { describe, test, expect } from 'vitest';
+
+/**
+ * Import for the predicate factory and input data type, so that we can use them in the test.
+ *
+ * Can't find these imports? Make sure you've run `fuels build` to generate these with typegen.
+ */
+import { TestPredicateAbi__factory, TestPredicateAbiInputs } from '../src/sway-api';
+
+/**
+ * @group node
+ *
+ * Tests for the predicate program type within the TS SDK. Here we will test the use of our predicate
+ * in a transaction.
+ */
+describe('Predicate', () => {
+  test('Transaction', async () => {
+    // First, we'll launch a test node to use for our predicate transaction.
+    using launched = await launchTestNode();
+
+    // We can now destructure the provider and the sender and receiver wallet from the launched object.
+    const {
+      wallets: [sender, receiver],
+      provider,
+    } = launched;
+
+    // For a predicate, we need to pass in an argument to evaluate the predicate.
+    const predicateData: TestPredicateAbiInputs = [1337];
+
+    // Now, we can instantiate our predicate.
+    const predicate = TestPredicateAbi__factory.createInstance(provider, predicateData);
+
+    // Lets also setup some transfer values to assert against.
+    const amountToPredicate = 250_000;
+    const amountToReceiver = 50_000;
+
+    // Lets also get the initial balance of the receiver wallet to assert against.
+    const initialReceiverBalance = await receiver.getBalance();
+
+    // We can now transfer some assets to the predicate.
+    const setupTx = await sender.transfer(predicate.address, amountToPredicate);
+    await setupTx.waitForResult();
+
+    // And we'll assert it's value to confirm success of the transfer.
+    const predicateBalance = await predicate.getBalance();
+    expect(predicateBalance.toNumber()).toBe(amountToPredicate);
+
+    // Now we can transfer assets from the predicate to the receiver.
+    const tx = await predicate.transfer(receiver.address, amountToReceiver);
+    const { isStatusSuccess } = await tx.waitForResult();
+    expect(isStatusSuccess).toBe(true);
+
+    // Then get our receivers final balance.
+    const finalReceiverBalance = await receiver.getBalance();
+
+    // And lastly we'll assert all the values to confirm the success of the predicate transfer.
+    expect(finalReceiverBalance.toNumber()).toBe(
+      initialReceiverBalance.add(amountToReceiver).toNumber()
+    );
+  });
+});

templates/nextjs/test/script.test.ts

@@ -0,0 +1,39 @@
+import { launchTestNode } from 'fuels/test-utils';
+
+import { describe, test, expect } from 'vitest';
+
+/**
+ * Import for the script factory, so that we can use them in the test.
+ *
+ * Can't find these imports? Make sure you've run `fuels build` to generate these with typegen.
+ */
+import { TestScriptAbi__factory } from '../src/sway-api';
+
+/**
+ * @group node
+ *
+ * Tests for the script program type within the TS SDK. Here we will test the use of our script
+ * function call.
+ */
+describe('Script', () => {
+  test('Call', async () => {
+    // First, we'll launch a test node to use for our script transaction.
+    using launched = await launchTestNode();
+
+    // We can now destructure the sender wallet from the launched object.
+    const {
+      wallets: [sender],
+    } = launched;
+
+    // Now, we can instantiate our script.
+    const script = TestScriptAbi__factory.createInstance(sender);
+
+    // Lets also setup a value to use in the test.
+    const expectedValue = 1337;
+
+    // We can now call the script function and assert the result.
+    const { waitForResult } = await script.functions.main(expectedValue).call();
+    const { value } = await waitForResult();
+    expect(value.toNumber()).toBe(expectedValue);
+  });
+});