Improve test naming (#571)

* test: 514: improve test naming to specify which involve mock, testnet, solo, or combine them

* fix: from instead caller

* fix: test names

* feat: check tests naming script

* fix: add exit code

* fix: correct exit condition and naming correctly last test

* fix: 514-improve-test-naming merged files conflicting with main: command not found

* fix: update contributing guidelines for tests

---------

Co-authored-by: ldebiasi <luca.nicola.debiasi@gmail.com>
Co-authored-by: rodolfopietro97 <rodolfo@rodolfopietro.it>
Co-authored-by: Rodolfo Pietro Calabrò <33911400+rodolfopietro97@users.noreply.github.com>
Co-authored-by: Luca Debiasi <ldebiasi@x1e.ht.home>

Author: 4 people

.github/CONTRIBUTING.md

@@ -4,3 +4,4 @@
 yarn build
 yarn lint
 yarn test:unit && git add docs
+yarn check-tests-naming

.husky/pre-commit

@@ -8,29 +8,21 @@
     "scripts": {
         "start-thor-solo": "echo 'Starting thor solo node ...' && docker compose up -d --wait && echo '\nThor solo node started ...'",
         "stop-thor-solo": "echo 'Stopping thor solo node ...' && docker compose down && echo 'Thor solo node stopped ...'",
-
         "postinstall": "husky install",
-
         "build": "turbo build",
-
         "generate:apidocs": "typedoc --options typedoc.json --logLevel Error",
         "generate:apidocs-debug": "typedoc --options typedoc.json --logLevel Verbose --plugin typedoc-plugin-missing-exports --validation.notDocumented",
-
         "lint": "turbo lint",
         "format": "turbo format",
-
         "test:unit": "turbo test:unit",
-
         "test:integration": "turbo test:integration",
         "test:integration:solo": "(yarn start-thor-solo && yarn test:integration && yarn stop-thor-solo) || yarn stop-thor-solo",
-
         "test:examples": "turbo test:examples",
         "test:examples:solo": "(yarn start-thor-solo && yarn test:examples && yarn stop-thor-solo) || yarn stop-thor-solo",
-
         "test": "turbo test --force && yarn merge-coverage",
         "test:solo": "(yarn start-thor-solo && yarn test && yarn stop-thor-solo) || yarn stop-thor-solo",
-
-        "merge-coverage": "ts-node scripts/merge-coverage.ts"
+        "merge-coverage": "ts-node scripts/merge-coverage.ts",
+        "check-tests-naming": "ts-node scripts/check-tests-naming.ts"
     },
     "private": true,
     "workspaces": [
@@ -53,6 +45,7 @@
         "eslint-plugin-prettier": "^5.1.3",
         "eslint-plugin-promise": "^6.0.0",
         "fs-extra": "^11.2.0",
+        "glob": "^10.3.10",
         "husky": "^9.0.11",
         "jest": "^29.7.0",
         "jest-docblock": "^29",

package.json

@@ -12,7 +12,7 @@ describe('ThorClient - Nodes Module', () => {
      */
     test('Should get nodes', async () => {
         /**
-         *  client required to access a node
+         *  client required accessing a node
          *  @internal
          */
         const thorClient = new ThorClient(testNetwork);

packages/core/tests/abi/abi.test.ts packages/core/tests/abi/abi.unit.test.ts

@@ -26,7 +26,7 @@ const TIMEOUT = 15000; // 15-second timeout
  *
  * @group integration/utils/subscriptions
  */
-describe('Subscriptions Solo', () => {
+describe('Subscriptions Solo network tests', () => {
     test(
         'Should receive new blocks from the block subscription',
         async () => {

packages/core/tests/abi/contract.test.ts packages/core/tests/abi/contract.unit.test.ts

@@ -14,7 +14,7 @@ import { testnetUrl } from '../../fixture';
 /**
  * Test suite for the Subscriptions utility methods for getting the subscription URLs
  *
- * @group unit/utils/subscriptions
+ * @group integration/utils/subscriptions
  */
 describe('Subscriptions Testnet', () => {
     /**

packages/core/tests/address/address.test.ts packages/core/tests/address/address.unit.test.ts

@@ -1,7 +1,7 @@
 import { beforeEach, describe, expect, test } from '@jest/globals';
 import { RPC_METHODS, RPCMethodsMap, VechainProvider } from '../../../../src';
 import { ThorClient } from '@vechain/vechain-sdk-network';
-import { testNetwork, THOR_SOLO_ACCOUNTS_BASE_WALLET } from '../../../fixture';
+import { soloNetwork, THOR_SOLO_ACCOUNTS_BASE_WALLET } from '../../../fixture';
 import { type Wallet } from '@vechain/vechain-sdk-wallet';
 
 /**
@@ -25,7 +25,7 @@ describe('RPC Mapper - eth_accounts method tests', () => {
      */
     beforeEach(() => {
         // Init thor client
-        thorClient = new ThorClient(testNetwork);
+        thorClient = new ThorClient(soloNetwork);
 
         // Init provider
         provider = new VechainProvider(

packages/core/tests/bloom/bloom.test.ts packages/core/tests/bloom/bloom.unit.test.ts

@@ -1,7 +1,7 @@
 import { beforeEach, describe, expect, test } from '@jest/globals';
 import { RPC_METHODS, RPCMethodsMap, VechainProvider } from '../../../../src';
 import { ThorClient } from '@vechain/vechain-sdk-network';
-import { testNetwork, THOR_SOLO_ACCOUNTS_BASE_WALLET } from '../../../fixture';
+import { soloNetwork, THOR_SOLO_ACCOUNTS_BASE_WALLET } from '../../../fixture';
 import { type Wallet, type WalletAccount } from '@vechain/vechain-sdk-wallet';
 import { ProviderRpcError } from '@vechain/vechain-sdk-errors';
 
@@ -26,7 +26,7 @@ describe('RPC Mapper - eth_requestAccounts method tests', () => {
      */
     beforeEach(() => {
         // Init thor client
-        thorClient = new ThorClient(testNetwork);
+        thorClient = new ThorClient(soloNetwork);
 
         // Init provider
         provider = new VechainProvider(

packages/core/tests/certificate/certificate.test.ts packages/core/tests/certificate/certificate.unit.test.ts

@@ -0,0 +1,62 @@
+// Define the glob pattern
+import { glob } from 'glob';
+
+/**
+ * Pattern to match all test files starting from the root of the project
+ */
+const test_pattern = './packages/**/**/*.test.ts';
+
+/**
+ * Allowed names for test files
+ */
+const allowed_names = [
+    // Unit tests
+    '.unit.test.ts',
+
+    // Integration tests
+    '.testnet.test.ts',
+    '.mainnet.test.ts',
+    '.solo.test.ts',
+
+    // Mocks
+    '.mock.testnet.ts',
+    '.mock.mainnet.ts',
+    '.mock.solo.ts'
+];
+
+/**
+ * Exit with error code 1 if any test file is not named correctly.
+ * The Default exit code is 0.
+ * As good programmers, we assume we're naming tests correctly :D
+ */
+let exit_code = 0;
+
+/**
+ * Get all test files
+ */
+glob(test_pattern, { ignore: 'node_modules/**' }).then((test_files) => {
+    /**
+     * Iterate over all test files to check if they are named correctly
+     */
+    test_files.forEach((file) => {
+        // File naming is not ok by default
+        let file_naming_ok = false;
+
+        /**
+         * Iterate over all allowed names to check if the file is named correctly
+         */
+        allowed_names.forEach((allowed_name) => {
+            if (file.endsWith(allowed_name)) {
+                file_naming_ok = true;
+            }
+        });
+
+        if (!file_naming_ok) {
+            console.error(`Test file \`${file}\` is not named correctly`);
+            exit_code = 1;
+        }
+    });
+
+    // Exit with the correct code
+    process.exit(exit_code);
+});