Skip to content

testing.md

Latest commit

 

History

History
84 lines (58 loc) · 4.41 KB

testing.md

File metadata and controls

84 lines (58 loc) · 4.41 KB

Testing

ServiceControl tests are designed to test different components and behaviors. This document outlines the tests in the repository and what they are meant to test.

Unit tests

ServiceControl components have specific unit test projects verifying their behaviors and API.

Packaging tests

Packaging tests check:

Installation engine tests

Installation engine tests run partial installations and checks:

  • That the generated configuration is correct.
  • That transport and persistence are correctly extracted.

Persistence tests

Persistence tests check assumptions at the persistence seam level by exercising each persister.

Transport tests

Transport tests are done by executing the transport test suite for each transport.

Acceptance tests

Run ServiceControl full version and use the HTTP API to validate results. LearningTransport is used for all tests.

Multi-instance tests

Multi-instance tests validate the interaction between different ServiceControl instances. ServiceControl instances are run in-memory in the same process. LearningTransport is used for all tests.

Container tests

Container images generated for all builds are pushed to the GitHub container registry. Once pushed, all images are tested by spinning them all up for each supported transport.

Containers built by a PR and stored on GitHub Container Registry can be tested locally:

  1. Authenticate to the GitHub Container Registry using a personal access token.
    • Create a classic token. Select the scope for read:packages
    • Copy the newly created token text.
    • Run the following command in a terminal: 
      docker login ghcr.io
      you will be prompted for a username (your particular.net email) and a password (the token)
    • ensure that you get a successful login message.
    • Use docker logout ghcr.io once the following steps are complete and consider removing the token from github if its no longer needed
  2. In the terminal, navigate to /docs/test-ghcr-tag.
  3. Edit the .env file to specify the PR-based tag (in the form pr-####) to test.
  4. Run docker compose up -d.
  5. Services will be available at the following URLs:
  6. Tear down services using docker compose down.

Container tests using Aspire

The Particular.Aspire.Hosting.ServicePlatform package integrates the Particular Platform with the Aspire hosting platform. This package configures environment variables to attach the platform. There is a single file apphost in test-ghcr-tag-aspire to start up serviceconrol from a prerelease container image.

Containers built by a PR and stored on GitHub Container Registry can be tested locally:

  1. Set up your github container registry credentials as described in the Container tests section above.
  2. Make sure you have the Aspire CLI installed.
  3. Run aspire run docs/test-ghcr-tag-aspire/AppHost.cs -- tag to start the application, where tag is the PR-based tag (in the form pr-####) to test. If no tag is provided, it will default to the latest tag.
  4. Once running you can open the dashboard from the link in the terminal, this dashboard will provide the assigned ports for each service.
    • RabbitMQ Management (Login: guest/guest)
    • RavenDB
    • ServiceControl API
    • Audit API
    • Monitoring API
    • ServicePulse (latest from Docker Hub)
  5. Aspire will automatically tear down the application when you exit the CLI process.