# Testing

## Unit tests

We are using Jest.

Simply run `pnpm test` to run all the tests locally.

## Integration Tests

We are using Jest to test the following concerns:

1. Main application flows and integration of different services
2. Containerize execution of all services
3. Cross-service network calls

Integration tests are based pre-built Docker images, so you can run it in 2 modes:

#### Running from source code

To run integration tests locally, from the local source code, you need to build a valid Docker
image.

To do so, follow these instructions:

2. Install all deps: `pnpm i`
3. Generate types: `pnpm graphql:generate`
4. Build source code: `pnpm build`
5. Set env vars:

```
export COMMIT_SHA="local"
export RELEASE="local"
export BRANCH_NAME="local"
export BUILD_TYPE=""
export DOCKER_TAG=":local"
```

6. Compile a local Docker image by running: `docker buildx bake -f docker.hcl build --load`
7. Use Docker Compose to run the built containers (based on `community` compose file), along with
   the extra containers:

```
export DOCKER_TAG=":local"
export DOCKER_REGISTRY=""

docker compose -f docker-compose.community.yml -f ./integration-tests/docker-compose.integration.yaml --env-file ./integration-tests/.env up -d --wait
```

8. Run the tests: `pnpm --filter integration-tests test:integration`

#### Running from pre-built Docker image

To run integration tests locally, from the pre-build Docker image, follow:

1. Install all deps: `pnpm i`
2. Generate types: `pnpm graphql:generate`
3. Build only addition, local CF Workers source code, by running:
   `pnpm --filter integration-tests prepare:env`
4. Decide on the commit ID / Docker image tag you would like to use (make sure `build-and-dockerize`
   is done successfully)
5. Set the needed env vars, and use Docker Compose to run all local services:

```
export DOCKER_REGISTRY="ghcr.io/kamilkisiela/graphql-hive/"
export DOCKER_TAG=":IMAGE_TAG_HERE"

docker compose -f docker-compose.community.yml -f ./integration-tests/docker-compose.integration.yaml --env-file ./integration-tests/.env up -d --wait
```

6. Run the tests: `pnpm --filter integration-tests test:integration`

## e2e Tests

e2e Tests are based on Cypress, and matches files that ends with `.cy.ts`. The tests flow runs from
a pre-build Docker image.

#### Running from source code

To run e2e tests locally, from the local source code, follow:

1. Make sure you have Docker installed. If you are having issues, try to run `docker system prune`
   to clean the Docker caches.
2. Install all deps: `pnpm i`
3. Generate types: `pnpm graphql:generate`
4. Build source code: `pnpm build`
5. Set env vars:

```
export COMMIT_SHA="local"
export RELEASE="local"
export BRANCH_NAME="local"
export BUILD_TYPE=""
export DOCKER_TAG=":local"
```

6. Compile a local Docker image by running: `docker buildx bake -f docker.hcl build --load`
7. Run the e2e environment, by running:
   `docker compose -f docker-compose.community.yml --env-file ./integration-tests/.env up -d --wait`
8. Run Cypress: `pnpm test:e2e`

#### Running from pre-built Docker image

To run integration tests locally, from the pre-build Docker image, follow:

1. Make sure you have Docker installed. If you are having issues, try to run `docker system prune`
   to clean the Docker caches.
2. Install all deps: `pnpm i`
3. Generate types: `pnpm graphql:generate`
4. Build source code: `pnpm build`
5. Decide on the commit ID / Docker image tag you would like to use.
6. Run the e2e environment, by running:
   `docker compose -f docker-compose.community.yml --env-file ./integration-tests/.env up -d --wait`
7. Run Cypress: `pnpm test:e2e`

#### Docker Compose configuration

Keep in mind that integration tests are running a combination of 2 Docker Compose files:

1. `docker-compose.community.yml` - this is also used for self-hosting Hive, so this file contains
   all services and configurations needed for running Hive core (without SaaS-specific services,
   like billing).
2. `docker-compose.integration.yaml` - An extension and overrides file: we are using that file to
   run local services such as CloudFlare CDN mock, external composition service and so on - this is
   done in order to mock a complete Hive SaaS environment and test all features. **This file also
   includes overrides such as environment variables that are specific only for integration testing -
   so make sure to choose wisely where to add environment variables!**

## Troubleshoot

If you are having issues with running Docker images, follow these instructions:

1. Make sure you have latest Docker installed.
1. Make sure no containers are running (`docker ps` and then `docker stop CONTAINER_ID`).
1. Delete the local volume used for testing, it's located under `.hive` directory.
1. Try to run `docker system prune` to clean all the Docker images, containers, networks and caches.