test: using getForcProject instead of manually reading files (#1361)

FuelLabs · Nov 18, 2023 · e3a798f · e3a798f
1 parent d608f3e
commit e3a798f
Show file tree

Hide file tree

Showing 88 changed files with 670 additions and 418 deletions.
diff --git a/.changeset/healthy-rings-share.md b/.changeset/healthy-rings-share.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/apps/docs-snippets/projects/index.ts b/apps/docs-snippets/projects/index.ts
@@ -2,7 +2,7 @@ import { getForcProject } from '@fuel-ts/utils/test-utils';
 import type { JsonAbi } from 'fuels';
 import { join } from 'path';
 
-export enum SnippetProjectEnum {
+export enum DocSnippetProjectsEnum {
   COUNTER = 'counter',
   ECHO_ENUM = 'echo-enum',
   LOG_VALUES = 'log-values',
@@ -26,5 +26,8 @@ export enum SnippetProjectEnum {
   SCRIPT_TRANSFER_TO_CONTRACT = 'script-transfer-to-contract',
 }
 
-export const getSnippetProjectArtifacts = (project: SnippetProjectEnum) =>
-  getForcProject<JsonAbi>(join(__dirname, project));
+export const getDocsSnippetsForcProject = (project: DocSnippetProjectsEnum) =>
+  getForcProject<JsonAbi>({
+    projectDir: join(__dirname, project),
+    projectName: project,
+  });
diff --git a/apps/docs-snippets/src/guide/contracts/call-parameters.test.ts b/apps/docs-snippets/src/guide/contracts/call-parameters.test.ts
@@ -1,14 +1,14 @@
 import type { Contract, Provider } from 'fuels';
 import { BN, BaseAssetId } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;
   beforeAll(async () => {
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.RETURN_CONTEXT);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.RETURN_CONTEXT);
     provider = contract.provider;
   });
 

diff --git a/apps/docs-snippets/src/guide/contracts/calls-with-different-wallets.test.ts b/apps/docs-snippets/src/guide/contracts/calls-with-different-wallets.test.ts
@@ -1,14 +1,16 @@
 import type { Contract } from 'fuels';
 import { FUEL_NETWORK_URL, Provider, WalletUnlocked } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let deployedContract: Contract;
 
   beforeAll(async () => {
-    deployedContract = await createAndDeployContractFromProject(SnippetProjectEnum.RETURN_CONTEXT);
+    deployedContract = await createAndDeployContractFromProject(
+      DocSnippetProjectsEnum.RETURN_CONTEXT
+    );
   });
 
   it('should successfully update contract instance wallet', async () => {

diff --git a/apps/docs-snippets/src/guide/contracts/configurable-constants.test.ts b/apps/docs-snippets/src/guide/contracts/configurable-constants.test.ts
@@ -1,14 +1,14 @@
 import type { Provider, WalletUnlocked } from 'fuels';
 import { ContractFactory } from 'fuels';
 
-import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let wallet: WalletUnlocked;
 
-  const { abiContents: abi, binHexlified: bin } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.ECHO_CONFIGURABLES
+  const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.ECHO_CONFIGURABLES
   );
 
   const defaultValues = {

diff --git a/apps/docs-snippets/src/guide/contracts/contract-balance.test.ts b/apps/docs-snippets/src/guide/contracts/contract-balance.test.ts
@@ -1,7 +1,7 @@
 import type { Contract } from 'fuels';
 import { Wallet, BN, BaseAssetId, Provider, FUEL_NETWORK_URL } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
@@ -10,7 +10,7 @@ describe(__filename, () => {
 
   beforeAll(async () => {
     provider = await Provider.create(FUEL_NETWORK_URL);
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.TRANSFER_TO_ADDRESS);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.TRANSFER_TO_ADDRESS);
   });
 
   it('should successfully get a contract balance', async () => {

diff --git a/apps/docs-snippets/src/guide/contracts/cost-estimation.test.ts b/apps/docs-snippets/src/guide/contracts/cost-estimation.test.ts
@@ -1,15 +1,14 @@
-import type { Contract, Provider } from 'fuels';
-import { BaseAssetId } from 'fuels';
+import { BaseAssetId, type Contract, type Provider } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;
 
   beforeAll(async () => {
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.RETURN_CONTEXT);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.RETURN_CONTEXT);
     provider = contract.provider;
   });
 

diff --git a/apps/docs-snippets/src/guide/contracts/deploying-contracts.test.ts b/apps/docs-snippets/src/guide/contracts/deploying-contracts.test.ts
@@ -2,7 +2,7 @@ import { readFileSync } from 'fs';
 import { Provider, FUEL_NETWORK_URL, Wallet, ContractFactory } from 'fuels';
 import { join } from 'path';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
@@ -14,7 +14,8 @@ describe(__filename, () => {
     const wallet = await getTestWallet();
     PRIVATE_KEY = wallet.privateKey;
     projectsPath = join(__dirname, '../../../projects');
-    contractName = SnippetProjectEnum.ECHO_VALUES;
+
+    contractName = DocSnippetProjectsEnum.ECHO_VALUES;
   });
 
   it('should successfully deploy and execute contract function', async () => {

diff --git a/apps/docs-snippets/src/guide/contracts/index.test.ts b/apps/docs-snippets/src/guide/contracts/index.test.ts
@@ -1,13 +1,13 @@
 import type { Contract } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
 
   beforeAll(async () => {
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.ECHO_VALUES);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.ECHO_VALUES);
   });
 
   it('should successfully call contract and echo values', async () => {

diff --git a/apps/docs-snippets/src/guide/contracts/inter-contract-calls.test.ts b/apps/docs-snippets/src/guide/contracts/inter-contract-calls.test.ts
@@ -1,7 +1,7 @@
 import type { Contract, Provider, WalletUnlocked } from 'fuels';
 import { BN, ContractFactory } from 'fuels';
 
-import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
@@ -15,8 +15,8 @@ describe(__filename, () => {
     provider = wallet.provider;
     const { minGasPrice } = provider.getGasConfig();
 
-    const tokenArtifacts = getSnippetProjectArtifacts(SnippetProjectEnum.SIMPLE_TOKEN);
-    const depositorArtifacts = getSnippetProjectArtifacts(SnippetProjectEnum.TOKEN_DEPOSITOR);
+    const tokenArtifacts = getDocsSnippetsForcProject(DocSnippetProjectsEnum.SIMPLE_TOKEN);
+    const depositorArtifacts = getDocsSnippetsForcProject(DocSnippetProjectsEnum.TOKEN_DEPOSITOR);
 
     simpleToken = await new ContractFactory(
       tokenArtifacts.binHexlified,

diff --git a/apps/docs-snippets/src/guide/contracts/logs.test.ts b/apps/docs-snippets/src/guide/contracts/logs.test.ts
@@ -1,15 +1,15 @@
 import type { Contract, Provider } from 'fuels';
 import { BN } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;
 
   beforeAll(async () => {
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.LOG_VALUES);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.LOG_VALUES);
     provider = contract.provider;
   });
 

diff --git a/apps/docs-snippets/src/guide/contracts/managing-deployed-contracts.test.ts b/apps/docs-snippets/src/guide/contracts/managing-deployed-contracts.test.ts
@@ -1,15 +1,15 @@
 import type { AbstractAddress, WalletUnlocked } from 'fuels';
 import { ContractFactory, Contract } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
   let contractId: AbstractAddress;
   let wallet: WalletUnlocked;
-  const { abiContents: abi, binHexlified: bin } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.ECHO_VALUES
+  const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.ECHO_VALUES
   );
 
   beforeAll(async () => {

diff --git a/apps/docs-snippets/src/guide/contracts/multicalls.test.ts b/apps/docs-snippets/src/guide/contracts/multicalls.test.ts
@@ -1,7 +1,7 @@
 import type { Contract, Provider } from 'fuels';
 import { BaseAssetId, BN, ContractFactory } from 'fuels';
 
-import { getSnippetProjectArtifacts, SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
@@ -15,9 +15,9 @@ describe(__filename, () => {
     provider = wallet.provider;
     const { minGasPrice: gasPrice } = provider.getGasConfig();
 
-    const counterArtifacts = getSnippetProjectArtifacts(SnippetProjectEnum.COUNTER);
-    const echoArtifacts = getSnippetProjectArtifacts(SnippetProjectEnum.ECHO_VALUES);
-    const contextArtifacts = getSnippetProjectArtifacts(SnippetProjectEnum.RETURN_CONTEXT);
+    const counterArtifacts = getDocsSnippetsForcProject(DocSnippetProjectsEnum.COUNTER);
+    const echoArtifacts = getDocsSnippetsForcProject(DocSnippetProjectsEnum.ECHO_VALUES);
+    const contextArtifacts = getDocsSnippetsForcProject(DocSnippetProjectsEnum.RETURN_CONTEXT);
 
     const factory1 = new ContractFactory(
       echoArtifacts.binHexlified,

diff --git a/apps/docs-snippets/src/guide/contracts/simulate-transactions.test.ts b/apps/docs-snippets/src/guide/contracts/simulate-transactions.test.ts
@@ -1,13 +1,13 @@
 import { safeExec } from '@fuel-ts/errors/test-utils';
 import { BaseAssetId, Wallet, BN, Contract } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   it('should successfully simulate contract call with forwarded amount', async () => {
     const contract = await createAndDeployContractFromProject(
-      SnippetProjectEnum.TRANSFER_TO_ADDRESS
+      DocSnippetProjectsEnum.TRANSFER_TO_ADDRESS
     );
 
     const amountToForward = 40;
@@ -33,7 +33,7 @@ describe(__filename, () => {
   });
 
   it('should successfully execute a simulate call', async () => {
-    const contract = await createAndDeployContractFromProject(SnippetProjectEnum.ECHO_VALUES);
+    const contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.ECHO_VALUES);
 
     // #region simulate-transactions-2
     const { value } = await contract.functions.echo_u8(15).simulate();
@@ -42,9 +42,9 @@ describe(__filename, () => {
   });
 
   it('should throw when simulating with an unfunded wallet', async () => {
-    const contract = await createAndDeployContractFromProject(SnippetProjectEnum.ECHO_VALUES);
+    const contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.ECHO_VALUES);
     const unfundedWallet = Wallet.generate({ provider: contract.provider });
-    const { abiContents: abi } = getSnippetProjectArtifacts(SnippetProjectEnum.ECHO_VALUES);
+    const { abiContents: abi } = getDocsSnippetsForcProject(DocSnippetProjectsEnum.ECHO_VALUES);
     const deployedContract = new Contract(contract.id, abi, unfundedWallet);
 
     const { error } = await safeExec(() => deployedContract.functions.echo_u8(15).simulate());
@@ -53,9 +53,9 @@ describe(__filename, () => {
   });
 
   it('should throw when dry running with an unfunded wallet', async () => {
-    const contract = await createAndDeployContractFromProject(SnippetProjectEnum.ECHO_VALUES);
+    const contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.ECHO_VALUES);
     const unfundedWallet = Wallet.generate({ provider: contract.provider });
-    const { abiContents: abi } = getSnippetProjectArtifacts(SnippetProjectEnum.ECHO_VALUES);
+    const { abiContents: abi } = getDocsSnippetsForcProject(DocSnippetProjectsEnum.ECHO_VALUES);
     const deployedContract = new Contract(contract.id, abi, unfundedWallet);
 
     const { error } = await safeExec(() => deployedContract.functions.echo_u8(15).dryRun());

diff --git a/apps/docs-snippets/src/guide/contracts/transaction-parameters.test.ts b/apps/docs-snippets/src/guide/contracts/transaction-parameters.test.ts
@@ -1,14 +1,14 @@
 import type { Contract, Provider } from 'fuels';
 import { BN } from 'fuels';
 
-import { SnippetProjectEnum } from '../../../projects';
+import { DocSnippetProjectsEnum } from '../../../projects';
 import { createAndDeployContractFromProject } from '../../utils';
 
 describe(__filename, () => {
   let contract: Contract;
   let provider: Provider;
   beforeAll(async () => {
-    contract = await createAndDeployContractFromProject(SnippetProjectEnum.COUNTER);
+    contract = await createAndDeployContractFromProject(DocSnippetProjectsEnum.COUNTER);
     provider = contract.provider;
   });
 

diff --git a/apps/docs-snippets/src/guide/predicates/index.test.ts b/apps/docs-snippets/src/guide/predicates/index.test.ts
@@ -1,10 +1,10 @@
 import { FUEL_NETWORK_URL, Provider, Predicate } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 
 describe(__filename, () => {
-  const { abiContents: jsonAbi, binHexlified: binary } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.RETURN_TRUE_PREDICATE
+  const { abiContents: jsonAbi, binHexlified: binary } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.RETURN_TRUE_PREDICATE
   );
 
   it('should successfully instantiate a predicate', async () => {

diff --git a/apps/docs-snippets/src/guide/predicates/predicate-with-configurable.test.ts b/apps/docs-snippets/src/guide/predicates/predicate-with-configurable.test.ts
@@ -1,14 +1,14 @@
 import { WalletUnlocked, Predicate, BaseAssetId, BN, getRandomB256 } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let wallet: WalletUnlocked;
   let gasPrice: BN;
 
-  const { abiContents: abi, binHexlified: bin } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.WHITELISTED_ADDRESS_PREDICATE
+  const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.WHITELISTED_ADDRESS_PREDICATE
   );
 
   beforeAll(async () => {

diff --git a/apps/docs-snippets/src/guide/predicates/send-and-spend-funds-from-predicates.test.ts b/apps/docs-snippets/src/guide/predicates/send-and-spend-funds-from-predicates.test.ts
@@ -9,14 +9,14 @@ import {
   BaseAssetId,
 } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let walletWithFunds: WalletUnlocked;
   let gasPrice: BN;
-  const { abiContents: abi, binHexlified: bin } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.SIMPLE_PREDICATE
+  const { abiContents: abi, binHexlified: bin } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.SIMPLE_PREDICATE
   );
 
   beforeAll(async () => {

diff --git a/apps/docs-snippets/src/guide/scripts/script-custom-transaction.test.ts b/apps/docs-snippets/src/guide/scripts/script-custom-transaction.test.ts
@@ -1,7 +1,7 @@
 import { BN, ContractFactory, BaseAssetId, ScriptTransactionRequest } from 'fuels';
 import type { CoinQuantityLike, Contract, WalletUnlocked } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { defaultTxParams, getTestWallet } from '../../utils';
 
 describe(__filename, () => {
@@ -11,12 +11,12 @@ describe(__filename, () => {
   const assetIdB = '0x0101010101010101010101010101010101010101010101010101010101010101';
   const assetIdA = '0x0202020202020202020202020202020202020202020202020202020202020202';
 
-  const { binHexlified: scriptBin, abiContents } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.SCRIPT_TRANSFER_TO_CONTRACT
+  const { binHexlified: scriptBin, abiContents } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.SCRIPT_TRANSFER_TO_CONTRACT
   );
 
-  const { abiContents: contractAbi, binHexlified: contractBin } = getSnippetProjectArtifacts(
-    SnippetProjectEnum.ECHO_VALUES
+  const { abiContents: contractAbi, binHexlified: contractBin } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.ECHO_VALUES
   );
 
   beforeAll(async () => {

diff --git a/apps/docs-snippets/src/guide/scripts/script-with-configurable.test.ts b/apps/docs-snippets/src/guide/scripts/script-with-configurable.test.ts
@@ -1,13 +1,15 @@
 import type { WalletUnlocked } from 'fuels';
 import { Script, BN } from 'fuels';
 
-import { SnippetProjectEnum, getSnippetProjectArtifacts } from '../../../projects';
+import { DocSnippetProjectsEnum, getDocsSnippetsForcProject } from '../../../projects';
 import { getTestWallet } from '../../utils';
 
 describe(__filename, () => {
   let wallet: WalletUnlocked;
   let gasPrice: BN;
-  const { abiContents, binHexlified } = getSnippetProjectArtifacts(SnippetProjectEnum.SUM_SCRIPT);
+  const { abiContents, binHexlified } = getDocsSnippetsForcProject(
+    DocSnippetProjectsEnum.SUM_SCRIPT
+  );
 
   beforeAll(async () => {
     wallet = await getTestWallet();