SYS-334 - Testing and Coverage Report Generation

.babelrc

@@ -0,0 +1,7 @@
+{
+    "presets": [
+      ["@babel/preset-env", { "targets": { "node": "current" } }],
+      "@babel/preset-typescript"
+    ]
+  }
+

.gitignore

@@ -13,3 +13,4 @@ config.js
 dist/
 .idea/
 .DS_Store
+.test/

README.md

@@ -1,3 +1,11 @@
+<p align="center">
+    <img src="https://github.com/shardeum/.github/raw/dev/shardeum-white-bg.png" alt="Shardeum Logo" width="70%">
+</p>
+
+<p align="center">
+    <h2 align="center">Shardeum is an EVM based autoscaling blockchain</h2>
+</p>
+
 # Overview
 
 The Shardeum JSON-RPC Server enables developers to interact with the Shardeum blockchain network. It allows dapps to post request, retrieve information, and other related operations, using JSON-RPC over HTTP. Additionally, the Shardeum JSON-RPC Server comes with an added REST API for debugging and monitoring purposes.
@@ -29,15 +37,15 @@ docker compose logs -f
 docker compose down
 ```
 
-# Developer Environment Setup
+## Developer Environment Setup
 
 For end users, such as exchanges and large decentralized applications (dApps), seeking to deploy their own RPC server, it is recommended to run the Shardeum JSON-RPC server using Docker. It ensures all dependencies are installed and the server is running in a consistent environment. For developers who want to contribute to this project, running the server from source is recommended. You can use `npm` for installing the server locally.
 
-## Requirements
+### Requirements
 
 If you are using `Docker`, in order to run the Shardeum JSON-RPC server, you must have the [Docker](https://docs.docker.com/get-docker/) daemon installed.
 
-## Installing project source code
+### Installing project source code
 
 Let’s install the project source code, switch to `dev` branch and follow the below instructions:
 
@@ -86,7 +94,42 @@ port: 8080
 
 The RPC URL for using Metamask with Remix IDE and for running scripts is <http://localhost:port> (default: <http://localhost:8080>)
 
-If you are contributing to this project, use Shardeum server to create the network from within the [validator repo](https://gitlab.com/shardus/archive/archive-server). You can find more details [here](https://github.com/shardeum/shardeum)
+If you are contributing to this project, use Shardeum server to create the network. You can find more details [here](https://github.com/shardeum/shardeum)
+
+## Running Tests
+
+There are two ways to set up the testing environment for the JSON RPC Server: Manual setup and using a Bash script.
+
+### Setting Up the Test Environment Manually
+
+Follow these steps to set up your local environment for testing:
+
+1. Run the Shardeum network locally (find instructions in the [Shardeum Readme.md](https://github.com/shardeum/shardeum/blob/dev/README.md) file).
+2. Once your network is running, visit `localhost:4000/cycleinfo/1` to see your network's details.
+3. Wait until the network enters processing mode, which happens when the active nodes in the network equals the minimum amount of nodes required (usually around cycle counter 12-14).
+4. Once the network is in processing mode, start the JSON RPC server with `npm run start`.
+5. Open a new terminal tab and run the tests with `npm run test` to see the test results.
+
+### Using the Bash Script
+
+The Bash script simplifies the process of setting up the test environment. It's particularly useful if you haven't already configured the Shardeum network and the JSON RPC server locally, though it can also be used if you have. The script will manage both situations and execute the tests for you.
+
+To run the script:
+
+1. Clone and set up the JSON RPC Server locally.
+2. Navigate to the root of the project: `cd json-rpc-server`.
+3. Execute the script:
+   - Run `npm local:test ~/root/path/to/your/shardeum/project` - If you already have the Shardeum repo installed locally.
+   - Run `npm local:test` - If you'd prefer the script to set one up for you.
+   - The script will creat a test environment path `/.test` and set up the Shardeum network there.
+4. It will then start a network of 10 nodes along with the JSON RPC server, and finally run the test suite.
+5. Tests involving transactions on the network will fail if your local network has fewer than 5 active nodes.
+   To address this, you can increase the wait time in the script to more than 10 minutes.
+   This will give the network sufficient time to reach processing mode with at least 5 active nodes.
+
+A test account with a hardcoded private key is provided in the tests, ensuring that your tests should pass without any extra configuration.
+
+> For detailed information about the tests, check the test document in the `src/__tests__/integration/TEST.md` file and the individual test files located in `src/__tests__`. Each test file contains specific tests for different parts of the JSON-RPC methods.
 
 ## Cleanup
 
@@ -104,7 +147,7 @@ make clean
 
 This will remove all docker images created by the server during the build process.
 
-# DEBUG Endpoints
+## DEBUG Endpoints
 
 These api are protected preventing general public to wiping out debug data to authenticate use `/authenticate/:passphrase`. `passphrase` is set in `config.ts` config file or within the system env variable.
 
@@ -127,6 +170,10 @@ GET `/cleanStatTable` this endpoint trigger purging of table that store interfac
 
 GET `/cleanTxTable` this endpoint trigger purging of table that store transaction logging
 
-# Contributing
+## Contributing
 
 Contributions are very welcome! Everyone interacting in our codebases, issue trackers, and any other form of communication, including chat rooms and mailing lists, is expected to follow our [code of conduct](CODE_OF_CONDUCT.md) so we can all enjoy the effort we put into this project.
+
+## Community
+
+For chatting with others using Shardeum: [Join the Shardeum Discord Server](https://discord.com/invite/shardeum)

TEST.md

@@ -0,0 +1,53 @@
+# Shardeum Automated Testing Documentation
+
+## Overview
+
+This documentation covers the setup and execution of automated tests for JSON-RPC methods in the Shardeum JSON RPC Server. The goal is to ensure that Shardeum's implementation adheres to expected behaviors in handling blockchain transactions via JSON-RPC.
+
+## Goals
+
+- Test all JSON-RPC functions to ensure that they perform as expected.
+- Verify the Shardus network connectivity and functionality.
+- Ensure proper transaction handling and balance updates.
+
+## Test Script Overview
+
+The test script is designed to prepare an environment that is suitable for running the JSON RPC tests. Here is a breakdown of its functionality:
+
+1. **Environment Preparation**:
+
+   - Checks for and uses NVM (Node Version Manager).
+   - Installs Node.js v18.16.1 if not present.
+   - Installs Rust if missing (version 1.74.1).
+   - Installs necessary build tools (build-essential on Linux, gcc on macOS).
+
+2. **Repository Management**:
+
+   - Uses an existing Shardeum project if specified, otherwise it clones a fresh copy from the Shardeum repository.
+   - Applies a debug patch for 10-node setup.
+
+3. **Dependency Installation**:
+
+   - Runs `npm ci` to install all project dependencies.
+   - Installs the Shardus CLI tool and the Shardus Archiver if not found.
+
+4. **Network Initialization**:
+   - Starts a Shardus network with 10 nodes.
+   - Waits for 4 minutes to allow network stabilization.
+   - Runs the tests
+
+### Test Execution
+
+Once the environment is set up, the tests are executed using Jest. These tests primarily interact with the `extendedServer` instance defined in the `server.ts` file. It handles JSON-RPC requests and performs the blockchain operations in the tests. Each test file imports its own instance of the RPC server and executes against it.
+
+Each RPC call has its own test file in the `src/__tests__` directory. Each file contains multiple test cases covering different aspects and edge cases for each RPC method.
+
+### Run Tests
+
+The tests typically run automatically through the test script, however, you can run the tests manually by executing the `npm test` command in the JSON RPC Server project. [More on how to run tests here ](https://github.com/shardeum/json-rpc-server/blob/localtest/README.md#running-tests).
+
+## Expand the Test Suite
+
+- **Add New Tests**: New tests can be added by creating new test files under the `src/__tests__` directory. Each new file should mimic the structure of existing tests, initializing its setup, defining the RPC calls, and tearing down after tests.
+- **Modifying Existing Tests**: To modify existing tests, locate the relevant test file and add or adjust test cases as needed. Be mindful of potential side effects on other tests due to shared state or network conditions.
+- **Enhancing Test Coverage**: Increase coverage by adding more scenarios and edge cases, particularly focusing on error handling and failure modes.

jest.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    testMatch: ['**/__tests__/**/*.test.ts'],
+    moduleNameMapper: {
+      '^@/(.*)$': '<rootDir>/src/$1'
+    },
+    testTimeout: 20000,
+    collectCoverage: true,
+    coverageDirectory: 'coverage',
+    coverageReporters: ['text', 'lcov'],
+    coveragePathIgnorePatterns: [
+      "/node_modules/",
+      "/dist/",
+      "/src/server.js" 
+    ],
+    transform: {
+      "^.+\\.(ts|tsx)$": "ts-jest",
+    },
+  };
+