Skip to content

Latest commit

 

History

History
108 lines (77 loc) · 4.46 KB

README.md

File metadata and controls

108 lines (77 loc) · 4.46 KB
Raw


Logo

Authority Portal

Backend + Frontend + E2E Tests
Report Bug · Request Feature

About This Component

Backend for the Authority Portal. Built with Quarkus, Kotlin and JOOQ.

(back to top)

Development

Local Development

Use Unit Tests and Integration Tests to test complexity and functionality of API endpoints.

The naming of the types of tests is not standardized. The distinction between E2E, Integration and Unit Tests is made here purely for the sake of explanation. One might argue all the these types of tests to be unit tests:

  • (Backend) E2E Tests:
    • These tests call entire API endpoints of a running application started by @QuarkusTest.
    • These tests need to manually clean the database after themselves, since the transaction breaks from "making a call to the backend via REST", so @TestTransaction is unavailable.
    • You can still use Quarkus' @InjectMock to mock parts of the running application, e.g. a KeycloakService.
  • Integration Tests:
    • These tests test ApiServices of a running backend started by @QuarkusTest
    • They are faster than E2E Tests due to being able to use @TestTransaction which allows them to not dirty the DB.
    • They might not test for HTTP-Related things such as additional headers as the above E2E Tests do.
    • You can still use Quarkus' @InjectMock to mock parts of the running application, e.g. a KeycloakService.
  • Unit Tests:
    • These tests should not be annotated with @QuarkusTest and should not require a DB.
    • If the unit under test is a CDI unit (e.g. a Service), Mockito will be used to create mocks for all the unit's dependencies.
    • Unit tests are lightning fast, because they don't need to start a quarkus application, postgresql testcontainers, etc.
    • Life is easy when all code with branch-wise complexity is tested locally by unit tests, so it can then be used in integration tests without having to test all branches again.
    • A large part of being a senior software developer is about learning how to structure code so that the complexity can be tested locally, allowing both code and tests to stay simple and manageable.
    • Unit test don't work well when the unit under test contains db concerns. For testing code that uses JooQ Integration Tests are recommended.

(back to top)

Local E2E Development

To start the backend in development mode, a JDK17 and docker are required.

./gradlew clean quarkusDev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/

(back to top)

Local E2E Development: Basic Auth

To simplify local development there are dev users available, see:

(back to top)

Keycloak

Local development uses a Keycloak instance launched by Quarkus Dev Services both for authentication and manual testing of our interactions with the Keycloak Admin API.

To add new Roles to the Dev Keycloak or change the Keycloak Realm Config, please refer to our Keycloak Realm Export Documentation.

(back to top)

License

See LICENSE for more information.

(back to top)

Contact

[email protected]

(back to top)