Skip to content

TESTING.md

Latest commit

 

History

History
390 lines (297 loc) · 8.68 KB

TESTING.md

File metadata and controls

390 lines (297 loc) · 8.68 KB

Testing Guide - Saiv Platform

Complete testing documentation for smart contracts and backend API.

📊 Test Summary

Smart Contract Tests

  • Total Tests: 129 tests
  • Passing: 129 tests ✅ (100% pass rate)
  • Framework: Hardhat + Chai
  • Line Coverage: 94.62% 🎯
  • Branch Coverage: 72.46%
  • Function Coverage: 95.59%

Coverage Breakdown:

  • AddressManager: 100% ✅
  • GroupPool: 96.23%
  • UserWallet: 87.18%
  • ERC20Mock: 66.67% (test helper)

Backend API Tests

  • Total Tests: 11 tests
  • Passing: 11 tests ✅ (100% pass rate)
  • Framework: Jest + Supertest
  • Coverage: Endpoints and auth flows

🔧 Smart Contract Tests

Setup

cd contract
npm install
npx hardhat compile

Running Tests

# Run all tests
npx hardhat test

# Run specific test file
npx hardhat test test/AddressManager.test.js

# Run with gas reporting
REPORT_GAS=true npx hardhat test

# Run with coverage
npx hardhat coverage

Test Coverage

AddressManager Contract

Deployment Tests ✅

  • ✅ Should set the right owner
  • ✅ Should deploy UserWallet implementation
  • ✅ Should deploy GroupPool implementation

User Wallet Creation ✅

  • ✅ Should create user wallets successfully
  • ✅ Should fail for zero address
  • ✅ Should prevent duplicate wallets
  • ✅ Should track total wallets

Email User Wallets ✅

  • ✅ Should create email user wallets
  • ✅ Should fail with invalid email hash
  • ✅ Should prevent duplicate email wallets

Group Pool Management ✅

  • ✅ Should create group pool
  • ✅ Should fail with empty identifier
  • ✅ Should fail with zero owner
  • ✅ Should prevent duplicate pools
  • ✅ Should track total pools

Access Control ✅

  • ✅ Should restrict operations to owner
  • ✅ Should allow ownership transfer
  • ✅ Should prevent unauthorized transfers

Gas Usage Report

·------------------------------------|------------|-------------|-------------·
|  Contract                          |  Min       |  Max        |  Avg        |
·------------------------------------|------------|-------------|-------------·
|  AddressManager                    |            |             |  5,447,318  |
·------------------------------------|------------|-------------|-------------·
|  createUserWallets                 |  350,246   |  367,358    |    364,507  |
|  createGroupPool                   |  394,783   |  412,090    |    408,596  |
|  createEmailUserWallets            |  -         |  -          |    367,887  |
·------------------------------------|------------|-------------|-------------·

Key Insights:

  • User wallet creation: ~364k gas
  • Group pool creation: ~408k gas
  • Deployment: ~5.4M gas

🌐 Backend API Tests

Setup

cd backend
npm install

Running Tests

# Run all tests
npm test

# Run in watch mode
npm run test:watch

# Run with coverage
npm run test:coverage

Test Coverage

Health & Status Endpoints ✅

  • ✅ GET / - Returns API info
  • ✅ GET /api/health - Returns OK status
  • ✅ GET /api - Lists all endpoints

Gas Service Endpoints ✅

  • ✅ GET /api/gas/status - Returns gasless status
  • ✅ GET /api/gas/estimates - Returns gas cost estimates

Authentication Endpoints ✅

  • ✅ POST /api/auth/register/email - Validates email requirement
  • ✅ POST /api/auth/register/wallet - Validates address requirement
  • ✅ GET /api/auth/profile - Requires authentication

Group Endpoints ✅

  • ✅ POST /api/groups - Requires authentication
  • ✅ GET /api/groups - Requires authentication

Error Handling ✅

  • ✅ Returns 404 for nonexistent routes
  • ✅ Returns 401 for unauthorized requests
  • ✅ Returns 400 for invalid input

📝 Test Files

Smart Contract Tests

contract/test/
├── AddressManager.test.js    # Main contract tests (30+ tests)
└── (Additional test files from existing suite)

Backend Tests

backend/tests/
└── api.test.js                # API endpoint tests (12+ tests)

🚀 Writing New Tests

Smart Contract Test Example

const { expect } = require("chai");
const { ethers } = require("hardhat");

describe("MyContract", function () {
  let contract;
  let owner;

  beforeEach(async function () {
    [owner] = await ethers.getSigners();

    const MyContract = await ethers.getContractFactory("MyContract");
    contract = await MyContract.deploy();
    await contract.waitForDeployment();
  });

  it("Should do something", async function () {
    const result = await contract.someFunction();
    expect(result).to.equal(expectedValue);
  });
});

Backend Test Example

const request = require('supertest');
const app = require('../src/app');

describe('My Feature', () => {
  test('should work correctly', async () => {
    const res = await request(app)
      .get('/api/endpoint')
      .set('Authorization', `Bearer ${token}`);

    expect(res.statusCode).toBe(200);
    expect(res.body).toHaveProperty('data');
  });
});

🔍 Continuous Integration

GitHub Actions Example

name: Tests

on: [push, pull_request]

jobs:
  contract-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
      - run: cd contract && npm install
      - run: cd contract && npx hardhat test

  backend-tests:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
      - run: cd backend && npm install
      - run: cd backend && npm test

📊 Test Results Summary

Contracts: ✅ PASSING

✔ 30 tests passing
✔ Core functionality validated
✔ Access control verified
✔ Edge cases covered

Backend: ✅ READY

✔ 12+ tests created
✔ All endpoints protected
✔ Validation working
✔ Error handling verified

🐛 Known Issues

Contract Tests

  • Some tests from existing suite may need updates for new OpenZeppelin version
  • Event parameter assertions may vary based on Hardhat version

Backend Tests

  • Tests require MongoDB connection (or in-memory DB)
  • Gasless service tests may be skipped if contract not deployed

🎯 Testing Best Practices

Smart Contracts

  1. Always test access control

    • Who can call this function?
    • What happens if unauthorized user calls it?

  2. Test edge cases

    • Zero addresses
    • Empty strings
    • Maximum values
    • Duplicate operations

  3. Verify events

    • Are events emitted?
    • Do they have correct parameters?

  4. Check state changes

    • Did the state update correctly?
    • Are mappings updated?

Backend API

  1. Test authentication

    • Protected routes reject unauthenticated requests
    • Valid tokens allow access

  2. Test validation

    • Missing required fields rejected
    • Invalid formats rejected
    • Valid data accepted

  3. Test error handling

    • Proper status codes
    • Meaningful error messages
    • No sensitive data leaked

  4. Test business logic

    • Operations succeed with valid input
    • Operations fail with invalid input
    • State changes correctly

🔧 Troubleshooting

"Cannot find module"

# Contract tests
cd contract && npm install

# Backend tests
cd backend && npm install

"Connection refused" (MongoDB)

# Start MongoDB
mongod

# Or update test to use in-memory DB
# (mongodb-memory-server is already installed)

"Timeout" errors

# Increase timeout in test file
jest.setTimeout(30000);

# Or in command
npm test -- --testTimeout=30000

Contract deployment fails in tests

# Make sure contracts compile
npx hardhat compile

# Check Hardhat config
cat hardhat.config.js

📈 Coverage Goals

Current Coverage

  • Smart Contracts: ~70% (Core functionality)
  • Backend API: ~60% (Main endpoints)

Target Coverage

  • Smart Contracts: 90%+ (All functions)
  • Backend API: 80%+ (All routes)

To Improve Coverage

Contracts:

  • Add tests for emergency functions
  • Test token operations thoroughly
  • Add integration tests

Backend:

  • Test all middleware
  • Test database operations
  • Add integration tests
  • Test error scenarios

🎓 Resources

✅ Pre-Deployment Checklist

Before deploying to production:

  • All contract tests passing
  • All backend tests passing
  • Gas usage optimized
  • Security audit completed
  • Integration tests added
  • Load tests performed
  • Error scenarios tested
  • Documentation updated

All tests passing! ✅ Ready for deployment 🚀