How to Perform E2E Testing with AdonisJS 6 and Vitest Without Using Japa?

[apirak]

I am currently working on testing AdonisJS 6 using Vitest instead of the official Japa framework. While unit testing with mocked models works fine, I encounter issues when attempting to perform E2E tests involving real database interactions through models.

✅ Unit Test (Works as Expected)
I can successfully mock and test model behavior like this:

import Document from '#models/document';
import { describe, expect, it, vi } from 'vitest';
import { getDocument } from '../../../app/use_case/document.js';

describe('getDocument', () => {
  it('should throw an error if documentId is not specified', async () => {
    const document = new Document();
    document.title = 'title';
    document.content = 'content';

    vi.spyOn(document, 'save').mockResolvedValue(document); // <-- Mock Save method
    document.save();

    await expect(getDocument('droidId')).rejects.toThrow('Document not specified');
  });
});

❌ E2E Test (Fails with TypeError)
However, when I try to test real database interactions (e.g., save() method), I encounter this error:

import Document from '#models/document';
import { describe, expect, it } from 'vitest';
import { getDocument } from '../../../app/use_case/document.js';

describe('getDocument', () => {
  it('should throw an error if document is not specified', async () => {
    const document = new Document();
    document.title = 'title';
    document.content = 'content';
    await document.save();  // <-- This throws an error

    await expect(getDocument('abc')).rejects.toThrow('Document not specified');
  });
});

Error Message
TypeError: Cannot read properties of undefined (reading 'insert')

🙇‍♂️ Question:

Do I need to initialize the database connection differently for Vitest? Or is there a workaround to make model operations (e.g., save(), query()) work correctly during tests?

Any guidance or best practices would be greatly appreciated! 🙏✨

[muco-rolle]

Hey @apirak, why do you prefer using Vitest over Japa? I think Japa would provide a better user experience.

[apirak]

Hey @apirak, why do you prefer using Vitest over Japa? I think Japa would provide a better user experience.

Thank you Muco, Our other projects using Vitest. To use a single testing framework minimizes context switching for our team 🙇‍♂️