Testing Guide

Project Test Layout

rc-unified-crm-extension/
├── packages/core/test/          # Unit tests for @app-connect/core
│   ├── setup.js                 # Syncs SQLite models, silences console, registers testUtils
│   ├── lib/                     # Pure utility tests (jwt, oauth, callLogComposer, util…)
│   ├── handlers/                # Handler tests (auth, contact, log, admin)
│   ├── models/                  # Sequelize model CRUD tests
│   ├── connector/               # Registry + proxy engine tests
│   └── mcp/tools/               # One test file per MCP tool
├── tests/                       # Root integration tests
│   ├── setup.js                 # Syncs SQLite models before all root tests
│   ├── fixtures/connectorMocks.js  # Shared mock data + factory functions for all CRMs
│   ├── platformInfo.json        # CRM platform config used in parameterised tests
│   └── connectors/              # One *.int.test.js per CRM connector
└── packages/template/test/      # Smoke tests for the template package

Running Tests

Environment: Tests automatically load packages/core/.env.test (for core) or .env.test at repo root (for integration tests). Never modify production .env for tests.

Test Type Decision

Writing Unit Tests (packages/core/test/)

Template

js
1const moduleUnderTest = require('../../../path/to/module');
2
3// Mock ALL external dependencies at the top
4jest.mock('../../../lib/jwt');
5jest.mock('../../../models/callLogModel');
6
7describe('Module Name', () => {
8  beforeEach(() => {
9    jest.clearAllMocks();
10  });
11
12  describe('functionName', () => {
13    test('should <expected behaviour> when <condition>', async () => {
14      // Arrange
15      dependency.method.mockReturnValue(value);
16
17      // Act
18      const result = await moduleUnderTest.functionName(input);
19
20      // Assert
21      expect(result).toEqual(expected);
22      expect(dependency.method).toHaveBeenCalledWith(expectedArg);
23    });
24  });
25});

Key conventions

• jest.mock() declarations go at the top of the file, before any require of the module under test.
• jest.clearAllMocks() in beforeEach (the jest config also sets clearMocks: true, but be explicit).
• Use // Arrange … // Act … // Assert comments for non-trivial tests.
• Use global.testUtils helpers from packages/core/test/setup.js:
  • createMockUser(overrides), createMockCallLog(overrides), createMockContact(overrides)
  • resetConnectorRegistry(), createMockConnector(overrides)
• For tests that need Sequelize models, use the in-memory SQLite pattern:

  js
  1jest.mock('../../models/sequelize', () => {
  2  const { Sequelize } = require('sequelize');
  3  return { sequelize: new Sequelize({ dialect: 'sqlite', storage: ':memory:', logging: false }) };
  4});

  Then await Model.sync({ force: true }) in beforeAll and await Model.destroy({ where: {} }) in afterEach.

Writing Integration Tests (tests/connectors/)

Template

js
1const nock = require('nock');
2const connector = require('../../src/connectors/<name>');
3const { createMockUser, createMockCallLog, … } = require('../fixtures/connectorMocks');
4
5jest.mock('@app-connect/core/lib/jwt', () => ({ decodeJwt: jest.fn().mockReturnValue({ id: 'decoded-user-id' }) }));
6jest.mock('@app-connect/core/models/userModel', () => ({ UserModel: { findByPk: jest.fn() } }));
7
8describe('<Name> Connector', () => {
9  let mockUser;
10
11  beforeEach(() => {
12    nock.cleanAll();
13    jest.clearAllMocks();
14    mockUser = createMockUser({ platform: '<name>', hostname: 'test.<crm>.com' });
15  });
16
17  afterEach(() => { nock.cleanAll(); });
18
19  describe('getAuthType', () => {
20    it('should return oauth', () => {
21      expect(connector.getAuthType()).toBe('oauth');
22    });
23  });
24
25  describe('findContact', () => {
26    it('should find a contact successfully', async () => {
27      // Arrange — nock intercepts the real HTTP call
28      nock('https://test.<crm>.com')
29        .get('/api/contacts')
30        .query({ query: '+1234567890' })
31        .reply(200, { data: [{ id: 1, name: 'Jane Doe' }] });
32
33      // Act
34      const result = await connector.findContact({ user: mockUser, phoneNumber: '+1234567890' });
35
36      // Assert
37      expect(result.successful).toBe(true);
38      expect(result.contact[0].name).toBe('Jane Doe');
39    });
40  });
41});

Key conventions

• Use nock (not jest.mock) for all external HTTP calls.
• Call nock.cleanAll() in both beforeEach and afterEach.
• Prefer it() in integration tests, test() in unit tests (both work — stay consistent per file).
• Import mock factories from tests/fixtures/connectorMocks.js; do not inline large mock objects.
• Cover at minimum: getAuthType, getOauthInfo/getApiKeyInfo, getUserInfo, findContact, createCallLog, updateCallLog, createMessageLog — and their error paths.

Writing MCP Tool Tests (packages/core/test/mcp/tools/)

Each file must test both sub-sections:

1. tool definition — verify definition.name, definition.description, definition.inputSchema, and required fields.
2. execute — happy path(s) + every named error condition (missing params, invalid JWT, connector not found, DB conflict, unexpected throws).

Error returns must use { success: false, error: '...' } shape; success returns { success: true, data: { … } }.

Examining Failing Tests

1. Run the specific file in isolation first:

   bash
   1npx jest packages/core/test/mcp/tools/createCallLog.test.js --no-coverage

2. Read the failure message carefully — most failures are either:
   • A mock not set up (undefined is not a function) → add/fix jest.mock().
   • Wrong assertion shape → diff actual vs expected object.
   • nock: No match for request → the interceptor URL/method/body doesn't match the real call.
3. Use --verbose to see individual test names:

   bash
   1npx jest tests/connectors/pipedrive.int.test.js --verbose --no-coverage

4. Check packages/core/.env.test is present and DATABASE_URL='sqlite::memory:' is set.

Is It the Test or the Code?

Before touching anything, decide which side is wrong. Getting this wrong wastes time or, worse, silences a real bug.

Ask these questions first

Decision rules for this codebase

Fix the code when:

• A connector function returns a different shape than what the integration test expects and the test was written against the documented CRM API contract.
• A handler test fails because error-handling logic was removed or changed in packages/core/handlers/.
• An MCP tool test fails on { success: false } but the tool was supposed to succeed — the tool's execute() is throwing unexpectedly.

Fix the test when:

• A refactor renamed an internal helper but the external behaviour is unchanged — update jest.mock() paths and call assertions.
• A mock was returning a stale data shape (e.g. UserModel.findByPk now returns an extra field) — update the mock return value in the test, not the model.
• The test was asserting on a hardcoded string that changed for a legitimate UX/copy reason.
• expect(...).toHaveBeenCalledWith(...) fails because the function signature gained a new optional param — update the assertion, not the code.

When it's genuinely unclear

1. Read the git blame / git log for the file under test — identify what changed and when.
2. Revert just that change locally (git stash or a temp branch) and re-run the test. If it goes green, the code change broke it.
3. If the test was never green (new test file), manually trace the code path by reading the source — don't assume the test is right.
4. Prefer fixing the code if the test was written before the code change; prefer fixing the test if the test was written after.

Fixing Tests

• Mock drift: When the module under test changes its internal calls, update the corresponding jest.mock() return values and expect(...).toHaveBeenCalledWith(...) assertions.
• nock mismatch: Log the real outgoing request with nock.recorder.rec() temporarily to capture the exact URL/body, then match the interceptor.
• SQLite schema mismatch: If a model adds a new column, add it to the createMockUser/CallLog factory and re-sync with { force: true }.
• Timeout: Increase the specific test with test('…', async () => { … }, 60000) or check for an unresolved promise (missing await).

Coverage

The core package collects coverage automatically. View the HTML report after running:

bash
1npm run test:coverage --workspace=@app-connect/core
2# Report at packages/core/coverage/index.html

Target: keep coverage stable or improving — CI runs npm run test-coverage on every push and PR.

Additional Reference

• Fixtures: tests/fixtures/connectorMocks.js
• Core test setup: packages/core/test/setup.js
• Jest config (core): packages/core/jest.config.js
• Jest config (root): jest.config.js
• CI workflow: .github/workflows/tests.yml