Testing¶

EUDIPLO is designed to be robust and easy to test both in development and CI environments. This guide outlines how to run, write, and automate tests for the project.

The current focus is on end-to-end (E2E) tests, which verify the overall functionality of the application.

OIDF Conformance Tests¶

EUDIPLO includes dedicated tests for validating compliance with the OpenID Foundation (OIDF) conformance suite for OID4VCI and OID4VP. These tests ensure that the implementation of OID4VCI (OpenID for Verifiable Credential Issuance) and OID4VP (OpenID for Verifiable Presentations) strictly follows the protocol specifications.

The test are part of the E2E tests that run in the Github Action CI pipeline for a pull request and on the main branch.

Info

Because there are no public docker images available, we are building them in a parallel github repo. Images of the suite will be build daily.

E2E Tests¶

Right now EUDIPLO has only implemented end-to-end (E2E) tests that are stored in the /test folder. These tests are designed to verify the overall functionality of the application, including interactions with external services like the EUDI Wallet.

The following command will run the E2E tests and also provide a coverage report:

pnpm run test:e2e

It is also accessible via codecov.

During writing E2E tests, you can use it in watch mode to automatically re-run tests on file changes:

pnpm run test:e2e:watch

Linting¶

Before pushing code, check linting rules and fix them:

pnpm run lint

GitHub Actions¶

Tests run automatically on every push to main or pull request via GitHub Actions.

You can find the workflow config in .github/workflows/ci-and-release.yml.

Running Tests Locally¶

To run all unit and integration tests locally:

pnpm run test

Or with watch mode:

pnpm run test:watch

This uses Vitest under the hood, which is configured for NestJS.

Test Coverage¶

The coverage is generated when running the E2E tests.

This generates a report in the /coverage folder. Open coverage/index.html in your browser to view it.

Test Structure¶

Tests are located next to their implementation files:

src/
  service/
    my.service.ts
    my.service.spec.ts  <-- Test file

Info

At this point EUDIPLO only has E2E tests. Unit and integration tests may be added in the future.