Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/testing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Testing

ServiceControl tests are designed to test difference components and behaviors. This document outlines the tests in the respository and what they are meant to test.
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 compoonents have specific unit tests projects verifying their behaviors and API.
ServiceControl components have specific unit test projects verifying their behaviors and API.

## Packaging tests

Expand All @@ -22,7 +22,7 @@ Installation engine tests run partial installations and checks:

## Persistence tests

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

## Transport tests

Expand All @@ -38,15 +38,15 @@ Multi-instance tests validate the interaction between different ServiceControl i

## Container tests

Containers images generated for all builds are pushed to the [GitHub container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry). Once pushed all images are tested by [spinning them all up for each supported transport](/src/container-integration-test/).
Container images generated for all builds are pushed to the [GitHub container registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry). Once pushed, all images are tested by [spinning them all up for each supported transport](/src/container-integration-test/).

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](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
2. In the terminal, navigate to []`/docs/test-ghcr-tag`](/docs/test/ghcr-tag).
2. In the terminal, navigate to `[/docs/test-ghcr-tag`](/docs/test/ghcr-tag).
3. Edit the [`.env` file](/docs/test-ghcr-tag/.env) to specify the PR-based tag (in the form `pr-####`) to test.
4. Run `docker compose up -d`.
5. Services will be avialable at the following URLs:
5. Services will be available at the following URLs:
* [RabbitMQ Management](http://localhost:15672) (Login: `guest`/`guest`)
* [RavenDB](http://localhost:8080)
* [ServiceControl API](http://localhost:33333/api)
Expand Down