Small utility to monitor the availability of websites.
The utility consists of two components; a monitor and a writer. The monitor checks the website's availability and produces a Kafka message with the results. The writer consumes said message and persists it to a database.
The application is deployed and run as two docker containers, one per component. The containers and the backing Kafka broker and database are automatically deployed via Terraform.
To deploy the application run:
$ terraform apply
The targets input variable needs to be defined, see the variables file
Unit and integration testing is run automatically via GitHub actions on push to the main branch.
Unit tests are run automatically during the creation of the docker image.
They can however, be run manually by running tox on the repository root.
Alternatively, they can also be run with pytest assuming that the utility's dependencies are installed.
Integration tests are automated with Terraform and can be run as follows:
$ terraform apply --var="integration=true"
$ terraform destroy --var="integration=true"
The terraform code provides no configuration for the terraform Aiven provider, this means that running terraform operations on the code as-is will result in an error. It is necessary to set either the api_token provider parameter or the AIVEN_TOKEN environment variable.